Package PyFoam :: Package Basics :: Module GitInterface :: Class GitInterface
[hide private]
[frames] | no frames]

Class GitInterface

source code

                             object --+    
                                      |    
GeneralVCSInterface.GeneralVCSInterface --+
                                          |
                                         GitInterface

The interface class to git

Only a partial implementation (As much as the BuildHelper needs)

Instance Methods [hide private]
 
__init__(self, path, init=False)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
getRoot(self, path)
Returns the actual repository root for a path.
source code
 
branchName(self)
Return the branch-name (or another identifying string)
source code
 
getRevision(self)
Get the current revision number
source code
 
update(self, timeout=None)
Update the working copy from the parent repository
source code

Inherited from GeneralVCSInterface.GeneralVCSInterface: addGlobToIgnore, addPath, addRegexpToIgnore, addStandardIgnores, clone, commit, doInPath, executeWithOuput

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, path, init=False)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • path - path which is supposed to be under version control
  • init - initialize the version control system here
Overrides: object.__init__
(inherited documentation)

getRoot(self, path)

source code 

Returns the actual repository root for a path. Default implmentation passes through the path

Overrides: GeneralVCSInterface.GeneralVCSInterface.getRoot
(inherited documentation)

branchName(self)

source code 

Return the branch-name (or another identifying string)

Overrides: GeneralVCSInterface.GeneralVCSInterface.branchName
(inherited documentation)

getRevision(self)

source code 

Get the current revision number

Overrides: GeneralVCSInterface.GeneralVCSInterface.getRevision
(inherited documentation)

update(self, timeout=None)

source code 

Update the working copy from the parent repository

Parameters:
  • timeout - Wait a maximum time (if the VCS supports this)
Overrides: GeneralVCSInterface.GeneralVCSInterface.update
(inherited documentation)