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

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/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/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.0.dist-info → csspin_python-3.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: csspin-python
-Version: 2.1.0
+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>
@@ -20,9 +20,14 @@ 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"
+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|
@@ -35,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
 -------------
@@ -107,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.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,,