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

Class GeneralVCSInterface

source code


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 help(type(x)) for signature
source code
 
addGlobToIgnore(self, expr)
Add to the ignore-facility of the current VCS
source code
 
addPath(self, path, rules=[])
Add the path to the repository (no commit)
source code
 
addRegexpToIgnore(self, expr)
Add to the ignore-facility of the current VCS
source code
 
addStandardIgnores(self)
Add the usual ignores
source code
 
branchName(self)
Return the branch-name (or another identifying string)
source code
 
clone(self, dest)
Clone the repository
source code
 
commit(self, msg)
Commit the current state
source code
 
doInPath(self, func, *args, **kwargs)
Execute a function in the root directory of the repository.
source code
 
executeWithOuput(self, cmd)
Executes a command and returns the output
source code
 
getRevision(self)
Get the current revision number
source code
 
getRoot(self, path)
Returns the actual repository root for a path.
source code
 
update(self, timeout=None)
Update the working copy from the parent repository
source code

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__

addGlobToIgnore(self, expr)

source code 

Add to the ignore-facility of the current VCS

Parameters:
  • expr - a glob expression

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

addRegexpToIgnore(self, expr)

source code 

Add to the ignore-facility of the current VCS

Parameters:
  • expr - a regular expression

clone(self, dest)

source code 

Clone the repository

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

commit(self, msg)

source code 

Commit the current state

Parameters:
  • msg - Commit message

doInPath(self, func, *args, **kwargs)

source code 

Execute a function in the root directory of the repository. Afterwards change back ot the original directory. Result of the function is returned

Parameters:
  • func - the function to be executed

getRoot(self, path)

source code 

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

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)