csspin-python 2.1.0__py3-none-any.whl → 2.1.1__py3-none-any.whl

csspin_python/behave.py

@@ -20,7 +20,7 @@
 
 import contextlib
 import sys
-from typing import Generator
+from typing import Generator, Iterable
 
 from csspin import config, die, info, option, rmtree, setenv, sh, task, writetext
 from csspin.tree import ConfigTree
@@ -67,16 +67,16 @@ def configure(cfg: ConfigTree) -> None:
         cfg.behave.opts.append("--tags=~windows")
 
 
-def create_coverage_pth(cfg: ConfigTree) -> str:  # pylint: disable=unused-argument
+def create_coverage_pth(cfg: ConfigTree) -> Path:  # pylint: disable=unused-argument
     """Creating the coverage path file and returning its path"""
-    coverage_pth_path = cfg.python.site_packages / "coverage.pth"
+    coverage_pth_path: Path = cfg.python.site_packages / "coverage.pth"
     info(f"Create {coverage_pth_path}")
     writetext(coverage_pth_path, "import coverage; coverage.process_startup()")
     return coverage_pth_path
 
 
 @contextlib.contextmanager
-def with_coverage(cfg: ConfigTree) -> Generator:
+def with_coverage(cfg: ConfigTree) -> Generator[None, None, None]:
     """Context-manager enabling to run coverage"""
     coverage_pth = ""
     try:
@@ -95,28 +95,28 @@ def with_coverage(cfg: ConfigTree) -> Generator:
 
 @task(when="cept")
 def behave(  # pylint: disable=too-many-arguments,too-many-positional-arguments
-    cfg,
-    instance: option(
+    cfg: ConfigTree,
+    instance: option(  # type: ignore[valid-type]
         "-i",  # noqa: F821
         "--instance",  # noqa: F821
         help="Directory of the CONTACT Elements instance.",  # noqa: F722
     ),
-    coverage: option(
+    coverage: option(  # type: ignore[valid-type]
         "-c",  # noqa: F821
         "--coverage",  # noqa: F821
         is_flag=True,
         help="Run the tests while collecting coverage.",  # noqa: F722
     ),
-    debug: option(
+    debug: option(  # type: ignore[valid-type]
         "--debug", is_flag=True, help="Start debug server."  # noqa: F722,F821
     ),
-    with_test_report: option(
+    with_test_report: option(  # type: ignore[valid-type]
         "--with-test-report",  # noqa: F722
         is_flag=True,
         help="Create a test execution report.",  # noqa: F722
     ),
-    args,
-):
+    args: Iterable[str],
+) -> None:
     """Run Gherkin tests using behave."""
     # pylint: disable=missing-function-docstring
     coverage_enabled = coverage or cfg.behave.coverage

csspin_python/devpi.py

@@ -18,7 +18,10 @@
 """Module implementing the devpi plugin for spin"""
 
 
+from typing import Iterable
+
 from csspin import Command, config, die, exists, readyaml, setenv, sh, task
+from csspin.tree import ConfigTree
 
 defaults = config(
     formats=["bdist_wheel"],
@@ -34,13 +37,13 @@ defaults = config(
 )
 
 
-def init(cfg):  # pylint: disable=unused-argument
+def init(cfg: ConfigTree) -> None:  # pylint: disable=unused-argument
     """Sets some environment variables"""
     setenv(DEVPI_VENV="{python.venv}", DEVPI_CLIENTDIR="{spin.spin_dir}/devpi")
 
 
 @task("devpi:upload")
-def upload(cfg):
+def upload(cfg: ConfigTree) -> None:
     """Upload project wheel to a package server."""
     if not cfg.devpi.user:
         die("devpi.user is required!")
@@ -68,7 +71,7 @@ def upload(cfg):
 
 
 @task()
-def devpi(cfg, args):
+def devpi(cfg: ConfigTree, args: Iterable[str]) -> None:
     """Run the 'devpi' command inside the project's virtual environment.
 
     All command line arguments are simply passed through to 'devpi'.

csspin_python/playwright.py

@@ -17,7 +17,10 @@
 
 """Module implementing the playwright plugin for spin"""
 
+from typing import Iterable
+
 from csspin import Path, Verbosity, config, die, option, setenv, sh, task
+from csspin.tree import ConfigTree
 
 defaults = config(
     browsers_path="{spin.data}/playwright_browsers",
@@ -50,29 +53,29 @@ defaults = config(
 
 @task(when="cept")
 def playwright(  # pylint: disable=too-many-arguments,too-many-positional-arguments
-    cfg,
-    instance: option(
+    cfg: ConfigTree,
+    instance: option(  # type: ignore[valid-type]
         "-i",  # noqa: F821
         "--instance",  # noqa: F821
         default=None,
         help="Directory of the CONTACT Elements instance.",  # noqa: F722
     ),
-    coverage: option(
+    coverage: option(  # type: ignore[valid-type]
         "-c",  # noqa: F821
         "--coverage",  # noqa: F821
         is_flag=True,
         help="Run the tests while collecting coverage.",  # noqa: F722
     ),
-    debug: option(
+    debug: option(  # type: ignore[valid-type]
         "--debug", is_flag=True, help="Start debug server."  # noqa: F722,F821
     ),
-    with_test_report: option(
+    with_test_report: option(  # type: ignore[valid-type]
         "--with-test-report",  # noqa: F722
         is_flag=True,
         help="Create a test execution report.",  # noqa: F722
     ),
-    args,
-):
+    args: Iterable[str],
+) -> None:
     """Run the playwright tests with pytest."""
     setenv(
         PLAYWRIGHT_BROWSERS_PATH=cfg.playwright.browsers_path,
@@ -113,7 +116,7 @@ def playwright(  # pylint: disable=too-many-arguments,too-many-positional-argume
         sh(*cmd, *opts, *args, *cfg.playwright.tests)
 
 
-def _download_playwright_browsers(cfg):
+def _download_playwright_browsers(cfg: ConfigTree) -> None:
     """Let playwright install the browsers"""
     sh(
         f"playwright install {' '.join(cfg.playwright.browsers)}",
@@ -121,6 +124,6 @@ def _download_playwright_browsers(cfg):
     )
 
 
-def provision(cfg):
+def provision(cfg: ConfigTree) -> None:
     """Install playwright browsers during provisioning"""
     _download_playwright_browsers(cfg)

csspin_python/pytest.py

@@ -18,7 +18,10 @@
 """Module implementing the pytest plugin for spin"""
 
 
+from typing import Iterable
+
 from csspin import Path, Verbosity, config, die, option, setenv, sh, task
+from csspin.tree import ConfigTree
 
 defaults = config(
     coverage=False,
@@ -49,29 +52,29 @@ defaults = config(
 
 @task(when="test")
 def pytest(  # pylint: disable=too-many-arguments,too-many-positional-arguments
-    cfg,
-    instance: option(
+    cfg: ConfigTree,
+    instance: option(  # type: ignore[valid-type]
         "-i",  # noqa: F821
         "--instance",  # noqa: F821
         default=None,
         help="Directory of the CONTACT Elements instance.",  # noqa: F722
     ),
-    coverage: option(
+    coverage: option(  # type: ignore[valid-type]
         "-c",  # noqa: F821
         "--coverage",  # noqa: F821
         is_flag=True,
         help="Run the tests while collecting coverage.",  # noqa: F722
     ),
-    debug: option(
+    debug: option(  # type: ignore[valid-type]
         "--debug", is_flag=True, help="Start debug server."  # noqa: F722,F821
     ),
-    with_test_report: option(
+    with_test_report: option(  # type: ignore[valid-type]
         "--with-test-report",  # noqa: F722
         is_flag=True,
         help="Create a test execution report.",  # noqa: F722
     ),
-    args,
-):
+    args: Iterable[str],
+) -> None:
     """Run the 'pytest' command."""
     opts = cfg.pytest.opts
     if cfg.verbosity == Verbosity.QUIET:

csspin_python/python.py

@@ -75,6 +75,14 @@ import shutil
 import sys
 from subprocess import check_output
 from textwrap import dedent, indent
+from typing import Iterable, Type, Union
+
+try:
+    from typing import Self  # type: ignore[attr-defined]
+except ImportError:
+    from typing import TypeVar
+
+    Self = TypeVar("Self")  # type: ignore[misc]
 
 from click.exceptions import Abort
 from csspin import (
@@ -185,16 +193,16 @@ defaults = config(
 
 
 @task()
-def python(args):
+def python(args: Iterable[object]) -> None:
     """Run the Python interpreter used for this projects."""
     sh("python", *args)
 
 
 @task("python:wheel", when="package")
 def wheel(
-    cfg,
-    paths: argument(type=str, nargs=-1, required=False),  # noqa: F722
-):
+    cfg: ConfigTree,
+    paths: argument(type=str, nargs=-1, required=False),  # type: ignore[valid-type]
+) -> None:
     """Build a wheel of the current project and any additional wheels."""
     setenv(PIP_INDEX_URL=cfg.python.index_url)
     search_paths = paths or cfg.python.build_wheels
@@ -226,8 +234,13 @@ def wheel(
 
 
 @task()
-def env():
-    """Generate command to activate the virtual environment"""
+def env() -> None:
+    """
+    Generate command to activate the virtual environment
+
+    NOTE: spin itself should not be run from within the activated virtual
+          environment!
+    """
     if sys.platform == "win32":
         # Don't care about cmd
         print(normpath("{python.scriptdir}", "activate.ps1"))
@@ -235,12 +248,12 @@ def env():
         print(f". {normpath('{python.scriptdir}', 'activate')}")
 
 
-def pyenv_install(cfg):
+def pyenv_install(cfg: ConfigTree) -> None:
     """Install and setup the virtual environment using pyenv"""
     with namespaces(cfg.python):
         if cfg.python.user_pyenv:
             info("Using your existing pyenv installation ...")
-            sh(f"pyenv install --skip-existing {cfg.python.version}")
+            sh("pyenv", "install", "--skip-existing", {cfg.python.version})
             cfg.python.interpreter = backtick("pyenv which python --nosystem").strip()
         else:
             info("Installing Python {version} to {inst_dir}")
@@ -248,16 +261,18 @@ def pyenv_install(cfg):
             # pyenv is by far the most robust way to install a
             # version of Python.
             if not exists("{pyenv.path}"):
-                sh(f"git clone {cfg.python.pyenv.url} {cfg.python.pyenv.path}")
+                sh("git", "clone", cfg.python.pyenv.url, cfg.python.pyenv.path)
             else:
                 with cd(cfg.python.pyenv.path):
-                    sh("git pull")
+                    sh("git", "pull")
             # we should set
             setenv(PYTHON_BUILD_CACHE_PATH=mkdir(cfg.python.pyenv.cache))
             setenv(PYTHON_CFLAGS="-DOPENSSL_NO_COMP")
             try:
                 sh(
-                    f"{cfg.python.pyenv.python_build} {cfg.python.version} {cfg.python.inst_dir}"
+                    cfg.python.pyenv.python_build,
+                    cfg.python.version,
+                    cfg.python.inst_dir,
                 )
             except Abort:
                 error("Failed to build the Python interpreter - removing it")
@@ -265,7 +280,7 @@ def pyenv_install(cfg):
                 raise
 
 
-def nuget_install(cfg):
+def nuget_install(cfg: ConfigTree) -> None:
     """Install the virtual environment using nuget"""
     if not exists(cfg.python.nuget.exe):
         download(cfg.python.nuget.url, cfg.python.nuget.exe)
@@ -283,7 +298,7 @@ def nuget_install(cfg):
         "-source",
         cfg.python.nuget.source,
     )
-    sh(f"{cfg.python.interpreter} -m ensurepip --upgrade")
+    sh(cfg.python.interpreter, "-m", "ensurepip", "--upgrade")
     sh(
         cfg.python.interpreter,
         "-mpip",
@@ -314,7 +329,7 @@ def provision(cfg: ConfigTree) -> None:
     cfg.python.site_packages = get_site_packages(interpreter=cfg.python.python)
 
 
-def configure(cfg):
+def configure(cfg: ConfigTree) -> None:
     """Configure the python plugin"""
     if not cfg.python.version and not cfg.python.use:
         die(
@@ -348,7 +363,7 @@ def configure(cfg):
         _check_aws_token_validity(cfg)
 
 
-def init(cfg):
+def init(cfg: ConfigTree) -> None:
     """Initialize the python plugin"""
     if not cfg.python.use:
         logging.debug("Checking for %s", cfg.python.interpreter)
@@ -365,7 +380,7 @@ def init(cfg):
 ACTIVATED = False
 
 
-def venv_init(cfg):
+def venv_init(cfg: ConfigTree) -> None:
     """Activate the virtual environment"""
     global ACTIVATED  # pylint: disable=global-statement
     if os.environ.get("VIRTUAL_ENV", "") != cfg.python.venv and not ACTIVATED:
@@ -386,7 +401,38 @@ def venv_init(cfg):
         ACTIVATED = True
 
 
-def patch_activate(schema):
+class ActivateScriptPatcher(abc.ABC):
+    activatescript: Union[str, Path]
+    setpattern: str
+    resetpattern: str
+    old_env_pattern: str
+    patchmarker: str
+    replacements: list[tuple[str, str]]
+    script: str
+
+    @staticmethod
+    @abc.abstractmethod
+    def interpolate_environ_value(value: str) -> str:
+        """
+        Translate value so the script can handle uninterpolated "{ENVVAR}" literals in value
+
+        Example:
+        # Assume the following subset of os.environ
+        os.environ = {
+            "PATH": "/bin:/usr/bin",
+            "COMPILER_PATHS": "/compiler/A/bin:/compiler/B/bin",
+        }
+
+        # Now, setenv has been called with
+        # setenv(PATH="{python.scriptdir}:{COMPILER_PATHS}:{PATH}") thus the
+        # value of ``PATH`` in ``EXPORTS`` equals "/venv/bin:{COMPILER_PATHS}:{PATH}" as
+        # ``COMPILER_PATHS`` and ``PATH`` haven't been interpolated yet.
+        interpolate_environ_value(value) => /venv/bin:/compiler/A/bin:/compiler/B/bin:/bin:/usr/bin
+        """
+        return value
+
+
+def patch_activate(schema: Type[ActivateScriptPatcher]) -> None:
     """Patch the activate script"""
     if exists(schema.activatescript):
         setters = []
@@ -397,9 +443,9 @@ def patch_activate(schema):
             setters.append(schema.setpattern.format(name=name, value=value))
             resetters.add(schema.resetpattern.format(name=name))
             old_value_setters.add(schema.old_env_pattern.format(name=name))
-        resetters = "\n".join(resetters)
-        setters = "\n".join(setters)
-        old_value_setters = "\n".join(old_value_setters)
+        resetters_string = "\n".join(resetters)
+        setters_string = "\n".join(setters)
+        old_value_setters_string = "\n".join(old_value_setters)
         original = readtext(schema.activatescript)
         if schema.patchmarker not in original:
             shutil.copyfile(
@@ -418,36 +464,13 @@ def patch_activate(schema):
         newscript = schema.script.format(
             patchmarker=schema.patchmarker,
             original=original,
-            resetters=resetters,
-            old_value_setters=old_value_setters,
-            setters=setters,
+            resetters=resetters_string,
+            old_value_setters=old_value_setters_string,
+            setters=setters_string,
         )
         writetext(f"{schema.activatescript}", newscript)
 
 
-class ActivateScriptPatcher(abc.ABC):
-    @staticmethod
-    @abc.abstractmethod
-    def interpolate_environ_value(value):
-        """
-        Translate value so the script can handle uninterpolated "{ENVVAR}" literals in value
-
-        Example:
-        # Assume the following subset of os.environ
-        os.environ = {
-            "PATH": "/bin:/usr/bin",
-            "COMPILER_PATHS": "/compiler/A/bin:/compiler/B/bin",
-        }
-
-        # Now, setenv has been called with
-        # setenv(PATH="{python.scriptdir}:{COMPILER_PATHS}:{PATH}") thus the
-        # value of ``PATH`` in ``EXPORTS`` equals "/venv/bin:{COMPILER_PATHS}:{PATH}" as
-        # ``COMPILER_PATHS`` and ``PATH`` haven't been interpolated yet.
-        interpolate_environ_value(value) => /venv/bin:/compiler/A/bin:/compiler/B/bin:/bin:/usr/bin
-        """
-        return value
-
-
 class BashActivate(ActivateScriptPatcher):
     patchmarker = "\n## Patched by csspin_python.python\n"
     activatescript = Path("{python.scriptdir}") / "activate"
@@ -510,7 +533,7 @@ class BashActivate(ActivateScriptPatcher):
     )
 
     @staticmethod
-    def interpolate_environ_value(value):
+    def interpolate_environ_value(value: str) -> str:
         if not value:
             return ""
         keys = re.findall(r"{(?P<key>\w+?)}", value)
@@ -564,7 +587,7 @@ class PowershellActivate(ActivateScriptPatcher):
     )
 
     @staticmethod
-    def interpolate_environ_value(value):
+    def interpolate_environ_value(value: str) -> str:
         if not value:
             return ""
         keys = re.findall(r"{(?P<key>\w+?)}", value)
@@ -577,7 +600,7 @@ class PowershellActivate(ActivateScriptPatcher):
 class BatchActivate(ActivateScriptPatcher):
     patchmarker = "\nREM Patched by csspin_python.python\n"
     activatescript = Path("{python.scriptdir}") / "activate.bat"
-    replacements = ()
+    replacements = []
     old_env_pattern = dedent(
         """
         if defined _OLD_SPIN_VALUE_{name} goto ENDIFSPIN{name}1
@@ -614,7 +637,7 @@ class BatchActivate(ActivateScriptPatcher):
     )
 
     @staticmethod
-    def interpolate_environ_value(value):
+    def interpolate_environ_value(value: str) -> str:
         if not value:
             return ""
         keys = re.findall(r"{(?P<key>\w+?)}", value)
@@ -627,7 +650,7 @@ class BatchActivate(ActivateScriptPatcher):
 class BatchDeactivate(ActivateScriptPatcher):
     patchmarker = "\nREM Patched by csspin_python.python\n"
     activatescript = Path("{python.scriptdir}") / "deactivate.bat"
-    replacements = ()
+    replacements = []
     old_env_pattern = ""
     setpattern = ""
     resetpattern = dedent(
@@ -658,7 +681,7 @@ class BatchDeactivate(ActivateScriptPatcher):
 class PythonActivate(ActivateScriptPatcher):
     patchmarker = "# Patched by csspin_python.python\n"
     activatescript = Path("{python.scriptdir}") / "activate_this.py"
-    replacements = ()
+    replacements = []
     old_env_pattern = ""
     setpattern = 'os.environ["{name}"] = fr"{value}"'
     resetpattern = ""
@@ -671,7 +694,7 @@ class PythonActivate(ActivateScriptPatcher):
     )
 
     @staticmethod
-    def interpolate_environ_value(value):
+    def interpolate_environ_value(value: str) -> str:
         if not value:
             return ""
         keys = re.findall(r"{(?P<key>\w+?)}", value)
@@ -681,7 +704,7 @@ class PythonActivate(ActivateScriptPatcher):
         return value
 
 
-def get_site_packages(interpreter):
+def get_site_packages(interpreter: Path) -> Path:
     """Return the path to the virtual environments site-packages."""
     return Path(
         check_output(
@@ -696,7 +719,7 @@ def get_site_packages(interpreter):
     )
 
 
-def finalize_provision(cfg):
+def finalize_provision(cfg: ConfigTree) -> None:
     """Patching the activate scripts and preparing the site-packages"""
     cfg.python.provisioner.install(cfg)
 
@@ -732,8 +755,11 @@ class ProvisionerProtocol:
     The provisioner will be memoized, so make sure it works with ``pickle.dumps``.
     """
 
+    requirements: set[str]
+    devpackages: set[str]
+
     # noinspection PyMethodMayBeStatic
-    def provision_python(self, cfg: ConfigTree) -> None:
+    def provision_python(self: Self, cfg: ConfigTree) -> None:
         """Provision the project's python interpreter"""
         if sys.platform == "win32":
             nuget_install(cfg)
@@ -742,7 +768,7 @@ class ProvisionerProtocol:
             pyenv_install(cfg)
 
     # noinspection PyMethodMayBeStatic
-    def provision_venv(self, cfg: ConfigTree) -> None:
+    def provision_venv(self: Self, cfg: ConfigTree) -> None:
         """Provision the virtual environment of the project"""
         # virtualenv is guaranteed to be available like this
         # as we declared it as one of spin's dependencies
@@ -761,26 +787,26 @@ class ProvisionerProtocol:
             env={"PYTHONPATH": cfg.spin.spin_dir / "plugins"},
         )
 
-    def prerequisites(self, cfg: ConfigTree) -> None:
+    def prerequisites(self: Self, cfg: ConfigTree) -> None:
         """Provide requirements for the provisioning strategy."""
 
-    def lock(self, cfg: ConfigTree) -> None:
+    def lock(self: Self, cfg: ConfigTree) -> None:
         """Lock the project's dependencies."""
 
-    def add(self, cfg: ConfigTree, req: str, devpackage: bool = False) -> None:
+    def add(self: Self, cfg: ConfigTree, req: str, devpackage: bool = False) -> None:
         """Add an extra dependency (incl. development ones)."""
 
-    def lock_extras(self, cfg: ConfigTree) -> None:
+    def lock_extras(self: Self, cfg: ConfigTree) -> None:
         """Lock the extra dependencies."""
 
-    def sync(self, cfg: ConfigTree) -> None:
+    def sync(self: Self, cfg: ConfigTree) -> None:
         """Synchronize the environment with the locked dependencies."""
 
-    def install(self, cfg: ConfigTree) -> None:
+    def install(self: Self, cfg: ConfigTree) -> None:
         """Install the project itself."""
 
     # noinspection PyMethodMayBeStatic
-    def cleanup(self, cfg: ConfigTree) -> None:
+    def cleanup(self: Self, cfg: ConfigTree) -> None:
         """Cleanup the provisioned environment"""
         rmtree(cfg.python.venv)
 
@@ -792,12 +818,12 @@ class SimpleProvisioner(ProvisionerProtocol):
     longer required.
     """
 
-    def __init__(self):
+    def __init__(self: Self) -> None:
         self.requirements = set()
         self.devpackages = set()
         self.m = Memoizer("{python.memo}")
 
-    def prerequisites(self, cfg):
+    def prerequisites(self: Self, cfg: ConfigTree) -> None:
         # We'll need pip
         sh(
             "python",
@@ -811,23 +837,23 @@ class SimpleProvisioner(ProvisionerProtocol):
             "pip",
         )
 
-    def lock(self, cfg):
+    def lock(self: Self, cfg: ConfigTree) -> None:
         """Noop"""
 
-    def add(self, cfg, req, devpackage=False):
+    def add(self: Self, cfg: ConfigTree, req: str, devpackage: bool = False) -> None:
         # Add the requirement or devpackage if not already there.
         if not self.m.check(req):
             lst = self.devpackages if devpackage else self.requirements
             lst.add(req)
 
-    def sync(self, cfg):
+    def sync(self: Self, cfg: ConfigTree) -> None:
         self.__execute_installation(
             self.requirements,
             None if cfg.verbosity > Verbosity.NORMAL else "-q",
             cfg.python.index_url,
         )
 
-    def install(self, cfg):
+    def install(self: Self, cfg: ConfigTree) -> None:
         quietflag = None if cfg.verbosity > Verbosity.NORMAL else "-q"
         self.__execute_installation(self.devpackages, quietflag, cfg.python.index_url)
 
@@ -862,14 +888,16 @@ class SimpleProvisioner(ProvisionerProtocol):
         if pip_check.returncode:
             die(pip_check.stdout)
 
-    def _split(self, reqset):
+    def _split(self: Self, reqset: set[str]) -> list[str]:
         """to pass whitespace-less args to sh()"""
         reqlist = []
         for req in reqset:
             reqlist.extend(req.split())
         return reqlist
 
-    def __execute_installation(self, packages, quietflag, index_url):
+    def __execute_installation(
+        self: Self, packages: set[str], quietflag: Union[str, None], index_url: str
+    ) -> None:
         """Install packages that are not yet memoized"""
         if to_install := {package for package in packages if not self.m.check(package)}:
             sh(
@@ -886,7 +914,9 @@ class SimpleProvisioner(ProvisionerProtocol):
             self.m.save()
 
 
-def venv_provision(cfg):  # pylint: disable=too-many-branches,missing-function-docstring
+def venv_provision(  # pylint: disable=too-many-branches,missing-function-docstring
+    cfg: ConfigTree,
+) -> None:
     fresh_env = False
 
     info("Checking venv '{python.venv}'")
@@ -961,7 +991,7 @@ def cleanup(cfg: ConfigTree) -> None:
                 rmtree(current_path / filename)
 
 
-def _get_pipconf(cfg):
+def _get_pipconf(cfg: ConfigTree) -> Path:
     """Retrieve the pipconf configuration file path."""
     if sys.platform == "win32":
         pipconf = interpolate1(Path(cfg.python.venv)) / "pip.ini"
@@ -971,7 +1001,7 @@ def _get_pipconf(cfg):
     return pipconf
 
 
-def _configure_pipconf(cfg, update=False):
+def _configure_pipconf(cfg: ConfigTree, update: bool = False) -> None:
     """Configure the pip configuration file"""
     config_parser = configparser.ConfigParser()
     config_parser.read_string(cfg.python.pipconf)
@@ -985,7 +1015,7 @@ def _configure_pipconf(cfg, update=False):
         config_parser.write(fd)
 
 
-def _obfuscate_index_url(index_url):
+def _obfuscate_index_url(index_url: str) -> None:
     """Add the CodeArtifact token to the secrets."""
 
     from csspin import secrets
@@ -993,7 +1023,7 @@ def _obfuscate_index_url(index_url):
     secrets.add(index_url.split(":")[2].split("@")[0])  # Codeartifact token
 
 
-def _check_aws_token_validity(cfg):
+def _check_aws_token_validity(cfg: ConfigTree) -> None:
     """
     If csspin-python[aws_auth] is installed, we can use csaccess to get the
     CodeArtifact authentication token.

csspin_python/radon.py

@@ -18,8 +18,10 @@
 """Module implementing the radon plugin for spin"""
 
 import logging
+from typing import Iterable
 
 from csspin import config, info, option, sh, task
+from csspin.tree import ConfigTree
 
 defaults = config(
     exe="radon",
@@ -36,20 +38,20 @@ defaults = config(
 
 @task()
 def radon(
-    cfg,
-    allsource: option(
+    cfg: ConfigTree,
+    allsource: option(  # type: ignore[valid-type]
         "--all",  # noqa: F821
         "allsource",  # noqa: F821
         is_flag=True,
         help="Run for all src- and test-files.",  # noqa: F722,F821
     ),
-    args,
-):
+    args: Iterable[str],
+) -> None:
     """Run radon to measure code complexity."""
     if allsource:
-        files = ("{spin.project_root}/src", "{spin.project_root}/tests")
+        files = ["{spin.project_root}/src", "{spin.project_root}/tests"]
     else:
-        files = args
+        files = list(args)
         if not files and hasattr(cfg, "vcs") and hasattr(cfg.vcs, "modified"):
             info("Found modified files.")
             files = cfg.vcs.modified

{csspin_python-2.1.0.dist-info → csspin_python-2.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: csspin-python
-Version: 2.1.0
+Version: 2.1.1
 Summary: Plugin-package for csspin providing Python related plugins
 Author-email: CONTACT Software GmbH <info@contact-software.com>
 Maintainer-email: Waleri Enns <waleri.enns@contact-software.com>, Benjamin Thomas Schwertfeger <benjaminthomas.schwertfeger@contact-software.com>, Fabian Hafer <fabian.hafer@contact-software.com>
@@ -20,6 +20,7 @@ Classifier: Topic :: Software Development
 Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: platformdirs~=4.3.8
 Requires-Dist: virtualenv
 Provides-Extra: aws-auth
 Requires-Dist: csaccess>=0.1.0; extra == "aws-auth"

csspin_python-2.1.1.dist-info/RECORD

@@ -0,0 +1,19 @@
+csspin_python/behave.py,sha256=iJZeyIqB7V_NzTdLTZldNY9W_GGwCWkXe6WY69wpDqs,4997
+csspin_python/behave_schema.yaml,sha256=8qoOCK-uTmwgRRW29urgK0X_kgn0zO0X34v89bvii2w,1241
+csspin_python/debugpy.py,sha256=v0ZZopv5TNoSaFf2kiePsw9OmhBpjfOBFh0u71jTcnQ,962
+csspin_python/debugpy_schema.yaml,sha256=BeH30nSirDYctkdhS9xMXUG5htj3PED_ZjmxPG5WRUc,364
+csspin_python/devpi.py,sha256=C-5O_vA06CwQR4uElOw-2VH2-m001SpxowM_X6RbRwo,2352
+csspin_python/devpi_schema.yaml,sha256=2gPATWjVcfvCTrGZX2FK6wH8hh9KS0XzZ35JvZeJGEU,487
+csspin_python/playwright.py,sha256=mzSsLcmewDZnZwdSyp5HytEMnXgkoJ9s1XXkd05eOwU,4254
+csspin_python/playwright_schema.yaml,sha256=WFMok7dB7G6L8f8y_2_RKHjGe4ww1iUUS4tqCoUI1FE,1054
+csspin_python/pytest.py,sha256=Mx6l4Cb28FjdZgL9Vd1zBbhcnYyc4QsqwkozksoKZJc,3189
+csspin_python/pytest_schema.yaml,sha256=1bF8hNsJfV-LHUwGBBJ3GnQOZJiIQkG81DCBma2MalU,809
+csspin_python/python.py,sha256=AbIX3r07c4tVAj0jIfjiRi7Vk9XFiap6AvS4xCYee48,34461
+csspin_python/python_schema.yaml,sha256=F_PMK8D3KBvXK945b6-oRDoaxuDgxkBGqVPAJ-eFmv0,5970
+csspin_python/radon.py,sha256=uFqm6FEi5oWj-_XVaAm3s9cam0cUmr1_FwRf40K6xWs,1876
+csspin_python/radon_schema.yaml,sha256=rlRzXw5z4XbjOVznRiUxWGP4E9hx1Jm-gGw1iQiYzE0,548
+csspin_python-2.1.1.dist-info/licenses/LICENSE,sha256=4MAecetnRTQw5DlHtiikDSzKWO1xVLwzM5_DsPMYlnE,10172
+csspin_python-2.1.1.dist-info/METADATA,sha256=pIuulk5YG9JUQqORop0oV4GoX0DdHZoOOGktz8YkhYA,4209
+csspin_python-2.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+csspin_python-2.1.1.dist-info/top_level.txt,sha256=QSeglMEGbFu1z4L6MCQYwo01NgL0KojWvC4rzgMQ8gU,14
+csspin_python-2.1.1.dist-info/RECORD,,

csspin_python-2.1.0.dist-info/RECORD

@@ -1,19 +0,0 @@
-csspin_python/behave.py,sha256=iA5t-vwMDhmWoo-FHaeZ6JyIzj6k4r2WLyYa2AjXyp4,4815
-csspin_python/behave_schema.yaml,sha256=8qoOCK-uTmwgRRW29urgK0X_kgn0zO0X34v89bvii2w,1241
-csspin_python/debugpy.py,sha256=v0ZZopv5TNoSaFf2kiePsw9OmhBpjfOBFh0u71jTcnQ,962
-csspin_python/debugpy_schema.yaml,sha256=BeH30nSirDYctkdhS9xMXUG5htj3PED_ZjmxPG5WRUc,364
-csspin_python/devpi.py,sha256=2NhGYzq4aVzDa_d80uItUlYM9cA0uRFQ4rvnCryxL2k,2213
-csspin_python/devpi_schema.yaml,sha256=2gPATWjVcfvCTrGZX2FK6wH8hh9KS0XzZ35JvZeJGEU,487
-csspin_python/playwright.py,sha256=nYuPjuTfGx_6QPYsUpr-eAZARyXX_hZF8D4AxeI2u1s,4003
-csspin_python/playwright_schema.yaml,sha256=WFMok7dB7G6L8f8y_2_RKHjGe4ww1iUUS4tqCoUI1FE,1054
-csspin_python/pytest.py,sha256=EwxPynyPWS72NTtIah1jUGVa7fJYY8I2_NQz0y0U7Os,2978
-csspin_python/pytest_schema.yaml,sha256=1bF8hNsJfV-LHUwGBBJ3GnQOZJiIQkG81DCBma2MalU,809
-csspin_python/python.py,sha256=du1sFA6Uh8Wp5V6sN3_iSsQNEz-OZBAJG-FdgCyvsjM,33114
-csspin_python/python_schema.yaml,sha256=F_PMK8D3KBvXK945b6-oRDoaxuDgxkBGqVPAJ-eFmv0,5970
-csspin_python/radon.py,sha256=OSV0vTz7SMMHC82jUvWsBq6vtWolOjdiZ2bBdxplVJ4,1744
-csspin_python/radon_schema.yaml,sha256=rlRzXw5z4XbjOVznRiUxWGP4E9hx1Jm-gGw1iQiYzE0,548
-csspin_python-2.1.0.dist-info/licenses/LICENSE,sha256=4MAecetnRTQw5DlHtiikDSzKWO1xVLwzM5_DsPMYlnE,10172
-csspin_python-2.1.0.dist-info/METADATA,sha256=-cWwMdEo8x0I1_vcEAjiCO5DC79Y-ymGXro6Qig7Q4s,4174
-csspin_python-2.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-csspin_python-2.1.0.dist-info/top_level.txt,sha256=QSeglMEGbFu1z4L6MCQYwo01NgL0KojWvC4rzgMQ8gU,14
-csspin_python-2.1.0.dist-info/RECORD,,