Add override namespace to pyproject.toml/uv.toml #3839

Di-Is · 2024-05-26T13:42:03Z

Summary

This PR adds a new namespace, override-dependencies, to pyproject.toml/uv.toml.
This namespace assumes that the dependencies you want to override are written in the form of requirements.txt.

a example of pyproject.toml

[project]
name = "example"
version = "0.0.0"
dependencies = [
  "flask==3.0.0"
]

[tool.uv]
override-dependencies = [
  "werkzeug==2.3.0"
]

This will improve usability by allowing you to override dependencies without having to specify the --override option when running uv pip compile/install.

Test Plan

added test to crates/uv/tests/pip_compile.rs.

…p compile and pip sync.

codspeed-hq · 2024-05-26T13:50:37Z

CodSpeed Performance Report

Merging #3839 will not alter performance

_{Comparing Di-Is:add-override-namaspace-to-toml (a25f901) with main (1b769b0)}

Summary

✅ 13 untouched benchmarks

konstin · 2024-05-27T09:58:25Z

I skimmed through the diff and it looks good. To get the tests passing you need to run cargo dev generate-json-schema and commit the json change. Mark your PR as ready for review and/or comment when you want a proper review.

… was overridden in the workspace configuration.

Di-Is · 2024-05-28T12:54:15Z

@konstin
Thanks for the advice!
I was able to update the uv.schema.json successfully!

Over the next few days I added a feature to the output of the uv pip compile to show that it was overridden from the workspace configuration.

Here is an excerpt of the output from uv pip compile.

    werkzeug==2.3.0
        # via.
        # --override (from workspace)
        # flask.

However, the implementation has become more complicated with the addition of this feature.
Please review when you have time.

crates/pep508-rs/src/origin.rs

konstin · 2024-05-29T14:58:51Z

crates/pep508-rs/src/origin.rs

@@ -17,6 +19,7 @@ impl RequirementOrigin {
        match self {
            RequirementOrigin::File(path) => path.as_path(),
            RequirementOrigin::Project(path, _) => path.as_path(),
+            _ => panic!("Unsupported RequirementOrigin variant"),


Can we instead attach the file containing the override?

I understand that multiple toml files(pyproject.toml, uv.toml) are combined to obtain an override dependency.

It seems difficult to keep track of which files have which overriding dependencies.

I'll give it a thought.

Make sense! What i'd like to do is try to avoid explicit panics where possible. Sometimes they are unavoidable, sometimes so you restructure code so the codepath becomes unreachable, sometimes you add a dummy value, etc.

I changed to return dummy paths instead of panic.

766bf17#diff-a8cc5969fdef854f20c6a58c35e8727e9066c25b4625338501beda19b447ac2bR23

konstin · 2024-05-29T14:59:29Z

crates/distribution-types/src/annotation.rs

@@ -25,13 +25,22 @@ impl std::fmt::Display for SourceAnnotation {
                RequirementOrigin::Project(path, project_name) => {
                    write!(f, "{project_name} ({})", path.portable_display())
                }
+                RequirementOrigin::Workspace => panic!("Unsupported RequirementOrigin variant"),


Could you write a value here instead of panicking?

I changed so as not to cause panic.

f480a65#diff-838c9ead31fb7f2602f55cb685ca61849dffa88781386be29b84027a83b7258eR28-R30

konstin · 2024-05-29T15:03:49Z

crates/uv-workspace/src/settings.rs

@@ -37,6 +37,7 @@ pub struct Options {
    pub preview: Option<bool>,
    pub cache_dir: Option<PathBuf>,
    pub pip: Option<PipOptions>,
+    pub override_dependencies: Option<Vec<String>>,


Can you make this Option<Vec<Requirement>>? This should simplify the specification.rs code too.

I added the deserialization process and JsonSchema and changed the type to Vec<pypi_types::Reuqirement>.

JsonSchema

766bf17#diff-ef8d164011970bb55e80ae99198f0698f74e77faf77cfa76ed6ea650194cad3fR34

Deserialization

766bf17#diff-c615ba811c1d932585ca0c27d737c61469970854c4e527a9e49d73cba5bef35fR46

…ce loading process.

…r is output as a warning in addition to the file name.

…in APPDATA at test

Di-Is · 2024-06-02T13:57:28Z

crates/uv/src/main.rs

+    // enable warning before workspace loading.
+    if !cli.global_args.quiet {
+        uv_warnings::enable();
+    }
+


If the flag is not set here, warnings of workspace parsing failure will not be output.

I noticed this bug when I was creating the test.

If it is better to separate them into separate PRs, I will remove the relevant process and some of the tests.

Yeah, could you create a different PR for those please?

Di-Is · 2024-06-02T13:59:49Z

crates/uv/src/main.rs

    // Configure the `warn!` macros, which control user-facing warnings in the CLI.
-    if !globals.quiet {
+    if globals.quiet {
+        uv_warnings::disable();
+    } else {
        uv_warnings::enable();
    }


Reflect workspace quiet flag after workspace loading.
Added new uv_warnings::disable() for this process.

These should become a separate PR.

konstin · 2024-06-03T09:52:07Z

I've removed the warnings changes in this PR to keep this to only adding overrides-dependencies, if you want you can make a separate PR for the warnings changes.

charliermarsh · 2024-06-03T13:13:19Z

@konstin - How does this intersect with the existing overrides feature?

konstin · 2024-06-03T14:23:18Z

We chain them, so you can use both atm:

uv/crates/uv/src/commands/pip/compile.rs

Lines 406 to 415 in 5c77693

    
           // Merge workspace overrides. 
        
           let overrides: Vec<UnresolvedRequirementSpecification> = overrides 
        
               .iter() 
        
               .cloned() 
        
               .chain( 
        
                   overrides_from_workspace 
        
                       .into_iter() 
        
                       .map(UnresolvedRequirementSpecification::from), 
        
               ) 
        
               .collect();

Resolves #4467. ## Summary This PR implements the following 1. Add `tool.uv.constraint-dependencies` to pyproject.toml 1. Support to refer `tool.uv.constraint-dependencies` in `uv lock` 1. Support to refer `tool.uv.constraint-dependencies` in `uv pip compile/install` These are analogues of the override features implemented in #3839 and #4369. ## Test Plan Add test.

Di-Is and others added 10 commits May 11, 2024 04:08

add: read override deps from pyproject.toml

c710baf

Merge branch 'astral-sh:main' into main

495742f

Merge branch 'astral-sh:main' into main

8957082

Merge branch 'astral-sh:main' into main

cc21e5c

Merge branch 'main' of https://github.com/Di-Is/uv

826a780

Merge branch 'astral-sh:main' into main

40120da

Merge branch 'astral-sh:main' into main

52e8e8e

add: add override dependency cfg to workspace setting and refer in pi…

20404a4

…p compile and pip sync.

refactor: fmt

6b49349

refactor: clippy

758ee9f

Di-Is marked this pull request as draft May 26, 2024 13:50

remove: del unnecessary changes

d3e91b0

Di-Is and others added 4 commits May 28, 2024 18:09

Merge branch 'astral-sh:main' into add-override-namaspace-to-toml

7561375

change: include in the result of uv pip compile that the dependency…

0948908

… was overridden in the workspace configuration.

refactor: lint

f8d14e6

remove: del unnecessary changes

2603cb6

Di-Is marked this pull request as ready for review May 28, 2024 12:54

Di-Is changed the title ~~Add override namaspace to pyproject.toml/uv.toml~~ Add override namespace to pyproject.toml/uv.toml May 28, 2024

Merge branch 'main' into add-override-namaspace-to-toml

a831968

konstin reviewed May 29, 2024

View reviewed changes

Di-Is and others added 7 commits May 31, 2024 19:28

Merge branch 'astral-sh:main' into add-override-namaspace-to-toml

b978b72

change: Deserialize override-dependencies to pypi_type::Requirement.

766bf17

change: Output message instead of panic

f480a65

fix: Fixed a bug in which warnings were not output during the workspa…

1a3ae34

…ce loading process.

update: If parsing fails in workspace config, the content of the erro…

9cd27d0

…r is output as a warning in addition to the file name.

fix: update test to change warnings log output.

7315624

fix: provide path compatibility with windows.

e298bc6

change: omit testing in windows due to difficulty in placing uv.toml …

1cedbed

…in APPDATA at test

Di-Is commented Jun 2, 2024

View reviewed changes

Di-Is requested a review from konstin June 2, 2024 14:02

konstin added 3 commits June 3, 2024 11:42

Simplify code

2723db9

Remove warning changes

a695cbf

These should become a separate PR.

Add TODO comment

a25f901

konstin approved these changes Jun 3, 2024

View reviewed changes

konstin merged commit 5c77693 into astral-sh:main Jun 3, 2024
46 checks passed

Di-Is deleted the add-override-namaspace-to-toml branch July 19, 2024 06:29

Di-Is mentioned this pull request Jul 21, 2024

Add constraint dependencies to pyproject.toml #5248

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add override namespace to pyproject.toml/uv.toml #3839

Add override namespace to pyproject.toml/uv.toml #3839

Di-Is commented May 26, 2024

codspeed-hq bot commented May 26, 2024 •

edited

Loading

konstin commented May 27, 2024

Di-Is commented May 28, 2024 •

edited

Loading

konstin May 29, 2024

Di-Is May 30, 2024

konstin May 31, 2024

Di-Is Jun 2, 2024 •

edited

Loading

konstin May 29, 2024

Di-Is Jun 2, 2024 •

edited

Loading

konstin May 29, 2024

Di-Is Jun 2, 2024

Di-Is Jun 2, 2024

Di-Is Jun 2, 2024

konstin Jun 3, 2024

Di-Is Jun 2, 2024

konstin commented Jun 3, 2024

charliermarsh commented Jun 3, 2024

konstin commented Jun 3, 2024

Add override namespace to pyproject.toml/uv.toml #3839

Add override namespace to pyproject.toml/uv.toml #3839

Conversation

Di-Is commented May 26, 2024

Summary

Test Plan

codspeed-hq bot commented May 26, 2024 • edited Loading

Merging #3839 will not alter performance

Summary

konstin commented May 27, 2024

Di-Is commented May 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Di-Is Jun 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Di-Is Jun 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JsonSchema

Deserialization

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

konstin commented Jun 3, 2024

charliermarsh commented Jun 3, 2024

konstin commented Jun 3, 2024

codspeed-hq bot commented May 26, 2024 •

edited

Loading

Di-Is commented May 28, 2024 •

edited

Loading

Di-Is Jun 2, 2024 •

edited

Loading

Di-Is Jun 2, 2024 •

edited

Loading