pre-commit-uv 4.0.0__tar.gz → 4.0.2__tar.gz

{pre_commit_uv-4.0.0 → pre_commit_uv-4.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pre-commit-uv
-Version: 4.0.0
+Version: 4.0.2
 Summary: Run pre-commit with uv
 Project-URL: Bug Tracker, https://github.com/tox-dev/pre-commit-uv/issues
 Project-URL: Changelog, https://github.com/tox-dev/pre-commit-uv/releases
@@ -56,6 +56,48 @@ Description-Content-Type: text/markdown
 
 Use `uv` to create virtual environments and install packages for `pre-commit`.
 
+## Installation
+
+With pipx:
+
+```shell
+pipx install pre-commit
+pipx inject pre-commit pre-commit-uv
+```
+
+With uv:
+
+```shell
+uv tool install pre-commit --with pre-commit-uv --force-reinstall
+```
+
+## Why?
+
+Compared to upstream `pre-commit` will speed up the initial seed operation. In general, upstream recommends caching the
+`pre-commit` cache, however, that is not always possible and is still helpful to have a more performant initial cache
+creation., Here's an example of what you could expect demonstrated on this project's own pre-commit setup (with a hot
+`uv` cache):
+
+```shell
+❯ hyperfine  'pre-commit install-hooks' 'pre-commit-uv install-hooks'
+Benchmark 1: pre-commit install-hooks
+  Time (mean ± σ):     54.132 s ±  8.827 s    [User: 15.424 s, System: 9.359 s]
+  Range (min … max):   45.972 s … 66.506 s    10 runs
+
+Benchmark 2: pre-commit-uv install-hooks
+  Time (mean ± σ):     41.695 s ±  7.395 s    [User: 7.614 s, System: 6.133 s]
+  Range (min … max):   32.198 s … 58.467 s    10 runs
+
+Summary
+  pre-commit-uv install-hooks ran 1.30 ± 0.31 times faster than pre-commit install-hooks
+```
+
 ## Configuration
 
-Once installed will use `uv` out of box, however the `DISABLE_PRE_COMMIT_UV_PATCH` environment variable if set will work as an escape hatch.
+Once installed will use `uv` out of box, however the `DISABLE_PRE_COMMIT_UV_PATCH` environment variable if is set it
+will work as an escape hatch to disable the new behavior.
+
+To avoid interpreter startup overhead of the patching, we only perform this when we detect you calling `pre-commit`.
+Should this logic fail you can force the patching by setting the `FORCE_PRE_COMMIT_UV_PATCH` variable. Should you
+experience this please raise an issue with the content of the `sys.argv`. Note that `DISABLE_PRE_COMMIT_UV_PATCH` will
+overwrite this flag should both be set.

pre_commit_uv-4.0.2/README.md

@@ -0,0 +1,56 @@
+# pre-commit-uv
+
+[![PyPI](https://img.shields.io/pypi/v/pre-commit-uv?style=flat-square)](https://pypi.org/project/pre-commit-uv)
+[![PyPI - Implementation](https://img.shields.io/pypi/implementation/pre-commit-uv?style=flat-square)](https://pypi.org/project/pre-commit-uv)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pre-commit-uv?style=flat-square)](https://pypi.org/project/pre-commit-uv)
+[![Downloads](https://static.pepy.tech/badge/pre-commit-uv/month)](https://pepy.tech/project/pre-commit-uv)
+[![PyPI - License](https://img.shields.io/pypi/l/pre-commit-uv?style=flat-square)](https://opensource.org/licenses/MIT)
+[![check](https://github.com/tox-dev/pre-commit-uv/actions/workflows/check.yml/badge.svg)](https://github.com/tox-dev/pre-commit-uv/actions/workflows/check.yml)
+
+Use `uv` to create virtual environments and install packages for `pre-commit`.
+
+## Installation
+
+With pipx:
+
+```shell
+pipx install pre-commit
+pipx inject pre-commit pre-commit-uv
+```
+
+With uv:
+
+```shell
+uv tool install pre-commit --with pre-commit-uv --force-reinstall
+```
+
+## Why?
+
+Compared to upstream `pre-commit` will speed up the initial seed operation. In general, upstream recommends caching the
+`pre-commit` cache, however, that is not always possible and is still helpful to have a more performant initial cache
+creation., Here's an example of what you could expect demonstrated on this project's own pre-commit setup (with a hot
+`uv` cache):
+
+```shell
+❯ hyperfine  'pre-commit install-hooks' 'pre-commit-uv install-hooks'
+Benchmark 1: pre-commit install-hooks
+  Time (mean ± σ):     54.132 s ±  8.827 s    [User: 15.424 s, System: 9.359 s]
+  Range (min … max):   45.972 s … 66.506 s    10 runs
+
+Benchmark 2: pre-commit-uv install-hooks
+  Time (mean ± σ):     41.695 s ±  7.395 s    [User: 7.614 s, System: 6.133 s]
+  Range (min … max):   32.198 s … 58.467 s    10 runs
+
+Summary
+  pre-commit-uv install-hooks ran 1.30 ± 0.31 times faster than pre-commit install-hooks
+```
+
+## Configuration
+
+Once installed will use `uv` out of box, however the `DISABLE_PRE_COMMIT_UV_PATCH` environment variable if is set it
+will work as an escape hatch to disable the new behavior.
+
+To avoid interpreter startup overhead of the patching, we only perform this when we detect you calling `pre-commit`.
+Should this logic fail you can force the patching by setting the `FORCE_PRE_COMMIT_UV_PATCH` variable. Should you
+experience this please raise an issue with the content of the `sys.argv`. Note that `DISABLE_PRE_COMMIT_UV_PATCH` will
+overwrite this flag should both be set.

{pre_commit_uv-4.0.0 → pre_commit_uv-4.0.2}/pyproject.toml

@@ -55,7 +55,8 @@ build.targets.sdist.include = [
   "/tests",
   "tox.ini",
 ]
-build.targets.wheel.force-include = { "src/pre_commit_uv_patch.pth" = "pre_commit_uv_patch.pth" }
+build.targets.wheel.only-include = [ "src" ]
+build.targets.wheel.sources = [ "src" ]
 version.source = "vcs"
 
 [tool.ruff]
@@ -86,8 +87,8 @@ lint.per-file-ignores."tests/**/*.py" = [
   "PLR0913", # any number of arguments in tests
   "PLR0917", # any number of arguments in tests
   "PLR2004", # Magic value used in comparison, consider replacing with a constant variable
+  "S",       # `subprocess` call: check for execution of untrusted input
   "S101",    # asserts allowed in tests...
-  "S603",    # `subprocess` call: check for execution of untrusted input
 ]
 lint.isort = { known-first-party = [
   "pre_commit_uv",
@@ -117,7 +118,7 @@ paths.source = [
   "**/src",
   "**\\src",
 ]
-report.fail_under = 50
+report.fail_under = 65
 run.parallel = true
 run.plugins = [
   "covdefaults",

pre_commit_uv-4.0.2/src/pre_commit_uv/__init__.py

@@ -0,0 +1,93 @@
+"""Package root."""
+
+from __future__ import annotations
+
+# only import built-ins at top level to avoid interpreter startup overhead
+import os
+import sys
+
+_original_main = None
+
+
+def _patch() -> None:
+    global _original_main
+    if _original_main is not None:  # already patched, nothing more to do
+        return
+    calling_pre_commit = "FORCE_PRE_COMMIT_UV_PATCH" in os.environ
+    if not calling_pre_commit and sys.argv and sys.argv[0]:  # must have arguments
+        calling = sys.argv[1] if sys.argv[0] == sys.executable and len(sys.argv) >= 1 else sys.argv[0]
+        if os.path.split(calling)[1] == f"pre-commit{'.exe' if sys.platform == 'win32' else ''}":
+            calling_pre_commit = True
+
+    if calling_pre_commit and os.environ.get("DISABLE_PRE_COMMIT_UV_PATCH") is None:
+        from pre_commit import main  # noqa: PLC0415
+
+        _original_main, main.main = main.main, _new_main
+
+
+def _new_main(argv: list[str] | None = None) -> int:
+    # imports applied locally to avoid patching import overhead cost
+    from functools import cache  # noqa: PLC0415
+    from typing import TYPE_CHECKING, cast  # noqa: PLC0415
+
+    from pre_commit.languages import python  # noqa: PLC0415
+
+    if TYPE_CHECKING:
+        from collections.abc import Sequence  # noqa: PLC0415
+
+        from pre_commit.prefix import Prefix  # noqa: PLC0415
+
+    def _install_environment(
+        prefix: Prefix,
+        version: str,
+        additional_dependencies: Sequence[str],
+    ) -> None:
+        import logging  # noqa: PLC0415
+
+        from pre_commit.lang_base import environment_dir, setup_cmd  # noqa: PLC0415
+        from pre_commit.util import cmd_output_b  # noqa: PLC0415
+
+        logger = logging.getLogger("pre_commit")
+        logger.info("Using pre-commit with uv %s via pre-commit-uv %s", uv_version(), self_version())
+        uv = _uv()
+        venv_cmd = [uv, "venv", environment_dir(prefix, python.ENVIRONMENT_DIR, version)]
+        py = python.norm_version(version)
+        if py is not None:
+            venv_cmd.extend(("-p", py))
+        cmd_output_b(*venv_cmd, cwd="/")
+
+        with python.in_env(prefix, version):
+            setup_cmd(prefix, (uv, "pip", "install", ".", *additional_dependencies))
+
+    @cache
+    def _uv() -> str:
+        from uv import find_uv_bin  # noqa: PLC0415
+
+        return find_uv_bin()
+
+    @cache
+    def self_version() -> str:
+        from importlib.metadata import version as _metadata_version  # noqa: PLC0415
+
+        return _metadata_version("pre-commit-uv")
+
+    @cache
+    def uv_version() -> str:
+        from importlib.metadata import version as _metadata_version  # noqa: PLC0415
+
+        return _metadata_version("uv")
+
+    @cache
+    def _version_info(exe: str) -> str:
+        from pre_commit.util import CalledProcessError, cmd_output  # noqa: PLC0415
+
+        prog = 'import sys;print(".".join(str(p) for p in sys.version_info[0:3]))'
+        try:
+            return cast(str, cmd_output(exe, "-S", "-c", prog)[1].strip())
+        except CalledProcessError:
+            return f"<<error retrieving version from {exe}>>"
+
+    python.install_environment = _install_environment
+    python._version_info = _version_info  # noqa: SLF001
+    assert _original_main is not None  # noqa: S101
+    return cast(int, _original_main(argv))

{pre_commit_uv-4.0.0 → pre_commit_uv-4.0.2}/tests/test_main.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from importlib.metadata import version
+from subprocess import check_call
 from textwrap import dedent
 from typing import TYPE_CHECKING
 
@@ -23,6 +24,8 @@ def test_install(tmp_path: Path, caplog: pytest.LogCaptureFixture, monkeypatch:
     conf_file = tmp_path / ".pre-commit-config.yaml"
     conf_file.write_text(dedent(conf))
     monkeypatch.setenv("PRE_COMMIT_HOME", str(tmp_path / "store"))
+    monkeypatch.chdir(tmp_path)
+    check_call(["git", "init"])
 
     main.main(["install-hooks", "-c", str(conf_file)])
 

{pre_commit_uv-4.0.0 → pre_commit_uv-4.0.2}/tox.ini

@@ -1,14 +1,14 @@
 [tox]
 requires =
-    tox>=4.2
+    tox>=4.17.1
 env_list =
     fix
-    py312
-    py311
-    py310
-    py39
     type
     readme
+    3.12
+    3.11
+    3.10
+    3.9
 skip_missing_interpreters = true
 
 [testenv]
@@ -17,10 +17,11 @@ package = wheel
 wheel_build_env = .pkg
 extras =
     test
+pass_env =
+    PYTEST_ADDOPTS
 set_env =
     COVERAGE_FILE = {toxworkdir}/.coverage.{envname}
-    COVERAGE_PROCESS_START = {toxinidir}/setup.cfg
-    _COVERAGE_SRC = {envsitepackagesdir}/sphinx_argparse_cli
+    FORCE_PRE_COMMIT_UV_PATCH = true
 commands =
     python -m pytest {tty:--color=yes} {posargs: \
       --junitxml {toxworkdir}{/}junit.{envname}.xml --cov {envsitepackagesdir}{/}pre_commit_uv \
@@ -52,11 +53,13 @@ commands =
 description = check that the long description is valid
 skip_install = true
 deps =
-    build[virtualenv]>=1.2.1
+    build[uv]>=1.2.1
+    check-wheel-contents>=0.6
     twine>=5.1.1
 commands =
-    python -m build --sdist --wheel -o {envtmpdir} .
+    python -m build --installer uv --sdist --wheel -o {envtmpdir} .
     twine check {envtmpdir}/*
+    check-wheel-contents {envtmpdir}
 
 [testenv:dev]
 description = generate a DEV environment
@@ -64,8 +67,9 @@ package = editable
 extras =
     docs
     test
+set_env =
+    FORCE_PRE_COMMIT_UV_PATCH = true
 commands =
-    python -c "import shutil; shutil.copy2('src{/}pre_commit_uv_patch.pth', '{env_site_packages_dir}{/}pre_commit_uv_patch.pth')"
-    python -m pip list --format=columns
+    uv tree
     python -c 'import sys; print(sys.executable)'
-uv_seed = true
+    python task/dev_pth.py {env_site_packages_dir}

pre_commit_uv-4.0.0/README.md

@@ -1,14 +0,0 @@
-# pre-commit-uv
-
-[![PyPI](https://img.shields.io/pypi/v/pre-commit-uv?style=flat-square)](https://pypi.org/project/pre-commit-uv)
-[![PyPI - Implementation](https://img.shields.io/pypi/implementation/pre-commit-uv?style=flat-square)](https://pypi.org/project/pre-commit-uv)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pre-commit-uv?style=flat-square)](https://pypi.org/project/pre-commit-uv)
-[![Downloads](https://static.pepy.tech/badge/pre-commit-uv/month)](https://pepy.tech/project/pre-commit-uv)
-[![PyPI - License](https://img.shields.io/pypi/l/pre-commit-uv?style=flat-square)](https://opensource.org/licenses/MIT)
-[![check](https://github.com/tox-dev/pre-commit-uv/actions/workflows/check.yml/badge.svg)](https://github.com/tox-dev/pre-commit-uv/actions/workflows/check.yml)
-
-Use `uv` to create virtual environments and install packages for `pre-commit`.
-
-## Configuration
-
-Once installed will use `uv` out of box, however the `DISABLE_PRE_COMMIT_UV_PATCH` environment variable if set will work as an escape hatch.

pre_commit_uv-4.0.0/src/pre_commit_uv/__init__.py

@@ -1,68 +0,0 @@
-"""Package root."""
-
-from __future__ import annotations
-
-import logging
-import os
-from functools import cache
-from importlib.metadata import version as _metadata_version
-from typing import TYPE_CHECKING, cast
-
-from pre_commit import lang_base, main
-from pre_commit.languages import python
-from pre_commit.languages.python import in_env, norm_version
-from pre_commit.util import CalledProcessError, cmd_output, cmd_output_b
-from uv import find_uv_bin
-
-if TYPE_CHECKING:
-    from collections.abc import Sequence
-
-    from pre_commit.prefix import Prefix
-
-
-__version__ = _metadata_version("pre-commit-uv")
-_uv_version = _metadata_version("uv")
-_original_main = main.main
-
-
-def _patch() -> None:
-    if os.environ.get("DISABLE_PRE_COMMIT_UV_PATCH") is None:
-        main.main = _new_main
-
-
-def _new_main(argv: Sequence[str] | None = None) -> int:
-    python.install_environment = _install_environment
-    python._version_info = _version_info  # noqa: SLF001
-    return cast(int, _original_main(argv))
-
-
-def _install_environment(
-    prefix: Prefix,
-    version: str,
-    additional_dependencies: Sequence[str],
-) -> None:
-    logging.getLogger("pre_commit").info("Using pre-commit with uv %s via pre-commit-uv %s", _uv_version, __version__)
-    uv = find_uv_bin()
-
-    venv_cmd = [uv, "venv", lang_base.environment_dir(prefix, python.ENVIRONMENT_DIR, version)]
-    py = norm_version(version)
-    if py is not None:
-        venv_cmd.extend(("-p", py))
-    cmd_output_b(*venv_cmd, cwd="/")
-
-    with in_env(prefix, version):
-        lang_base.setup_cmd(prefix, (uv, "pip", "install", ".", *additional_dependencies))
-
-
-@cache
-def _version_info(exe: str) -> str:
-    prog = 'import sys;print(".".join(str(p) for p in sys.version_info[0:3]))'
-    try:
-        return cast(str, cmd_output(exe, "-S", "-c", prog)[1].strip())
-    except CalledProcessError:
-        return f"<<error retrieving version from {exe}>>"
-
-
-__all__ = [
-    "__version__",
-]