PyFoam.Basics.GeneralVCSInterface module¶
General interface to VCS implementations
-
class
PyFoam.Basics.GeneralVCSInterface.
GeneralVCSInterface
(path, init=False)[source]¶ Bases:
object
This is an abstract class that implements an interface to general VCS operations
-
__dict__
= dict_proxy({'getRevision': <function getRevision>, '__module__': 'PyFoam.Basics.GeneralVCSInterface', 'getRoot': <function getRoot>, 'addGlobToIgnore': <function addGlobToIgnore>, 'clone': <function clone>, 'doInPath': <function doInPath>, 'update': <function update>, '__doc__': 'This is an abstract class that implements an interface to general VCS operations', 'executeWithOuput': <function executeWithOuput>, 'addStandardIgnores': <function addStandardIgnores>, '__dict__': <attribute '__dict__' of 'GeneralVCSInterface' objects>, 'commit': <function commit>, 'addRegexpToIgnore': <function addRegexpToIgnore>, 'branchName': <function branchName>, '__weakref__': <attribute '__weakref__' of 'GeneralVCSInterface' objects>, 'addPath': <function addPath>, '__init__': <function __init__>})¶
-
__init__
(path, init=False)[source]¶ Parameters: - path – path which is supposed to be under version control
- init – initialize the version control system here
-
__module__
= 'PyFoam.Basics.GeneralVCSInterface'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
addGlobToIgnore
(expr)[source]¶ Add to the ignore-facility of the current VCS :param expr: a glob expression
-
addPath
(path, rules=[])[source]¶ Add the path to the repository (no commit) :param path: the path (directory or file) to commit :param rules: a list of tuples: first is whether to include or exclude the regular expression that is the second member of the tuple
-
addRegexpToIgnore
(expr)[source]¶ Add to the ignore-facility of the current VCS :param expr: a regular expression
-
doInPath
(func, *args, **kwargs)[source]¶ 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
-
-
PyFoam.Basics.GeneralVCSInterface.
getVCS
(vcs, path, init=False, tolerant=False)[source]¶ Factory to create a proper VCS-interface :param vcs: name of the VCS-implementation :param path: path which is under version control :param init: whether the Version-control should be initialized here :param tolerant: If there is no interface for the VCS in question return None