libvcs.cmd.svn

For subversion, aka svn(1)

Run svn (subversion) commands directly against SVN working copy.

Busman’s holiday?.

We need to fill these SVN commands and their tests to exquisite perfection, like the artisans in those Michelin-star videos on YouTube. We welcome your contributions, providing you “color between the lines” and stick to the interface. Get in, ‘APIs unstable until we fit the spec.

exception libvcs.cmd.svn.SvnPropsetValueOrValuePathRequired

exception

exception

exception libvcs.cmd.svn.SvnPropsetValueOrValuePathRequired

Bases: LibVCSException, TypeError

Raised when required parameters are not passed.

__init__(*args)

method

method

__init__(*args)

Parameters:

args (object)

Return type:

None

class libvcs.cmd.svn.Svn

class

class

class libvcs.cmd.svn.Svn

Bases: object

Run commands directly against SVN working copy.

__init__(*, path, progress_callback=None)

method

method

__init__(*, path, progress_callback=None)

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

Parameters:

• path (StrPath) – Operates as PATH in the corresponding svn subcommand.

• progress_callback (ProgressCallbackProtocol | None)

Return type:

None

Examples

>>> Svn(path=tmp_path)
<Svn 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, *, quiet=None, username=None, password=None, no_auth_cache=None, non_interactive=True, trust_server_cert=None, config_dir=None, config_option=None, make_parents=True, check_returncode=None, timeout=None, **kwargs)

method

method

run(args, *, quiet=None, username=None, password=None, no_auth_cache=None, non_interactive=True, trust_server_cert=None, config_dir=None, config_option=None, make_parents=True, check_returncode=None, timeout=None, **kwargs)

Run a command for this SVN working copy.

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

svn help and svn help [cmd]

Wraps svn’s Options.

Parameters:

• quiet (bool | None) – -q / –quiet

• username (str | None) – –username

• password (str | None) – –password

• no_auth_cache (bool | None) – –no-auth-cache

• non_interactive (bool | None) – –non-interactive, defaults to True

• trust_server_cert (bool | None) – –trust-server-cert

• config_dir (Path | None) – –config-dir

• config_option (Path | None) – –config-option, FILE:SECTION:OPTION=[VALUE]

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

• make_parents (bool, default: True) – Creates checkout directory (:attr:`self.path) if it doesn’t already exist.

• check_returncode (bool, default: None) – Passthrough to Svn.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

>>> svn = Svn(path=tmp_path)
>>> svn.run(['help'])
"usage: svn <subcommand> [options] [args]..."

checkout(*, url, revision=None, force=None, ignore_externals=None, depth=None, quiet=None, username=None, password=None, no_auth_cache=None, non_interactive=True, trust_server_cert=None, make_parents=True, check_returncode=False)

method

method

checkout(*, url, revision=None, force=None, ignore_externals=None, depth=None, quiet=None, username=None, password=None, no_auth_cache=None, non_interactive=True, trust_server_cert=None, make_parents=True, check_returncode=False)

Check out a working copy from an SVN repo.

Wraps svn checkout (co).

Parameters:

• url (str)

• revision (RevisionLiteral | str) – Number, ‘{ DATE }’, ‘HEAD’, ‘BASE’, ‘COMMITTED’, ‘PREV’

• force (bool, optional) – force operation to run

• ignore_externals (bool, optional) – ignore externals definitions

• depth (DepthLiteral) – Sparse checkout support, Optional

• make_parents (bool, default: True) – Creates checkout directory (:attr:`self.path) if it doesn’t already exist.

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

• quiet (bool | None)

• username (str | None)

• password (str | None)

• no_auth_cache (bool | None)

• non_interactive (bool | None)

• trust_server_cert (bool | None)

Return type:

str

Examples

>>> svn = Svn(path=tmp_path)
>>> svn_remote_repo = create_svn_remote_repo()
>>> svn.checkout(url=f'file://{svn_remote_repo}')
'...Checked out revision ...'
>>> svn.checkout(url=f'file://{svn_remote_repo}', revision=10)
'svn: E160006: No such revision 10...'

add(*, path, targets=None, depth=None, force=None, auto_props=None, no_auto_props=None, parents=None)

method

method

add(*, path, targets=None, depth=None, force=None, auto_props=None, no_auto_props=None, parents=None)

Stage an unversioned file to be pushed to repository next commit.

Passing None means the flag won’t be passed unless otherwise stated.

Wraps svn add.

Parameters:

• targets (pathlib.Path) – –targets ARG: contents of file ARG as additional args

• depth (DepthLiteral) – –depth ARG, Sparse checkout support, Optional

• force (bool | None) – –force, Ignore already versioned paths

• no_ignore – –no-ignore

• auto_props (bool | None) – –auto-props

• no_auto_props (bool | None) – –no-auto-props

• parents (bool | None) – –parents

• path (list[Path] | Path)

Return type:

str

Examples

>>> svn = Svn(path=tmp_path)
>>> svn.checkout(url=f'file://{create_svn_remote_repo()}')
'...'
>>> new_file = tmp_path / 'new.txt'
>>> new_file.write_text('example text', encoding="utf-8")
12
>>> svn.add(path=new_file)
'A  new.txt'

auth(remove=None, show_passwords=None, **kwargs)

method

method

auth(remove=None, show_passwords=None, **kwargs)

Manage stored authentication credentials.

Wraps svn auth.

Parameters:

• remove (str, optional) – Remove matching auth credentials

• show_passwords (bool, optional) – Show cached passwords

• kwargs (Any)

Return type:

str

Examples

>>> Svn(path=tmp_path).auth()
"Credentials cache in '...' is empty"

blame(target, *, revision=None, verbose=None, force=None, use_merge_history=None, incremental=None, xml=None, extensions=None, **kwargs)

method

method

blame(target, *, revision=None, verbose=None, force=None, use_merge_history=None, incremental=None, xml=None, extensions=None, **kwargs)

Show authorship for file line-by-line.

Wraps svn blame.

Parameters:

• target (pathlib.Path) – path of file

• revision (RevisionLiteral | str) – Number, ‘{ DATE }’, ‘HEAD’, ‘BASE’, ‘COMMITTED’, ‘PREV’

• verbose (bool) – -v, –verbose, output extra info

• use_merge_history (bool) – -g, –use-merge-history, show extra mergeg info

• incremental (bool) – –incremental, give output suitable for concatenation

• xml (bool) – –xml, xml output

• extensions (str, optional) – Diff or blame tool (pass raw args).

• force (bool, optional) – force operation to run

• kwargs (Any)

Return type:

str

Examples

>>> svn = Svn(path=tmp_path)
>>> repo = create_svn_remote_repo()
>>> svn.checkout(url=f'file://{repo}')
'...Checked out revision ...'
>>> new_file = tmp_path / 'new.txt'
>>> new_file.write_text('example text', encoding="utf-8")
12
>>> svn.add(path=new_file)
'A  new.txt'
>>> svn.commit(path=new_file, message='My new commit')
'...'
>>> svn.blame('new.txt')
'4        ... example text'

cat(*args, **kwargs)

method

method

cat(*args, **kwargs)

Output contents of files from working copy or repository URLs.

Wraps svn cat.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

changelist(*args, **kwargs)

method

method

changelist(*args, **kwargs)

Connect or disconnect files with a changelist.

Wraps svn changelist (cl).

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

cleanup(*args, **kwargs)

method

method

cleanup(*args, **kwargs)

Recursively clean up working copy of locks. Unblocks operations.

Wraps svn cleanup.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

commit(*, path, targets=None, message=None, no_unlock=None, file=None, depth=None, encoding=None, force_log=None, keep_changelists=None, include_externals=None, **kwargs)

method

method

commit(*, path, targets=None, message=None, no_unlock=None, file=None, depth=None, encoding=None, force_log=None, keep_changelists=None, include_externals=None, **kwargs)

Push changes from working copy to SVN repo.

Wraps svn commit (ci).

Parameters:

• targets (pathlib.Path) – –targets ARG: contents of file ARG as additional args

• depth (DepthLiteral) – –depth ARG, Sparse checkout support, Optional

• encoding (str | None) – –encoding, treat value as charset encoding passed

• keep_changelists (bool | None) – –keep_changelists, don’t delete changelists after commit

• force_log (bool | None) – –force-log, Ignore already versioned paths

• path (list[Path] | Path)

• message (str | None)

• no_unlock (bool | None)

• file (Path | None)

• include_externals (bool | None)

• kwargs (Any)

Return type:

str

Examples

>>> svn = Svn(path=tmp_path)
>>> svn.checkout(url=f'file://{create_svn_remote_repo()}')
'...'
>>> new_file = tmp_path / 'new.txt'
>>> new_file.write_text('example text', encoding="utf-8")
12
>>> svn.add(path=new_file)
'A  new.txt'
>>> svn.commit(path=new_file, message='My new commit')
'Adding          new.txt...Transmitting file data...Committed revision 4.'

copy(*args, **kwargs)

method

method

copy(*args, **kwargs)

Copy file or dir in this SVN working copy or repo.

Wraps svn copy (cp).

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

delete(*args, **kwargs)

method

method

delete(*args, **kwargs)

Remove file from this SVN working copy or repo.

Wraps svn delete (del, remove, rm).

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

diff(*args, **kwargs)

method

method

diff(*args, **kwargs)

Return diff of two files or revisions.

Wraps svn diff.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

export(*args, **kwargs)

method

method

export(*args, **kwargs)

Export clean directory tree of working directory.

Wraps svn export.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

help(*args, **kwargs)

method

method

help(*args, **kwargs)

SVN Help command.

Wraps svn help (?, h).

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

import_(*args, **kwargs)

method

method

import_(*args, **kwargs)

Import local directory into repository.

Wraps svn import.

Due to python limitation, .import isn’t possible.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

info(target=None, targets=None, changelist=None, revision=None, depth=None, incremental=None, recursive=None, xml=None, *args, **kwargs)

method

method

info(target=None, targets=None, changelist=None, revision=None, depth=None, incremental=None, recursive=None, xml=None, *args, **kwargs)

Return info about this SVN repository.

Wraps svn info.

targetspathlib.Path

–targets ARG: contents of file ARG as additional args

xmlbool

–xml, xml output

revisionUnion[RevisionLiteral, str]

Number, ‘{ DATE }’, ‘HEAD’, ‘BASE’, ‘COMMITTED’, ‘PREV’

depth :

–depth ARG, Sparse checkout support, Optional

incrementalbool

–incremental, give output suitable for concatenation

Parameters:

• target (StrPath | None)

• targets (list[StrPath] | StrPath | None)

• changelist (list[str] | None)

• revision (str | None)

• depth (DepthLiteral)

• incremental (bool | None)

• recursive (bool | None)

• xml (bool | None)

• args (Any)

• kwargs (Any)

Return type:

str

ls(*args, **kwargs)

method

method

ls(*args, **kwargs)

List files in SVN repository (without downloading them).

Wraps svn list (ls).

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

lock(targets=None, force=None, **kwargs)

method

method

lock(targets=None, force=None, **kwargs)

Lock path or URLs for working copy or repository.

Wraps svn lock.

Examples

>>> svn = Svn(path=tmp_path)
>>> svn.checkout(url=f'file://{create_svn_remote_repo()}')
'...Checked out revision ...'
>>> svn.lock(targets='samplepickle')
"'samplepickle' locked by user '...'."

Parameters:

• targets (Path | None)

• force (bool | None)

• kwargs (Any)

Return type:

str

log(*args, **kwargs)

method

method

log(*args, **kwargs)

Show logs from repository.

Wraps svn log.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

merge(*args, **kwargs)

method

method

merge(*args, **kwargs)

Apply diffs between two places to SVN working copy.

Wraps svn merge.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

mkdir(*args, **kwargs)

method

method

mkdir(*args, **kwargs)

Create directory in SVN working copy.

Wraps svn mkdir.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

move(*args, **kwargs)

method

method

move(*args, **kwargs)

Move a file in SVN working copy.

Wraps svn move (mv, rename, ren).

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

patch(*args, **kwargs)

method

method

patch(*args, **kwargs)

Apply a patch to SVN working copy.

Wraps svn patch.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

propdel(*args, **kwargs)

method

method

propdel(*args, **kwargs)

Remove a property for this SVN working copy.

Wraps svn propdel (pdel, pd).

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

propedit(*args, **kwargs)

method

method

propedit(*args, **kwargs)

Change a property for this SVN working copy.

Wraps svn propedit (pedit, pe).

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

propget(*args, **kwargs)

method

method

propget(*args, **kwargs)

Return a property for this SVN working copy.

Wraps svn propget (pget, pg).

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

proplist(*args, **kwargs)

method

method

proplist(*args, **kwargs)

Return list of properties for this SVN working copy.

Wraps svn proplist (plist, pl).

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

propset(name, path=None, value=None, value_path=None, target=None, *args, **kwargs)

method

method

propset(name, path=None, value=None, value_path=None, target=None, *args, **kwargs)

Set property for this SVN working copy or a remote revision.

Note: Setting remote properties via –revprop does not work yet.

Wraps svn propset (pset, ps).

Parameters:

• name (str) – propname

• value_path (StrPath | None) – VALFILE

• path (StrPath | None)

• value (str | None)

• target (StrOrBytesPath | None)

• args (Any)

• kwargs (Any)

Return type:

str

Examples

>>> svn = Svn(path=tmp_path)
>>> svn.checkout(url=f'file://{create_svn_remote_repo()}')
'...Checked out revision ...'
>>> svn.propset(name="my_prop", value="value", path=".")
"property 'my_prop' set on '.'"

relocate(*, to_path, **kwargs)

method

method

relocate(*, to_path, **kwargs)

Set the SVN repository URL for this working copy.

Wraps svn relocate.

Examples

>>> svn = Svn(path=tmp_path / 'initial_place')
>>> repo_path = create_svn_remote_repo()
>>> svn.checkout(url=repo_path.as_uri())
'...Checked out revision ...'
>>> new_place = repo_path.rename(tmp_path / 'new_place')
>>> svn.relocate(to_path=new_place.absolute().as_uri())
''

Parameters:

• to_path (StrPath)

• kwargs (Any)

Return type:

str

resolve(path, targets=None, depth=None, force=None, *args, **kwargs)

method

method

resolve(path, targets=None, depth=None, force=None, *args, **kwargs)

Resolve conflicts with this SVN working copy.

Wraps svn resolve.

Examples

>>> svn = Svn(path=tmp_path)
>>> svn.checkout(url=f'file://{create_svn_remote_repo()}')
'...Checked out revision ...'
>>> svn.resolve(path='.')
''

Parameters:

• path (list[Path] | Path)

• targets (Path | None)

• depth (DepthLiteral)

• force (bool | None)

• args (Any)

• kwargs (Any)

Return type:

str

resolved(*, path, targets=None, depth=None, force=None, **kwargs)

method

method

resolved(*, path, targets=None, depth=None, force=None, **kwargs)

Resolve this working copy’s conflicted state.

Wraps svn resolved.

Examples

>>> svn = Svn(path=tmp_path)
>>> svn.checkout(url=f'file://{create_svn_remote_repo()}')
'...Checked out revision ...'
>>> svn.resolved(path='.')
''

Parameters:

• path (list[Path] | Path)

• targets (Path | None)

• depth (DepthLiteral)

• force (bool | None)

• kwargs (Any)

Return type:

str

revert(*, path, targets=None, depth=None, force=None, **kwargs)

method

method

revert(*, path, targets=None, depth=None, force=None, **kwargs)

Revert any changes to this SVN working copy.

Wraps svn revert.

Examples

>>> svn = Svn(path=tmp_path)
>>> svn.checkout(url=f'file://{create_svn_remote_repo()}')
'...Checked out revision ...'
>>> new_file = tmp_path / 'new.txt'
>>> new_file.write_text('example text', encoding="utf-8")
12
>>> svn.add(path=new_file)
'A  new.txt'
>>> svn.commit(path=new_file, message='My new commit')
'...'
>>> svn.revert(path=new_file)
''

Parameters:

• path (list[Path] | Path)

• targets (Path | None)

• depth (DepthLiteral)

• force (bool | None)

• kwargs (Any)

Return type:

str

status(*args, **kwargs)

method

method

status(*args, **kwargs)

Return status of this SVN working copy.

Wraps svn status (stat, st).

Examples

>>> svn = Svn(path=tmp_path)
>>> svn.checkout(url=f'file://{create_svn_remote_repo()}')
'...Checked out revision ...'
>>> svn.status()
''

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str

switch(*, to_path, path, ignore_ancestry=None, **kwargs)

method

method

switch(*, to_path, path, ignore_ancestry=None, **kwargs)

Switch working copy to a different SVN repo URL.

Wraps svn switch (sw).

Examples

>>> svn = Svn(path=tmp_path / 'initial_place')
>>> repo_path = create_svn_remote_repo()
>>> svn.checkout(url=(repo_path / 'sampledir').as_uri())
'...Checked out revision ...'
>>> other_dir = repo_path / 'otherdir'
>>> svn.switch(to_path=other_dir.as_uri(), path='.', ignore_ancestry=True)
'D...Updated to revision...'

Parameters:

• to_path (StrPath)

• path (StrPath)

• ignore_ancestry (bool | None)

• kwargs (Any)

Return type:

str

unlock(targets=None, force=None, **kwargs)

method

method

unlock(targets=None, force=None, **kwargs)

Unlock path or URL reserved by another user.

Wraps svn unlock.

Examples

>>> svn = Svn(path=tmp_path)
>>> svn.checkout(url=f'file://{create_svn_remote_repo()}')
'...Checked out revision ...'
>>> svn.lock(targets='samplepickle')
"'samplepickle' locked by user '...'."
>>> svn.unlock(targets='samplepickle')
"'samplepickle' unlocked."

Parameters:

• targets (Path | None)

• force (bool | None)

• kwargs (Any)

Return type:

str

update(accept=None, changelist=None, diff3_cmd=None, editor_cmd=None, force=None, ignore_externals=None, parents=None, quiet=None, revision=None, set_depth=None, *args, **kwargs)

method

method

update(accept=None, changelist=None, diff3_cmd=None, editor_cmd=None, force=None, ignore_externals=None, parents=None, quiet=None, revision=None, set_depth=None, *args, **kwargs)

Fetch latest changes to working copy.

Wraps svn update (up).

Examples

>>> svn = Svn(path=tmp_path)
>>> svn.checkout(url=f'file://{create_svn_remote_repo()}')
'...Checked out revision ...'
>>> svn.update()
"Updating ..."

Parameters:

• accept (str | None)

• changelist (list[str] | None)

• diff3_cmd (str | None)

• editor_cmd (str | None)

• force (bool | None)

• ignore_externals (bool | None)

• parents (bool | None)

• quiet (bool | None)

• revision (str | None)

• set_depth (str | None)

• args (Any)

• kwargs (Any)

Return type:

str

upgrade(*args, **kwargs)

method

method

upgrade(*args, **kwargs)

Upgrade working copy’s metadata storage format.

Wraps svn upgrade.

Parameters:

• args (Any)

• kwargs (Any)

Return type:

str