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 x.__class__.__doc__ for signature
source code
 
addPath(self, path, rules=[])
Add the path to the repository (no commit)
source code
 
clone(self, dest)
Clone the repository
source code
 
commit(self, msg)
Commit the current state
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

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

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

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ 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)

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)

commit(self, msg)

source code 

Commit the current state

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