Python
/
uv
mirror of https://github.com/astral-sh/uv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify behavior of of overrides in CLI reference (#7537) 

## Summary
Improve the description of override-dependencies based on the statement
in `concepts/resolution.md`: "As with constraints, overrides do not add
a dependency on the package and only take effect if the package is
requested in a direct or transitive dependency."

I tested it locally, `concepts/resolution.md` is correct. It would be
better to also include this in the Reference Chapter of the docs.
This commit is contained in:
You Jiacheng 2024-09-19 20:02:42 +08:00 committed by GitHub
parent 6b08aaecad
commit a235b7d70d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/uv-workspace/src/pyproject.rs
View File

@ -230,6 +230,10 @@ pub struct ToolUv {
/// constituent packages, overrides are _absolute_, in that they completely replace the /// constituent packages, overrides are _absolute_, in that they completely replace the
/// requirements of any constituent packages. /// requirements of any constituent packages.
/// ///
/// Including a package as an override will _not_ trigger installation of the package on its
/// own; instead, the package must be requested elsewhere in the project's first-party or
/// transitive dependencies.
///
/// !!! note /// !!! note
/// In `uv lock`, `uv sync`, and `uv run`, uv will only read `override-dependencies` from /// In `uv lock`, `uv sync`, and `uv run`, uv will only read `override-dependencies` from
/// the `pyproject.toml` at the workspace root, and will ignore any declarations in other /// the `pyproject.toml` at the workspace root, and will ignore any declarations in other

4
docs/reference/settings.md
View File

@ -103,6 +103,10 @@ While constraints are _additive_, in that they're combined with the requirements
constituent packages, overrides are _absolute_, in that they completely replace the constituent packages, overrides are _absolute_, in that they completely replace the
requirements of any constituent packages. requirements of any constituent packages.
Including a package as an override will _not_ trigger installation of the package on its
own; instead, the package must be requested elsewhere in the project's first-party or
transitive dependencies.
!!! note !!! note
In `uv lock`, `uv sync`, and `uv run`, uv will only read `override-dependencies` from In `uv lock`, `uv sync`, and `uv run`, uv will only read `override-dependencies` from
the `pyproject.toml` at the workspace root, and will ignore any declarations in other the `pyproject.toml` at the workspace root, and will ignore any declarations in other