Skip to main content

Run pre-commit with uv

Project description

pre-commit-uv

PyPI PyPI - Implementation PyPI - Python Version Downloads PyPI - License check

Use uv to create virtual environments and install packages for pre-commit.

Installation

With pipx:

pipx install pre-commit
pipx inject pre-commit pre-commit-uv

With uv:

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):

 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pre_commit_uv-4.0.2.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

pre_commit_uv-4.0.2-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file pre_commit_uv-4.0.2.tar.gz.

File metadata

  • Download URL: pre_commit_uv-4.0.2.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for pre_commit_uv-4.0.2.tar.gz
Algorithm Hash digest
SHA256 cef7b60ed289051dc87b7b26292274620db411915c659d62fd936cbee5c88b60
MD5 922ff605151c75c239aa4cc105527e4e
BLAKE2b-256 f18310bdc5a4d8a7c84deea546a598891f45126f3b4a586a7c914a9fc521b682

See more details on using hashes here.

File details

Details for the file pre_commit_uv-4.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pre_commit_uv-4.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f28c0a56a48261b678873f9dca45f78dd749a230e0ab9672d946dadfd18408ae
MD5 e982ffeabf599d20a02a0fc5bdcdeef5
BLAKE2b-256 77e7c01627c82dd7bbd4e7e582329bfad4dc18f0b57aaf768627dc6b33ed7773

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page