chore: Small fixes for docstrings, pytest plugin typings, add an HgSync test (#450)

Author: tony

CHANGES

@@ -15,6 +15,26 @@ $ pip install --user --upgrade --pre libvcs
 
 <!-- Maintainers, insert changes / features for the next release here -->
 
+### Breaking changes
+
+- Rename pytest plugin protocol typings (#450):
+
+  - `CreateProjectCallbackProtocol` -> `CreateRepoPostInitFn`
+  - `CreateProjectCallbackFixtureProtocol` -> `CreateRepoPytestFixtureFn`
+
+### Bug fixes
+
+- Remove unused command: `Svn.mergelist` (#450)
+- Fix `Git.config` docstring (#450)
+
+### Development
+
+- Add test for direct usage of `HgSync` (#450)
+- pytest-watcher, Add configuration (#450): 
+
+  - Run initially by default
+  - Skip post-save files from vim
+
 ## libvcs 0.25.1 (2023-11-23)
 
 ### Packaging

pyproject.toml

@@ -171,6 +171,10 @@ filterwarnings = [
   "ignore:The frontend.Option(Parser)? class.*:DeprecationWarning::",
 ]
 
+[tool.pytest-watcher]
+now = true
+ignore_patterns = ["*.py.*.py"]
+
 [build-system]
 requires = ["poetry_core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

src/libvcs/cmd/git.py

@@ -1586,10 +1586,10 @@ def config(
         check_returncode: Optional[bool] = None,
         **kwargs: Any,
     ) -> str:
-        """Status of working tree. Wraps
-        `git status <https://git-scm.com/docs/git-status>`_.
+        """Get and set repo configuration.
 
-        `git ls-files` has similar params (e.g. `z`)
+        Status of working tree. Wraps
+        `git config <https://git-scm.com/docs/git-config>`_.
 
         Parameters
         ----------

src/libvcs/cmd/svn.py

@@ -686,18 +686,6 @@ def merge(self, *args: Any, **kwargs: Any) -> str:
 
         return self.run(["merge", *local_flags])
 
-    def mergelist(self, *args: Any, **kwargs: Any) -> str:
-        """
-        Wraps `svn mergelist
-        <https://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.mergelist.html>`_.
-
-        Parameters
-        ----------
-        """
-        local_flags: list[str] = [*args]
-
-        return self.run(["mergelist", *local_flags])
-
     def mkdir(self, *args: Any, **kwargs: Any) -> str:
         """
         Wraps `svn mkdir

src/libvcs/pytest_plugin.py

@@ -194,17 +194,17 @@ def unique_repo_name(remote_repos_path: pathlib.Path, max_retries: int = 15) ->
 InitCmdArgs: "TypeAlias" = Optional[list[str]]
 
 
-class CreateProjectCallbackProtocol(Protocol):
+class CreateRepoPostInitFn(Protocol):
     def __call__(self, remote_repo_path: pathlib.Path) -> None:
         ...
 
 
-class CreateProjectCallbackFixtureProtocol(Protocol):
+class CreateRepoPytestFixtureFn(Protocol):
     def __call__(
         self,
         remote_repos_path: pathlib.Path = ...,
         remote_repo_name: Optional[str] = ...,
-        remote_repo_post_init: Optional[CreateProjectCallbackProtocol] = ...,
+        remote_repo_post_init: Optional[CreateRepoPostInitFn] = ...,
         init_cmd_args: InitCmdArgs = ...,
     ) -> pathlib.Path:
         ...
@@ -216,7 +216,7 @@ def __call__(
 def _create_git_remote_repo(
     remote_repos_path: pathlib.Path,
     remote_repo_name: str,
-    remote_repo_post_init: Optional[CreateProjectCallbackProtocol] = None,
+    remote_repo_post_init: Optional[CreateRepoPostInitFn] = None,
     init_cmd_args: InitCmdArgs = DEFAULT_GIT_REMOTE_REPO_CMD_ARGS,
 ) -> pathlib.Path:
     if init_cmd_args is None:
@@ -234,13 +234,13 @@ def _create_git_remote_repo(
 @skip_if_git_missing
 def create_git_remote_repo(
     remote_repos_path: pathlib.Path,
-) -> CreateProjectCallbackFixtureProtocol:
-    """Factory. Create git remote repo to for clone / push purposes"""
+) -> CreateRepoPytestFixtureFn:
+    """Factory. Create git remote repo to for clone / push purposes."""
 
     def fn(
         remote_repos_path: pathlib.Path = remote_repos_path,
         remote_repo_name: Optional[str] = None,
-        remote_repo_post_init: Optional[CreateProjectCallbackProtocol] = None,
+        remote_repo_post_init: Optional[CreateRepoPostInitFn] = None,
         init_cmd_args: InitCmdArgs = DEFAULT_GIT_REMOTE_REPO_CMD_ARGS,
     ) -> pathlib.Path:
         return _create_git_remote_repo(
@@ -278,7 +278,7 @@ def git_remote_repo(remote_repos_path: pathlib.Path) -> pathlib.Path:
 def _create_svn_remote_repo(
     remote_repos_path: pathlib.Path,
     remote_repo_name: str,
-    remote_repo_post_init: Optional[CreateProjectCallbackProtocol] = None,
+    remote_repo_post_init: Optional[CreateRepoPostInitFn] = None,
     init_cmd_args: InitCmdArgs = None,
 ) -> pathlib.Path:
     """Create a test SVN repo to for checkout / commit purposes"""
@@ -318,13 +318,13 @@ def svn_remote_repo_single_commit_post_init(remote_repo_path: pathlib.Path) -> N
 @skip_if_svn_missing
 def create_svn_remote_repo(
     remote_repos_path: pathlib.Path,
-) -> CreateProjectCallbackFixtureProtocol:
+) -> CreateRepoPytestFixtureFn:
     """Pre-made svn repo, bare, used as a file:// remote to checkout and commit to."""
 
     def fn(
         remote_repos_path: pathlib.Path = remote_repos_path,
         remote_repo_name: Optional[str] = None,
-        remote_repo_post_init: Optional[CreateProjectCallbackProtocol] = None,
+        remote_repo_post_init: Optional[CreateRepoPostInitFn] = None,
         init_cmd_args: InitCmdArgs = None,
     ) -> pathlib.Path:
         return _create_svn_remote_repo(
@@ -355,7 +355,7 @@ def svn_remote_repo(remote_repos_path: pathlib.Path) -> pathlib.Path:
 def _create_hg_remote_repo(
     remote_repos_path: pathlib.Path,
     remote_repo_name: str,
-    remote_repo_post_init: Optional[CreateProjectCallbackProtocol] = None,
+    remote_repo_post_init: Optional[CreateRepoPostInitFn] = None,
     init_cmd_args: InitCmdArgs = None,
 ) -> pathlib.Path:
     """Create a test hg repo to for checkout / commit purposes"""
@@ -384,13 +384,13 @@ def create_hg_remote_repo(
     remote_repos_path: pathlib.Path,
     hgconfig: pathlib.Path,
     set_home: pathlib.Path,
-) -> CreateProjectCallbackFixtureProtocol:
+) -> CreateRepoPytestFixtureFn:
     """Pre-made hg repo, bare, used as a file:// remote to checkout and commit to."""
 
     def fn(
         remote_repos_path: pathlib.Path = remote_repos_path,
         remote_repo_name: Optional[str] = None,
-        remote_repo_post_init: Optional[CreateProjectCallbackProtocol] = None,
+        remote_repo_post_init: Optional[CreateRepoPostInitFn] = None,
         init_cmd_args: InitCmdArgs = None,
     ) -> pathlib.Path:
         return _create_hg_remote_repo(
@@ -465,9 +465,9 @@ def add_doctest_fixtures(
     tmp_path: pathlib.Path,
     set_home: pathlib.Path,
     gitconfig: pathlib.Path,
-    create_git_remote_repo: CreateProjectCallbackFixtureProtocol,
-    create_svn_remote_repo: CreateProjectCallbackFixtureProtocol,
-    create_hg_remote_repo: CreateProjectCallbackFixtureProtocol,
+    create_git_remote_repo: CreateRepoPytestFixtureFn,
+    create_svn_remote_repo: CreateRepoPytestFixtureFn,
+    create_hg_remote_repo: CreateRepoPytestFixtureFn,
     git_repo: pathlib.Path,
 ) -> None:
     from _pytest.doctest import DoctestItem

tests/sync/test_git.py

@@ -12,7 +12,7 @@
 from libvcs import exc
 from libvcs._internal.run import run
 from libvcs._internal.shortcuts import create_project
-from libvcs.pytest_plugin import CreateProjectCallbackFixtureProtocol
+from libvcs.pytest_plugin import CreateRepoPytestFixtureFn
 from libvcs.sync.git import (
     GitRemote,
     GitStatus,
@@ -169,7 +169,7 @@ def test_repo_update_handle_cases(
 )
 def test_repo_update_stash_cases(
     tmp_path: pathlib.Path,
-    create_git_remote_repo: CreateProjectCallbackFixtureProtocol,
+    create_git_remote_repo: CreateRepoPytestFixtureFn,
     mocker: MockerFixture,
     has_untracked_files: bool,
     needs_stash: bool,
@@ -531,7 +531,7 @@ def test_remotes_update_repo(
     lazy_constructor_options: ProjectTestFactoryLazyKwargs,
     lazy_remote_dict: ProjectTestFactoryRemoteLazyExpected,
     lazy_remote_expected: ProjectTestFactoryRemoteLazyExpected,
-    create_git_remote_repo: CreateProjectCallbackFixtureProtocol,
+    create_git_remote_repo: CreateRepoPytestFixtureFn,
 ) -> None:
     repo_name = "myrepo"
     remote_name = "myremote"
@@ -887,7 +887,7 @@ def test_GitRemote__from_stdout_c(fixture: str, expected_result: GitStatus) -> N
 
 
 def test_repo_git_remote_checkout(
-    create_git_remote_repo: CreateProjectCallbackFixtureProtocol,
+    create_git_remote_repo: CreateRepoPytestFixtureFn,
     tmp_path: pathlib.Path,
     projects_path: pathlib.Path,
 ) -> None:

tests/sync/test_hg.py

@@ -7,16 +7,42 @@
 from libvcs import exc
 from libvcs._internal.run import run
 from libvcs._internal.shortcuts import create_project
+from libvcs.sync.hg import HgSync
 
 if not shutil.which("hg"):
     pytestmark = pytest.mark.skip(reason="hg is not available")
 
 
-def test_repo_mercurial(
+def test_hg_sync(
     tmp_path: pathlib.Path,
     projects_path: pathlib.Path,
     hg_remote_repo: pathlib.Path,
 ) -> None:
+    """Test HgSync."""
+    repo_name = "my_mercurial_project"
+
+    mercurial_repo = HgSync(
+        url=f"file://{hg_remote_repo}",
+        dir=projects_path / repo_name,
+    )
+
+    run(["hg", "init", mercurial_repo.repo_name], cwd=tmp_path)
+
+    mercurial_repo.update_repo()
+
+    test_repo_revision = run(
+        ["hg", "parents", "--template={rev}"], cwd=projects_path / repo_name
+    )
+
+    assert mercurial_repo.get_revision() == test_repo_revision
+
+
+def test_repo_mercurial_via_create_project(
+    tmp_path: pathlib.Path,
+    projects_path: pathlib.Path,
+    hg_remote_repo: pathlib.Path,
+) -> None:
+    """Test HgSync via create_project()."""
     repo_name = "my_mercurial_project"
 
     mercurial_repo = create_project(

tests/sync/test_svn.py

@@ -4,7 +4,7 @@
 
 import pytest
 
-from libvcs.pytest_plugin import CreateProjectCallbackFixtureProtocol
+from libvcs.pytest_plugin import CreateRepoPytestFixtureFn
 from libvcs.sync.svn import SvnSync
 
 if not shutil.which("svn"):
@@ -29,7 +29,7 @@ def test_repo_svn(tmp_path: pathlib.Path, svn_remote_repo: pathlib.Path) -> None
 
 
 def test_repo_svn_remote_checkout(
-    create_svn_remote_repo: CreateProjectCallbackFixtureProtocol,
+    create_svn_remote_repo: CreateRepoPytestFixtureFn,
     tmp_path: pathlib.Path,
     projects_path: pathlib.Path,
 ) -> None:

tests/test_pytest_plugin.py

@@ -4,12 +4,12 @@
 
 import pytest
 
-from libvcs.pytest_plugin import CreateProjectCallbackFixtureProtocol
+from libvcs.pytest_plugin import CreateRepoPytestFixtureFn
 
 
 @pytest.mark.skipif(not shutil.which("git"), reason="git is not available")
 def test_create_git_remote_repo(
-    create_git_remote_repo: CreateProjectCallbackFixtureProtocol,
+    create_git_remote_repo: CreateRepoPytestFixtureFn,
     tmp_path: pathlib.Path,
     projects_path: pathlib.Path,
 ) -> None:
@@ -21,7 +21,7 @@ def test_create_git_remote_repo(
 
 @pytest.mark.skipif(not shutil.which("svn"), reason="svn is not available")
 def test_create_svn_remote_repo(
-    create_svn_remote_repo: CreateProjectCallbackFixtureProtocol,
+    create_svn_remote_repo: CreateRepoPytestFixtureFn,
     tmp_path: pathlib.Path,
     projects_path: pathlib.Path,
 ) -> None:
@@ -69,10 +69,10 @@ def setup(
 import pathlib
 
 from libvcs.sync.git import GitSync
-from libvcs.pytest_plugin import CreateProjectCallbackFixtureProtocol
+from libvcs.pytest_plugin import CreateRepoPytestFixtureFn
 
 def test_repo_git_remote_checkout(
-    create_git_remote_repo: CreateProjectCallbackFixtureProtocol,
+    create_git_remote_repo: CreateRepoPytestFixtureFn,
     tmp_path: pathlib.Path,
     projects_path: pathlib.Path,
 ) -> None: