Repository navigation
GH-51265: [Python] Refactor and centralize duplicated reader docstrin… - #51630
Open
MarkCruz911 wants to merge 1 commit into
Open
MarkCruz911 wants to merge 1 commit into
MarkCruz911 wants to merge 1 commit into
Conversation
…cstrings in parquet/core.py
|
|
Author
raulcd
reviewed
Oct 6, 2026
raulcd
left a comment
raulcd
left a comment
Member
There was a problem hiding this comment.
We seem to be using already _read_docstring_common on lots of them, can't this be part of that?
It seems wrong to have both _read_docstring_common and a new _READER_COMMON_DOCS
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.
Rationale for this change
This PR resolves issue #51265 by refactoring duplicated reader docstrings in
python/pyarrow/parquet/core.pyto adhere to DRY (Don't Repeat Yourself) principles.What changes are included in this PR?
thrift_string_size_limit,thrift_container_size_limit, andschema_depth_limitinto a module-level constant_READER_COMMON_DOCS.ParquetFile,ParquetDataset, and_read_table_docstringwith{_READER_COMMON_DOCS}f-string interpolation.Are these changes tested?
Yes, verified syntax validity and confirmed via
git diffandgrepchecks that duplicated string blocks were eliminated without changing the end-user documentation output.Are there any user-facing changes?
No. Rendered documentation and API signatures remain identical.
Was AI used for this PR?
PR code and description written by:
Reviewed before submission by: