8000 DEPR: Deprecate ravel by phofl · Pull Request #56053 · pandas-dev/pandas · GitHub
[go: up one dir, main page]
Skip to content

DEPR: Deprecate ravel #56053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jorisvandenbossche merged 15 commits into from
Nov 27, 2023
Merged

DEPR: Deprecate ravel #56053

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
b2f2774
DEP: Deprecate ravel
phofl Nov 18, 2023
41f31aa
Merge branch 'main' into dep_ravel
phofl Nov 19, 2023
dd9cfe6
Fix ravel deprecations
phofl Nov 19, 2023
054ca87
Update pivot.py
phofl Nov 19, 2023
5a15389
Fix doctest
phofl Nov 19, 2023
28fb76c
Fix view
phofl Nov 19, 2023
636e3c4
Fix
phofl Nov 20, 2023
d48e5ca
Update
phofl Nov 21, 2023
146e1aa
Update whatsnew
phofl Nov 21, 2023
5be6f6c
Merge branch 'main' into dep_ravel
phofl Nov 21, 2023
571bc1a
FIx
phofl Nov 21, 2023
d54a80c
Add note
phofl Nov 21, 2023
cf79da9
Merge branch 'main' into dep_ravel
phofl Nov 24, 2023
4afe81c
Update pandas/core/series.py
jorisvandenbossche Nov 27, 2023
bd292ad
Merge branch 'main' into dep_ravel
jorisvandenbossche Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix view
  • Loading branch information
@phofl
phofl committed Nov 19, 2023
commit 28fb76c43074492123e058302d84e8c76d2550fc
10 changes: 5 additions & 5 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -861,6 +861,11 @@ def ravel(self, order: str = "C") -> ArrayLike:
>>> s.ravel() # doctest: +SKIP
array([1, 2, 3])
"""
warnings.warn(
"Series.ravel is deprecated. Use numpy.ravel directly.",
Copy link
Member
@jorisvandenbossche jorisvandenbossche Nov 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe we should also point to to_numpy() in case people use this to essentially get the numpy series (the "ravel" aspect never does something, since Series is already 1D)

Copy link
Member
@jbrockmendel jbrockmendel Nov 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or just "dont do it bc it isnt necessary"? (also should we deprecate Index.ravel?)

Copy link
Member Author
@phofl phofl Nov 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes and yes

Copy link
Member
@jorisvandenbossche jorisvandenbossche Nov 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or just "dont do it bc it isnt necessary"?

That's not necessarily correct. If you rely on the current return value, i.e. if your code requires that the object is a 1D numpy array, and you currently use ravel for that, you do need to replace ravel with a conversion to numpy.
(and that's actually how we were implicitly using it internally)

FutureWarning,
stacklevel=find_stack_level(),
Copy link
Member
@jorisvandenbossche jorisvandenbossche Nov 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
stacklevel=find_stack_level(),
stacklevel=2,

For a simple case like this where the warning is directly raised in the top-level method, I prefer setting it explicitly, which avoids potential hickups with the function (I think we had perf issues in certain cases, and this also avoids getting a wrong stacklevel in case we forget a use case of ravel in our own code base)

Copy link
Member Author
@phofl phofl Nov 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

)
arr = self._values.ravel(order=order)
if isinstance(arr, np.ndarray) and using_copy_on_write():
arr.flags.writeable = False
Expand Down Expand Up @@ -938,11 +943,6 @@ def view(self, dtype: Dtype | None = None) -> Series:
4 2
dtype: int8
"""
warnings.warn(
"Series.view is deprecated and will be removed in a future version.",
FutureWarning,
stacklevel=find_stack_level(),
)
# self.array instead of self._values so we piggyback on NumpyExtensionArray
# implementation
res_values = self.array.view(dtype)
Expand Down
0