The VcsClient class provides a generic API for
API for interacting with source-controlled paths independent of actual version-control implementation.
Parameters: |
|
---|
Returns: | True if path exists on disk. |
---|
Returns: | filesystem path this client is initialized with. |
---|
client can decide whether the url and the other url are equivalent. Checks string equality by default
Parameters: | url_or_shortcut – url or shortcut (e.g. bzr launchpad url) |
---|---|
Returns: | bool if params are equivalent |
Parameters: | spec – token for identifying repository revision desired. Token might be a tagname, branchname, version-id, or SHA-ID depending on the VCS implementation.
|
---|---|
Returns: | current revision number of the repository. Or if spec is provided, the globally unique identifier (e.g. revision number, or SHA-ID) of a revision specified by some token. |
Find an identifier for the current revision on remote. Token spec might be a tagname, version-id, SHA-ID, ... depending on the VCS implementation.
Parameters: | fetch – if False, only local information may be used |
---|---|
Returns: | current revision number of the remote repository. |
Find an description for the current local version. Token spec might be a branchname, version-id, SHA-ID, ... depending on the VCS implementation.
returns: short description of local version (e.g. branchname, tagename).
Checkout the given URL to the path associated with this client.
Parameters: |
|
---|
Update the local checkout from upstream source control.
Returns: | True if path has a checkout with matching VCS type, e.g. if the type of this client is ‘svn’, the checkout at the path is managed by Subversion. |
---|
Returns: | type of VCS this client is initialized with. |
---|
Returns: | Upstream URL that this code was checked out from. |
---|
(Git Only)
Returns: | parent branch. |
---|
Parameters: | basepath – compute diff relative to this path, if provided |
---|---|
Returns: | A string showing local differences |
Calls scm status command. semantics of untracked are difficult to generalize. In SVN, this would be new files only. In git, hg, bzr, this would be changes that have not been added for commit.
Parameters: |
|
---|---|
Returns: | A string summarizing locally modified files |