also make requires_dist always output

astral-sh · Jan 29, 2025 · 11d6ebd · 11d6ebd
1 parent 58d63de
commit 11d6ebd
Show file tree

Hide file tree

Showing 17 changed files with 145 additions and 84 deletions.
diff --git a/crates/uv-resolver/src/lock/mod.rs b/crates/uv-resolver/src/lock/mod.rs
@@ -998,6 +998,7 @@ impl Lock {
                 .metadata
                 .requires_dist
                 .iter()
+                .flatten()
                 .cloned()
                 .map(|requirement| normalize_requirement(requirement, root))
                 .collect::<Result<_, _>>()?;
@@ -1773,18 +1774,20 @@ impl Package {
         let sdist = SourceDist::from_annotated_dist(&id, annotated_dist)?;
         let wheels = Wheel::from_annotated_dist(annotated_dist)?;
         let requires_dist = if id.source.is_immutable() {
-            BTreeSet::default()
+            None
         } else {
-            annotated_dist
-                .metadata
-                .as_ref()
-                .expect("metadata is present")
-                .requires_dist
-                .iter()
-                .cloned()
-                .map(|requirement| requirement.relative_to(root))
-                .collect::<Result<_, _>>()
-                .map_err(LockErrorKind::RequirementRelativePath)?
+            Some(
+                annotated_dist
+                    .metadata
+                    .as_ref()
+                    .expect("metadata is present")
+                    .requires_dist
+                    .iter()
+                    .cloned()
+                    .map(|requirement| requirement.relative_to(root))
+                    .collect::<Result<_, _>>()
+                    .map_err(LockErrorKind::RequirementRelativePath)?,
+            )
         };
         let provides_extras = if id.source.is_immutable() {
             None
@@ -2411,24 +2414,22 @@ impl Package {
         {
             let mut metadata_table = Table::new();
 
-            // Always output this, even if it's an empty list
-            // (let's us treat its presence as a pseudo-lockfile-version without breaking compat)
+            // Even output the empty list to signal it's *known* empty.
             if let Some(provides_extras) = &self.metadata.provides_extras {
                 let provides_extras = provides_extras
                     .iter()
                     .map(|extra| {
                         serde::Serialize::serialize(&extra, toml_edit::ser::ValueSerializer::new())
                     })
                     .collect::<Result<Vec<_>, _>>()?;
-                // This is just a list of names, so linebreaking it is excessive
+                // This is just a list of names, so linebreaking it is excessive.
                 let provides_extras = Array::from_iter(provides_extras);
                 metadata_table.insert("provides-extras", value(provides_extras));
             }
 
-            if !self.metadata.requires_dist.is_empty() {
-                let requires_dist = self
-                    .metadata
-                    .requires_dist
+            // Even output the empty set to signal it's *known* empty.
+            if let Some(requires_dist) = &self.metadata.requires_dist {
+                let requires_dist = requires_dist
                     .iter()
                     .map(|requirement| {
                         serde::Serialize::serialize(
@@ -2655,10 +2656,10 @@ struct PackageWire {
 #[derive(Clone, Default, Debug, Eq, PartialEq, serde::Deserialize)]
 #[serde(rename_all = "kebab-case")]
 struct PackageMetadata {
+    // The Options here are so we can distinguish "no info available"
+    // from "known and empty".
     #[serde(default)]
-    requires_dist: BTreeSet<Requirement>,
-    // This is an Option<Vec<_>> so we can distinguish whether it was there or not,
-    // so we can tell if we're dealing with a lack of info or a genuinely empty list.
+    requires_dist: Option<BTreeSet<Requirement>>,
     #[serde(default)]
     provides_extras: Option<Vec<ExtraName>>,
     #[serde(default, rename = "requires-dev", alias = "dependency-groups")]

diff --git a/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__hash_optional_missing.snap b/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__hash_optional_missing.snap
@@ -86,7 +86,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },

diff --git a/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__hash_optional_present.snap b/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__hash_optional_present.snap
@@ -93,7 +93,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },

diff --git a/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__hash_required_present.snap b/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__hash_required_present.snap
@@ -89,7 +89,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },

diff --git a/...r/src/lock/snapshots/uv_resolver__lock__tests__missing_dependency_source_unambiguous.snap b/...r/src/lock/snapshots/uv_resolver__lock__tests__missing_dependency_source_unambiguous.snap
@@ -79,7 +79,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },
@@ -149,7 +149,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },

diff --git a/...ck/snapshots/uv_resolver__lock__tests__missing_dependency_source_version_unambiguous.snap b/...ck/snapshots/uv_resolver__lock__tests__missing_dependency_source_version_unambiguous.snap
@@ -79,7 +79,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },
@@ -149,7 +149,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },

diff --git a/.../src/lock/snapshots/uv_resolver__lock__tests__missing_dependency_version_unambiguous.snap b/.../src/lock/snapshots/uv_resolver__lock__tests__missing_dependency_version_unambiguous.snap
@@ -79,7 +79,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },
@@ -149,7 +149,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },

diff --git a/...es/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__source_direct_has_subdir.snap b/...es/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__source_direct_has_subdir.snap
@@ -63,7 +63,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },

diff --git a/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__source_direct_no_subdir.snap b/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__source_direct_no_subdir.snap
@@ -61,7 +61,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },

diff --git a/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__source_directory.snap b/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__source_directory.snap
@@ -56,7 +56,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },

diff --git a/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__source_editable.snap b/crates/uv-resolver/src/lock/snapshots/uv_resolver__lock__tests__source_editable.snap
@@ -56,7 +56,7 @@ Ok(
                 optional_dependencies: {},
                 dependency_groups: {},
                 metadata: PackageMetadata {
-                    requires_dist: {},
+                    requires_dist: None,
                     provides_extras: None,
                     dependency_groups: {},
                 },

diff --git a/crates/uv/tests/it/branching_urls.rs b/crates/uv/tests/it/branching_urls.rs
@@ -326,6 +326,7 @@ fn root_package_splits_transitive_too() -> Result<()> {
 
     [package.metadata]
     provides-extras = []
+    requires-dist = []
 
     [[package]]
     name = "iniconfig"
@@ -340,6 +341,7 @@ fn root_package_splits_transitive_too() -> Result<()> {
 
     [package.metadata]
     provides-extras = []
+    requires-dist = []
 
     [[package]]
     name = "sniffio"
@@ -624,6 +626,7 @@ fn branching_between_registry_and_direct_url() -> Result<()> {
 
     [package.metadata]
     provides-extras = []
+    requires-dist = []
     "#);
 
     Ok(())
@@ -702,6 +705,7 @@ fn branching_urls_of_different_sources_disjoint() -> Result<()> {
 
     [package.metadata]
     provides-extras = []
+    requires-dist = []
 
     [[package]]
     name = "iniconfig"
@@ -794,7 +798,7 @@ fn dont_pre_visit_url_packages() -> Result<()> {
     "###
     );
 
-    assert_snapshot!(context.read("uv.lock"), @r###"
+    assert_snapshot!(context.read("uv.lock"), @r#"
     version = 1
     requires-python = ">=3.11, <3.13"
 
@@ -836,7 +840,8 @@ fn dont_pre_visit_url_packages() -> Result<()> {
 
     [package.metadata]
     provides-extras = []
-    "###);
+    requires-dist = []
+    "#);
 
     Ok(())
 }