Sync - libvcs.sync

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

Warning

All APIs are considered experimental and subject to break pre-1.0. They can and will break between versions.

API

• libvcs.sync.git
  • GitStatusParsingException
  • GitRemoteOriginMissing
  • GitRemoteSetError
  • GitNoBranchFound
  • GitRemoteRefNotFound
  • GitRemote
    • name
    • fetch_url
    • push_url
  • GitStatus
    • branch_oid
    • branch_head
    • branch_upstream
    • branch_ab
    • branch_ahead
    • branch_behind
    • from_stdout()
  • convert_pip_url()
  • GitSync
    • bin_name
    • schemes
    • __init__()
    • _remotes
    • cmd
    • from_pip_url()
    • get_revision()
    • set_remotes()
    • obtain()
    • update_repo()
    • remotes()
    • remote()
    • set_remote()
    • chomp_protocol()
    • get_git_version()
    • status()
    • get_current_remote_name()
• libvcs.sync.hg
  • HgSync
    • bin_name
    • schemes
    • __init__()
    • cmd
    • obtain()
    • get_revision()
    • update_repo()
• libvcs.sync.svn
  • SvnUrlRevFormattingError
  • SvnSync
    • bin_name
    • schemes
    • __init__()
    • cmd
    • _user_pw_args()
    • obtain()
    • get_revision_file()
    • get_revision()
    • update_repo()
    • _get_svn_url_rev()
• libvcs.sync.base
  • VCSLocation
    • url
    • rev
    • _asdict()
    • _field_defaults
    • _fields
    • _make()
    • _replace()
  • convert_pip_url()
  • BaseSync
    • log_in_real_time
    • bin_name
    • schemes
    • __init__()
    • progress_callback
    • dir
    • log
    • repo_name
    • from_pip_url()
    • run()
    • ensure_dir()
    • update_repo()
    • obtain()

Constants

Constants for use by libvcs.sync.

libvcs.sync.constants.DEFAULT_VCS_LITERAL

Default VCS systems by string (in DEFAULT_VCS_CLASS_MAP)

alias of Literal[‘git’, ‘hg’, ‘svn’]

libvcs.sync.constants.DEFAULT_VCS_CLASS_UNION

Union of VCS Classes

alias of type[Union[GitSync, HgSync, SvnSync]]

libvcs.sync.constants.DEFAULT_VCS_CLASS_MAP: dict[Literal['git', 'hg', 'svn'], type[GitSync | HgSync | SvnSync]] = {'git': <class 'libvcs.sync.git.GitSync'>, 'hg': <class 'libvcs.sync.hg.HgSync'>, 'svn': <class 'libvcs.sync.svn.SvnSync'>}

str -> class Map. DEFAULT_VCS_CLASS_MAP['git'] -> GitSync