Skip to content

Commit

Permalink
Warn when patch isn't specified (#7959)
Browse files Browse the repository at this point in the history
When patch version isn't specified and a matching version is referenced,
it will default patch to 0 which could be unclear/confusing. This PR
warns the user of that default.

<!--
Thank you for contributing to uv! To help us out with reviewing, please
consider the following:

- Does this pull request include a summary of the change? (See below.)
- Does this pull request include a descriptive title?
- Does this pull request include references to any relevant issues?
-->

## Summary

<!-- What's the purpose of the change? What does it do, and why? -->

The first part of this issue
#7426. Will tackle the second part
mentioned (`~=`) in a separate PR once I know this is the correct way to
warn users.

## Test Plan

<!-- How was it tested? -->

Unit tests were added

---------

Co-authored-by: Zanie Blue <[email protected]>
  • Loading branch information
ianpaul10 and zanieb authored Oct 16, 2024
1 parent 999b3f0 commit e71b1d0
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 0 deletions.
12 changes: 12 additions & 0 deletions crates/uv-resolver/src/requires_python.rs
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,18 @@ impl RequiresPython {
self.range.lower().as_ref() == Bound::Unbounded
}

/// Returns `true` if the `Requires-Python` specifier is set to an exact version
/// without specifying a patch version. (e.g. `==3.10`)
pub fn is_exact_without_patch(&self) -> bool {
match self.range.lower().as_ref() {
Bound::Included(version) => {
version.release().len() == 2
&& self.range.upper().as_ref() == Bound::Included(version)
}
_ => false,
}
}

/// Returns the [`RequiresPythonBound`] truncated to the major and minor version.
pub fn bound_major_minor(&self) -> LowerBound {
match self.range.lower().as_ref() {
Expand Down
22 changes: 22 additions & 0 deletions crates/uv-resolver/src/requires_python/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,25 @@ fn upper_bound_ordering() {
}
}
}

#[test]
fn is_exact_without_patch() {
let test_cases = [
("==3.12", true),
("==3.10, <3.11", true),
("==3.10, <=3.11", true),
("==3.12.1", false),
("==3.12.*", false),
("==3.*", false),
(">=3.10", false),
(">3.9", false),
("<4.0", false),
(">=3.10, <3.11", false),
("", false),
];
for (version, expected) in test_cases {
let version_specifiers = VersionSpecifiers::from_str(version).unwrap();
let requires_python = RequiresPython::from_specifiers(&version_specifiers).unwrap();
assert_eq!(requires_python.is_exact_without_patch(), expected);
}
}
2 changes: 2 additions & 0 deletions crates/uv/src/commands/project/lock.rs
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,8 @@ async fn do_lock(
let default =
RequiresPython::greater_than_equal_version(&interpreter.python_minor_version());
warn_user_once!("The workspace `requires-python` value does not contain a lower bound: `{requires_python}`. Set a lower bound to indicate the minimum compatible Python version (e.g., `{default}`).");
} else if requires_python.is_exact_without_patch() {
warn_user_once!("The workspace `requires-python` value contains an exact match without a patch version: `{requires_python}`. When omitted, the patch version is implicitly `0`, e.g., `{requires_python}.0`. Did you mean `{requires_python}.*`?");
}
requires_python
} else {
Expand Down
2 changes: 2 additions & 0 deletions crates/uv/tests/it/lock.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3530,6 +3530,7 @@ fn lock_requires_python_exact() -> Result<()> {

----- stderr -----
Using CPython 3.12.[X]
warning: The workspace `requires-python` value contains an exact match without a patch version: `==3.12`. When omitted, the patch version is implicitly `0`, e.g., `==3.12.[X]`. Did you mean `==3.12.*`?
Resolved 2 packages in [TIME]
"###);

Expand Down Expand Up @@ -3586,6 +3587,7 @@ fn lock_requires_python_exact() -> Result<()> {

----- stderr -----
Using CPython 3.12.[X]
warning: The workspace `requires-python` value contains an exact match without a patch version: `==3.12`. When omitted, the patch version is implicitly `0`, e.g., `==3.12.[X]`. Did you mean `==3.12.*`?
Resolved 2 packages in [TIME]
"###);

Expand Down

0 comments on commit e71b1d0

Please sign in to comment.