Merge pull request #136 from sbidoul/uv-support

Add experimental support for the uv installer

Author: sbidoul

README.rst

@@ -341,6 +341,12 @@ pip-df sync
                                      dependencies of the project. If not
                                      specified, ask confirmation.
 
+     --installer [default|env-pip|uv]
+                                     The installer to use. For now the default is
+                                     to use 'pip' that is installed in the target
+                                     environment. To use 'uv', pip-deepfreeze must be
+                                     installed with the 'uv' extra.
+
      --help                          Show this message and exit.
 
 pip-df tree

news/135.feature

@@ -0,0 +1,4 @@
+Add experimental support for `uv <https://github.com/astral-sh/uv>`_ as the installation
+command. For now we still need `pip` to be installed in the target environment, to
+inspect its content. A new ``--installer`` option is available to select the installer
+to use.

pyproject.toml

@@ -33,6 +33,7 @@ dependencies=[
 dynamic = ["version"]
 
 [project.optional-dependencies]
+"uv" = ["uv"]
 "test" = ["pytest", "pytest-cov", "pytest-xdist", "virtualenv", "setuptools", "wheel"]
 "mypy" = ["mypy", "types-toml", "types-setuptools"]
 

src/pip_deepfreeze/__main__.py

@@ -6,6 +6,7 @@
 import typer
 from packaging.utils import canonicalize_name
 
+from .pip import Installer
 from .pyproject_toml import load_pyproject_toml
 from .sanity import check_env
 from .sync import sync as sync_operation
@@ -68,6 +69,9 @@ def sync(
             "Can be specified multiple times."
         ),
     ),
+    installer: Installer = typer.Option(
+        "default",
+    ),
 ) -> None:
     """Install/update the environment to match the project requirements.
 
@@ -85,6 +89,7 @@ def sync(
         uninstall_unneeded=uninstall_unneeded,
         project_root=ctx.obj.project_root,
         post_sync_commands=post_sync_commands,
+        installer=installer,
     )
 
 

src/pip_deepfreeze/pip.py

@@ -1,9 +1,15 @@
+import importlib.util
 import json
+import os
 import shlex
+import sys
+from enum import Enum
+from functools import lru_cache
 from importlib.resources import path as resource_path
 from pathlib import Path
 from typing import Any, Dict, Iterable, List, Optional, Sequence, Tuple, TypedDict, cast
 
+import typer
 from packaging.utils import NormalizedName
 from packaging.version import Version
 
@@ -29,6 +35,7 @@
     check_output,
     get_temp_path_in_dir,
     log_debug,
+    log_error,
     log_info,
     log_warning,
     normalize_req_line,
@@ -41,11 +48,53 @@ class PipInspectReport(TypedDict, total=False):
     environment: Dict[str, str]
 
 
+class Installer(str, Enum):
+    default = "default"
+    envpip = "env-pip"
+    uv = "uv"
+
+
+@lru_cache
+def _has_uv() -> bool:
+    return bool(importlib.util.find_spec("uv"))
+
+
+def _env_pip_install_cmd_and_env(python: str) -> Tuple[List[str], Dict[str, str]]:
+    return [python, "-m", "pip", "install"], {}
+
+
+def _uv_install_cmd_and_env(python: str) -> Tuple[List[str], Dict[str, str]]:
+    # TODO when https://github.com/astral-sh/uv/issues/1396 is implemented,
+    # we will not need to return the VIRTUAL_ENV environment variable.
+    return [sys.executable, "-m", "uv", "pip", "install"], {
+        "VIRTUAL_ENV": str(Path(python).parent.parent)
+    }
+
+
+def _install_cmd_and_env(
+    installer: Installer, python: str
+) -> Tuple[List[str], Dict[str, str]]:
+    if installer == Installer.default:
+        installer = Installer.envpip
+    if installer == Installer.envpip:
+        return _env_pip_install_cmd_and_env(python)
+    elif installer == Installer.uv:
+        if not _has_uv():
+            log_error(
+                "The 'uv' installer was requested but it is not available. "
+                "Please install pip-deepfreeze with the 'uv' extra to use it."
+            )
+            raise typer.Exit(1)
+        return _uv_install_cmd_and_env(python)
+    raise NotImplementedError(f"Installer {installer} is not implemented.")
+
+
 def pip_upgrade_project(
     python: str,
     constraints_filename: Path,
     project_root: Path,
     extras: Optional[Sequence[NormalizedName]] = None,
+    installer: Installer = Installer.envpip,
 ) -> None:
     """Upgrade a project.
 
@@ -117,15 +166,14 @@ def pip_upgrade_project(
     # 4. install project with constraints
     project_name = get_project_name(python, project_root)
     log_info(f"Installing/updating {project_name}")
-    cmd = [
-        python,
-        "-m",
-        "pip",
-        "install",
-        "-c",
-        f"{constraints_without_editables_filename}",
-        *editable_constraints,
-    ]
+    cmd, env = _install_cmd_and_env(installer, python)
+    cmd.extend(
+        [
+            "-c",
+            f"{constraints_without_editables_filename}",
+            *editable_constraints,
+        ]
+    )
     cmd.append("-e")
     if extras:
         extras_str = ",".join(extras)
@@ -141,7 +189,7 @@ def pip_upgrade_project(
         log_debug(constraints)
     else:
         log_debug(f"with empty {constraints_without_editables_filename}.")
-    check_call(cmd)
+    check_call(cmd, os.environ.copy().update(env))
 
 
 def _pip_list__env_info_json(python: str) -> InstalledDistributions:

src/pip_deepfreeze/sync.py

@@ -5,6 +5,7 @@
 from packaging.utils import NormalizedName
 
 from .pip import (
+    Installer,
     pip_fixup_vcs_direct_urls,
     pip_freeze_dependencies_by_extra,
     pip_uninstall,
@@ -43,6 +44,7 @@ def sync(
     uninstall_unneeded: Optional[bool],
     project_root: Path,
     post_sync_commands: Sequence[str] = (),
+    installer: Installer = Installer.envpip,
 ) -> None:
     project_name = get_project_name(python, project_root)
     project_name_with_extras = make_project_name_with_extras(project_name, extras)
@@ -64,6 +66,7 @@ def sync(
         constraints_path,
         project_root,
         extras=extras,
+        installer=installer,
     )
     # freeze dependencies
     frozen_reqs_by_extra, unneeded_reqs = pip_freeze_dependencies_by_extra(

src/pip_deepfreeze/utils.py

@@ -81,9 +81,13 @@ def log_error(msg: str) -> None:
     typer.secho(msg, fg=typer.colors.RED, err=True)
 
 
-def check_call(cmd: Sequence[Union[str, Path]], cwd: Optional[Path] = None) -> int:
+def check_call(
+    cmd: Sequence[Union[str, Path]],
+    cwd: Optional[Path] = None,
+    env: Optional[Dict[str, str]] = None,
+) -> int:
     try:
-        return subprocess.check_call(cmd, cwd=cwd)
+        return subprocess.check_call(cmd, cwd=cwd, env=env)
     except CalledProcessError as e:
         cmd_str = shlex.join(str(item) for item in cmd)
         log_error(f"Error running: {cmd_str}.")