SVN URL Parser - `libvcs.url.svn`¶

Detect and parse Subversion URLs through SvnURL, aka svn(1).

Detect, parse, and validate SVN (Subversion) URLs.

Detect: SvnURL.is_valid()
Parse: SvnURL

compare to urllib.parse.ParseResult
- Output svn(1) URL: SvnURL.to_url()
Extendable via RuleMap, Rule

Note

Subversion URL support is experimental. If you rely on these URL shapes in production, please verify them against your repositories and report gaps in the project tracker.

libvcs.url.svn.DEFAULT_RULES: list[Rule] = <...truncated, 638 chars> ¶ data data libvcs.url.svn.DEFAULT_RULES: list[Rule] = <...truncated, 638 chars> ¶: Core regular expressions. These are patterns understood by svn(1)

libvcs.url.svn.PIP_DEFAULT_RULES: list[Rule] = <...truncated, 516 chars> ¶ data data libvcs.url.svn.PIP_DEFAULT_RULES: list[Rule] = <...truncated, 516 chars> ¶

pip-style svn URLs.

Examples of PIP-style svn URLs (via pip.pypa.io):

MyProject @ svn+https://svn.example.com/MyProject
MyProject @ svn+ssh://svn.example.com/MyProject
MyProject @ svn+ssh://user@svn.example.com/MyProject

Refs (via pip.pypa.io):

MyProject @ -e svn+http://svn.example.com/svn/MyProject/trunk@2019
MyProject @ -e svn+http://svn.example.com/svn/MyProject/trunk@{20080101}

Notes

https://pip.pypa.io/en/stable/topics/vcs-support/

class libvcs.url.svn.SvnBaseURL ¶ class[source] class[source] class libvcs.url.svn.SvnBaseURL ¶

Bases: URLProtocol, SkipDefaultFieldsReprMixin

SVN repository location. Parses URLs on initialization.

Examples

>>> SvnBaseURL(
...     url='svn+ssh://svn.debian.org/svn/aliothproj/path/in/project/repository')
SvnBaseURL(url=svn+ssh://svn.debian.org/svn/aliothproj/path/in/project/repository,
       scheme=svn+ssh,
       hostname=svn.debian.org,
       path=svn/aliothproj/path/in/project/repository,
       rule=core-svn)

>>> myrepo = SvnBaseURL(
...     url='svn+ssh://svn.debian.org/svn/aliothproj/path/in/project/repository'
... )

>>> myrepo.hostname
'svn.debian.org'

>>> myrepo.path
'svn/aliothproj/path/in/project/repository'

Compatibility checking: SvnBaseURL.is_valid()
URLs compatible with svn(1): SvnBaseURL.to_url()

to_url() ¶ method[source] method[source] to_url() ¶

Return a svn(1)-compatible URL. Can be used with svn checkout.

Examples

>>> svn_url = SvnBaseURL(
...     url='svn+ssh://my-username@my-server/vcs-python/libvcs'
... )

>>> svn_url
SvnBaseURL(url=svn+ssh://my-username@my-server/vcs-python/libvcs,
        scheme=svn+ssh,
        user=my-username,
        hostname=my-server,
        path=vcs-python/libvcs,
        rule=core-svn)

Switch repo libvcs -> vcspull:

>>> svn_url.path = 'vcs-python/vcspull'

>>> svn_url.to_url()
'svn+ssh://my-username@my-server/vcs-python/vcspull'

Switch user to “tom”:

>>> svn_url.user = 'tom'

>>> svn_url.to_url()
'svn+ssh://tom@my-server/vcs-python/vcspull'

Return type:: str

class libvcs.url.svn.SvnPipURL ¶ class[source] class[source] class libvcs.url.svn.SvnPipURL ¶

Bases: SvnBaseURL, URLProtocol, SkipDefaultFieldsReprMixin

Supports pip svn URLs.

to_url() ¶ method[source] method[source] to_url() ¶

Return a svn(1)-compatible URL. Can be used with svn checkout.

Examples

>>> svn_url = SvnPipURL(url='svn+https://svn.project.org/project-central')

>>> svn_url
SvnPipURL(url=svn+https://svn.project.org/project-central,
        scheme=svn+https,
        hostname=svn.project.org,
        path=project-central,
        rule=pip-url)

Switch repo project-central -> mobile-browser:

>>> svn_url.path = 'mobile-browser'

>>> svn_url.to_url()
'svn+https://svn.project.org/mobile-browser'

Switch them to localhost:

>>> svn_url.hostname = 'localhost'
>>> svn_url.scheme = 'http'

>>> svn_url.to_url()
'http://localhost/mobile-browser'

Return type:: str

class libvcs.url.svn.SvnURL ¶ class[source] class[source] class libvcs.url.svn.SvnURL ¶

Bases: SvnPipURL, SvnBaseURL, URLProtocol, SkipDefaultFieldsReprMixin

Batteries included URL Parser. Supports svn(1) and pip URLs.

Ancestors (MRO) This URL parser inherits methods and attributes from the following parsers:

SvnPipURL
- SvnPipURL.to_url()
SvnBaseURL
- SvnBaseURL.to_url()

classmethod is_valid(url, is_explicit=None) ¶ classmethod method[source] classmethod method[source] classmethod is_valid(url, is_explicit=None) ¶

Whether URL is compatible included Svn URL rule_map or not.

Examples

Will match normal svn(1) URLs, use SvnURL.is_valid() for that.

>>> SvnURL.is_valid(
... url='https://svn.project.org/project-central/project-central')
True

>>> SvnURL.is_valid(url='[email protected]:MyProject/project')
True

Pip-style URLs:

>>> SvnURL.is_valid(url='svn+https://svn.project.org/project-central/project')
True

>>> SvnURL.is_valid(url='svn+ssh://[email protected]:MyProject/project')
True

>>> SvnURL.is_valid(url='notaurl')
False

Explicit VCS detection

Pip-style URLs are prefixed with the VCS name in front, so its rule_map can unambiguously narrow the type of VCS:

>>> SvnURL.is_valid(
...     url='svn+ssh://[email protected]:project-central/image',
...     is_explicit=True
... )
True

Below, while it’s svn.project.org, that doesn’t necessarily mean that the URL itself is conclusively a svn URL (e.g. the pattern is too broad):

>>> SvnURL.is_valid(
...     url='[email protected]:project-central/image', is_explicit=True
... )
False

You could create a project rule that consider svn.project.org hostnames to be exclusively svn:

>>> projectRule = Rule(
...     # Since svn.project.org exclusively serves svn repos, make explicit
...     label='project-rule',
...     description='Matches svn.project.org https URLs, exact VCS match',
...     pattern=re.compile(
...         rf'''
...         ^(?P<scheme>ssh)?
...         ((?P<user>\w+)@)?
...         (?P<hostname>(svn.project.org)+):
...         (?P<path>(\w[^:]+))
...         ''',
...         re.VERBOSE,
...     ),
...     is_explicit=True,
...     defaults={
...         'hostname': 'svn.project.org'
...     }
... )

>>> SvnURL.rule_map.register(projectRule)

>>> SvnURL.is_valid(
...     url='[email protected]:project-central/image', is_explicit=True
... )
True

>>> SvnURL(url='[email protected]:project-central/image').rule
'project-rule'

This is just us cleaning up:

>>> SvnURL.rule_map.unregister('project-rule')

>>> SvnURL(url='[email protected]:project-central/project-rule').rule
'core-svn-scp'

Parameters:

url (str)
is_explicit (bool | None)

Return type:

bool

to_url() ¶ method[source] method[source] to_url() ¶

Return a svn(1)-compatible URL. Can be used with svn checkout.

Examples

SSH style URL:

>>> svn_url = SvnURL(url='[email protected]:project-central/browser')

>>> svn_url.path = 'project-central/gfx'

>>> svn_url.to_url()
'[email protected]:project-central/gfx'

HTTPs URL:

>>> svn_url = SvnURL(url='https://svn.project.org/project-central/memory')

>>> svn_url.path = 'project-central/image'

>>> svn_url.to_url()
'https://svn.project.org/project-central/image'

Switch them to svnlab:

>>> svn_url.hostname = 'localhost'
>>> svn_url.scheme = 'http'

>>> svn_url.to_url()
'http://localhost/project-central/image'

Pip style URL, thanks to this class implementing SvnPipURL:

>>> svn_url = SvnURL(url='svn+ssh://[email protected]/project-central/image')

>>> svn_url.hostname = 'localhost'

>>> svn_url.to_url()
'svn+ssh://svn@localhost/project-central/image'

>>> svn_url.user = None

>>> svn_url.to_url()
'svn+ssh://localhost/project-central/image'

SVN URL Parser - libvcs.url.svn¶

SVN URL Parser - `libvcs.url.svn`¶