refactor(types): Hide .types imports behind TypeGuard (#414)

Fixes #412, alternative backup approach is at #413

Author: tony

CHANGES

@@ -21,6 +21,11 @@ $ pipx install --suffix=@next 'vcspull' --pip-args '\--pre' --force
 
 <!-- Maintainers, insert changes / features for the next release here -->
 
+## Bug fix
+
+- Refactor `.types` imports to not require `typing-extensions` on production
+  builds (fixes #412 via #414, thank you for the report @Jasha10)
+
 ## vcspull v1.20.2 (2023-04-07)
 
 _Maintenance only, no bug fixes or features_

src/vcspull/config.py

@@ -16,14 +16,15 @@
 
 from . import exc
 from ._internal.config_reader import ConfigReader
-from .types import ConfigDict, RawConfigDict
 from .util import get_config_dir, update_dict
 
 log = logging.getLogger(__name__)
 
 if t.TYPE_CHECKING:
     from typing_extensions import TypeGuard
 
+    from .types import ConfigDict, RawConfigDict
+
 
 def expand_dir(
     _dir: pathlib.Path, cwd: pathlib.Path = pathlib.Path.cwd()
@@ -50,8 +51,8 @@ def expand_dir(
 
 
 def extract_repos(
-    config: RawConfigDict, cwd: pathlib.Path = pathlib.Path.cwd()
-) -> list[ConfigDict]:
+    config: "RawConfigDict", cwd: pathlib.Path = pathlib.Path.cwd()
+) -> list["ConfigDict"]:
     """Return expanded configuration.
 
     end-user configuration permit inline configuration shortcuts, expand to
@@ -68,7 +69,7 @@ def extract_repos(
     -------
     list : List of normalized repository information
     """
-    configs: list[ConfigDict] = []
+    configs: list["ConfigDict"] = []
     for directory, repos in config.items():
         assert isinstance(repos, dict)
         for repo, repo_data in repos.items():
@@ -220,7 +221,7 @@ def find_config_files(
 
 def load_configs(
     files: list[pathlib.Path], cwd: pathlib.Path = pathlib.Path.cwd()
-) -> t.List[ConfigDict]:
+) -> t.List["ConfigDict"]:
     """Return repos from a list of files.
 
     Parameters
@@ -239,7 +240,7 @@ def load_configs(
     ----
     Validate scheme, check for duplicate destinations, VCS urls
     """
-    repos: list[ConfigDict] = []
+    repos: list["ConfigDict"] = []
     for file in files:
         if isinstance(file, str):
             file = pathlib.Path(file)
@@ -262,11 +263,11 @@ def load_configs(
     return repos
 
 
-ConfigDictTuple = tuple[ConfigDict, ConfigDict]
+ConfigDictTuple = tuple["ConfigDict", "ConfigDict"]
 
 
 def detect_duplicate_repos(
-    config1: list[ConfigDict], config2: list[ConfigDict]
+    config1: list["ConfigDict"], config2: list["ConfigDict"]
 ) -> list[ConfigDictTuple]:
     """Return duplicate repos dict if repo_dir same and vcs different.
 
@@ -329,11 +330,11 @@ def in_dir(
 
 
 def filter_repos(
-    config: t.List[ConfigDict],
+    config: t.List["ConfigDict"],
     dir: t.Union[pathlib.Path, t.Literal["*"], str, None] = None,
     vcs_url: t.Union[str, None] = None,
     name: t.Union[str, None] = None,
-) -> list[ConfigDict]:
+) -> list["ConfigDict"]:
     """Return a :py:obj:`list` list of repos from (expanded) config file.
 
     dir, vcs_url and name all support fnmatch.
@@ -354,7 +355,7 @@ def filter_repos(
     list :
         Repos
     """
-    repo_list: list[ConfigDict] = []
+    repo_list: list["ConfigDict"] = []
 
     if dir:
         repo_list.extend(

src/vcspull/validator.py

@@ -1,11 +1,11 @@
 import pathlib
 import typing as t
 
-from vcspull.types import RawConfigDict
-
 if t.TYPE_CHECKING:
     from typing_extensions import TypeGuard
 
+    from vcspull.types import RawConfigDict
+
 
 def is_valid_config(config: t.Dict[str, t.Any]) -> "TypeGuard[RawConfigDict]":
     if not isinstance(config, dict):

tests/fixtures/example.py

@@ -1,7 +1,10 @@
 import pathlib
+import typing as t
 
 from libvcs.sync.git import GitRemote
-from vcspull.types import ConfigDict
+
+if t.TYPE_CHECKING:
+    from vcspull.types import ConfigDict
 
 config_dict = {
     "/home/me/myproject/study/": {
@@ -33,7 +36,7 @@
     },
 }
 
-config_dict_expanded: list[ConfigDict] = [
+config_dict_expanded: list["ConfigDict"] = [
     {
         "vcs": "git",
         "name": "linux",

tests/test_config.py

@@ -4,7 +4,9 @@
 import pytest
 
 from vcspull import config
-from vcspull.types import ConfigDict
+
+if t.TYPE_CHECKING:
+    from vcspull.types import ConfigDict
 
 
 class LoadYAMLFn(t.Protocol):
@@ -14,7 +16,7 @@ def __call__(
         dir: str = "randomdir",
         filename: str = "randomfilename.yaml",
     ) -> t.Tuple[
-        pathlib.Path, t.List[t.Union[t.Any, pathlib.Path]], t.List[ConfigDict]
+        pathlib.Path, t.List[t.Union[t.Any, pathlib.Path]], t.List["ConfigDict"]
     ]:
         ...
 
@@ -23,7 +25,7 @@ def __call__(
 def load_yaml(tmp_path: pathlib.Path) -> LoadYAMLFn:
     def fn(
         content: str, dir: str = "randomdir", filename: str = "randomfilename.yaml"
-    ) -> t.Tuple[pathlib.Path, t.List[pathlib.Path], t.List[ConfigDict]]:
+    ) -> t.Tuple[pathlib.Path, t.List[pathlib.Path], t.List["ConfigDict"]]:
         _dir = tmp_path / dir
         _dir.mkdir()
         _config = _dir / filename

tests/test_sync.py

@@ -10,11 +10,13 @@
 from vcspull._internal.config_reader import ConfigReader
 from vcspull.cli.sync import update_repo
 from vcspull.config import extract_repos, filter_repos, load_configs
-from vcspull.types import ConfigDict
 from vcspull.validator import is_valid_config
 
 from .helpers import write_config
 
+if t.TYPE_CHECKING:
+    from vcspull.types import ConfigDict
+
 
 def test_makes_recursive(
     tmp_path: pathlib.Path,
@@ -176,7 +178,7 @@ def test_updating_remote(
     repo_parent = tmp_path / "study" / "myrepo"
     repo_parent.mkdir(parents=True)
 
-    initial_config: ConfigDict = {
+    initial_config: "ConfigDict" = {
         "vcs": "git",
         "name": "myclone",
         "dir": tmp_path / "study/myrepo/myclone",
@@ -198,7 +200,7 @@ def test_updating_remote(
 
     expected_remote_url = f"git+file://{mirror_repo}"
 
-    expected_config: ConfigDict = initial_config.copy()
+    expected_config: "ConfigDict" = initial_config.copy()
     assert isinstance(expected_config["remotes"], dict)
     expected_config["remotes"][mirror_name] = GitRemote(
         name=mirror_name,