[SPARK-50753][PYTHON] Add CachedAccessor for PySpark Plotting #49394
+50
−43
Conversation
This file contains 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
zhengruifeng
previously approved these changes
Jan 7, 2025
xinrong-meng
force-pushed
the
plot_accessor
branch
from
2cbc4de to
420b86d
Compare
xinrong-meng
changed the title
xinrong-meng
changed the title
xinrong-meng
changed the title
xinrong-meng
changed the title
xinrong-meng
force-pushed
the
plot_accessor
branch
from
420b86d to
c532020
Compare
xinrong-meng
changed the title
xinrong-meng
commented
Jan 8, 2025
| T = TypeVar("T") | ||
|
|
||
|
|
||
| class CachedAccessor(Generic[T]): |
There was a problem hiding this comment.
There will be a followup to consolidate CachedAccessors between the Pandas API on Spark and the one here
xinrong-meng
commented
Jan 8, 2025
| >>> df.plot(kind="line", x="category", y=["int_val", "float_val"]) # doctest: +SKIP | ||
| """ | ||
| ... | ||
| plot: CachedAccessor = CachedAccessor("plot", "pyspark.sql.plot.core.PySparkPlotAccessor") |
There was a problem hiding this comment.
That lazy import fails doc generation
Warning, treated as error:
autodoc: failed to import class 'plot' from module 'DataFrame'; the following exception was raised:
No module named 'DataFrame'
make: *** [Makefile:35: html] Error 2
@HyukjinKwon @itholic do you happen to know how to work around this? Thank you!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What changes were proposed in this pull request?
Add CachedAccessor for PySpark Plotting.
Why are the changes needed?
Previously,
plotis defined as a property:This caused an issue where Sphinx, the documentation generator, could not recognize its chaining methods (e.g., bar, barh, etc.). As a result, it failed to populate the documentation for the available plot methods.
It should reach parity with Pandas API on Spark
Does this PR introduce any user-facing change?
No user-facing changes.
From
TO
How was this patch tested?
Existing tests.
Was this patch authored or co-authored using generative AI tooling?
No.