Go to file
konsti cabca7bf23
Fix metadata cache instability (#6332)
For a path dep such as the root project, uv can read metadata statically
from `pyproject.toml` or dynamically from the build backend.

Python's `packaging`
[sorts](cc938f984b/src/packaging/specifiers.py (L777))
specifiers before emitting them, so all build backends built on top of
it - such as hatchling - will change the specifier order compared to
pyproject.toml. The core metadata spec does say "If a field is not
marked as Dynamic, then the value of the field in any wheel built from
the sdist MUST match the value in the sdist", but it doesn't specify if
"match" means string equivalent or semantically equivalent, so it's
arguable if that spec conformant. This change means that the specifiers
have a different ordering when coming from the build backend than when
read statically from pyproject.toml.

Previously, we tried to read path dep metadata in order:
* From the (built wheel) cache (`packaging` order)
* From pyproject.toml (verbatim specifier)
* From a fresh build (`packaging` order)

This behaviour is unstable: On the first run, we cache is cold, so we
read the verbatim specifier from `pyproject.toml`, then we build and
store the metadata in the cache. On the second run, we read the
`packaging` sorted specifier from the cache.

Reproducer:

```shell
rm -rf newproj
uv init -q --no-config newproj
cd newproj/
uv add -q "anyio>=4,<5"
cat uv.lock | grep "requires-dist"
uv sync -q
cat uv.lock | grep "requires-dist"
cd ..
```

```
requires-dist = [{ name = "anyio", specifier = ">=4,<5" }]
requires-dist = [{ name = "anyio", specifier = "<5,>=4" }]
```

A project either has static metadata, so we can read from
pyproject.toml, or it doesn't, and we always read from the build through
`packaging`. We can use this to stabilize the behavior by slightly
switching the order.

* From pyproject.toml (verbatim specifier)
* From the (built wheel) cache (`packaging` order)
* From a fresh build (`packaging` order)

Potentially, we still want to sort the specifiers we get anyway, after
all, the is no guarantee that the specifiers from a build backend are
deterministic. But our metadata reading behavior should be independent
of the cache state, hence changing the order in the PR.

Fixes #6316
2024-08-21 17:18:42 +02:00
.cargo Windows: Statically linked C runtime (#3966) 2024-06-03 09:18:07 +02:00
.config Abort tests running for more than 60s to catch deadlocks (#3694) 2024-05-21 13:19:57 +00:00
.github ci: increase dev drive size 2024-08-13 08:35:46 -07:00
assets Add top-level benchmark to the README (#2622) 2024-03-22 16:07:31 -04:00
crates Fix metadata cache instability (#6332) 2024-08-21 17:18:42 +02:00
docs Update env vars doc about `XDG_*` variables on macOS (#6337) 2024-08-21 10:09:26 -05:00
ecosystem ecosystem: remove superfluous lock files 2024-08-13 08:35:46 -07:00
python/uv find uv binary relative to package root (#4336) 2024-06-14 20:02:23 -05:00
scripts Remove the preview changelog (#6259) 2024-08-20 16:47:46 +00:00
.editorconfig change indent to sensible value (#1540) 2024-02-16 16:11:26 -05:00
.gitattributes Add JSON Schema support (#3046) 2024-04-17 17:24:41 +00:00
.gitignore Add `settings.md` to docs (#5091) 2024-07-16 02:46:21 +00:00
.pre-commit-config.yaml Update pre-commit dependencies (#6195) 2024-08-19 02:33:22 +00:00
.prettierignore Resolver internals docs touchups (#5850) 2024-08-07 08:32:31 +00:00
.python-versions Respect `.python-version` in `uv venv --preview` (#4360) 2024-06-18 14:21:35 +00:00
BENCHMARKS.md Update `BENCHMARKS.md` (#6258) 2024-08-20 16:42:57 +00:00
CHANGELOG.md Add blog post to changelog (#6263) 2024-08-20 13:16:54 -05:00
CONTRIBUTING.md Use `uvx` in docs serve contributing command (#5795) 2024-08-05 12:41:22 -05:00
Cargo.lock Bump version to 0.3.0 (#6260) 2024-08-20 12:29:58 -05:00
Cargo.toml Impl `Ord` for ADD `MarkerTree` (#6253) 2024-08-20 19:11:57 +02:00
Dockerfile Include uvx binary to docker image. (#4764) 2024-07-03 07:51:55 -04:00
LICENSE-APACHE Add README and LICENSE files 2023-10-05 12:45:38 -04:00
LICENSE-MIT Add README and LICENSE files 2023-10-05 12:45:38 -04:00
PIP_COMPATIBILITY.md Move pip compatibility guide to the documentation (#6213) 2024-08-20 11:31:46 -05:00
README.md Link to Trio (#6322) 2024-08-21 07:48:52 -05:00
STYLE.md Allow user to constrain supported lock environments (#6210) 2024-08-20 13:28:04 +00:00
_typos.toml uv/tests: add new 'ecosystem' integration tests (#5970) 2024-08-13 09:48:00 -04:00
clippy.toml Improve the `uv python` CLI documentation (#5961) 2024-08-09 14:46:21 -05:00
mkdocs.insiders.yml Migrate from MdBook to MkDocs (#5062) 2024-07-15 22:22:07 +00:00
mkdocs.public.yml Move anchors validation to only the public mkdocs config (#6099) 2024-08-14 19:37:25 -05:00
mkdocs.template.yml Add link to benchmarks in documentation (#6257) 2024-08-20 12:54:46 -04:00
pyproject.toml Bump version to 0.3.0 (#6260) 2024-08-20 12:29:58 -05:00
ruff.toml uv/tests: add new 'ecosystem' integration tests (#5970) 2024-08-13 09:48:00 -04:00
rust-toolchain.toml Upgrade to Rust 1.80.0 (#5472) 2024-07-27 01:49:47 +00:00
uv.schema.json Remove `--legacy-setup-py` command-line argument (#4255) 2024-08-20 11:31:46 -05:00

README.md

uv

uv image image image Actions status Discord

An extremely fast Python package and project manager, written in Rust.

Shows a bar chart with benchmark results.

Installing Trio's dependencies with a warm cache.

Highlights

uv is backed by Astral, the creators of Ruff.

Installation

Install uv with our standalone installers, or from PyPI:

# On macOS and Linux.
$ curl -LsSf https://astral.sh/uv/install.sh | sh

# On Windows.
$ powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

# With pip.
$ pip install uv

See the installation documentation for details and alternative installation methods.

Documentation

uv's documentation is available at docs.astral.sh/uv.

Additionally, the command line reference documentation can be viewed with uv help.

Features

Project management

uv manages project dependencies and environments, with support for lockfiles, workspaces, and more, similar to rye or poetry:

$ uv init example
Initialized project `example` at `/home/user/example`

$ cd example

$ uv add ruff
Creating virtualenv at: .venv
Resolved 2 packages in 170ms
   Built example @ file:///home/user/example
Prepared 2 packages in 627ms
Installed 2 packages in 1ms
 + example==0.1.0 (from file:///home/user/example)
 + ruff==0.5.4

$ uv run ruff check
All checks passed!

See the project documentation to get started.

Tool management

uv executes and installs command-line tools provided by Python packages, similar to pipx.

Run a tool in an ephemeral environment using uvx (an alias for uv tool run):

$ uvx pycowsay 'hello world!'
Resolved 1 package in 167ms
Installed 1 package in 9ms
 + pycowsay==0.0.0.2
  """

  ------------
< hello world! >
  ------------
   \   ^__^
    \  (oo)\_______
       (__)\       )\/\
           ||----w |
           ||     ||

Install a tool with uv tool install:

$ uv tool install ruff
Resolved 1 package in 6ms
Installed 1 package in 2ms
 + ruff==0.5.4
Installed 1 executable: ruff

$ ruff --version
ruff 0.5.4

See the tools documentation to get started.

Python management

uv installs Python and allows quickly switching between versions.

Install multiple Python versions:

$ uv python install 3.10 3.11 3.12
Searching for Python versions matching: Python 3.10
Searching for Python versions matching: Python 3.11
Searching for Python versions matching: Python 3.12
Installed 3 versions in 3.42s
 + cpython-3.10.14-macos-aarch64-none
 + cpython-3.11.9-macos-aarch64-none
 + cpython-3.12.4-macos-aarch64-none

Download Python versions as needed:

$ uv venv --python 3.12.0
Using Python 3.12.0
Creating virtualenv at: .venv
Activate with: source .venv/bin/activate

$ uv run --python pypy@3.8 -- python --version
Python 3.8.16 (a9dbdca6fc3286b0addd2240f11d97d8e8de187a, Dec 29 2022, 11:45:30)
[PyPy 7.3.11 with GCC Apple LLVM 13.1.6 (clang-1316.0.21.2.5)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>>>

Use a specific Python version in the current directory:

$ uv python pin pypy@3.11
Pinned `.python-version` to `pypy@3.11`

See the Python installation documentation to get started.

Script support

uv manages dependencies and environments for single-file scripts.

Create a new script and add inline metadata declaring its dependencies:

$ echo 'import requests; print(requests.get("https://astral.sh"))' > example.py

$ uv add --script example.py requests
Updated `example.py`

Then, run the script in an isolated virtual environment:

$ uv run example.py
Reading inline script metadata from: example.py
Installed 5 packages in 12ms
<Response [200]>

See the scripts documentation to get started.

A pip-compatible interface

uv provides a drop-in replacement for common pip, pip-tools, and virtualenv commands.

uv extends their interfaces with advanced features, such as dependency version overrides, platform-independent resolutions, reproducible resolutions, alternative resolution strategies, and more.

Migrate to uv without changing your existing workflows — and experience a 10-100x speedup — with the uv pip interface.

Compile requirements into a platform-independent requirements file:

$ uv pip compile docs/requirements.in \
   --universal \
   --output-file docs/requirements.txt
Resolved 43 packages in 12ms

Create a virtual environment:

$ uv venv
Using Python 3.12.3
Creating virtualenv at: .venv
Activate with: source .venv/bin/activate

Install the locked requirements:

$ uv pip sync docs/requirements.txt
Resolved 43 packages in 11ms
Installed 43 packages in 208ms
 + babel==2.15.0
 + black==24.4.2
 + certifi==2024.7.4
 ...

See the pip interface documentation to get started.

Platform support

See uv's platform support document.

Versioning policy

See uv's versioning policy document.

Contributing

We are passionate about supporting contributors of all levels of experience and would love to see you get involved in the project. See the contributing guide to get started.

Acknowledgements

uv's dependency resolver uses PubGrub under the hood. We're grateful to the PubGrub maintainers, especially Jacob Finkelman, for their support.

uv's Git implementation is based on Cargo.

Some of uv's optimizations are inspired by the great work we've seen in pnpm, Orogene, and Bun. We've also learned a lot from Nathaniel J. Smith's Posy and adapted its trampoline for Windows support.

License

uv is licensed under either of

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in uv by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any additional terms or conditions.