upload.VersionControlSystem Class Reference

Inheritance diagram for upload.VersionControlSystem:

Public Member Functions
def	__init__ (self, options)
def	GenerateDiff (self, args)
def	GetUnknownFiles (self)
def	CheckForUnknownFiles (self)
def	GetBaseFile (self, filename)
def	GetBaseFiles (self, diff)
def	UploadBaseFiles (self, issue, rpc_server, patch_list, patchset, options, files)
def	IsImage (self, filename)

Public Attributes
	options

Detailed Description

Abstract base class providing an interface to the VCS.

Definition at line 603 of file upload.py.

Constructor & Destructor Documentation

__init__()

def upload.VersionControlSystem.__init__	(		self,
			options
	)

Constructor.

Args:
  options: Command line options.

Reimplemented in upload.SubversionVCS, upload.GitVCS, and upload.MercurialVCS.

Definition at line 606 of file upload.py.

  def __init__(self, options):
    """Constructor.
 
    Args:
      options: Command line options.
    """
    self.options = options
 

Member Function Documentation

CheckForUnknownFiles()

def upload.VersionControlSystem.CheckForUnknownFiles

(

self

)

Show an "are you sure?" prompt if there are unknown files.

Definition at line 628 of file upload.py.

  def CheckForUnknownFiles(self):
    """Show an "are you sure?" prompt if there are unknown files."""
    unknown_files = self.GetUnknownFiles()
    if unknown_files:
      print "The following files are not added to version control:"
      for line in unknown_files:
        print line
      prompt = "Are you sure to continue?(y/N) "
      answer = raw_input(prompt).strip()
      if answer != "y":
        ErrorExit("User aborted")
 

GenerateDiff()

def upload.VersionControlSystem.GenerateDiff	(		self,
			args
	)

Return the current diff as a string.

Args:
  args: Extra arguments to pass to the diff command.

Reimplemented in upload.SubversionVCS, upload.GitVCS, and upload.MercurialVCS.

Definition at line 614 of file upload.py.

  def GenerateDiff(self, args):
    """Return the current diff as a string.
 
    Args:
      args: Extra arguments to pass to the diff command.
    """
    raise NotImplementedError(
        "abstract method -- subclass %s must override" % self.__class__)
 

GetBaseFile()

def upload.VersionControlSystem.GetBaseFile	(		self,
			filename
	)

Get the content of the upstream version of a file.

Returns:
  A tuple (base_content, new_content, is_binary, status)
    base_content: The contents of the base file.
    new_content: For text files, this is empty.  For binary files, this is
      the contents of the new file, since the diff output won't contain
      information to reconstruct the current file.
    is_binary: True iff the file is binary.
    status: The status of the file.

Reimplemented in upload.SubversionVCS, upload.GitVCS, and upload.MercurialVCS.

Definition at line 640 of file upload.py.

  def GetBaseFile(self, filename):
    """Get the content of the upstream version of a file.
 
    Returns:
      A tuple (base_content, new_content, is_binary, status)
        base_content: The contents of the base file.
        new_content: For text files, this is empty.  For binary files, this is
          the contents of the new file, since the diff output won't contain
          information to reconstruct the current file.
        is_binary: True iff the file is binary.
        status: The status of the file.
    """
 
    raise NotImplementedError(
        "abstract method -- subclass %s must override" % self.__class__)
 
 

GetBaseFiles()

def upload.VersionControlSystem.GetBaseFiles	(		self,
			diff
	)

Helper that calls GetBase file for each file in the patch.

Returns:
  A dictionary that maps from filename to GetBaseFile's tuple.  Filenames
  are retrieved based on lines that start with "Index:" or
  "Property changes on:".

Definition at line 657 of file upload.py.

  def GetBaseFiles(self, diff):
    """Helper that calls GetBase file for each file in the patch.
 
    Returns:
      A dictionary that maps from filename to GetBaseFile's tuple.  Filenames
      are retrieved based on lines that start with "Index:" or
      "Property changes on:".
    """
    files = {}
    for line in diff.splitlines(True):
      if line.startswith('Index:') or line.startswith('Property changes on:'):
        unused, filename = line.split(':', 1)
        # On Windows if a file has property changes its filename uses '\'
        # instead of '/'.
        filename = filename.strip().replace('\\', '/')
        files[filename] = self.GetBaseFile(filename)
    return files
 
 

GetUnknownFiles()

def upload.VersionControlSystem.GetUnknownFiles

(

self

)

Return a list of files unknown to the VCS.

Reimplemented in upload.SubversionVCS, upload.GitVCS, and upload.MercurialVCS.

Definition at line 623 of file upload.py.

  def GetUnknownFiles(self):
    """Return a list of files unknown to the VCS."""
    raise NotImplementedError(
        "abstract method -- subclass %s must override" % self.__class__)
 

IsImage()

def upload.VersionControlSystem.IsImage	(		self,
			filename
	)

Returns true if the filename has an image extension.

Definition at line 728 of file upload.py.

  def IsImage(self, filename):
    """Returns true if the filename has an image extension."""
    mimetype =  mimetypes.guess_type(filename)[0]
    if not mimetype:
      return False
    return mimetype.startswith("image/")
 
 

UploadBaseFiles()

def upload.VersionControlSystem.UploadBaseFiles	(		self,
			issue,
			rpc_server,
			patch_list,
			patchset,
			options,
			files
	)

Uploads the base files (and if necessary, the current ones as well).

Definition at line 676 of file upload.py.

                      files):
    """Uploads the base files (and if necessary, the current ones as well)."""
 
    def UploadFile(filename, file_id, content, is_binary, status, is_base):
      """Uploads a file to the server."""
      file_too_large = False
      if is_base:
        type = "base"
      else:
        type = "current"
      if len(content) > MAX_UPLOAD_SIZE:
        print ("Not uploading the %s file for %s because it's too large." %
               (type, filename))
        file_too_large = True
        content = ""
      checksum = md5.new(content).hexdigest()
      if options.verbose > 0 and not file_too_large:
        print "Uploading %s file for %s" % (type, filename)
      url = "/%d/upload_content/%d/%d" % (int(issue), int(patchset), file_id)
      form_fields = [("filename", filename),
                     ("status", status),
                     ("checksum", checksum),
                     ("is_binary", str(is_binary)),
                     ("is_current", str(not is_base)),
                    ]
      if file_too_large:
        form_fields.append(("file_too_large", "1"))
      if options.email:
        form_fields.append(("user", options.email))
      ctype, body = EncodeMultipartFormData(form_fields,
                                            [("data", filename, content)])
      response_body = rpc_server.Send(url, body,
                                      content_type=ctype)
      if not response_body.startswith("OK"):
        StatusUpdate("  --> %s" % response_body)
        sys.exit(1)
 
    patches = dict()
    [patches.setdefault(v, k) for k, v in patch_list]
    for filename in patches.keys():
      base_content, new_content, is_binary, status = files[filename]
      file_id_str = patches.get(filename)
      if file_id_str.find("nobase") != -1:
        base_content = None
        file_id_str = file_id_str[file_id_str.rfind("_") + 1:]
      file_id = int(file_id_str)
      if base_content != None:
        UploadFile(filename, file_id, base_content, is_binary, status, True)
      if new_content != None:
        UploadFile(filename, file_id, new_content, is_binary, status, False)
 

Member Data Documentation

options

upload.VersionControlSystem.options

Definition at line 612 of file upload.py.

---

The documentation for this class was generated from the following file:

• /media/home/debian/src/github/tesseract-ocr/tesseract/unittest/third_party/googletest/googletest/scripts/upload.py