mirrors/uv
1
0
Fork 0
mirror of https://github.com/astral-sh/uv.git synced 2025-07-07 13:25:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Expand documentation in scripts/bench/__main__.py (#2875)

Browse source 
Closes https://github.com/astral-sh/uv/issues/1318.
This commit is contained in:
Charlie Marsh 2024-04-07 22:48:12 -04:00 • committed by GitHub
parent f5334a4914
commit e109e02b12
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 41 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

48
scripts/bench/__main__.py
View file

@ -1,11 +1,11 @@
"""Benchmark uv against other packaging tools.
This script assumes that `pip`, `pip-tools`, `virtualenv`, `poetry` and `hyperfine` are
installed, and that a uv release builds exists at `./target/release/uv`
(relative to the repository root).
This script assumes that Python 3.12 is installed.
By default, this script also assumes that `pip`, `pip-tools`, `virtualenv`, `poetry` and
`hyperfine` are installed, and that a uv release builds exists at `./target/release/uv`
(relative to the repository root). However, the set of tools is configurable.
To set up the required environment, run:
cargo build --release
@ -13,17 +13,51 @@ To set up the required environment, run:
source .venv/bin/activate
./target/release/uv pip sync ./scripts/bench/requirements.txt
Example usage:
Then, to benchmark uv against `pip-tools`:
python -m scripts.bench --uv --pip-compile requirements.in
Multiple versions of uv can be benchmarked by specifying the path to the binary for
each build, as in:
It's most common to benchmark multiple uv versions against one another by building
from multiple branches and specifying the path to each binary, as in:
# Build the baseline version.
git checkout main
cargo build --release
mv ./target/release/uv ./target/release/baseline
# Build the feature version.
git checkout feature
cargo build --release
# Run the benchmark.
python -m scripts.bench \
--uv-path ./target/release/uv \
--uv-path ./target/release/baseline \
requirements.in
By default, the script will run the resolution benchmarks when a `requirements.in` file
is provided, and the installation benchmarks when a `requirements.txt` file is provided:
# Run the resolution benchmarks against the Trio project.
python -m scripts.bench \
--uv-path ./target/release/uv \
--uv-path ./target/release/baseline \
./scripts/requirements/trio.in
# Run the installation benchmarks against the Trio project.
python -m scripts.bench \
--uv-path ./target/release/uv \
--uv-path ./target/release/baseline \
./scripts/requirements/compiled/trio.txt
You can also specify the benchmark to run explicitly:
# Run the "uncached install" benchmark against the Trio project.
python -m scripts.bench \
--uv-path ./target/release/uv \
--uv-path ./target/release/baseline \
--benchmark install-cold \
./scripts/requirements/compiled/trio.txt
"""
import abc