Prune unreachable wheels from lockfile #6961
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,16 @@ | ||
| use either::Either; | ||
| use itertools::Itertools; | ||
| use petgraph::graph::NodeIndex; | ||
| use petgraph::visit::EdgeRef; | ||
| use rustc_hash::{FxHashMap, FxHashSet}; | ||
| use std::borrow::Cow; | ||
| use std::collections::{BTreeMap, BTreeSet, VecDeque}; | ||
| use std::convert::Infallible; | ||
| use std::fmt::{Debug, Display}; | ||
| use std::io; | ||
| use std::path::{Path, PathBuf}; | ||
| use std::str::FromStr; | ||
| use std::sync::LazyLock; | ||
| use toml_edit::{value, Array, ArrayOfTables, InlineTable, Item, Table, Value}; | ||
| use tracing::debug; | ||
| use url::Url; | ||
|
|
@@ -50,6 +51,25 @@ mod tree; | |
| /// The current version of the lockfile format. | ||
| const VERSION: u32 = 1; | ||
|
|
||
| static LINUX_MARKERS: LazyLock<MarkerTree> = LazyLock::new(|| { | ||
| MarkerTree::from_str( | ||
| "platform_system == 'Linux' and os_name == 'posix' and sys_platform == 'linux'", | ||
| ) | ||
| .unwrap() | ||
| }); | ||
| static WINDOWS_MARKERS: LazyLock<MarkerTree> = LazyLock::new(|| { | ||
| MarkerTree::from_str( | ||
| "platform_system == 'Windows' and os_name == 'nt' and sys_platform == 'win32'", | ||
| ) | ||
| .unwrap() | ||
| }); | ||
| static MAC_MARKERS: LazyLock<MarkerTree> = LazyLock::new(|| { | ||
| MarkerTree::from_str( | ||
| "platform_system == 'Darwin' and os_name == 'posix' and sys_platform == 'darwin'", | ||
| ) | ||
| .unwrap() | ||
| }); | ||
|
|
||
| #[derive(Clone, Debug, serde::Deserialize)] | ||
| #[serde(try_from = "LockWire")] | ||
| pub struct Lock { | ||
|
|
@@ -104,8 +124,7 @@ impl Lock { | |
| .cloned() | ||
| .unwrap_or_default(); | ||
| let mut package = Package::from_annotated_dist(dist, fork_markers, root)?; | ||
| Self::remove_unreachable_wheels(graph, &requires_python, node_index, &mut package); | ||
|
|
||
| // Add all dependencies | ||
| for edge in graph.petgraph.edges(node_index) { | ||
|
|
@@ -215,12 +234,60 @@ impl Lock { | |
| } | ||
|
|
||
| /// Remove wheels that can't be selected for installation due to environment markers. | ||
| /// | ||
| /// For example, a package included under `sys_platform == 'win32'` does not need Linux | ||
| /// wheels. | ||
| fn remove_unreachable_wheels( | ||
| graph: &ResolutionGraph, | ||
| requires_python: &RequiresPython, | ||
| node_index: NodeIndex, | ||
| locked_dist: &mut Package, | ||
| ) { | ||
| // Remove wheels that don't match `requires-python` and can't be selected for installation. | ||
| locked_dist | ||
| .wheels | ||
| .retain(|wheel| requires_python.matches_wheel_tag(&wheel.filename)); | ||
|
|
||
| // Filter by platform tags. | ||
|
|
||
| // See https://github.com/pypi/warehouse/blob/ccff64920db7965078cf1fdb50f028e640328887/warehouse/forklift/legacy.py#L100-L169 | ||
| // for a list of relevant platforms. | ||
| let linux_tags = [ | ||
| "manylinux1_", | ||
| "manylinux2010_", | ||
| "manylinux2014_", | ||
| "musllinux_", | ||
| "manylinux_", | ||
| ]; | ||
| let windows_tags = ["win32", "win_arm64", "win_amd64", "win_ia64"]; | ||
|
|
||
| locked_dist.wheels.retain(|wheel| { | ||
| // Naively, we'd check whether `platform_system == 'Linux'` is disjoint, or | ||
| // `os_name == 'posix'` is disjoint, or `sys_platform == 'linux'` is disjoint (each on its | ||
| // own sufficient to exclude linux wheels), but due to | ||
| // `(A ∩ (B ∩ C) = ∅) => ((A ∩ B = ∅) or (A ∩ C = ∅))` | ||
| // a single disjointness check with the intersection is sufficient, so we have one | ||
| // constant per platform. | ||
| let reachability_markers = &graph.reachability[&node_index]; | ||
| let platform_tags = &wheel.filename.platform_tag; | ||
| if platform_tags.iter().all(|tag| { | ||
| linux_tags.into_iter().any(|linux_tag| { | ||
| // These two linux tags are allowed by warehouse. | ||
| tag.starts_with(linux_tag) || tag == "linux_armv6l" || tag == "linux_armv7l" | ||
| }) | ||
| }) { | ||
| !reachability_markers.is_disjoint(&LINUX_MARKERS) | ||
| } else if platform_tags | ||
| .iter() | ||
| .all(|tag| windows_tags.contains(&&**tag)) | ||
| { | ||
| !graph.reachability[&node_index].is_disjoint(&WINDOWS_MARKERS) | ||
| } else if platform_tags.iter().all(|tag| tag.starts_with("macosx_")) { | ||
| !graph.reachability[&node_index].is_disjoint(&MAC_MARKERS) | ||
| } else { | ||
| true | ||
| } | ||
| }); | ||
|
There was a problem hiding this comment. Can we write this in a way such that we can have test coverage for the disjointness checks? There was a problem hiding this comment. astral-sh/packse#217 should have test coverage for all cases, or did you mean something else? There was a problem hiding this comment. This looks really unit-testable. Can we have some unit tests for it? I would rather not have to go through packse just to make updates to it in the future to fix bugs. |
||
| } | ||
|
|
||
| /// Initialize a [`Lock`] from a list of [`Package`] entries. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does this work? Is this the full markers along all paths to the node?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't you need
propagate_markershere?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes
I didn't want to modify the graph and we need to consider the starting environments too, so it's separate.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don’t understand how this is correct without using marker propagation though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wdym by marker propagation? Currently,
graph.reachabilityis computed byResolutionGraph::reachability, which determines for package the set of markers it can be reached by across the whole graph. It's similar topropagate_markersexcept that we include the starting fork environments and we don't modify the graph itself so we can still use the edge weights inLock::from_resolution_graph.I'll check if we can replace
propagate_markerswith usingreachabilityor iftool.uv.environmentscauses problems with that.