Breaking changes
- 343: `libvcs.cmd.core` moved to `libvcs._internal.run` to make it more clear the API is closed.
This includes {func}`~libvcs._internal.run.run`
Before in 0.13:
python
from libvcs.cmd.core import run
New module in >=0.13:
python
from libvcs._internal.run import run
- 361: {class}`~libvcs._internal.run.run`'s params are now a pass-through to
{class}`subprocess.Popen`.
- `run(cmd, ...)` is now `run(args, ...)` to match `Popen`'s convention.
- {class}`libvcs.sync.base.BaseSync`:
- Removed `parent_dir`:
Before: `project.parent_dir`
After: `project.parent.path`.
- `repo_name` switched from attribute to property
- Keyword-only arguments via [PEP 3102], [PEP 570]
- 366: `libvcs.cmd` for hg, git, and svn updated to use
- 364: Project classes no longer accept positional arguments.
Deprecated in >=0.13:
python
GitSync('https://github.com/vcs-python/libvcs.git')
New style in >=0.13:
python
GitSync(url='https://github.com/vcs-python/libvcs.git')
[pep 570]: https://peps.python.org/pep-0570/
[pep 3102]: https://peps.python.org/pep-3102/#specification
What's new
- **Commands**: Experimental command wrappers added (346):
- {class}`libvcs.cmd.git.Git`
- {meth}`libvcs.cmd.git.Git.help`
- {meth}`libvcs.cmd.git.Git.reset`
- {meth}`libvcs.cmd.git.Git.checkout`
- {meth}`libvcs.cmd.git.Git.status`
- {meth}`libvcs.cmd.git.Git.config` via 360
- **Command**: Now support `-C` (which accepts `.git` dirs, see git's manual) in addition to `cwd`
(subprocess-passthrough), 360
Bug fixes
- Fix argument input for commands, for instance `git config --get color.diff` would not properly
pass-through to subprocess. git: 360, svn and hg: 365
Internals
- 362 [mypy] support added:
- Basic mypy tests now pass
- Type annotations added, including improved typings for:
- {func}`libvcs._internal.run.run`
- {meth}`libvcs._internal.subprocess.SubprocessCommand.Popen`
- {meth}`libvcs._internal.subprocess.SubprocessCommand.check_output`
- {meth}`libvcs._internal.subprocess.SubprocessCommand.run`
- `make mypy` and `make watch_mypy`
- Automatic checking on CI
- 345 `libvcs.utils` -> `libvcs._internal` to make it more obvious the APIs are strictly closed.
- `StrOrPath` -> `StrPath`
- 336: {class}`~libvcs._internal.subprocess.SubprocessCommand`: Encapsulated {mod}`subprocess` call
in a {func}`dataclasses.dataclass` for introspecting, modifying, mocking and controlling
execution.
- Dataclass helper: {class}`~libvcs._internal.dataclasses.SkipDefaultFieldsReprMixin`
Skip default fields in object representations.
Credit: Pietro Oldrati, 2022-05-08,
[StackOverflow Post](https://stackoverflow.com/a/72161437/1396928)
Documentation
- Document `libvcs.types`
- 362: Improve developer documentation to note [mypy] and have tabbed examples for flake8.
[mypy]: http://mypy-lang.org/
Packaging
- Update description and keywords