PyFoam.Basics.HgInterface module

A VCS-interface to Mercurial

class PyFoam.Basics.HgInterface.HgInterface(path, init=False)[source]

Bases: PyFoam.Basics.GeneralVCSInterface.GeneralVCSInterface

The interface class to mercurial

__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.HgInterface'
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

addToHgIgnore(expr)[source]
branchName()[source]

Return the branch-name (or another identifying string)

clone(dest)[source]

Clone the repository :param dest: the path that should be clones to

commit(msg)[source]

Commit the current state :param msg: Commit message

getRevision()[source]

Get the current revision number

getRoot(path)[source]

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

update(timeout=None)[source]

Update the working copy from the parent repository :param timeout: Wait a maximum time (if the VCS supports this)