Use uv venv instead of python venv when available

Adds a huge speed boost in creating virtualenv by taking advantage
of uv when it is found as being installed.

Author: ssbarnea

.config/requirements-test.in

@@ -12,3 +12,4 @@ ruff
 toml-sort
 tox
 types-PyYAML
+uv

.pre-commit-config.yaml

@@ -21,8 +21,6 @@ repos:
     rev: v3.1.0
     hooks:
       - id: add-trailing-comma
-        args:
-          - --py36-plus
 
   - repo: https://github.com/Lucas-C/pre-commit-hooks.git
     rev: v1.5.5
@@ -101,11 +99,12 @@ repos:
     hooks:
       - id: mypy
         additional_dependencies:
-          - pytest
           - pip
+          - pytest
           - subprocess_tee
           - types-pyyaml
           - types-setuptools
+          - uv
         # Override default pre-commit '--ignore-missing-imports'
         args: [--strict]
 

docs/index.md

@@ -22,6 +22,7 @@ For more information about communication, see the [Ansible communication guide](
 - Checks for missing system packages
 - Symlinks the current collection into the current python interpreter's site-packages
 - Install all collection collection dependencies into the current python interpreter's site-packages
+- Uses `uv env` instead of python's venv when available to boost performance. Can be disabled with `SKIP_UV=1`
 
 By placing collections into the python site-packages directory they are discoverable by ansible as well as python and pytest.
 

pyproject.toml

@@ -70,7 +70,7 @@ allow-init-docstring = true
 arg-type-hints-in-docstring = false
 baseline = ".config/pydoclint-baseline.txt"
 check-return-types = false
-exclude = '\.git|\.tox|build|out|venv'
+exclude = '\.git|\.tox|\.venv|build|out|venv'
 should-document-private-class-attributes = true
 show-filenames-in-every-violation-message = true
 skip-checking-short-docstrings = false

src/ansible_dev_environment/config.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import json
+import logging
 import os
 import shutil
 import subprocess
@@ -21,10 +22,40 @@
     from .utils import TermFeatures
 
 
-class Config:
-    """The application configuration."""
+_logger = logging.getLogger(__name__)
+
+
+def use_uv() -> bool:
+    """Return whether to use uv commands like venv or pip.
+
+    Returns:
+        True if uv is to be used.
+    """
+    if int(os.environ.get("SKIP_UV", "0")):
+        return False
+    try:
+        import uv  # noqa: F401
+    except ImportError:
+        pass
+    else:
+        _logger.info(
+            "UV detected and will be used instead of venv/pip. To disable that define SKIP_UP=1 in your environment.",
+        )
+        return True
+    return False
+
+
+class Config:  # pylint: disable=too-many-instance-attributes
+    """The application configuration.
+
+    Attributes:
+        pip_cmd: The pip command.
+        venv_cmd: The venv command.
+    """
+
+    pip_cmd: str
+    venv_cmd: str
 
-    # pylint: disable=too-many-instance-attributes
     def __init__(
         self,
         args: Namespace,
@@ -144,11 +175,18 @@ def _set_interpreter(
         self,
     ) -> None:
         """Set the interpreter."""
+        self.pip_cmd = f"{sys.executable} -m pip"
+        self.venv_cmd = f"{sys.executable} -m venv"
+        if use_uv():
+            self.pip_cmd = f"{sys.executable} -m uv pip"
+            # seed and python-preference make uv venv match python -m venv behavior:
+            self.venv_cmd = f"{sys.executable} -m uv venv --seed --python-preference=system"
+
         if not self.venv.exists():
             if self._create_venv:
                 msg = f"Creating virtual environment: {self.venv}"
                 self._output.debug(msg)
-                command = f"python -m venv {self.venv}"
+                command = f"{self.venv_cmd} {self.venv}"
                 msg = f"Creating virtual environment: {self.venv}"
                 if self.args.system_site_packages:
                     command = f"{command} --system-site-packages"

src/ansible_dev_environment/subcommands/installer.py

@@ -505,10 +505,7 @@ def _pip_install(self) -> None:
         msg = "Installing python requirements."
         self._output.info(msg)
 
-        command = (
-            f"{self._config.venv_interpreter} -m pip install"
-            f" -r {self._config.discovered_python_reqs}"
-        )
+        command = f"{self._config.pip_cmd} install" f" -r {self._config.discovered_python_reqs}"
 
         msg = f"Installing python requirements from {self._config.discovered_python_reqs}"
         self._output.debug(msg)

tests/unit/test_config.py

@@ -42,13 +42,20 @@ def gen_args(
 
 
 @pytest.mark.parametrize(
-    "system_site_packages",
-    ((True, False)),
-    ids=["ssp_true", "ssp_false"],
+    ("system_site_packages", "uv"),
+    (
+        pytest.param(True, False, id="ssp1-uv0"),
+        pytest.param(False, False, id="ssp0-uv0"),
+        pytest.param(True, True, id="ssp1-uv1"),
+        pytest.param(False, True, id="ssp0-uv1"),
+    ),
 )
 def test_paths(
+    *,
     tmpdir: Path,
-    system_site_packages: bool,  # noqa: FBT001
+    system_site_packages: bool,
+    uv: bool,
+    monkeypatch: pytest.MonkeyPatch,
     output: Output,
 ) -> None:
     """Test the paths.
@@ -58,8 +65,11 @@ def test_paths(
     Args:
         tmpdir: A temporary directory.
         system_site_packages: Whether to include system site packages.
+        uv: Whether to use the uv module.
+        monkeypatch: A pytest fixture for monkey patching.
         output: The output fixture.
     """
+    monkeypatch.setenv("SKIP_UV", "0" if uv else "1")
     venv = tmpdir / "test_venv"
     args = gen_args(
         venv=str(venv),
@@ -69,6 +79,13 @@ def test_paths(
     config = Config(args=args, output=output, term_features=output.term_features)
     config.init()
 
+    if uv:
+        assert "-m uv venv" in config.venv_cmd
+        assert "-m uv pip" in config.pip_cmd
+    else:
+        assert "-m venv" in config.venv_cmd
+        assert "-m pip" in config.pip_cmd
+
     assert config.venv == venv
     for attr in (
         "site_pkg_collections_path",