Add docstrings to pyiceberg/table/inspect.py - #3802
Merged
Merged
Conversation
The inspect API had no docstrings. This ports the review-approved text from apache#3457 onto current main, including key_metadata on all_manifests which landed after that PR. Co-authored-by: RyukR1 <biplovsingh785@gmail.com>
entries() already documents this ValueError from _get_snapshot(); partitions() uses the same helper.
Fokko
approved these changes
Aug 15, 2026
Fokko
left a comment
Fokko
left a comment
Contributor
There was a problem hiding this comment.
Thanks for adding this @daviddallakyan2005 🙌
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #1191
Rationale for this change
InspectTableinpyiceberg/table/inspect.pyhad no docstrings. This ports the review-approved text from #3457 (RyukR1; approved by Fokko, rambleraptor, and ebyhr) onto currentmain.#3457 was CI-green and approved, then stale-closed. #3555 was a later attempt that closed unreviewed; there is no open PR.
Two docstring-only adjustments versus #3457, because
mainmoved:key_metadatacolumn onall_manifests/_get_all_manifests_schemaspec_idinpartitionsFollow-up:
partitions()Raisesnow matchesentries(). Both call_get_snapshot(), which raisesValueErrorwhen the specified snapshot is missing or the table has no snapshots andsnapshot_idisNone.No code changes. RyukR1 is credited as co-author.
Are these changes tested?
make lint— all hooks pass, including pydocstyle and mypymake test— 3929 passed, 3 skippedAre there any user-facing changes?
No behavior or API changes. Docstrings only; help text / IDE discoverability for the existing inspect methods.