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

Class GeneralVCSInterface

source code

object --+
         |
        GeneralVCSInterface

This is an abstract class that implements an interface to general VCS operations

Instance Methods [hide private]
 
__init__(self, path, init=False)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
commit(self, msg)
Commit the current state
source code
 
addPath(self, path, rules=[])
Add the path to the repository (no commit)
source code
 
clone(self, dest)
Clone the repository
source code
 
addRegexpToIgnore(self, expr)
Add to the ignore-facility of the current VCS
source code
 
addGlobToIgnore(self, expr)
Add to the ignore-facility of the current VCS
source code
 
addStandardIgnores(self)
Add the usual ignores
source code

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__

commit(self, msg)

source code 

Commit the current state

Parameters:
  • msg - Commit message

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

clone(self, dest)

source code 

Clone the repository

Parameters:
  • dest - the path that should be clones to

addRegexpToIgnore(self, expr)

source code 

Add to the ignore-facility of the current VCS

Parameters:
  • expr - a regular expression

addGlobToIgnore(self, expr)

source code 

Add to the ignore-facility of the current VCS

Parameters:
  • expr - a glob expression