Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions src/pre_commit_uv/_pre_commit_patch.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class _PatchablePython(Protocol):
_ORIGINAL_MAIN = None


def _patch() -> None:
def patch() -> None:
global _ORIGINAL_MAIN
if _ORIGINAL_MAIN is not None: # already patched, nothing more to do
return
Expand Down Expand Up @@ -130,7 +130,7 @@ def uv_version() -> str:
patched = cast("_PatchablePython", python)
patched.install_environment = _install_environment
patched.health_check = _health_check
assert _ORIGINAL_MAIN is not None # ruff:ignore[assert] _patch sets _ORIGINAL_MAIN before installing _new_main
assert _ORIGINAL_MAIN is not None # ruff:ignore[assert] patch sets _ORIGINAL_MAIN before installing _new_main
return _ORIGINAL_MAIN(argv)


Expand All @@ -145,11 +145,7 @@ def _health_check(prefix: Prefix, version: str) -> str | None:
if not pyvenv_cfg.exists():
return "pyvenv.cfg does not exist (old virtualenv?)"

cfg = {}
for line in pyvenv_cfg.read_text(encoding="utf-8").splitlines():
key, separator, value = line.partition("=")
if separator and "=" not in value:
cfg[key.strip()] = value.strip()
cfg = python._read_pyvenv_cfg(str(pyvenv_cfg)) # ruff:ignore[private-member-access] no public parser in pre-commit
if "version_info" not in cfg:
return "created virtualenv's pyvenv.cfg is missing `version_info`"
expected = cfg["version_info"].split(".")
Expand All @@ -175,3 +171,8 @@ def _version_info(exe: str) -> str:
return cmd_output(exe, "-S", "-c", prog)[1].strip()
except CalledProcessError:
return f"<<error retrieving version from {exe}>>"


__all__ = [
"patch",
]
2 changes: 1 addition & 1 deletion src/pre_commit_uv_patch.pth
Original file line number Diff line number Diff line change
@@ -1 +1 @@
import pre_commit_uv._pre_commit_patch; pre_commit_uv._pre_commit_patch._patch()
import pre_commit_uv._pre_commit_patch; pre_commit_uv._pre_commit_patch.patch()
43 changes: 31 additions & 12 deletions tests/pre_commit_uv/test_pre_commit_patch.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from __future__ import annotations

import sys
from importlib import reload
from importlib.metadata import version
from shutil import which
from subprocess import check_call, check_output
Expand All @@ -12,7 +13,7 @@
from pre_commit.languages import python
from pre_commit.prefix import Prefix

from pre_commit_uv._pre_commit_patch import _health_check, _patch
from pre_commit_uv._pre_commit_patch import patch

if TYPE_CHECKING:
from pathlib import Path
Expand Down Expand Up @@ -74,7 +75,9 @@ def test_call_as_module() -> None:
def test_install(git_repo: Path, caplog: pytest.LogCaptureFixture, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("FORCE_PRE_COMMIT_UV_PATCH", "1")

_patch()
reload(main)
reload(sys.modules[patch.__module__])
patch()
main.main(["install-hooks", "-c", str(git_repo / _PRECOMMIT_FILE)])

assert caplog.messages == [
Expand All @@ -89,7 +92,7 @@ def test_install(git_repo: Path, caplog: pytest.LogCaptureFixture, monkeypatch:
def test_install_seeds_pip(git_repo: Path, monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("FORCE_PRE_COMMIT_UV_PATCH", "1")

_patch()
patch()
main.main(["install-hooks", "-c", str(git_repo / _PRECOMMIT_FILE)])

env_dirs = list((git_repo / "store").rglob("py_env-*"))
Expand Down Expand Up @@ -135,7 +138,7 @@ def test_install_with_uv_config(

monkeypatch.setenv("FORCE_PRE_COMMIT_UV_PATCH", "1")

_patch()
patch()
main.main(["install-hooks", "-c", str(git_repo / _PRECOMMIT_FILE)])

assert caplog.messages == [
Expand Down Expand Up @@ -181,18 +184,28 @@ def test_install_with_uv_config_raises_error(

monkeypatch.setenv("FORCE_PRE_COMMIT_UV_PATCH", "1")

_patch()
patch()

# would raise SystemExit due to bad config
with pytest.raises(SystemExit):
main.main(["install-hooks", "-c", str(git_repo / _PRECOMMIT_FILE)])


@pytest.fixture
def patched_pre_commit(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setenv("FORCE_PRE_COMMIT_UV_PATCH", "1")
patch()
with pytest.raises(SystemExit) as result:
main.main(["--version"])
assert result.value.code == 0


@pytest.mark.usefixtures("patched_pre_commit")
def test_health_check_truncated_version_passes(tmp_path: Path) -> None:
# uv >=0.11.22 writes only the major.minor into pyvenv.cfg (see issue #152).
prefix = _make_env(tmp_path, f"version_info = {_MAJOR_MINOR}\nbase-executable = {sys.executable}\n")

assert _health_check(prefix, _VERSION) is None
assert python.health_check(prefix, _VERSION) is None


def _make_env(tmp_path: Path, pyvenv_cfg: str | None) -> Prefix:
Expand All @@ -205,39 +218,44 @@ def _make_env(tmp_path: Path, pyvenv_cfg: str | None) -> Prefix:
return Prefix(str(tmp_path))


@pytest.mark.usefixtures("patched_pre_commit")
def test_health_check_full_version_passes(tmp_path: Path) -> None:
prefix = _make_env(tmp_path, f"version_info = {_FULL_VERSION}\nbase-executable = {sys.executable}\n")

assert _health_check(prefix, _VERSION) is None
assert python.health_check(prefix, _VERSION) is None


@pytest.mark.usefixtures("patched_pre_commit")
def test_health_check_no_base_executable_passes(tmp_path: Path) -> None:
prefix = _make_env(tmp_path, f"version_info = {_MAJOR_MINOR}\n")

assert _health_check(prefix, _VERSION) is None
assert python.health_check(prefix, _VERSION) is None


@pytest.mark.usefixtures("patched_pre_commit")
def test_health_check_version_mismatch_fails(tmp_path: Path) -> None:
result = _health_check(_make_env(tmp_path, f"version_info = {_WRONG_VERSION}\n"), _VERSION)
result = python.health_check(_make_env(tmp_path, f"version_info = {_WRONG_VERSION}\n"), _VERSION)

assert result is not None
assert "virtualenv python version did not match created version" in result
assert f"- expected version: {_WRONG_VERSION}" in result


@pytest.mark.usefixtures("patched_pre_commit")
def test_health_check_base_executable_mismatch_fails(tmp_path: Path) -> None:
prefix = _make_env(tmp_path, f"version_info = {_MAJOR_MINOR}\nbase-executable = /does/not/exist/python\n")

result = _health_check(prefix, _VERSION)
result = python.health_check(prefix, _VERSION)

assert result is not None
assert "base executable version did not match created version" in result


@pytest.mark.usefixtures("patched_pre_commit")
def test_health_check_missing_pyvenv_cfg(tmp_path: Path) -> None:
prefix = _make_env(tmp_path, None)

assert _health_check(prefix, _VERSION) == "pyvenv.cfg does not exist (old virtualenv?)"
assert python.health_check(prefix, _VERSION) == "pyvenv.cfg does not exist (old virtualenv?)"


@pytest.mark.parametrize(
Expand All @@ -247,7 +265,8 @@ def test_health_check_missing_pyvenv_cfg(tmp_path: Path) -> None:
pytest.param("version_info = 3=15\n", id="extra-equals"),
],
)
@pytest.mark.usefixtures("patched_pre_commit")
def test_health_check_missing_version_info(tmp_path: Path, contents: str) -> None:
prefix = _make_env(tmp_path, contents)

assert _health_check(prefix, _VERSION) == "created virtualenv's pyvenv.cfg is missing `version_info`"
assert python.health_check(prefix, _VERSION) == "created virtualenv's pyvenv.cfg is missing `version_info`"