Skip to content

Commit d8d2b30

Browse files
Omit empty manifest headers from lockfiles (#22070)
## Summary When a lockfile manifest contains only subtables, we write an empty `[manifest]` header even though the subtables already define their parent. Omit the header in this case and teach the fast lockfile parser to read the resulting implicit manifest. We continue to write `[manifest]` when it contains direct entries. This changes the canonical output for lockfiles with only manifest dependency groups or dependency metadata; the lockfile contents are otherwise unchanged. Prerequisite for #22010.
1 parent 77ab05f commit d8d2b30

6 files changed

Lines changed: 47 additions & 32 deletions

File tree

‎crates/uv-lock/src/lock/deserialize.rs‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,17 @@ impl<'de> DocumentMapAccess<'_, 'de> {
466466
(MapKind::Root, "[manifest]") => {
467467
Some(("manifest", Pending::Map(MapKind::Manifest), "[manifest]"))
468468
}
469+
(
470+
MapKind::Root,
471+
"[manifest.dependency-groups]" | "[[manifest.dependency-metadata]]",
472+
) => {
473+
// The manifest map consumes the first subtable when its parent is implicit.
474+
self.track_key("manifest")?;
475+
self.pending = Some(Pending::Map(MapKind::Manifest));
476+
return seed
477+
.deserialize(de::value::BorrowedStrDeserializer::new("manifest"))
478+
.map(Some);
479+
}
469480
(MapKind::Root, "[[package]]") => Some((
470481
"package",
471482
Pending::Sequence(SequenceKind::Packages),
@@ -965,6 +976,38 @@ dev = [{ name = "dependency", specifier = ">=1" }]
965976
assert_eq!(actual, expected);
966977
}
967978

979+
#[test]
980+
fn implicit_manifest_matches_toml() {
981+
for subtable in [
982+
r#"[manifest.dependency-groups]
983+
dev = [{ name = "dependency", specifier = ">=1" }]
984+
"#,
985+
r#"[[manifest.dependency-metadata]]
986+
name = "dependency"
987+
version = "1.0.0"
988+
"#,
989+
r#"[manifest.dependency-groups]
990+
dev = [{ name = "dependency", specifier = ">=1" }]
991+
992+
[[manifest.dependency-metadata]]
993+
name = "dependency"
994+
version = "1.0.0"
995+
"#,
996+
] {
997+
let input =
998+
format!("version = 1\nrevision = 3\nrequires-python = \">=3.12\"\n\n{subtable}");
999+
let expected: Lock =
1000+
toml::from_str(&input).expect("valid TOML lock with an implicit manifest");
1001+
let actual = from_str(&input).expect("implicit manifest uses the direct parser");
1002+
1003+
assert_eq!(actual, expected);
1004+
assert_eq!(
1005+
actual.to_toml().expect("lock serializes canonically"),
1006+
input
1007+
);
1008+
}
1009+
}
1010+
9681011
#[test]
9691012
fn escaped_strings_match_toml() {
9701013
let input = CANONICAL_LOCK.replace(

‎crates/uv-lock/src/lock/serialize.rs‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -222,14 +222,12 @@ fn write_manifest(writer: &mut LockWriter, manifest: &ResolverManifest) -> Resul
222222
|| !manifest.constraints.is_empty()
223223
|| !manifest.overrides.is_empty()
224224
|| !manifest.excludes.is_empty()
225-
|| !manifest.build_constraints.is_empty()
226-
|| has_dependency_groups
227-
|| !manifest.dependency_metadata.is_empty();
228-
if !has_manifest {
229-
return Ok(());
225+
|| !manifest.build_constraints.is_empty();
226+
// Subtables define their parent implicitly, so only write the header for direct entries.
227+
if has_manifest {
228+
writer.table(&["manifest"])?;
230229
}
231230

232-
writer.table(&["manifest"])?;
233231
if !manifest.members.is_empty() {
234232
writer.key_multiline_array("members", &manifest.members, |writer, member| {
235233
writer.value(member.as_ref())

‎crates/uv/tests/it/snapshots/it__ecosystem__warehouse-lock-file.snap‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ requires-python = "==3.11.*"
99
[options]
1010
exclude-newer = "2026-06-30T00:00:00Z"
1111

12-
[manifest]
13-
1412
[[manifest.dependency-metadata]]
1513
name = "psycopg-c"
1614
version = "3.2.1"

‎crates/uv/tests/lock/lock.rs‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -15038,8 +15038,6 @@ fn lock_redact_git_pep508_non_project() -> Result<()> {
1503815038
[options]
1503915039
exclude-newer = "2024-03-25T00:00:00Z"
1504015040

15041-
[manifest]
15042-
1504315041
[manifest.dependency-groups]
1504415042
dev = [{ name = "uv-private-pypackage", git = "https://github.com/astral-test/uv-private-pypackage" }]
1504515043

@@ -25860,8 +25858,6 @@ fn lock_non_project_fork() -> Result<()> {
2586025858
[options]
2586125859
exclude-newer = "2024-03-25T00:00:00Z"
2586225860

25863-
[manifest]
25864-
2586525861
[manifest.dependency-groups]
2586625862
dev = [
2586725863
{ name = "anyio", marker = "python_full_version < '3.11'", specifier = ">3" },
@@ -26035,8 +26031,6 @@ fn lock_non_project_conditional() -> Result<()> {
2603526031
[options]
2603626032
exclude-newer = "2024-03-25T00:00:00Z"
2603726033

26038-
[manifest]
26039-
2604026034
[manifest.dependency-groups]
2604126035
dev = [{ name = "anyio", marker = "sys_platform == 'linux'", specifier = ">3" }]
2604226036

@@ -26136,8 +26130,6 @@ fn lock_non_project_group() -> Result<()> {
2613626130
[options]
2613726131
exclude-newer = "2024-03-25T00:00:00Z"
2613826132

26139-
[manifest]
26140-
2614126133
[manifest.dependency-groups]
2614226134
dev = [
2614326135
{ name = "anyio" },
@@ -26268,8 +26260,6 @@ fn lock_non_project_group_standard() -> Result<()> {
2626826260
[options]
2626926261
exclude-newer = "2024-03-25T00:00:00Z"
2627026262

26271-
[manifest]
26272-
2627326263
[manifest.dependency-groups]
2627426264
dev = [{ name = "typing-extensions" }]
2627526265
lint = [{ name = "iniconfig" }]
@@ -26356,8 +26346,6 @@ fn lock_non_project_sources() -> Result<()> {
2635626346
[options]
2635726347
exclude-newer = "2024-03-25T00:00:00Z"
2635826348

26359-
[manifest]
26360-
2636126349
[manifest.dependency-groups]
2636226350
dev = [{ name = "idna", url = "https://files.pythonhosted.org/packages/d7/77/ff688d1504cdc4db2a938e2b7b9adee5dd52e34efbd2431051efc9984de9/idna-3.2-py3-none-any.whl" }]
2636326351

@@ -29984,8 +29972,6 @@ fn lock_dependency_metadata() -> Result<()> {
2998429972
[options]
2998529973
exclude-newer = "2024-03-25T00:00:00Z"
2998629974

29987-
[manifest]
29988-
2998929975
[[manifest.dependency-metadata]]
2999029976
name = "anyio"
2999129977
version = "3.7.0"
@@ -30202,8 +30188,6 @@ fn lock_dependency_metadata_git() -> Result<()> {
3020230188
[options]
3020330189
exclude-newer = "2024-03-25T00:00:00Z"
3020430190

30205-
[manifest]
30206-
3020730191
[[manifest.dependency-metadata]]
3020830192
name = "anyio"
3020930193
version = "4.6.0.post2"
@@ -46985,8 +46969,6 @@ fn lock_resolution_inputs_metadata_declarations() -> Result<()> {
4698546969
[options]
4698646970
exclude-newer = "2024-03-25T00:00:00Z"
4698746971

46988-
[manifest]
46989-
4699046972
[[manifest.dependency-metadata]]
4699146973
name = "anyio"
4699246974

@@ -47755,8 +47737,6 @@ fn lock_resolution_inputs_metadata_unknown_version() -> Result<()> {
4775547737
[options]
4775647738
exclude-newer = "2024-03-25T00:00:00Z"
4775747739

47758-
[manifest]
47759-
4776047740
[[manifest.dependency-metadata]]
4776147741
name = "child"
4776247742

‎crates/uv/tests/lock_scenarios/lock_conflict.rs‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5818,8 +5818,6 @@ fn extra_inferences() -> Result<()> {
58185818
[options]
58195819
exclude-newer = "2024-03-25T00:00:00Z"
58205820

5821-
[manifest]
5822-
58235821
[[manifest.dependency-metadata]]
58245822
name = "python-nvd3"
58255823
version = "0.16.0"

‎crates/uv/tests/project/edit.rs‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5154,8 +5154,6 @@ fn add_non_project() -> Result<()> {
51545154
[options]
51555155
exclude-newer = "2024-03-25T00:00:00Z"
51565156

5157-
[manifest]
5158-
51595157
[manifest.dependency-groups]
51605158
dev = [{ name = "iniconfig", specifier = ">=2.0.0" }]
51615159

0 commit comments

Comments
 (0)