Skip to content

Omit origin when comparing requirements #9570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
charliermarsh merged 1 commit into from
Dec 2, 2024
Merged

Omit origin when comparing requirements #9570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 42 additions & 3 deletions crates/uv-pypi-types/src/requirement.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@ pub enum RequirementError {
///
/// The main change is using [`RequirementSource`] to represent all supported package sources over
/// [`VersionOrUrl`], which collapses all URL sources into a single stringly type.
#[derive(
Hash, Debug, Clone, Eq, PartialEq, Ord, PartialOrd, serde::Serialize, serde::Deserialize,
)]
#[derive(Debug, Clone, Ord, PartialOrd, serde::Serialize, serde::Deserialize)]
pub struct Requirement {
pub name: PackageName,
#[serde(skip_serializing_if = "Vec::is_empty", default)]
Expand Down Expand Up @@ -97,6 +95,47 @@ impl Requirement {
}
}

impl std::hash::Hash for Requirement {
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
let Self {
name,
extras,
marker,
source,
origin: _,
} = self;
name.hash(state);
extras.hash(state);
marker.hash(state);
source.hash(state);
}
}

impl PartialEq for Requirement {
fn eq(&self, other: &Self) -> bool {
let Self {
name,
extras,
marker,
source,
origin: _,
} = self;
let Self {
name: other_name,
extras: other_extras,
marker: other_marker,
source: other_source,
origin: _,
} = other;
name == other_name
&& extras == other_extras
&& marker == other_marker
&& source == other_source
}
}
Copy link
Member

@BurntSushi BurntSushi Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need custom Ord/PartialOrd trait impls too, right? Otherwise, those will incorporate origin for comparisons and I think result in an inconsistency with your Eq/PartialEq trait impls.

Copy link
Member

@zanieb zanieb Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Classic :D

Copy link
Member Author

@charliermarsh charliermarsh Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah this is truly classic. Thank you.


impl Eq for Requirement {}

impl From<Requirement> for uv_pep508::Requirement<VerbatimUrl> {
/// Convert a [`Requirement`] to a [`uv_pep508::Requirement`].
fn from(requirement: Requirement) -> Self {
Expand Down
2 changes: 1 addition & 1 deletion crates/uv/tests/it/tool_install.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1974,7 +1974,7 @@ fn tool_install_requirements_txt_arguments() {
----- stdout -----

----- stderr -----
Installed 2 executables: black, blackd
`black` is already installed
Copy link
Member Author

@charliermarsh charliermarsh Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As an example: we didn't detect that this install request was identical to the previous, because in this latter case, the requirement came from a requirements.txt file rather than the CLI.

"###);

let requirements_txt = context.temp_dir.child("requirements.txt");
Expand Down