config: expose typing aliases for autodoc

Author: tony

src/vcspull/_internal/config_reader.py

@@ -7,12 +7,8 @@
 
 import yaml
 
-if t.TYPE_CHECKING:
-    from typing import Literal, TypeAlias
-
-    FormatLiteral = Literal["json", "yaml"]
-
-    RawConfigData: TypeAlias = dict[t.Any, t.Any]
+FormatLiteral = t.Literal["json", "yaml"]
+RawConfigData: t.TypeAlias = dict[t.Any, t.Any]
 
 
 class ConfigReader:

src/vcspull/config.py

@@ -7,6 +7,7 @@
 import logging
 import os
 import pathlib
+from collections.abc import Callable
 import typing as t
 
 from libvcs.sync.git import GitRemote
@@ -16,15 +17,10 @@
 from . import exc
 from ._internal.config_reader import ConfigReader, DuplicateAwareConfigReader
 from .util import get_config_dir, update_dict
+from .types import ConfigDict, RawConfigDict
 
 log = logging.getLogger(__name__)
 
-if t.TYPE_CHECKING:
-    from collections.abc import Callable
-    from typing import TypeGuard
-
-    from .types import ConfigDict, RawConfigDict
-
 
 def expand_dir(
     dir_: pathlib.Path,
@@ -34,14 +30,15 @@ def expand_dir(
 
     Parameters
     ----------
-    _dir : pathlib.Path
+    dir_ : pathlib.Path
+        Directory path to expand
     cwd : pathlib.Path, optional
-        current working dir (for deciphering relative _dir paths), defaults to
-        :py:meth:`os.getcwd()`
+        Current working dir (used to resolve relative paths). Defaults to
+        :py:meth:`pathlib.Path.cwd`.
 
     Returns
     -------
-    pathlib.Path :
+    pathlib.Path
         Absolute directory path
     """
     dir_ = pathlib.Path(os.path.expandvars(str(dir_))).expanduser()
@@ -136,7 +133,7 @@ def extract_repos(
                             **url,
                         )
 
-            def is_valid_config_dict(val: t.Any) -> TypeGuard[ConfigDict]:
+            def is_valid_config_dict(val: t.Any) -> t.TypeGuard[ConfigDict]:
                 assert isinstance(val, dict)
                 return True
 

src/vcspull/validator.py

@@ -5,13 +5,10 @@
 import pathlib
 import typing as t
 
-if t.TYPE_CHECKING:
-    from typing import TypeGuard
+from vcspull.types import RawConfigDict
 
-    from vcspull.types import RawConfigDict
 
-
-def is_valid_config(config: dict[str, t.Any]) -> TypeGuard[RawConfigDict]:
+def is_valid_config(config: dict[str, t.Any]) -> t.TypeGuard[RawConfigDict]:
     """Return true and upcast if vcspull configuration file is valid."""
     if not isinstance(config, dict):
         return False