What's new
- New and improved logo
- **Improved typings**
Now [`mypy --strict`] compliant (390)
[`mypy --strict`]: https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-strict
- **Parser**: Experimental VCS URL parsing added (376, 381, 384, 386):
VCS Parsers return {func}`dataclasses.dataclass` instances. The new tools support validation,
parsing, mutating and exporting into URLs consumable by the VCS.
::: {warning}
APIs are unstable and subject to break until we get it right.
:::
- {mod}`libvcs.url.git`
- {class}`~libvcs.url.git.GitBaseURL` - Parse git URLs, `git(1)` compatible
- {meth}`~libvcs.url.git.GitBaseURL.is_valid`
- {meth}`~libvcs.url.git.GitBaseURL.to_url` - export `git clone`-compatible URL
- {class}`~libvcs.url.git.GitPipURL` - Pip URLs, {meth}`~libvcs.url.git.GitPipURL.is_valid`,
{meth}`~libvcs.url.git.GitPipURL.to_url`
- {class}`~libvcs.url.git.GitURL` - Compatibility focused,
{meth}`~libvcs.url.git.GitURL.is_valid` {meth}`~libvcs.url.git.GitURL.to_url`
- {mod}`libvcs.url.hg`
- {class}`~libvcs.url.hg.HgURL` - Parse Mercurial URLs
- {meth}`~libvcs.url.hg.HgURL.is_valid`
- {meth}`~libvcs.url.hg.HgURL.to_url` - export `hg clone`-compatible URL
- {mod}`libvcs.url.svn`
- {class}`~libvcs.url.svn.SvnURL` - Parse Subversion URLs
- {meth}`~libvcs.url.svn.SvnURL.is_valid`
- {meth}`~libvcs.url.svn.SvnURL.to_url` - export `svn checkout`-compatible URL
Detection can be extended through writing {class}`~libvcs.url.base.Matcher`s and adding them to
the classes' {class}`~libvcs.url.base.MatcherRegistry`
You can write your own VCS parser by implementing {class}`~libvcs.url.base.URLProtocol`, but it
would be most efficient if you studied the source of the `git(1)` parser to see how it's done.
Breaking changes
- 391 Removed `flat` keyword argument for {class}`libvcs.sync.git.GitSync`. This was unused and the
equivalent can be retrieved via `.to_dict()` on `GitRemote`
- 379 Support for `git+git` URLs removed. Pip removed these in 21.0 due to them being insecure
[^pip-git+git]
- 372 Typings moved from `libvcs.types` -> {mod}`libvcs._internal.types`
- 377 Remove deprecated functions and exceptions
- Removed `libvcs.shortcuts`
- Removed `libvcs.shortcuts.create_project_from_pip_url()`: This will be replaced in future
versions by 376 / parsing utilities
- Moved `libvcs.shortcuts.create_project()` to {func}`libvcs._internal.shortcuts.create_project`
- Removed {exc}`libvcs.exc.InvalidPipURL`
[^pip-git+git]: pip removes `git+git` <https://github.com/pypa/pip/pull/7543>
Fixes
- Minor spelling fix in Git's `convert_pip_url()` exception
- Fix mercurial cloning in {class}`libvcs.sync.hg.HgSync`
_Backport from 0.13.1_
Typings
- Rename `VcsLiteral` -> `VCSLiteral`
_Backport from 0.13.4_
- {func}`~libvcs.shortcuts.create_project`: Add overloads that return the typed project (e.g.,
{class}`~libvcs.sync.git.GitSync`)
_Backport from 0.13.3_
Cleanup
- 378 380 Remove duplicate `uses_netloc` scheme for `git+ssh` (this was in cpython since 2.7 / 3.1
[^git+ssh][^python:bugs:8657])
[^git+ssh]: `uses_netloc` added `'git'` and `'git+ssh'` in {mod}`urllib.parse`
[python/cpythonead169d]
[python/cpythonead169d]: https://github.com/python/cpython/commit/ead169d3114ed0f1041b5b59ca20293449608c50
[^python:bugs:8657]: <https://bugs.python.org/issue8657>