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

csspin_python/playwright.py

@@ -19,7 +19,7 @@
 
 from typing import Iterable
 
-from csspin import Path, Verbosity, config, die, option, setenv, sh, task
+from csspin import Path, Verbosity, config, die, option, setenv, sh, task, warn
 from csspin.tree import ConfigTree
 
 defaults = config(
@@ -77,6 +77,16 @@ def playwright(  # pylint: disable=too-many-arguments,too-many-positional-argume
     args: Iterable[str],
 ) -> None:
     """Run the playwright tests with pytest."""
+    if cfg.pytest.playwright.enabled:
+        # This prevents the playwright tests from being run twice.
+        warn(
+            (
+                "The 'playwright' task has been skipped, as the playwright tests"
+                " are already being run by the csspin_python.pytest plugin."
+                " Please stop using the csspin_python.playwright plugin."
+            )
+        )
+        return
     setenv(
         PLAYWRIGHT_BROWSERS_PATH=cfg.playwright.browsers_path,
         PACKAGE_NAME=cfg.spin.project_name,
@@ -124,6 +134,17 @@ def _download_playwright_browsers(cfg: ConfigTree) -> None:
     )
 
 
-def provision(cfg: ConfigTree) -> None:
+def finalize_provision(cfg: ConfigTree) -> None:
     """Install playwright browsers during provisioning"""
     _download_playwright_browsers(cfg)
+
+
+def init(cfg: ConfigTree) -> None:  # pylint: disable=unused-argument
+    """Show deprecation notice in every spin call"""
+    warn(
+        (
+            "The csspin_python.playwright plugin will be removed with the next major release."
+            " Please use csspin_python.pytest with the 'pytest.playwright.enabled=True' setting"
+            " instead and stop using the csspin_python.playwright plugin."
+        )
+    )

csspin_python/playwright_schema.yaml

@@ -5,7 +5,9 @@
 playwright:
     type: object
     help: |
-        The pytest plugin provides the full pytest experience for spin.
+        The pytest plugin provides the full pytest experience for spin. This
+        plugin is deprecated, use the pytest plugin with the
+        'pytest.playwright.enabled=true' setting instead.
     properties:
         browsers_path:
             type: path

csspin_python/pytest.py

@@ -20,7 +20,7 @@
 
 from typing import Iterable
 
-from csspin import Path, Verbosity, config, die, option, setenv, sh, task
+from csspin import Path, Verbosity, config, die, interpolate1, option, setenv, sh, task
 from csspin.tree import ConfigTree
 
 defaults = config(
@@ -36,6 +36,11 @@ defaults = config(
     opts=[],
     tests=["cs", "tests"],  # Strong convention @CONTACT
     test_report="pytest.xml",
+    playwright=config(
+        enabled=False,
+        browsers_path="{spin.data}/playwright_browsers",
+        browsers=["chromium"],
+    ),
     requires=config(
         spin=[
             "csspin_python.debugpy",
@@ -50,6 +55,24 @@ defaults = config(
 )
 
 
+def _install_playwright_browsers(cfg: ConfigTree) -> None:
+    """Let playwright install the browsers"""
+    sh(
+        f"playwright install {' '.join(cfg.pytest.playwright.browsers)}",
+        env={"PLAYWRIGHT_BROWSERS_PATH": cfg.pytest.playwright.browsers_path},
+    )
+
+
+def configure(cfg: ConfigTree) -> None:
+    if interpolate1(cfg.pytest.playwright.enabled).lower() == "true":
+        cfg.pytest.requires.python.extend(["pytest-base-url", "pytest-playwright"])
+
+
+def provision(cfg: ConfigTree) -> None:
+    if cfg.pytest.playwright.enabled:
+        _install_playwright_browsers(cfg)
+
+
 @task(when="test")
 def pytest(  # pylint: disable=too-many-arguments,too-many-positional-arguments
     cfg: ConfigTree,
@@ -88,6 +111,20 @@ def pytest(  # pylint: disable=too-many-arguments,too-many-positional-arguments
     else:
         cmd = ["pytest"]
 
+    if cfg.pytest.playwright.enabled:
+        setenv(
+            PLAYWRIGHT_BROWSERS_PATH=cfg.pytest.playwright.browsers_path,
+            PACKAGE_NAME=cfg.spin.project_name,
+        )
+        for browser in cfg.pytest.playwright.browsers:
+            opts.extend(["--browser", browser])
+        # Run the browser download again, so that changes for
+        # cfg.pytest.playwright.browsers don't require a new provision call. If the
+        # browsers are already present it's more or less a noop.
+        _install_playwright_browsers(cfg)
+        if coverage or cfg.pytest.coverage:
+            setenv(PLAYWRIGHT_COVERAGE=1)
+
     if cfg.loaded.get("csspin_ce.mkinstance"):
         if not (
             inst := Path(instance or cfg.mkinstance.base.instance_location).absolute()

csspin_python/pytest_schema.yaml

@@ -25,3 +25,22 @@ pytest:
         tests:
             type: list
             help: List of test files or directories to include.
+        playwright:
+            type: object
+            help: |
+                Settings necessary to also run playwright tests with the pytest
+                plugin.
+            properties:
+                enabled:
+                    type: bool
+                    help: |
+                        Should the pytest-playwright plugin be installed and
+                        initialized.
+                browsers_path:
+                    type: path
+                    help: Path for playwright to install the browsers.
+                browsers:
+                    type: list
+                    help: |
+                        The browsers to install and to use for running the
+                        playwright tests.

csspin_python/python.py

@@ -68,6 +68,7 @@ point to the base installation.
 
 import abc
 import configparser
+import hashlib
 import logging
 import os
 import re
@@ -152,10 +153,6 @@ defaults = config(
     python="{python.scriptdir}/python{platform.exe}",
     provisioner=None,
     provisioner_memo="{spin.spin_dir}/python_provisioner.memo",
-    current_package=config(
-        install=True,
-        extras=[],
-    ),
     aws_auth=config(
         enabled=False,
         memo="{spin.spin_dir}/aws_auth.memo",
@@ -315,13 +312,11 @@ def provision(cfg: ConfigTree) -> None:
     """Provision the python plugin"""
     with memoizer(cfg.python.provisioner_memo) as memo:
         if cfg.python.provisioner is None:
-            cfg.python.provisioner = SimpleProvisioner()
+            cfg.python.provisioner = SimpleProvisioner(cfg)
         if not memo.check(cfg.python.provisioner):
             memo.add(cfg.python.provisioner)
 
-    info("Checking {python.interpreter}")
     if not shutil.which(cfg.python.interpreter):
-        info("Provisioning '{python.interpreter}'")
         cfg.python.provisioner.provision_python(cfg)
 
     venv_provision(cfg)
@@ -746,7 +741,7 @@ def finalize_provision(cfg: ConfigTree) -> None:
 
 class ProvisionerProtocol:
     """An implementation of this protocol is used to provision
-    dependencies to a virtual environment.
+    requirements to a virtual environment.
 
     Separate plugins, can implement this interface and overwrite
     cfg.python.provisioner.
@@ -755,10 +750,8 @@ class ProvisionerProtocol:
     The provisioner will be memoized, so make sure it works with ``pickle.dumps``.
     """
 
-    requirements: set[str]
-    devpackages: set[str]
+    _requirements: set[str] = set()
 
-    # noinspection PyMethodMayBeStatic
     def provision_python(self: Self, cfg: ConfigTree) -> None:
         """Provision the project's python interpreter"""
         if sys.platform == "win32":
@@ -770,8 +763,6 @@ class ProvisionerProtocol:
     # noinspection PyMethodMayBeStatic
     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
         cmd = [
             sys.executable,
             "-mvirtualenv",
@@ -790,38 +781,39 @@ class ProvisionerProtocol:
     def prerequisites(self: Self, cfg: ConfigTree) -> None:
         """Provide requirements for the provisioning strategy."""
 
-    def lock(self: Self, cfg: ConfigTree) -> None:
-        """Lock the project's dependencies."""
-
-    def add(self: Self, cfg: ConfigTree, req: str, devpackage: bool = False) -> None:
-        """Add an extra dependency (incl. development ones)."""
-
-    def lock_extras(self: Self, cfg: ConfigTree) -> None:
-        """Lock the extra dependencies."""
-
-    def sync(self: Self, cfg: ConfigTree) -> None:
-        """Synchronize the environment with the locked dependencies."""
+    def add(
+        self: Self, cfg: ConfigTree, req: str  # pylint: disable=unused-argument
+    ) -> None:
+        """
+        Add a single requirement `req`, that will be installed into the
+        environment.
+        """
+        self._requirements.add(req)
 
     def install(self: Self, cfg: ConfigTree) -> None:
-        """Install the project itself."""
+        """Install the requirements"""
 
-    # noinspection PyMethodMayBeStatic
     def cleanup(self: Self, cfg: ConfigTree) -> None:
         """Cleanup the provisioned environment"""
         rmtree(cfg.python.venv)
 
 
 class SimpleProvisioner(ProvisionerProtocol):
-    """The simplest Python dependency provisioner using pip.
+    """
+    The simplest Python provisioner, using pip.
 
-    This provisioner will never uninstall dependencies that are no
-    longer required.
+    This provisioner will never uninstall requirements that are no longer
+    required.
     """
 
-    def __init__(self: Self) -> None:
-        self.requirements = set()
-        self.devpackages = set()
-        self.m = Memoizer("{python.memo}")
+    def __init__(self: Self, cfg: ConfigTree) -> None:
+        self._m = Memoizer(interpolate1("{python.memo}"))
+        self._install_command = Command(
+            "pip",
+            None if cfg.verbosity > Verbosity.NORMAL else "-q",
+            "--disable-pip-version-check",
+            "install",
+        )
 
     def prerequisites(self: Self, cfg: ConfigTree) -> None:
         # We'll need pip
@@ -837,81 +829,92 @@ class SimpleProvisioner(ProvisionerProtocol):
             "pip",
         )
 
-    def lock(self: Self, cfg: ConfigTree) -> None:
-        """Noop"""
+    def install(self: Self, cfg: ConfigTree) -> None:
+        if requirements := self._filter(
+            self._requirements, self._m, cfg.spin.project_root
+        ):
+            self._install_command(*self._split(requirements))
+            self._m.clear()
+            for req in requirements:
+                self._m.add(_req_for_memo(req, cfg.spin.project_root))
 
-    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)
+    @staticmethod
+    def _split(requirements: Iterable[str]) -> list[str]:
+        """Used to pass whitespace-less args to :func:`csspin.sh()`."""
+        requirement_list = []
+        for requirement in requirements:
+            requirement_list.extend(requirement.split())
+        return requirement_list
 
-    def sync(self: Self, cfg: ConfigTree) -> None:
-        self.__execute_installation(
-            self.requirements,
-            None if cfg.verbosity > Verbosity.NORMAL else "-q",
-            cfg.python.index_url,
-        )
+    @staticmethod
+    def _filter(
+        requirements: set[str], memo: Memoizer, project_root: Union[Path, str]
+    ) -> set[str]:
+        """
+        We want to filter all requirements prior to installing them, because we
+        only want to run the install, when there are changes, as it takes pip
+        quite some time to check, whether it has to do something.
+        """
+        if all(memo.check(_req_for_memo(req, project_root)) for req in requirements):
+            return set()
+        else:
+            return requirements
 
-    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)
 
-        # If there is a setup.py, make an editable install (which
-        # transitively also installs runtime dependencies of the project).
-        if cfg.python.current_package.install and any(
-            (exists("setup.py"), exists("setup.cfg"), exists("pyproject.toml"))
-        ):
-            cmd = [
-                "pip",
-                quietflag,
-                "--disable-pip-version-check",
-                "install",
-                "--index-url",
-                cfg.python.index_url,
-                "-e",
-            ]
-            if cfg.python.current_package.extras:
-                cmd.append(f".[{','.join(cfg.python.current_package.extras)}]")
-            else:
-                cmd.append(".")
-            sh(*cmd)
+def _file_hash(filename: Union[Path, str]) -> str:
+    """
+    Calculate a sha256 hash of a file's content and return its hexdigest.
+    """
+    with open(filename, mode="br") as fd:
+        return hashlib.sha256(fd.read()).hexdigest()  # nosec: hashlib
+
+
+def _split_requirement_option(req: str, project_root: Path) -> Union[Path, None]:
+    """
+    Takes an element of ``python.requirements`` and checks if it
+    is an argument for pip that contains a filename. If so,
+    the filename will be returned, ``None`` otherwise.
+
+    The following options are respected:
+        - ``-r``/``--requirement``
+        - ``-c``/``--constraint``
+
+    If a file for an option cannot be found, the plugin will
+    :func:`csspin.die()`.
+    """
+    if (
+        req.startswith(option := "-r")
+        or req.startswith(option := "--requirement")
+        or req.startswith(option := "-c")
+        or req.startswith(option := "--constraint")
+    ):
+        # The pattern has to enforce the " "/"=" for the long-options
+        match_many = "+" if option.startswith("--") else "*"
+        pattern = rf"{option}[ =]{match_many}(?P<filename>.*)"
+        match = re.match(pattern, req)
+        if not match:
+            die(f"{req} could not be validated.")
+        else:
+            file = project_root / match.group("filename")
+            if not file.exists():
+                die(f"{file} does not exist.")
+            return file
+    return None
 
-        # Verify dependency compatibility of installed packages
-        pip_check = sh(
-            "pip",
-            "--disable-pip-version-check",
-            "check",
-            check=False,
-            capture_output=True,
-        )
-        if pip_check.returncode:
-            die(pip_check.stdout)
-
-    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: 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(
-                "pip",
-                quietflag,
-                "--disable-pip-version-check",
-                "install",
-                "--index-url",
-                index_url,
-                *self._split(to_install),
-            )
-            for package in to_install:
-                self.m.add(package)
-            self.m.save()
+
+def _req_for_memo(
+    req: str, project_root: Union[Path, str]
+) -> str:  # pylint: disable=inconsistent-return-statements
+    """
+    Return a memoizable representation of a python requirement. In case a
+    requirement is on of the following options, the function returns requirement
+    with a hash of the files' content appended. Otherwise the requirement itself
+    will be returned.
+    """
+    if file := _split_requirement_option(req, project_root):
+        return f"{req}{_file_hash(file)}"
+    else:
+        return req
 
 
 def venv_provision(  # pylint: disable=too-many-branches,missing-function-docstring
@@ -946,16 +949,10 @@ def venv_provision(  # pylint: disable=too-many-branches,missing-function-docstr
             logging.debug(f"{plugin_module.__name__}.venv_hook()")
             hook(cfg)
 
-    cfg.python.provisioner.lock(cfg)
-
-    # Install packages required by the project ('requirements')
+    # Add packages required by the project ('requirements')
     for req in cfg.python.get("requirements", []):
         cfg.python.provisioner.add(cfg, interpolate1(req))
 
-    # Install development packages required by the project ('devpackages')
-    for pkgspec in cfg.python.get("devpackages", []):
-        cfg.python.provisioner.add(cfg, interpolate1(pkgspec), True)
-
     # Install packages required by plugins used
     # ('<plugin>.requires.python')
     for plugin in cfg.spin.topo_plugins:
@@ -963,9 +960,6 @@ def venv_provision(  # pylint: disable=too-many-branches,missing-function-docstr
         for req in get_requires(plugin_module.defaults, "python"):
             cfg.python.provisioner.add(cfg, interpolate1(req))
 
-    cfg.python.provisioner.lock_extras(cfg)
-    cfg.python.provisioner.sync(cfg)
-
 
 def cleanup(cfg: ConfigTree) -> None:
     """Remove directories and files generated by the python plugin."""
@@ -1046,7 +1040,9 @@ def _check_aws_token_validity(cfg: ConfigTree) -> None:
         for item in memo.items():
             if isinstance(item, str) and item.startswith(f"{timestamp_key}:"):
                 last_time = int(item.split(":", 1)[1])
-                if current_time - last_time < cfg.python.aws_auth.key_duration:
+                if current_time - last_time < int(
+                    interpolate1(cfg.python.aws_auth.key_duration)
+                ):
                     pipconf = _get_pipconf(cfg)
                     config_parser = configparser.ConfigParser()
                     config_parser.read(pipconf)
@@ -1064,12 +1060,18 @@ def _check_aws_token_validity(cfg: ConfigTree) -> None:
             info("Updating Codeartifact token.")
             from urllib.parse import urljoin
 
+            opts = {
+                "static_oidc": interpolate1(cfg.python.aws_auth.static_oidc).lower()
+                == "true"
+            }
+            if cfg.python.aws_auth.client_id:
+                opts["client_id"] = interpolate1(cfg.python.aws_auth.client_id)
+            if cfg.python.aws_auth.role_arn:
+                opts["aws_role_arn"] = interpolate1(cfg.python.aws_auth.role_arn)
+
+            index_base_url = get_ca_pypi_url_programmatic(**opts)
             index_url = urljoin(
-                get_ca_pypi_url_programmatic(
-                    static_oidc=cfg.python.aws_auth.static_oidc
-                )
-                + "/",
-                cfg.python.aws_auth.index,
+                index_base_url + "/", interpolate1(cfg.python.aws_auth.index)
             )
             cfg.python.index_url = index_url
             _obfuscate_index_url(index_url)

csspin_python/python_schema.yaml

@@ -96,9 +96,6 @@ python:
         site_packages:
             type: path internal
             help: The path to the virtual environments site-packages directory.
-        devpackages:
-            type: list
-            help: A list of packages that will be editable installed
         requirements:
             type: list
             help: |
@@ -106,18 +103,8 @@ python:
                 have to be installed into the project's virtual environment.
                 This excludes requirements stated as 'install_requires' in
                 setup.py/setup.cfg.
-        current_package:
-            type: object
-            help: Install configuration of the current python project
-            properties:
-                install:
-                    type: bool
-                    help: |
-                        Property to determine whether the current package should
-                        get installed or not.
-                extras:
-                    type: list
-                    help: The extras of the current package to install.
+                Note that editable installs with ``-e`` or requirement files
+                with ``-r`` can also be used here.
         index_url:
             type: str
             help: |
@@ -157,3 +144,9 @@ python:
                 index:
                     type: str
                     help: The Codeartifact repository index (e.g. "16.0/simple").
+                client_id:
+                    type: str
+                    help: The OIDC client ID to use.
+                role_arn:
+                    type: str
+                    help: The role ARN to assume when authenticating.

csspin_python/uv_provisioner.py

@@ -0,0 +1,187 @@
+# -*- mode: python; coding: utf-8 -*-
+#
+# Copyright (C) 2025 CONTACT Software GmbH
+# https://www.contact-software.com/
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Plugin to replace certain things of the csspin_python.python plugin with the
+tool ``uv``. Can only be used if the ``uv`` extra of csspin_python has been
+installed.
+"""
+
+import shutil
+import subprocess
+from typing import Union
+
+try:
+    import tomllib
+except ImportError:
+    # Fallback for spin has been installed with python < 3.11
+    import tomli as tomllib
+
+import tomli_w
+from csspin import Command, Path, Verbosity, config, die, info, interpolate1, setenv
+from csspin.tree import ConfigTree
+
+from csspin_python.python import SimpleProvisioner
+
+defaults = config(
+    enabled=False,
+    uv_python_data="{spin.data}/uv_python",
+    uv_toml_path="{python.venv}/uv.toml",
+    requires=config(
+        spin=[
+            "csspin_python.python",
+        ],
+    ),
+)
+
+
+def venv_hook(cfg: ConfigTree) -> None:
+    """Things to do right after venv creation."""
+    _configure_uv_toml(cfg)
+    setenv(UV_CONFIG_FILE=cfg.uv_provisioner.uv_toml_path)
+
+
+def configure(cfg: ConfigTree) -> None:
+    """Configure the uv_provisioner plugin."""
+    if interpolate1(cfg.uv_provisioner.enabled).lower() == "true":
+        cfg.python.provisioner = SimpleUvProvisioner(cfg)
+        setenv(
+            UV_PYTHON_INSTALL_DIR=interpolate1(cfg.uv_provisioner.uv_python_data),
+        )
+        if cfg.python.use:
+            cfg.python.interpreter = shutil.which(interpolate1(cfg.python.interpreter))
+        else:
+            if interpreter_path := _get_uv_python(cfg, True):
+                cfg.python.interpreter = interpreter_path
+            else:
+                # No uv provisioned python found, set to an empty string to
+                # force provisioning
+                cfg.python.interpreter = ""
+
+        if cfg.python.aws_auth.enabled:
+            # In case we use aws_auth the index-url might have changed
+            _update_index_url_in_toml(cfg)
+
+
+def _get_uv_python(cfg: ConfigTree, ignore_errors: bool = False) -> Union[Path, None]:
+    """Use uv to find its provisioned python interpreter."""
+    # We cannot put this import top-level as "spin cleanup" might not work
+    # otherwise.
+    from uv import find_uv_bin
+
+    cmd = [
+        find_uv_bin(),
+        "python",
+        "find",
+        "--no-project",
+        "--system",
+        "--managed-python",
+        cfg.python.version,
+    ]
+    try:
+        out = subprocess.check_output(
+            cmd, encoding="utf-8", stderr=subprocess.DEVNULL if ignore_errors else None
+        )
+        interpreter = out.strip()
+        return Path(interpreter)
+    except subprocess.CalledProcessError as ex:
+        if not ignore_errors:
+            die(ex)
+    return None
+
+
+class SimpleUvProvisioner(SimpleProvisioner):
+    """
+    Drop-in replacement for the SimpleProvisioner that uses ``uv`` for creating
+    the environment and installing the requirements.
+
+    Especially when installing Python packages, the ``SimpleUvProvisioner`` is
+    much faster than the ``SimpleProvisioner``.
+    """
+
+    def __init__(self, cfg: ConfigTree) -> None:
+        super().__init__(cfg)
+
+        from uv import find_uv_bin
+
+        uv_bin = find_uv_bin()
+
+        if cfg.verbosity == Verbosity.QUIET:
+            verbosity = "-q"
+        elif cfg.verbosity == Verbosity.DEBUG:
+            verbosity = "-v"
+        else:
+            verbosity = None
+
+        self._uv_cmd = Command(
+            uv_bin,
+            verbosity,
+        )
+        self._install_command = Command(
+            *self._uv_cmd._cmd,
+            "pip",
+            "install",
+        )
+
+    def provision_python(self, cfg: ConfigTree) -> None:
+        self._uv_cmd(
+            "python",
+            "install",
+            cfg.python.version,
+            "--no-bin",
+            "--no-registry",
+        )
+        cfg.python.interpreter = _get_uv_python(cfg)
+        info(f"Using '{cfg.python.interpreter}' as interpreter")
+
+    def provision_venv(self, cfg: ConfigTree) -> None:
+        setenv(UV_PROJECT_ENVIRONMENT=cfg.python.venv)
+        self._uv_cmd(
+            "venv",
+            f"--python={cfg.python.interpreter}",
+            cfg.python.venv,
+        )
+
+    def prerequisites(self, cfg: ConfigTree) -> None:
+        self._uv_cmd("pip", "install", "pip")
+
+
+def _configure_uv_toml(cfg: ConfigTree) -> None:
+    """
+    Create a config file for uv, similar to the pip.conf of
+    csspin_python.python, since `uv` pip won't respect the pip.conf.
+    """
+    toml_content = tomllib.loads(cfg.uv_provisioner.uv_toml or "")
+    if "index-url" not in toml_content:
+        toml_content["index-url"] = cfg.python.index_url
+    else:
+        toml_content["index-url"] = toml_content.get("index-url", cfg.python.index_url)
+
+    with open(cfg.uv_provisioner.uv_toml_path, mode="wb") as fd:
+        tomli_w.dump(toml_content, fd)
+
+
+def _update_index_url_in_toml(cfg: ConfigTree) -> None:
+    """
+    Update the index-url in the uv.toml in case it changed.
+    """
+    if (uv_toml_path := interpolate1(cfg.uv_provisioner.uv_toml_path)).exists():
+        with open(uv_toml_path, mode="r+b") as fd:
+            toml_content = tomllib.load(fd)
+            if toml_content.get("index-url") != cfg.python.index_url:
+                toml_content["index-url"] = cfg.python.index_url
+                tomli_w.dump(toml_content, fd)

csspin_python/uv_provisioner_schema.yaml

@@ -0,0 +1,24 @@
+# -*- mode: yaml; coding: utf-8 -*-
+#
+# Schema for the uv_provisioner plugin for spin
+
+uv_provisioner:
+    type: object
+    help: Configuration of the csspin_python.uv plugin
+    properties:
+        enabled:
+            type: bool
+            help: |
+                Used to let the python plugin use the SimpleUvProvisioner to
+                provision the python environment.
+        uv_python_data:
+            type: path
+            help: |
+                The directory where the python interpreters uv provisions are
+                being stored.
+        uv_toml_path:
+            type: path
+            help: Path to uv's config file
+        uv_toml:
+            type: str
+            help: Content for uv's config file

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: csspin-python
-Version: 2.1.1
+Version: 3.0.0
 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>
@@ -24,6 +24,10 @@ Requires-Dist: platformdirs~=4.3.8
 Requires-Dist: virtualenv
 Provides-Extra: aws-auth
 Requires-Dist: csaccess>=0.1.0; extra == "aws-auth"
+Provides-Extra: uv
+Requires-Dist: tomli; python_version < "3.11" and extra == "uv"
+Requires-Dist: tomli-w; extra == "uv"
+Requires-Dist: uv; extra == "uv"
 Dynamic: license-file
 
 |Latest Version| |Python| |License|
@@ -36,16 +40,20 @@ The following plugins are available:
 - `csspin_python.behave`: A plugin for running tests using Behave.
 - `csspin_python.debugpy`: A plugin for debugging Python code using `debugpy`_.
 - `csspin_python.devpi`: A plugin for simplified usage of `devpi`_.
-- `csspin_python.playwright`: A plugin for running tests using `playwright`_.
 - `csspin_python.pytest`: A plugin for running tests using pytest.
 - `csspin_python.python`: A plugin for provisioning Python environments  and
   installing dependencies.
 - `csspin_python.radon`: A plugin for running `radon`_ to analyze code
   complexity.
 - `csspin_python.sphinx`: A plugin for building Sphinx documentation.
+- `csspin_python.playwright`: A plugin for running tests using `playwright`_.
+  This plugin is deprecated, use the pytest plugin with the
+  'pytest.playwright.enabled=true' setting instead.
+- `csspin_python.uv_provisioner`: A plugin that uses `uv`_ to provision the Python environment.
 
-The package provides an ``aws_auth`` extra, that, if enabled, can
-authenticate to `CONTACT Software GmbH`_'s AWS Codeartifact.
+The package provides an ``aws_auth`` extra, that, if enabled, can authenticate
+to `CONTACT Software GmbH`_'s AWS Codeartifact. It also provides an ``uv``
+extra, that is necessary for using the ``csspin_python.uv_provisioner`` plugin.
 
 Prerequisites
 -------------
@@ -108,3 +116,4 @@ tests using ``spin pytest`` and do other great things.
 .. _`devpi`: https://pypi.org/project/devpi
 .. _`playwright`: https://pypi.org/project/pytest-playwright
 .. _`radon`: https://pypi.org/project/radon
+.. _`uv`: https://docs.astral.sh/uv/

csspin_python-3.0.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+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=oFfphLqa4AB6K9vasCUFHN0kFXu63n3ocrsqVuRp4-0,5102
+csspin_python/playwright_schema.yaml,sha256=TSeR16YHa7m7bfO59F2eMV-jXcglluTJdEpUeL16saY,1178
+csspin_python/pytest.py,sha256=fX50f22DYtJNNTBkAt75ki26eM0sZDcRXnwoFsKWV_M,4565
+csspin_python/pytest_schema.yaml,sha256=tzXtdF6MvGC9v59EVRJFfLeMMHqPsXcFXy2zJtRECBI,1535
+csspin_python/python.py,sha256=SRsl7wXkPFxEqwhjDtr-Uq80N_JNRrlD0kPMaE1gfrU,34610
+csspin_python/python_schema.yaml,sha256=s8snEDJ8UdfpORgCgqbKvy0exaXlvy4U1gUwBd-Do94,5739
+csspin_python/radon.py,sha256=uFqm6FEi5oWj-_XVaAm3s9cam0cUmr1_FwRf40K6xWs,1876
+csspin_python/radon_schema.yaml,sha256=rlRzXw5z4XbjOVznRiUxWGP4E9hx1Jm-gGw1iQiYzE0,548
+csspin_python/uv_provisioner.py,sha256=A6Di0ahCrZCO3KhYedry7JCfa5ME6h7vH4ypRBZh5UA,5907
+csspin_python/uv_provisioner_schema.yaml,sha256=Y8ZNC2OMnhR8Us3WUXAXK9hMjqGWAKFJB2puX4X5XNQ,727
+csspin_python-3.0.0.dist-info/licenses/LICENSE,sha256=4MAecetnRTQw5DlHtiikDSzKWO1xVLwzM5_DsPMYlnE,10172
+csspin_python-3.0.0.dist-info/METADATA,sha256=NkiY16n49Q9lFYCu-emb9G1OjQlg3gEm0vW5t3EJwtE,4715
+csspin_python-3.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+csspin_python-3.0.0.dist-info/top_level.txt,sha256=QSeglMEGbFu1z4L6MCQYwo01NgL0KojWvC4rzgMQ8gU,14
+csspin_python-3.0.0.dist-info/RECORD,,

csspin_python-2.1.1.dist-info/RECORD

@@ -1,19 +0,0 @@
-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,,