feat: warn the deprecated max_download_size, random_state and sampling_method parameters in (DataFrame|Series).to_pandas()#1573
Merged
chelsea-lin merged 6 commits intomainfrom Apr 8, 2025
Conversation
d13bd11 to
74be48d
Compare
random_state and sampling_method parameters and in (DataFrame|Series).to_pandas()
random_state and sampling_method parameters and in (DataFrame|Series).to_pandas()random_state and sampling_method parameters in (DataFrame|Series).to_pandas()
74be48d to
d41fea1
Compare
d41fea1 to
18661bb
Compare
d60123c to
9711b83
Compare
random_state and sampling_method parameters in (DataFrame|Series).to_pandas()max_download_size, random_state and sampling_method parameters in (DataFrame|Series).to_pandas()
tswast
reviewed
Apr 3, 2025
Collaborator
tswast
left a comment
There was a problem hiding this comment.
Looks like theres some typos in the docstrings. Please fix.
bigframes/dataframe.py
Outdated
| Args: | ||
| max_download_size (int, default None): | ||
| .. deprecated:: 2.0.0 | ||
| `max_download_size` parameter is deprecated. Please use `to_pandas_batch()` method |
Collaborator
There was a problem hiding this comment.
Nit: RST uses two backticks for code format. One is italics.
Suggested change
| `max_download_size` parameter is deprecated. Please use `to_pandas_batch()` method | |
| ``max_download_size`` parameter is deprecated. Please use ``to_pandas_batches()`` method |
Contributor
Author
There was a problem hiding this comment.
Good catches. Fixed!
bigframes/dataframe.py
Outdated
| if max_download_size is not None: | ||
| msg = bfe.format_message( | ||
| "DEPRECATED: The `max_download_size` parameters for `DataFrame.to_pandas()` " | ||
| "are deprecated and will be removed soon. Please use `DataFrame.to_pandas_batch()`." |
Collaborator
There was a problem hiding this comment.
Suggested change
| "are deprecated and will be removed soon. Please use `DataFrame.to_pandas_batch()`." | |
| "are deprecated and will be removed soon. Please use ``DataFrame.to_pandas_batches()``." |
Contributor
Author
There was a problem hiding this comment.
Good catches. Fixed!
f64c060 to
ea82a5b
Compare
38a085b to
c1d379d
Compare
c1d379d to
626d432
Compare
tswast
approved these changes
Apr 8, 2025
Collaborator
tswast
left a comment
There was a problem hiding this comment.
Thanks!
I added a commit to use FutureWarning instead of UserWarning. See: https://docs.python.org/3/library/exceptions.html#FutureWarning
Per https://stackoverflow.com/a/55378483/101923 both DeprecationWarning and PendingDeprecationWarning are ignored by default, so FutureWarning is the most appropriate for bigframes which is used in notebooks and won't necessarily have pytest test code or similar where the deprecation warnings would be seen.
83fb83f to
a22a470
Compare
9f72eb5 to
a22a470
Compare
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
4 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.
Fixes internal issue 391676515 🦕