local pre-commit hooks

Author: joshuarli

.github/workflows/pre-commit.yml

@@ -9,7 +9,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
+
+    - uses: astral-sh/setup-uv@884ad927a57e558e7a70b92f2bccf9198a4be546 # v6
+      with:
+        version: '0.8.2'
+        # we just cache the venv-dir directly in action-setup-venv
+        enable-cache: false
+
+    - uses: getsentry/[email protected]
       with:
-        python-version: '3.11'
+        cache-dependency-path: uv.lock
+        install-cmd: uv sync --frozen --active
+
     - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -12,28 +12,42 @@ repos:
     hooks:
     -   id: reorder-python-imports
         args: [--py311-plus, --add-import, 'from __future__ import annotations']
--   repo: https://github.com/psf/black
-    rev: 24.1.1
-    hooks:
-    -   id: black
--   repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.0
-    hooks:
-    -   id: pyupgrade
-        args: [--py311-plus]
--   repo: https://github.com/PyCQA/flake8
-    rev: 7.0.0
-    hooks:
-    -   id: flake8
--   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.8.0
-    hooks:
-    -   id: mypy
 -   repo: local
     hooks:
     -   id: format-packages-ini
         name: format packages.ini
         language: python
-        entry: python -m format_ini
+        entry: .venv/bin/python -m format_ini
         files: ^packages\.ini$
-        additional_dependencies: [packaging==21.3]
+
+    # Configuration for black exists in pyproject.toml,
+    # but we let pre-commit take care of the file filtering.
+    - id: black
+      name: black
+      entry: .venv/bin/black
+      language: system
+      types_or: [python, pyi]
+      require_serial: true
+
+    # Configuration for flake8 exists in setup.cfg,
+    # but we let pre-commit take care of the file filtering.
+    - id: flake8
+      name: flake8
+      entry: .venv/bin/flake8
+      language: system
+      types: [python]
+      require_serial: true
+
+    - id: pyupgrade
+      name: pyupgrade
+      entry: .venv/bin/pyupgrade
+      language: system
+      types: [python]
+      args: [--py311-plus]
+
+    - id: mypy
+      name: mypy
+      entry: .venv/bin/mypy
+      language: system
+      types: [python]
+      require_serial: true

build.py

@@ -146,7 +146,7 @@ def _brew_paths(*pkgs: str) -> list[str]:
 
 
 @contextlib.contextmanager
-def _brew_install(packages: tuple[str, ...]) -> Generator[None, None, None]:
+def _brew_install(packages: tuple[str, ...]) -> Generator[None]:
     installed_before = _darwin_installed_packages()
 
     subprocess.check_call(
@@ -180,7 +180,7 @@ def _paths(*parts: str) -> list[str]:
 
 
 @contextlib.contextmanager
-def _darwin_install(package: Package) -> Generator[None, None, None]:
+def _darwin_install(package: Package) -> Generator[None]:
     with contextlib.ExitStack() as ctx:
         if package.brew_requires:
             ctx.enter_context(_brew_install(package.brew_requires))
@@ -252,7 +252,7 @@ def _linux_installed_packages() -> frozenset[str]:
 
 
 @contextlib.contextmanager
-def _apt_install(packages: tuple[str, ...]) -> Generator[None, None, None]:
+def _apt_install(packages: tuple[str, ...]) -> Generator[None]:
     _apt_update()
 
     installed_before = _linux_installed_packages()
@@ -280,7 +280,7 @@ def _apt_install(packages: tuple[str, ...]) -> Generator[None, None, None]:
 
 
 @contextlib.contextmanager
-def _linux_install(package: Package) -> Generator[None, None, None]:
+def _linux_install(package: Package) -> Generator[None]:
     with contextlib.ExitStack() as ctx:
         if package.apt_requires:
             ctx.enter_context(_apt_install(package.apt_requires))
@@ -446,7 +446,7 @@ def _join_env(
 @contextlib.contextmanager
 def _prebuild(
     package: Package, tmpdir: str, *, env: MutableMapping[str, str] | None = None
-) -> Generator[None, None, None]:
+) -> Generator[None]:
     if env is None:
         env = os.environ
 

devenv/sync.py

@@ -20,4 +20,7 @@ def main(context: dict[str, str]) -> int:
     print("syncing .venv ...")
     proc.run(("uv", "sync", "--frozen", "--quiet"))
 
+    print("installing pre-commit hooks ...")
+    proc.run((f"{reporoot}/.venv/bin/pre-commit", "install", "--install-hooks"))
+
     return 0

pyproject.toml

@@ -9,8 +9,12 @@ version = "0.0.0"
 # and run pytest on 3 different python versions in ci by swapping out .python-version.
 # Tox remains the most ergonomic solution to test on multiple pythons.
 dev = [
+    "black>=22.10.0",
+    "flake8>=7.3.0",
+    "mypy>=1.18.2",
     "packaging==21.3",
     "pre-commit==4.2.0",
+    "pyupgrade>=3.19.1",
     "sentry-devenv>=1.25.0",
     "tox==3.25.1",
 ]