libvcs.cmd.hg¶

For mercurial, aka hg(1).

Run hg (Mercurial) commands directly against a local mercurial repo.

Note

At a Mercurial shop? Can you help us jimmy this module into the next Sunbeam toaster of Mercurialian perfection? We need to patch and shimmy this thing into shape and seek a skilled tradesperson to give it - in Robert M. Pirsig’s sense - care. Connect with us on the tracker. It’s not too late to change the API.

class libvcs.cmd.hg.HgColorType
¶
class[source]
class[source]
class libvcs.cmd.hg.HgColorType
¶

Bases: Enum

CLI Color enum for Mercurial.

boolean = 'boolean'
¶
attribute
attribute
boolean = 'boolean'
¶
always = 'always'
¶
attribute
attribute
always = 'always'
¶
auto = 'auto'
¶
attribute
attribute
auto = 'auto'
¶
never = 'never'
¶
attribute
attribute
never = 'never'
¶
debug = 'debug'
¶
attribute
attribute
debug = 'debug'
¶
class libvcs.cmd.hg.HgPagerType
¶
class[source]
class[source]
class libvcs.cmd.hg.HgPagerType
¶

Bases: Enum

CLI Pagination enum for Mercurial.

boolean = 'boolean'
¶
attribute
attribute
boolean = 'boolean'
¶
always = 'always'
¶
attribute
attribute
always = 'always'
¶
auto = 'auto'
¶
attribute
attribute
auto = 'auto'
¶
never = 'never'
¶
attribute
attribute
never = 'never'
¶
class libvcs.cmd.hg.Hg
¶
class[source]
class[source]
class libvcs.cmd.hg.Hg
¶

Bases: object

Run commands directly on a Mercurial repository.

__init__(*, path, progress_callback=None)
¶
method[source]
method[source]
__init__(*, path, progress_callback=None)
¶

Lite, typed, pythonic wrapper for hg(1).

Parameters:
Return type:

None

Examples

>>> Hg(path=tmp_path)
<Hg path=...>
path: Path
¶
attribute
attribute
path: Path
¶

Directory to check out

progress_callback: ProgressCallbackProtocol | None = None
¶
attribute
attribute
progress_callback: ProgressCallbackProtocol | None = None
¶
run(args, *, config=None, repository=None, quiet=None, _help=None, encoding=None, encoding_mode=None, verbose=None, traceback=None, debug=None, debugger=None, profile=None, version=None, hidden=None, time=None, pager=None, color=None, check_returncode=None, timeout=None, **kwargs)
¶
method[source]
method[source]
run(args, *, config=None, repository=None, quiet=None, _help=None, encoding=None, encoding_mode=None, verbose=None, traceback=None, debug=None, debugger=None, profile=None, version=None, hidden=None, time=None, pager=None, color=None, check_returncode=None, timeout=None, **kwargs)
¶

Run a command for this Mercurial repository.

Passing None to a subcommand option, the flag won’t be passed unless otherwise stated.

hg help and hg help [cmd]

Wraps hg’s Options.

Parameters:

  • quiet (bool) – -q / –quiet

  • repository (str) – --repository REPO

  • cwd (libvcs._internal.types.StrOrBytesPath, optional) – --cwd DIR, Defaults to cwd

  • verbose (bool) – -v / --verbose

  • non_interactive (bool) – -y / --noninteractive, defaults to True

  • color (HgColorTypeLiteral) – --color

  • debug (bool) – --debug

  • debugger (bool) – --debugger

  • encoding (str) – --encoding ENCODE

  • encoding_mode (str) – --encodingmode MODE

  • traceback (bool) – --traceback

  • time (bool) – --time

  • profile (bool) – --profile

  • version (bool) – --version

  • _help (bool) – -h / --help

  • hidden (bool) – --hidden

  • pager (HgPagerType) – --pager TYPE

  • config (str | None) – --config CONFIG [+], section.name=value

  • check_returncode (bool, default: True) – Passthrough to libvcs._internal.run.run()

  • timeout (float, optional) – Wall-clock seconds to wait before terminating the subprocess. None (default) preserves the legacy behaviour of blocking until the process exits. When the deadline is exceeded the process is sent SIGTERM (then SIGKILL after a grace period) and libvcs.exc.CommandTimeoutError is raised with any output collected so far.

  • args (_CMD)

  • kwargs (Any)

Return type:

str

Examples

>>> hg = Hg(path=tmp_path)
>>> hg.run(['help'])
"Mercurial Distributed SCM..."
clone(*, url, no_update=None, update_rev=None, rev=None, branch=None, ssh=None, remote_cmd=None, pull=None, stream=None, insecure=None, quiet=None, make_parents=True, check_returncode=None)
¶
method[source]
method[source]
clone(*, url, no_update=None, update_rev=None, rev=None, branch=None, ssh=None, remote_cmd=None, pull=None, stream=None, insecure=None, quiet=None, make_parents=True, check_returncode=None)
¶

Clone a working copy from a mercurial repo.

Wraps hg clone.

Parameters:
Return type:

str

Examples

>>> hg = Hg(path=tmp_path)
>>> hg_remote_repo = create_hg_remote_repo()
>>> hg.clone(url=f'file://{hg_remote_repo}')
'updating to branch default...1 files updated, 0 files merged, ...'
>>> hg.path.exists()
True
update(quiet=None, verbose=None, check_returncode=True, *args, **kwargs)
¶
method[source]
method[source]
update(quiet=None, verbose=None, check_returncode=True, *args, **kwargs)
¶

Update working directory.

Wraps hg update.

Examples

>>> hg = Hg(path=tmp_path)
>>> hg_remote_repo = create_hg_remote_repo()
>>> hg.clone(url=f'file://{hg_remote_repo}')
'updating to branch default...1 files updated, 0 files merged, ...'
>>> hg.update()
'0 files updated, 0 files merged, 0 files removed, 0 files unresolved'
Parameters:
Return type:

str

pull(quiet=None, verbose=None, update=None, check_returncode=True, *args, **kwargs)
¶
method[source]
method[source]
pull(quiet=None, verbose=None, update=None, check_returncode=True, *args, **kwargs)
¶

Update working directory.

Wraps hg pull.

Examples

>>> hg = Hg(path=tmp_path)
>>> hg_remote_repo = create_hg_remote_repo()
>>> hg.clone(url=f'file://{hg_remote_repo}')
'updating to branch default...1 files updated, 0 files merged, ...'
>>> hg.pull()
'pulling from ...searching for changes...no changes found'
>>> hg.pull(update=True)
'pulling from ...searching for changes...no changes found'
Parameters:
Return type:

str