!squash typings

Author: tony

conftest.py

@@ -34,36 +34,40 @@ def cwd_default(monkeypatch: pytest.MonkeyPatch, tmp_path: pathlib.Path) -> None
 
 @pytest.fixture(autouse=True, scope="session")
 @pytest.mark.usefixtures("set_home")
-def xdg_config_path(user_path: pathlib.Path):
+def xdg_config_path(user_path: pathlib.Path) -> pathlib.Path:
     p = user_path / ".config"
     p.mkdir()
     return p
 
 
 @pytest.fixture(scope="function")
-def config_path(xdg_config_path: pathlib.Path, request: pytest.FixtureRequest):
+def config_path(
+    xdg_config_path: pathlib.Path, request: pytest.FixtureRequest
+) -> pathlib.Path:
     conf_path = xdg_config_path / "vcspull"
     conf_path.mkdir(exist_ok=True)
 
-    def clean():
+    def clean() -> None:
         shutil.rmtree(conf_path)
 
     request.addfinalizer(clean)
     return conf_path
 
 
 @pytest.fixture(autouse=True)
-def set_xdg_config_path(monkeypatch: pytest.MonkeyPatch, xdg_config_path: pathlib.Path):
+def set_xdg_config_path(
+    monkeypatch: pytest.MonkeyPatch, xdg_config_path: pathlib.Path
+) -> None:
     monkeypatch.setenv("XDG_CONFIG_HOME", str(xdg_config_path))
 
 
 @pytest.fixture(scope="function")
-def repos_path(user_path: pathlib.Path, request: pytest.FixtureRequest):
+def repos_path(user_path: pathlib.Path, request: pytest.FixtureRequest) -> pathlib.Path:
     """Return temporary directory for repository checkout guaranteed unique."""
     dir = user_path / "repos"
     dir.mkdir(exist_ok=True)
 
-    def clean():
+    def clean() -> None:
         shutil.rmtree(dir)
 
     request.addfinalizer(clean)

src/vcspull/cli/__init__.py

@@ -7,6 +7,8 @@
 import argparse
 import logging
 import textwrap
+import typing as t
+from typing import overload
 
 from libvcs.__about__ import __version__ as libvcs_version
 
@@ -30,7 +32,19 @@
 ).strip()
 
 
-def create_parser(return_subparsers: bool = False):
+@overload
+def create_parser(
+    return_subparsers: t.Literal[True],
+) -> t.Tuple[argparse.ArgumentParser, t.Any]:
+    ...
+
+
+@overload
+def create_parser(return_subparsers: t.Literal[False]) -> argparse.ArgumentParser:
+    ...
+
+
+def create_parser(return_subparsers: bool = False) -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         prog="vcspull",
         formatter_class=argparse.RawDescriptionHelpFormatter,
@@ -64,9 +78,9 @@ def create_parser(return_subparsers: bool = False):
     return parser
 
 
-def cli(args=None):
+def cli(_args: t.Optional[t.List[str]] = None) -> None:
     parser, sync_parser = create_parser(return_subparsers=True)
-    args = parser.parse_args(args)
+    args = parser.parse_args(_args)
 
     setup_logger(log=log, level=args.log_level.upper())
 

src/vcspull/cli/sync.py

@@ -3,8 +3,10 @@
 import sys
 import typing as t
 from copy import deepcopy
+from datetime import datetime
 
 from libvcs._internal.shortcuts import create_project
+from libvcs.sync.git import GitSync
 from libvcs.url import registry as url_tools
 
 from ..config import filter_repos, find_config_files, load_configs
@@ -102,12 +104,15 @@ def sync(
                     raise SystemExit(EXIT_ON_ERROR_MSG)
 
 
-def progress_cb(output, timestamp):
+def progress_cb(output: str, timestamp: datetime) -> None:
     sys.stdout.write(output)
     sys.stdout.flush()
 
 
-def update_repo(repo_dict):
+def update_repo(
+    repo_dict: t.Any,
+    # repo_dict: Dict[str, Union[str, Dict[str, GitRemote], pathlib.Path]]
+) -> GitSync:
     repo_dict = deepcopy(repo_dict)
     if "pip_url" not in repo_dict:
         repo_dict["pip_url"] = repo_dict.pop("url")

src/vcspull/config.py

@@ -49,7 +49,9 @@ def expand_dir(
     return _dir
 
 
-def extract_repos(config: RawConfigDict, cwd=pathlib.Path.cwd()) -> list[ConfigDict]:
+def extract_repos(
+    config: RawConfigDict, cwd: pathlib.Path = pathlib.Path.cwd()
+) -> list[ConfigDict]:
     """Return expanded configuration.
 
     end-user configuration permit inline configuration shortcuts, expand to
@@ -165,7 +167,7 @@ def find_config_files(
         t.Literal["json", "yaml", "*"], list[t.Literal["json", "yaml", "*"]]
     ] = ["json", "yaml"],
     include_home: bool = False,
-):
+) -> t.List[t.Union[t.Any, pathlib.Path]]:
     """Return repos from a directory and match. Not recursive.
 
     Parameters
@@ -216,7 +218,9 @@ def find_config_files(
     return configs
 
 
-def load_configs(files: list[StrPath], cwd=pathlib.Path.cwd()):
+def load_configs(
+    files: list[StrPath], cwd: pathlib.Path = pathlib.Path.cwd()
+) -> t.List[t.Dict[str, t.Union[str, t.Dict[str, GitRemote], pathlib.Path]]]:
     """Return repos from a list of files.
 
     Parameters
@@ -295,7 +299,10 @@ def detect_duplicate_repos(
     return dupes
 
 
-def in_dir(config_dir=None, extensions: list[str] = [".yml", ".yaml", ".json"]):
+def in_dir(
+    config_dir: t.Optional[str] = None,
+    extensions: list[str] = [".yml", ".yaml", ".json"],
+) -> t.List[str]:
     """Return a list of configs in ``config_dir``.
 
     Parameters

src/vcspull/util.py

@@ -6,6 +6,7 @@
 """
 import os
 import pathlib
+import typing as t
 from collections.abc import Mapping
 
 LEGACY_CONFIG_DIR = os.path.expanduser("~/.vcspull/")  # remove dupes of this
@@ -45,7 +46,10 @@ def get_config_dir() -> pathlib.Path:
     return pathlib.Path(path)
 
 
-def update_dict(d, u):
+def update_dict(
+    d: t.Dict[t.Any, t.Any],
+    u: t.Mapping[str, t.Union[str, t.Dict[str, str], t.List[str]]],
+) -> t.Dict[str, t.Union[str, t.Dict[str, str], t.List[str]]]:
     """Return updated dict.
 
     Parameters

tests/fixtures/_util.py

@@ -1,5 +1,5 @@
 import os
 
 
-def curjoin(_file):  # return filepath relative to __file__ (this file)
+def curjoin(_file: str) -> str:  # return filepath relative to __file__ (this file)
     return os.path.join(os.path.dirname(__file__), _file)

tests/helpers.py

@@ -15,12 +15,12 @@ class EnvironmentVarGuard:
     including test module, see #121.
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         self._environ = os.environ
         self._unset = set()
         self._reset = dict()
 
-    def set(self, envvar, value):
+    def set(self, envvar: str, value: str) -> None:
         if envvar not in self._environ:
             self._unset.add(envvar)
         else:
@@ -32,10 +32,10 @@ def unset(self, envvar):
             self._reset[envvar] = self._environ[envvar]
             del self._environ[envvar]
 
-    def __enter__(self):
+    def __enter__(self) -> "EnvironmentVarGuard":
         return self
 
-    def __exit__(self, *ignore_exc):
+    def __exit__(self, *ignore_exc) -> None:
         for envvar, value in self._reset.items():
             self._environ[envvar] = value
         for unset in self._unset:

tests/test_cli.py

@@ -61,7 +61,7 @@ class SyncCLINonExistentRepo(t.NamedTuple):
 )
 def test_sync_cli_filter_non_existent(
     tmp_path: pathlib.Path,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
     monkeypatch: pytest.MonkeyPatch,
     user_path: pathlib.Path,
     config_path: pathlib.Path,
@@ -192,7 +192,7 @@ class SyncFixture(t.NamedTuple):
 )
 def test_sync(
     tmp_path: pathlib.Path,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
     monkeypatch: pytest.MonkeyPatch,
     user_path: pathlib.Path,
     config_path: pathlib.Path,
@@ -324,7 +324,7 @@ class SyncBrokenFixture(t.NamedTuple):
 )
 def test_sync_broken(
     tmp_path: pathlib.Path,
-    capsys: pytest.CaptureFixture,
+    capsys: pytest.CaptureFixture[str],
     monkeypatch: pytest.MonkeyPatch,
     user_path: pathlib.Path,
     config_path: pathlib.Path,

tests/test_config.py

@@ -1,13 +1,27 @@
 import pathlib
+import typing as t
+from typing import Callable
 
 import pytest
 
 from vcspull import config
 
 
+class LoadYAMLFn(t.Protocol):
+    def __call__(
+        self,
+        content: str,
+        dir: str = "randomdir",
+        filename: str = "randomfilename.yaml",
+    ) -> t.Tuple[
+        pathlib.Path, t.List[t.Union[t.Any, pathlib.Path]], t.List[t.Dict[str, t.Any]]
+    ]:
+        ...
+
+
 @pytest.fixture
-def load_yaml(tmp_path: pathlib.Path):
-    def fn(content, dir="randomdir", filename="randomfilename.yaml"):
+def load_yaml(tmp_path: pathlib.Path) -> LoadYAMLFn:
+    def fn(content: str, dir: str = "randomdir", filename: str = "randomfilename.yaml"):
         _dir = tmp_path / dir
         _dir.mkdir()
         _config = _dir / filename
@@ -20,7 +34,7 @@ def fn(content, dir="randomdir", filename="randomfilename.yaml"):
     return fn
 
 
-def test_simple_format(load_yaml):
+def test_simple_format(load_yaml: LoadYAMLFn) -> None:
     dir, _, repos = load_yaml(
         """
 vcspull:
@@ -35,7 +49,7 @@ def test_simple_format(load_yaml):
     assert dir / "vcspull" / "libvcs" == repo["dir"]
 
 
-def test_relative_dir(load_yaml):
+def test_relative_dir(load_yaml: LoadYAMLFn) -> None:
     dir, _, repos = load_yaml(
         """
 ./relativedir: