5.5 KiB
Caching
Dependency caching
uv uses aggressive caching to avoid re-downloading (and re-building dependencies) that have already been accessed in prior runs.
The specifics of uv's caching semantics vary based on the nature of the dependency:
- For registry dependencies (like those downloaded from PyPI), uv respects HTTP caching headers.
- For direct URL dependencies, uv respects HTTP caching headers, and also caches based on the URL itself.
- For Git dependencies, uv caches based on the fully-resolved Git commit hash. As such,
uv pip compile
will pin Git dependencies to a specific commit hash when writing the resolved dependency set. - For local dependencies, uv caches based on the last-modified time of the source archive (i.e.,
the local
.whl
or.tar.gz
file). For directories, uv caches based on the last-modified time of thepyproject.toml
,setup.py
, orsetup.cfg
file.
If you're running into caching issues, uv includes a few escape hatches:
- To force uv to revalidate cached data for all dependencies, pass
--refresh
to any command (e.g.,uv sync --refresh
oruv pip install --refresh ...
). - To force uv to revalidate cached data for a specific dependency pass
--refresh-dependency
to any command (e.g.,uv sync --refresh-package flask
oruv pip install --refresh-package flask ...
). - To force uv to ignore existing installed versions, pass
--reinstall
to any installation command (e.g.,uv sync --reinstall
oruv pip install --reinstall ...
).
Dynamic metadata
Note that for local directory dependencies in particular (e.g., editables), uv will only reinstall
the package if its pyproject.toml
, setup.py
, or setup.cfg
file has changed. This is a
heuristic and, in some cases, may lead to fewer re-installs than desired.
For example, if a local dependency uses dynamic
metadata, you can instruct uv to always
reinstall the package by adding reinstall-package
to the uv
section of your pyproject.toml
:
[tool.uv]
reinstall-package = ["my-package"]
This will force uv to rebuild and reinstall my-package
on every run, regardless of whether the
package's pyproject.toml
, setup.py
, or setup.cfg
file has changed.
Cache safety
It's safe to run multiple uv commands concurrently, even against the same virtual environment. uv's cache is designed to be thread-safe and append-only, and thus robust to multiple concurrent readers and writers. uv applies a file-based lock to the target virtual environment when installing, to avoid concurrent modifications across processes.
Note that it's not safe to modify the uv cache (e.g., uv cache clean
) while other uv commands
are running, and never safe to modify the cache directly (e.g., by removing a file or directory).
Clearing the cache
uv provides a few different mechanisms for removing entries from the cache:
uv cache clean
removes all cache entries from the cache directory, clearing it out entirely.uv cache clean ruff
removes all cache entries for theruff
package, useful for invalidating the cache for a single or finite set of packages.uv cache prune
removes all unused cache entries. For example, the cache directory may contain entries created in previous uv versions that are no longer necessary and can be safely removed.uv cache prune
is safe to run periodically, to keep the cache directory clean.
Caching in continuous integration
It's common to cache package installation artifacts in continuous integration environments (like GitHub Actions or GitLab CI) to speed up subsequent runs.
By default, uv caches both the wheels that it builds from source and the pre-built wheels that it downloads directly, to enable high-performance package installation.
However, in continuous integration environments, persisting pre-built wheels may be undesirable. With uv, it turns out that it's often faster to omit pre-built wheels from the cache (and instead re-download them from the registry on each run). On the other hand, caching wheels that are built from source tends to be worthwhile, since the wheel building process can be expensive, especially for extension modules.
To support this caching strategy, uv provides a uv cache prune --ci
command, which removes all
pre-built wheels from the cache but retains any wheels that were built from source. We recommend
running uv cache prune --ci
at the end of your continuous integration job to ensure maximum cache
efficiency. For an example, see the
GitHub integration guide.
Cache directory
uv determines the cache directory according to, in order:
- A temporary cache directory, if
--no-cache
was requested. - The specific cache directory specified via
--cache-dir
,UV_CACHE_DIR
, ortool.uv.cache-dir
. - A system-appropriate cache directory, e.g.,
$XDG_CACHE_HOME/uv
or$HOME/.cache/uv
on Unix and%LOCALAPPDATA%\uv\cache
on Windows
!!! note
uv _always_ requires a cache directory. When `--no-cache` is requested, uv will still use
a temporary cache for sharing data within that single invocation.
In most cases, `--refresh` should be used instead of `--no-cache` — as it will update the cache
for subsequent operations but not read from the cache.
It is important for performance for the cache directory to be located on the same file system as the Python environment uv is operating on. Otherwise, uv will not be able to link files from the cache into the environment and will instead need to fallback to slow copy operations.