Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
upload.VersionControlSystem Class Reference
+ Inheritance diagram for upload.VersionControlSystem:
+ Collaboration diagram for upload.VersionControlSystem:

Public Member Functions

def __init__
 
def GenerateDiff
 
def GetUnknownFiles
 
def CheckForUnknownFiles
 
def GetBaseFile
 
def GetBaseFiles
 
def UploadBaseFiles
 
def IsImage
 
def __init__
 
def GenerateDiff
 
def GetUnknownFiles
 
def CheckForUnknownFiles
 
def GetBaseFile
 
def GetBaseFiles
 
def UploadBaseFiles
 
def IsImage
 

Public Attributes

 options
 

Detailed Description

Abstract base class providing an interface to the VCS.

Definition at line 588 of file upload.py.

View newest version in sPHENIX GitHub at line 588 of file upload.py

Constructor & Destructor Documentation

def upload.VersionControlSystem.__init__ (   self,
  options 
)
Constructor.

Args:
  options: Command line options.

Definition at line 591 of file upload.py.

View newest version in sPHENIX GitHub at line 591 of file upload.py

Referenced by upload.VersionControlSystem.__init__().

+ Here is the caller graph for this function:

def upload.VersionControlSystem.__init__ (   self,
  options 
)

Member Function Documentation

def upload.VersionControlSystem.CheckForUnknownFiles (   self)
Show an "are you sure?" prompt if there are unknown files.

Definition at line 613 of file upload.py.

View newest version in sPHENIX GitHub at line 613 of file upload.py

References upload.ErrorExit(), and upload.VersionControlSystem.GetUnknownFiles().

Referenced by upload.VersionControlSystem.CheckForUnknownFiles().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

def upload.VersionControlSystem.CheckForUnknownFiles (   self)
Show an "are you sure?" prompt if there are unknown files.

Definition at line 613 of file upload.py.

View newest version in sPHENIX GitHub at line 613 of file upload.py

References upload.VersionControlSystem.CheckForUnknownFiles(), upload.ErrorExit(), and upload.VersionControlSystem.GetUnknownFiles().

+ Here is the call graph for this function:

def upload.VersionControlSystem.GenerateDiff (   self,
  args 
)
Return the current diff as a string.

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

Definition at line 599 of file upload.py.

View newest version in sPHENIX GitHub at line 599 of file upload.py

References upload.VersionControlSystem.GenerateDiff().

+ Here is the call graph for this function:

def upload.VersionControlSystem.GenerateDiff (   self,
  args 
)
Return the current diff as a string.

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

Definition at line 599 of file upload.py.

View newest version in sPHENIX GitHub at line 599 of file upload.py

Referenced by upload.VersionControlSystem.GenerateDiff().

+ Here is the caller graph for this function:

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.

Definition at line 625 of file upload.py.

View newest version in sPHENIX GitHub at line 625 of file upload.py

Referenced by upload.VersionControlSystem.GetBaseFile(), and upload.VersionControlSystem.GetBaseFiles().

+ Here is the caller graph for this function:

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.

Definition at line 625 of file upload.py.

View newest version in sPHENIX GitHub at line 625 of file upload.py

References upload.VersionControlSystem.GetBaseFile().

+ Here is the call graph for this function:

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 642 of file upload.py.

View newest version in sPHENIX GitHub at line 642 of file upload.py

References upload.VersionControlSystem.GetBaseFile(), and upload.VersionControlSystem.UploadBaseFiles().

Referenced by upload.VersionControlSystem.GetBaseFiles().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 642 of file upload.py.

View newest version in sPHENIX GitHub at line 642 of file upload.py

References upload.VersionControlSystem.GetBaseFile(), upload.VersionControlSystem.GetBaseFiles(), and upload.VersionControlSystem.UploadBaseFiles().

+ Here is the call graph for this function:

def upload.VersionControlSystem.GetUnknownFiles (   self)
Return a list of files unknown to the VCS.

Definition at line 608 of file upload.py.

View newest version in sPHENIX GitHub at line 608 of file upload.py

References upload.VersionControlSystem.GetUnknownFiles().

+ Here is the call graph for this function:

def upload.VersionControlSystem.GetUnknownFiles (   self)
Return a list of files unknown to the VCS.

Definition at line 608 of file upload.py.

View newest version in sPHENIX GitHub at line 608 of file upload.py

Referenced by upload.VersionControlSystem.CheckForUnknownFiles(), and upload.VersionControlSystem.GetUnknownFiles().

+ Here is the caller graph for this function:

def upload.VersionControlSystem.IsImage (   self,
  filename 
)
Returns true if the filename has an image extension.

Definition at line 713 of file upload.py.

View newest version in sPHENIX GitHub at line 713 of file upload.py

References upload.VersionControlSystem.IsImage().

+ Here is the call graph for this function:

def upload.VersionControlSystem.IsImage (   self,
  filename 
)
Returns true if the filename has an image extension.

Definition at line 713 of file upload.py.

View newest version in sPHENIX GitHub at line 713 of file upload.py

Referenced by upload.SubversionVCS.GetBaseFile(), upload.MercurialVCS.GetBaseFile(), and upload.VersionControlSystem.IsImage().

+ Here is the caller graph for this function:

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 662 of file upload.py.

View newest version in sPHENIX GitHub at line 662 of file upload.py

References upload.EncodeMultipartFormData(), upload.StatusUpdate(), and str.

+ Here is the call graph for this function:

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 662 of file upload.py.

View newest version in sPHENIX GitHub at line 662 of file upload.py

References upload.EncodeMultipartFormData(), upload.StatusUpdate(), and str.

Referenced by upload.VersionControlSystem.GetBaseFiles().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

upload.VersionControlSystem.options

Definition at line 597 of file upload.py.

View newest version in sPHENIX GitHub at line 597 of file upload.py

Referenced by upload.VersionControlSystem.__init__().


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