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.1.2.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

pre_commit_uv-4.1.2-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pre_commit_uv-4.1.2.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pre_commit_uv-4.1.2.tar.gz
Algorithm Hash digest
SHA256 5e9bbcab0589900bf56c06a485f7e040801c5093b3e6f895cd33558c1c629059
MD5 2cf97e1eb57964a7494cb4e132d6b68f
BLAKE2b-256 df94c35794c3bffd4cd3cfaa9f1c862ce5ad7075795b5560b5978093a16c5ba7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pre_commit_uv-4.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9c0fafa06862e7878f90d8d976fd03f082c78b7d53e655a7f07fb26162788bd5
MD5 eaa4369f9ecf02b7080dd26c71be6f17
BLAKE2b-256 7baea48bbce0d4ead4c3547b82249ee5375d6add3db570b658ab31667b8d5d49

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