Git URL Parser - `libvcs.url.git`¶

Detect, parse, and change git URLs using libvcs’s URL parser for git(1). It builds on top of the VCS-friendly URL parser framework.

Detect, parse, and validate git URLs.

Detect: GitURL.is_valid()
Parse:

compare to urllib.parse.ParseResult
- Compatibility focused: GitURL: Will work with git(1) as well as pip(1) style URLs
  - Output git(1) URL: GitURL.to_url()
- Strict git(1) compatibility: GitBaseURL.
  - Output git(1) URL: GitBaseURL.to_url()
Extendable via RuleMap, Rule

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

See also: https://git-scm.com/docs/git-clone#URLS

libvcs.url.git.AWS_CODE_COMMIT_DEFAULT_RULES: list[Rule] = <...truncated, 1394 chars> ¶ data data libvcs.url.git.AWS_CODE_COMMIT_DEFAULT_RULES: list[Rule] = <...truncated, 1394 chars> ¶

AWS CodeCommit-style git URLs.

Examples of CodeCommit-style git URLs (via AWS):

codecommit://MyDemoRepo
codecommit://`CodeCommitProfile`@MyDemoRepo
codecommit::ap-northeast-1://MyDemoRepo

Notes

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

pip-style git URLs.

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

MyProject @ git+ssh://git.example.com/MyProject
MyProject @ git+file:///home/user/projects/MyProject
MyProject @ git+https://git.example.com/MyProject

Refs (via pip.pypa.io):

MyProject @ git+https://git.example.com/MyProject.git@master
MyProject @ git+https://git.example.com/MyProject.git@v1.0
MyProject @ git+https://git.example.com/MyProject.git@da39a3ee5e6b4b0d3255bfef95601890afd80709
MyProject @ git+https://git.example.com/MyProject.git@refs/pull/123/head

Notes

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

libvcs.url.git.NPM_DEFAULT_RULES: list[Rule] = [] ¶ data data libvcs.url.git.NPM_DEFAULT_RULES: list[Rule] = [] ¶

NPM-style git URLs.

Git URL pattern (from docs.npmjs.com):

<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]

Examples of NPM-style git URLs (from docs.npmjs.com):

ssh://git@github.com:npm/cli.git#v1.0.27
git+ssh://git@github.com:npm/cli#semver:^5.0
git+https://isaacs@github.com/npm/cli.git
git://github.com/npm/cli.git#v1.0.27

Notes

https://docs.npmjs.com/cli/v8/configuring-npm/package-json#git-urls-as-dependencies

class libvcs.url.git.GitBaseURL ¶ class[source] class[source] class libvcs.url.git.GitBaseURL ¶

Bases: URLProtocol, SkipDefaultFieldsReprMixin

Git repository location. Parses URLs on initialization.

Examples

>>> GitBaseURL(url='https://github.com/vcs-python/libvcs.git')
GitBaseURL(url=https://github.com/vcs-python/libvcs.git,
        scheme=https,
        hostname=github.com,
        path=vcs-python/libvcs,
        suffix=.git,
        rule=core-git-https)

>>> myrepo = GitBaseURL(url='https://github.com/myproject/myrepo.git')

>>> myrepo.hostname
'github.com'

>>> myrepo.path
'myproject/myrepo'

>>> GitBaseURL(url='[email protected]:vcs-python/libvcs.git')
GitBaseURL([email protected]:vcs-python/libvcs.git,
        user=git,
        hostname=github.com,
        path=vcs-python/libvcs,
        suffix=.git,
        rule=core-git-scp)

Compatibility checking: GitBaseURL.is_valid()
URLs compatible with git(1): GitBaseURL.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 with VCS or not.

Examples

>>> GitBaseURL.is_valid(url='https://github.com/vcs-python/libvcs.git')
True

>>> GitBaseURL.is_valid(url='[email protected]:vcs-python/libvcs.git')
True

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

Unambiguous VCS detection

Sometimes you may want to match a VCS exclusively, without any change for, e.g. in order to outright detect the VCS system being used.

>>> GitBaseURL.is_valid(
...     url='[email protected]:vcs-python/libvcs.git', is_explicit=True
... )
True

In this case, check GitPipURL.is_valid() or GitURL.is_valid()’s examples.

Parameters:

url (str)
is_explicit (bool | None)

Return type:

bool

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

Return a git(1)-compatible URL. Can be used with git clone.

Examples

>>> git_url = GitBaseURL(url='[email protected]:vcs-python/libvcs.git')

>>> git_url
GitBaseURL([email protected]:vcs-python/libvcs.git,
        user=git,
        hostname=github.com,
        path=vcs-python/libvcs,
        suffix=.git,
        rule=core-git-scp)

Switch repo libvcs -> vcspull:

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

>>> git_url.to_url()
'[email protected]:vcs-python/vcspull.git'

Switch them to gitlab:

>>> git_url.hostname = 'gitlab.com'

>>> git_url.to_url()
'[email protected]:vcs-python/vcspull.git'

Return type:: str

class libvcs.url.git.GitAWSCodeCommitURL ¶ class[source] class[source] class libvcs.url.git.GitAWSCodeCommitURL ¶

Bases: GitBaseURL, URLProtocol, SkipDefaultFieldsReprMixin

Supports AWS CodeCommit git URLs.

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

Export AWS CodeCommit-compliant URL.

Examples

HTTPS (GRC, a.k.a. git-remote-codecommit) URL:

>>> git_url = GitAWSCodeCommitURL(
...     url='codecommit://test'
... )

>>> git_url
GitAWSCodeCommitURL(url=codecommit://test,
        hostname=test,
        rule=aws-code-commit-https-grc)

>>> git_url = GitAWSCodeCommitURL(
...     url='codecommit::us-east-1://test'
... )

>>> git_url
GitAWSCodeCommitURL(url=codecommit::us-east-1://test,
        hostname=test,
        rule=aws-code-commit-https-grc-with-region,
        region=us-east-1)

>>> git_url.path = 'libvcs/vcspull'

>>> git_url.to_url()
'codecommit::us-east-1://libvcs/vcspull'

It also accepts revisions, e.g. branch, tag, ref:

>>> git_url = GitAWSCodeCommitURL(
...     url='codecommit::us-east-1://[email protected]'
... )

>>> git_url
GitAWSCodeCommitURL(url=codecommit::us-east-1://[email protected],
        hostname=test,
        rule=aws-code-commit-https-grc-with-region,
        region=us-east-1,
        rev=v0.10.0)

>>> git_url.path = 'libvcs/vcspull'

>>> git_url.to_url()
'codecommit::us-east-1://libvcs/[email protected]'

Return type:: str

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

Whether URL is compatible with AWS CodeCommit Git’s VCS URL pattern or not.

Examples

Will not match normal git(1) URLs, use GitURL.is_valid() for that.

>>> GitAWSCodeCommitURL.is_valid(url='https://github.com/vcs-python/libvcs.git')
False

>>> GitAWSCodeCommitURL.is_valid(url='[email protected]:vcs-python/libvcs.git')
False

AWS CodeCommit HTTPS URL:

>>> GitAWSCodeCommitURL.is_valid(
...     url='https://git-codecommit.us-east-1.amazonaws.com/v1/repos/test',
... )
True

AWS CodeCommit HTTPS (GRC) URLs:

>>> GitAWSCodeCommitURL.is_valid(url='codecommit::ap-northeast-1://MyDemoRepo')
True

>>> GitAWSCodeCommitURL.is_valid(url='codecommit://MyDemoRepo')
True

AWS CodeCommit SSH URL:

>>> GitAWSCodeCommitURL.is_valid(
...     url='ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/test',
... )
True

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

Explicit VCS detection

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

>>> GitAWSCodeCommitURL.is_valid(
...     url='ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/test',
...     is_explicit=True,
... )
True

Parameters:

url (str)
is_explicit (bool | None)

Return type:

bool

class libvcs.url.git.GitPipURL ¶ class[source] class[source] class libvcs.url.git.GitPipURL ¶

Bases: GitBaseURL, URLProtocol, SkipDefaultFieldsReprMixin

Supports pip git URLs.

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

Export a pip-compliant URL.

Examples

>>> git_url = GitPipURL(
...     url='git+ssh://[email protected]:7999/PROJ/repo.git'
... )

>>> git_url
GitPipURL(url=git+ssh://[email protected]:7999/PROJ/repo.git,
        scheme=git+ssh,
        user=git,
        hostname=bitbucket.example.com,
        port=7999,
        path=PROJ/repo,
        suffix=.git,
        rule=pip-url)

>>> git_url.path = 'libvcs/vcspull'

>>> git_url.to_url()
'git+ssh://bitbucket.example.com/libvcs/vcspull.git'

It also accepts revisions, e.g. branch, tag, ref:

>>> git_url = GitPipURL(
...     url='git+https://github.com/vcs-python/[email protected]'
... )

>>> git_url
GitPipURL(url=git+https://github.com/vcs-python/[email protected],
        scheme=git+https,
        hostname=github.com,
        path=vcs-python/libvcs,
        suffix=.git,
        rule=pip-url,
        rev=v0.10.0)

>>> git_url.path = 'libvcs/vcspull'

>>> git_url.to_url()
'git+https://github.com/libvcs/[email protected]'

Return type:: str

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

Whether URL is compatible with Pip Git’s VCS URL pattern or not.

Examples

Will not match normal git(1) URLs, use GitURL.is_valid() for that.

>>> GitPipURL.is_valid(url='https://github.com/vcs-python/libvcs.git')
False

>>> GitPipURL.is_valid(url='[email protected]:vcs-python/libvcs.git')
False

Pip-style URLs:

>>> GitPipURL.is_valid(url='git+https://github.com/vcs-python/libvcs.git')
True

>>> GitPipURL.is_valid(url='git+ssh://[email protected]:vcs-python/libvcs.git')
True

>>> GitPipURL.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:

>>> GitPipURL.is_valid(
...     url='git+ssh://[email protected]:vcs-python/libvcs.git', is_explicit=True
... )
True

Parameters:

url (str)
is_explicit (bool | None)

Return type:

bool

class libvcs.url.git.GitURL ¶ class[source] class[source] class libvcs.url.git.GitURL ¶

Bases: GitAWSCodeCommitURL, GitPipURL, GitBaseURL, URLProtocol, SkipDefaultFieldsReprMixin

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

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

GitPipURL
- GitPipURL.to_url()
GitAWSCodeCommitURL
- GitAWSCodeCommitURL.to_url()
GitBaseURL
- GitBaseURL.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 Git URL rule_map or not.

Examples

Will match normal git(1) URLs, use GitURL.is_valid() for that.

>>> GitURL.is_valid(url='https://github.com/vcs-python/libvcs.git')
True

>>> GitURL.is_valid(url='[email protected]:vcs-python/libvcs.git')
True

Pip-style URLs:

>>> GitURL.is_valid(url='git+https://github.com/vcs-python/libvcs.git')
True

>>> GitURL.is_valid(url='git+ssh://[email protected]:vcs-python/libvcs.git')
True

>>> GitURL.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:

>>> GitURL.is_valid(
...     url='git+ssh://[email protected]:vcs-python/libvcs.git', is_explicit=True
... )
True

Below, while it’s GitHub, that doesn’t necessarily mean that the URL itself is conclusively a git URL (e.g. the pattern is too lax):

>>> GitURL.is_valid(
...     url='[email protected]:vcs-python/libvcs.git', is_explicit=True
... )
True

You could create a GitHub rule that consider github.com hostnames to be exclusively git:

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

>>> GitURL.rule_map.register(GitHubRule)

>>> GitURL.is_valid(
...     url='[email protected]:vcs-python/libvcs.git', is_explicit=True
... )
True

>>> GitURL(url='[email protected]:vcs-python/libvcs.git').rule
'gh-rule'

This is just us cleaning up:

>>> GitURL.rule_map.unregister('gh-rule')

>>> GitURL(url='[email protected]:vcs-python/libvcs.git').rule
'core-git-scp'

Parameters:

url (str)
is_explicit (bool | None)

Return type:

bool

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

Return a git(1)-compatible URL. Can be used with git clone.

Examples

SSH style URL:

>>> git_url = GitURL(url='[email protected]:vcs-python/libvcs')

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

>>> git_url.to_url()
'[email protected]:vcs-python/vcspull'

HTTPs URL:

>>> git_url = GitURL(url='https://github.com/vcs-python/libvcs.git')

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

>>> git_url.to_url()
'https://github.com/vcs-python/vcspull.git'

Switch them to gitlab:

>>> git_url.hostname = 'gitlab.com'

>>> git_url.to_url()
'https://gitlab.com/vcs-python/vcspull.git'

Pip style URL, thanks to this class implementing GitPipURL:

>>> git_url = GitURL(url='git+ssh://[email protected]/vcs-python/libvcs')

>>> git_url.hostname = 'gitlab.com'

>>> git_url.to_url()
'git+ssh://gitlab.com/vcs-python/libvcs'

Git URL Parser - libvcs.url.git¶

Git URL Parser - `libvcs.url.git`¶