libvcs.sync.git

For git(1).

Compare to: fabtools.require.git, salt.states.git, ansible.builtin.git

Tool to manage a local git clone from an external git repository.

exception libvcs.sync.git.GitStatusParsingException

exception

Bases: LibVCSException

Raised when git status output is not in the expected format.

__init__(git_status_output, *args)

method

Parameters:

• git_status_output (str)

• args (object)

Return type:

None

exception libvcs.sync.git.GitRemoteOriginMissing

exception

Bases: LibVCSException

Raised when git origin remote was not found.

__init__(remotes, *args)

method

Parameters:

• remotes (list[str])

• args (object)

Return type:

None

exception libvcs.sync.git.GitRemoteSetError

exception

Bases: LibVCSException

Raised when a git remote could not be set.

__init__(remote_name)

method

Parameters:

remote_name (str)

Return type:

None

exception libvcs.sync.git.GitNoBranchFound

exception

Bases: LibVCSException

Raised with git branch could not be found.

__init__(*args)

method

Parameters:

args (object)

Return type:

None

exception libvcs.sync.git.GitRemoteRefNotFound

exception

Bases: CommandError

Raised when a git remote ref (tag, branch) could not be found.

__init__(git_tag, ref_output, *args)

method

Parameters:

• git_tag (str)

• ref_output (str)

• args (object)

Return type:

None

_message: str

attribute

class libvcs.sync.git.GitRemote

class

Bases: object

Structure containing git working copy information.

name: str

attribute

fetch_url: str

attribute

push_url: str

attribute

__init__(name, fetch_url, push_url)

method

Parameters:

• name (str)

• fetch_url (str)

• push_url (str)

Return type:

None

class libvcs.sync.git.GitStatus

class

Bases: object

Git status information.

branch_oid: str | None = None

attribute

branch_head: str | None = None

attribute

branch_upstream: str | None = None

attribute

branch_ab: str | None = None

attribute

branch_ahead: str | None = None

attribute

branch_behind: str | None = None

attribute

classmethod from_stdout(value)

classmethod method

Return git status -sb --porcelain=2 extracted to a dict.

Return type:

Dictionary of git repo’s status

Parameters:

value (str)

__init__(branch_oid=None, branch_head=None, branch_upstream=None, branch_ab=None, branch_ahead=None, branch_behind=None)

method

Parameters:

• branch_oid (str | None)

• branch_head (str | None)

• branch_upstream (str | None)

• branch_ab (str | None)

• branch_ahead (str | None)

• branch_behind (str | None)

Return type:

None

libvcs.sync.git.convert_pip_url(pip_url)

function

Convert pip-style URL to a VCSLocation.

Prefixes stub URLs like ‘user@hostname:user/repo.git’ with ‘ssh://’. That’s required because although they use SSH they sometimes doesn’t work with a ssh:// scheme (e.g. Github). But we need a scheme for parsing. Hence we remove it again afterwards and return it as a stub. The manpage for git-clone(1) refers to this as the “scp-like styntax”.

Parameters:

pip_url (str)

Return type:

VCSLocation

class libvcs.sync.git.GitSync

class

Bases: BaseSync

Tool to manage a local git clone from an external git repository.

bin_name: str = 'git'

attribute

VCS app name, e.g. ‘git’

schemes: tuple[str, ...] = ('git+http', 'git+https', 'git+file')

attribute

List of supported schemes to register in urlparse.uses_netloc

__init__(*, url, path, remotes=None, **kwargs)

method

Local git repository.

Parameters:

• url (str) – URL of repo

• tls_verify (bool) – Should certificate for https be checked (default False)

• path (StrPath)

• remotes (GitRemotesArgs)

• kwargs (Any)

Return type:

None

Examples

import os
from libvcs.sync.git import GitSync

checkout = pathlib.Path(__name__) + '/' + 'my_libvcs'

repo = GitSync(
   url="https://github.com/vcs-python/libvcs",
   path=checkout,
   remotes={
       'gitlab': 'https://gitlab.com/vcs-python/libvcs'
   }
)

import os
from libvcs.sync.git import GitSync

checkout = pathlib.Path(__name__) + '/' + 'my_libvcs'

repo = GitSync(
   url="https://github.com/vcs-python/libvcs",
   path=checkout,
   remotes={
       'gitlab': {
           'fetch_url': 'https://gitlab.com/vcs-python/libvcs',
           'push_url': 'https://gitlab.com/vcs-python/libvcs',
       },
   }
)

_remotes: GitSyncRemoteDict

attribute

cmd: Git

attribute

classmethod from_pip_url(pip_url, **kwargs)

classmethod method

Clone a git repository from a pip-style URL.

Parameters:

• pip_url (str)

• kwargs (Any)

Return type:

GitSync

get_revision()

method

Return current revision. Initial repositories return ‘initial’.

Return type:

str

set_remotes(overwrite=False)

method

Apply remotes in local repository to match GitSync’s configuration.

Parameters:

overwrite (bool)

Return type:

None

obtain(*args, **kwargs)

method

Retrieve the repository, clone if doesn’t exist.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

None

update_repo(set_remotes=False, *args, **kwargs)

method

Pull latest changes from git remote.

Parameters:

• set_remotes (bool) – If True, configure remotes before updating.

• args (Any)

• kwargs (Any)

Returns:

Result of the sync operation, with any errors recorded.

Return type:

SyncResult

remotes()

method

Return remotes like git remote -v.

Parameters:

flat (bool) – Return a dict of tuple instead of dict, default False.

Return type:

dict of git upstream / remote URLs

remote(name, **kwargs)

method

Get the fetch and push URL for a specified remote name.

Parameters:

• name (str) – The remote name used to define the fetch and push URL

• kwargs (Any)

Return type:

Remote name and url in tuple form

set_remote(name, url, push=False, overwrite=False)

method

Set remote with name and URL like git remote add.

Parameters:

• name (str) – defines the remote name.

• url (str) – defines the remote URL

• push (bool)

• overwrite (bool)

Return type:

GitRemote

static chomp_protocol(url)

staticmethod method

Return clean VCS url from RFC-style url.

Parameters:

url (str) – PIP-style url

Return type:

URL as VCS software would accept it

get_git_version()

method

Return current version of git binary.

Return type:

git version

status()

method

Retrieve status of project in dict format.

Wraps git status --sb --porcelain=2. Does not include changed files, yet.

Return type:

Status of current checked out repository

Examples

>>> git_repo = GitSync(
...     url=f'file://{create_git_remote_repo()}',
...     path=tmp_path
... )
>>> git_repo.obtain()
>>> git_repo.status()
GitStatus(branch_oid='...', branch_head='master', branch_upstream='origin/master', branch_ab='+0 -0', branch_ahead='0', branch_behind='0')

get_current_remote_name()

method

Retrieve name of the remote / upstream of currently checked out branch.

Returns:

• If upstream the same, returns branch_name.

• If upstream mismatches, returns remote_name/branch_name.

Return type:

str