feat: add --installer option

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

.github/workflows/ci.yml

@@ -49,11 +49,13 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - uses: yezz123/setup-uv@v4
+
       - name: Install package
-        run: python -m pip install .[test]
+        run: uv pip install -e.[test] --system
 
       - name: Test package
-        run: python -m pytest -ra --cov=check-sdist
+        run: pytest -ra --cov=check-sdist
 
       - name: Upload coverage report
         uses: codecov/codecov-action@v4

.pre-commit-config.yaml

@@ -3,11 +3,6 @@ ci:
   autofix_commit_msg: "style: pre-commit fixes"
 
 repos:
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: "24.4.0"
-    hooks:
-      - id: black-jupyter
-
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: "v4.6.0"
     hooks:
@@ -43,6 +38,7 @@ repos:
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
+      - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: "v1.9.0"

noxfile.py

@@ -2,7 +2,8 @@
 
 import nox
 
-nox.options.sessions = ["lint", "pylint", "tests"]
+nox.needs_version = ">=2024.4.15"
+nox.options.default_venv_backend = "uv|virtualenv"
 
 
 @nox.session
@@ -21,7 +22,7 @@ def pylint(session: nox.Session) -> None:
     """
     # This needs to be installed into the package environment, and is slower
     # than a pre-commit check
-    session.install(".", "pylint")
+    session.install("-e.", "pylint")
     session.run("pylint", "src", *session.posargs)
 
 
@@ -30,7 +31,7 @@ def tests(session: nox.Session) -> None:
     """
     Run the unit and regular tests.
     """
-    session.install(".[test]")
+    session.install("-e.[test]")
     session.run("pytest", *session.posargs)
 
 
@@ -44,7 +45,7 @@ def coverage(session: nox.Session) -> None:
     tests(session)
 
 
-@nox.session
+@nox.session(default=False)
 def build(session: nox.Session) -> None:
     """
     Build an SDist and wheel.

pyproject.toml

@@ -27,10 +27,10 @@ classifiers = [
 ]
 dynamic = ["version"]
 dependencies = [
-  "build",
+  "build >=1.2",
+  "importlib-resources; python_version<'3.9'",
   "pathspec",
   "tomli; python_version<'3.11'",
-  "importlib-resources; python_version<'3.9'",
 ]
 keywords = ["sdist", "packaging", "lint"]
 
@@ -43,6 +43,9 @@ dev = [
   "pytest >=6",
   "pytest-cov >=3",
 ]
+uv = [
+  "uv",
+]
 
 [project.urls]
 Homepage = "https://github.com/henryiii/check-sdist"
@@ -89,8 +92,10 @@ disallow_incomplete_defs = true
 
 
 [tool.ruff]
-select = [
-  "E", "F", "W", # flake8
+src = ["src"]
+
+[tool.ruff.lint]
+extend-select = [
   "B",           # flake8-bugbear
   "I",           # isort
   "ARG",         # flake8-unused-arguments
@@ -111,13 +116,10 @@ select = [
   "YTT",         # flake8-2020
   "EXE",         # flake8-executable
 ]
-extend-ignore = [
-  "PLR",    # Design related pylint codes
+ignore = [
+  "PLR09",  # Design related pylint codes
   "E501",   # Line too long
-]
-src = ["src"]
-unfixable = [
-  "F841", # Removes unused variables
+  "ISC001", # Conflicts with formatter
 ]
 flake8-unused-arguments.ignore-variadic-names = true
 isort.required-imports = ["from __future__ import annotations"]

src/check_sdist/__main__.py

@@ -2,8 +2,11 @@
 
 import argparse
 import contextlib
+import importlib.util
+import shutil
 from collections.abc import Sequence
 from pathlib import Path
+from typing import Literal
 
 import pathspec
 
@@ -15,7 +18,34 @@
 from .sdist import sdist_files
 
 
-def compare(source_dir: Path, *, isolated: bool, verbose: bool = False) -> int:
+def select_installer(
+    installer: Literal["pip", "uv", "uv|pip"],  # type: ignore[name-defined]
+) -> Literal["uv", "pip"]:
+    """
+    Select uv, pip, or uv if available, then pip ("uv|pip"). Returns uv, pip,
+    or throws an error if uv was required and not available.
+    """
+    if "uv" in installer:
+        if importlib.util.find_spec("uv") is not None:
+            return "uv"
+
+        if shutil.which("uv") is not None:
+            return "uv"
+
+        if installer == "uv":
+            msg = "Can't find uv"
+            raise ImportError(msg)
+
+    return "pip"
+
+
+def compare(
+    source_dir: Path,
+    *,
+    isolated: bool,
+    verbose: bool = False,
+    installer: Literal["uv", "pip", "uv|pip"] = "uv|pip",  # type: ignore[name-defined]
+) -> int:
     """
     Compare the files in the SDist with the files tracked by git.
 
@@ -27,6 +57,8 @@ def compare(source_dir: Path, *, isolated: bool, verbose: bool = False) -> int:
     conditions are true.
     """
 
+    installer = select_installer(installer)
+
     config = {}
     pyproject_toml = source_dir.joinpath("pyproject.toml")
     with contextlib.suppress(FileNotFoundError), pyproject_toml.open("rb") as f:
@@ -38,7 +70,9 @@ def compare(source_dir: Path, *, isolated: bool, verbose: bool = False) -> int:
     default_ignore = config.get("default-ignore", True)
     recurse_submodules = config.get("recurse-submodules", True)
 
-    sdist = sdist_files(source_dir, isolated) - {"PKG-INFO"}
+    sdist = sdist_files(source_dir, isolated=isolated, installer=installer) - {
+        "PKG-INFO"
+    }
     git = git_files(source_dir, recurse_submodules=recurse_submodules)
 
     if default_ignore:
@@ -100,14 +134,25 @@ def main(sys_args: Sequence[str] | None = None, /) -> None:
         action="store_true",
         help="Print out SDist contents too",
     )
+    parser.add_argument(
+        "--installer",
+        choices={"uv", "pip", "uv|pip"},
+        default="uv|pip",
+        help="Tool to use when installing packages for making the SDist",
+    )
     args = parser.parse_args(sys_args)
 
     with contextlib.ExitStack() as stack:
         if args.inject_junk:
             stack.enter_context(inject_junk_files(args.source_dir))
 
     raise SystemExit(
-        compare(args.source_dir, isolated=not args.no_isolation, verbose=args.verbose)
+        compare(
+            args.source_dir,
+            isolated=not args.no_isolation,
+            verbose=args.verbose,
+            installer=args.installer,
+        )
     )
 
 

src/check_sdist/sdist.py

@@ -5,13 +5,24 @@
 import tarfile
 import tempfile
 from pathlib import Path
+from typing import Literal
 
 
-def sdist_files(source_dir: Path, isolated: bool) -> frozenset[str]:
+def sdist_files(
+    source_dir: Path, *, isolated: bool, installer: Literal["uv", "pip"]
+) -> frozenset[str]:
     """Return the files that would be (are) placed in the SDist."""
 
     with tempfile.TemporaryDirectory() as outdir:
-        cmd = [sys.executable, "-m", "build", "--sdist", "--outdir", outdir]
+        cmd = [
+            sys.executable,
+            "-m",
+            "build",
+            "--sdist",
+            "--outdir",
+            outdir,
+            f"--installer={installer}",
+        ]
         if not isolated:
             cmd.append("--no-isolation")
         subprocess.run(cmd, check=True, cwd=source_dir)
@@ -31,4 +42,4 @@ def sdist_files(source_dir: Path, isolated: bool) -> frozenset[str]:
 
 
 if __name__ == "__main__":
-    print(*sorted(sdist_files(Path.cwd(), True)), sep="\n")
+    print(*sorted(sdist_files(Path.cwd(), isolated=True, installer="pip")), sep="\n")