Skip to content

Allow snapshot-id in assert-ref-snapshot-id requirement to serialize to null in json #2343

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
kevinjqliu merged 5 commits into from
Aug 19, 2025
Merged

Allow snapshot-id in assert-ref-snapshot-id requirement to serialize to null in json #2343

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
43774b7
Allow snapshot-id in assert-ref-snapshot-id requirement to serialize …
ox Aug 18, 2025
fc39204
remove exclude from Field
ox Aug 19, 2025
4a62692
Simplify
Fokko Aug 19, 2025
cf5a1f3
Simplify
Fokko Aug 19, 2025
499b8af
Make the linter happy
Fokko Aug 19, 2025
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
7 changes: 7 additions & 0 deletions pyiceberg/table/update/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -756,6 +756,13 @@ def validate(self, base_metadata: Optional[TableMetadata]) -> None:
elif self.snapshot_id is not None:
raise CommitFailedException(f"Requirement failed: branch or tag {self.ref} is missing, expected {self.snapshot_id}")

# override the override method, allowing None to serialize to `null` instead of being omitted.
def model_dump_json(
self, exclude_none: bool = False, exclude: Optional[Set[str]] = None, by_alias: bool = True, **kwargs: Any
) -> str:
return super().model_dump_json(
exclude_none=exclude_none, exclude=self._exclude_private_properties(exclude), by_alias=by_alias, **kwargs
)
Copy link
Copy Markdown
Contributor

@kevinjqliu kevinjqliu Aug 19, 2025

Choose a reason for hiding this comment

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

nit: i think we can simply this to

    def model_dump_json(self) -> str:
        # `snapshot-id` is required in json response, even if null
        return super().model_dump_json(exclude_none=False)


class AssertLastAssignedFieldId(ValidatableTableRequirement):
"""The table's last assigned column id must match the requirement's `last-assigned-field-id`."""
Expand Down
5 changes: 5 additions & 0 deletions tests/table/test_init.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1039,6 +1039,11 @@ def test_assert_ref_snapshot_id(table_v2: Table) -> None:
):
AssertRefSnapshotId(ref="test", snapshot_id=3055729675574597004).validate(base_metadata)

expected_json = """{"type":"assert-ref-snapshot-id","ref":"main","snapshot-id":null}"""
assert_json = AssertRefSnapshotId(ref="main").model_dump_json()
print(assert_json)
assert assert_json == expected_json


def test_assert_last_assigned_field_id(table_v2: Table) -> None:
base_metadata = table_v2.metadata
Expand Down
Loading