Doc: Generate Arrow fallback Reference tables #63805
Draft
+2,873
−1
Conversation
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
Add documentation and tooling for Arrow method fallback behavior: - Add scripts/generate_arrow_fallback_table.py: Generator script that introspects pandas source to classify methods by their Arrow support (ARROW_NATIVE, CONDITIONAL, ELEMENTWISE, OBJECT_FALLBACK, VERSION_GATED, NOT_IMPLEMENTED). Includes --check flag for CI validation. - Add doc/source/user_guide/arrow_string_fallbacks.rst: Generated reference documenting which methods use native PyArrow compute vs falling back to Python/NumPy. Covers string, arithmetic, datetime, aggregation, array, list accessor, and struct accessor methods. - Add pre-commit hook (arrow-fallback-docs-sync) to ensure documentation stays in sync with source code changes. - Add comprehensive verification tests (204 tests) that validate classifications match actual runtime behavior. - Link new reference from pyarrow.rst user guide. - Update exclude pattern for private-import check to include scripts/tests. Co-Authored-By: Claude Opus 4.5 <[email protected]>
Replace the AST-based analysis with runtime observation: - Actually run all operations on all Arrow dtypes - Observe return types and errors - Instrument to_numpy and _apply_elementwise to detect fallbacks This approach is more accurate because it observes actual behavior rather than inferring from code analysis. Changes: - Rewrite scripts/generate_arrow_fallback_table.py using runtime tests - Update scripts/tests/test_generate_arrow_fallback_table.py for new API - Remove scripts/tests/test_arrow_fallback_verification.py (no longer needed) - Regenerate doc/source/user_guide/arrow_string_fallbacks.rst - Update pre-commit hook to use manual stage (requires pandas-dev env) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Contributor
zhengruifeng
left a comment
zhengruifeng
left a comment
There was a problem hiding this comment.
Thank you so much for working on it, it is very helpful!
Contributor
|
cc @HyukjinKwon |
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.
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.AGENTS.md.Add a script to generate documentation tracking Arrow method fallbacks in pandas. Requested by Databricks' PySpark team to identify which operations trigger Arrow-to-NumPy conversions in PySpark's pandas UDFs.
@zhengruifeng @Yicong-Huang