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

Class HgInterface

source code

                             object --+    
                                      |    
GeneralVCSInterface.GeneralVCSInterface --+
                                          |
                                         HgInterface

The interface class to mercurial

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
 
addPath(self, path, rules=[])
Add the path to the repository (no commit)
source code
 
clone(self, dest)
Clone the repository
source code
 
branchName(self)
Return the branch-name (or another identifying string)
source code
 
getRevision(self)
Get the current revision number
source code
 
commit(self, msg)
Commit the current state
source code
 
update(self, timeout=None)
Update the working copy from the parent repository
source code
 
addGlobToIgnore(self, expr)
Add to the ignore-facility of the current VCS
source code
 
addRegexpToIgnore(self, expr)
Add to the ignore-facility of the current VCS
source code
 
addToHgIgnore(self, expr) source code

Inherited from GeneralVCSInterface.GeneralVCSInterface: addStandardIgnores, 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)

addPath(self, path, rules=[])

source code 

Add the path to the repository (no commit)

Parameters:
  • path - the path (directory or file) to commit
  • rules - a list of tuples: first is whether to include or exclude the regular expression that is the second member of the tuple
Overrides: GeneralVCSInterface.GeneralVCSInterface.addPath
(inherited documentation)

clone(self, dest)

source code 

Clone the repository

Parameters:
  • dest - the path that should be clones to
Overrides: GeneralVCSInterface.GeneralVCSInterface.clone
(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)

commit(self, msg)

source code 

Commit the current state

Parameters:
  • msg - Commit message
Overrides: GeneralVCSInterface.GeneralVCSInterface.commit
(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)

addGlobToIgnore(self, expr)

source code 

Add to the ignore-facility of the current VCS

Parameters:
  • expr - a glob expression
Overrides: GeneralVCSInterface.GeneralVCSInterface.addGlobToIgnore
(inherited documentation)

addRegexpToIgnore(self, expr)

source code 

Add to the ignore-facility of the current VCS

Parameters:
  • expr - a regular expression
Overrides: GeneralVCSInterface.GeneralVCSInterface.addRegexpToIgnore
(inherited documentation)