Class p.u.a.i.ILocalVCS(Interface):

Part of pida.utils.anyvc.interfaces View In Hierarchy

Known subclasses: pida.utils.anyvc.interfaces.IDistributedVCS

a high level interface to local vcs operations on a revision controlled directory
Line # Kind Name Docs
32 Method configure Set up the instace for the actual vcs
35 Method is_in determine if a directory is managed by the implementing vcs
38 Method parse_list_item item is a rcs-specidic file entry, returns a stated file
41 Method _list_impl iterate over vcs specifiv file entries
44 Method list return an iterator over stated files
47 Method diff differences of all files below the paths
50 Method update update to the most recent revision
53 Method commit commit all changes of files below the paths
58 Method revert revert all changes in files below the paths
64 Method add adds all paths to version controll
70 Method drop removes a path from version-controll
def configure():
Set up the instace for the actual vcs
def is_in(dir):
determine if a directory is managed by the implementing vcs
def parse_list_item(item):
item is a rcs-specidic file entry, returns a stated file
def _list_impl(paths=None, recursive=None):
iterate over vcs specifiv file entries
def list(paths=None, recursive=False):
return an iterator over stated files
def diff(paths=None):
differences of all files below the paths
def update():
update to the most recent revision
def commit(paths=None):

commit all changes of files below the paths

  • might be a network operation
def revert(paths=None, missing=False):

revert all changes in files below the paths

  • if missing is True only restore deleted files wich are still in revision controll
def add(paths=None, recursive=False):

adds all paths to version controll

  • if recursive is True add all files/directories below paths to the rcs
def drop(paths=None, execute=False, recursive=False):

removes a path from version-controll if its not recursive it will fail on directories wich contain versioned files

params:
execute -- also remove the files from the local filesystem recursive -- recurse a directory tree - use with caution
API Documentation for PIDA, generated by pydoctor.