DEPR: Series.ptp() #21614

KalyanGokhale · 2018-06-24T15:23:53Z

xref #18262

tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

PTP

codecov · 2018-06-24T17:04:06Z

Codecov Report

Merging #21614 into master will increase coverage by 0.03%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #21614      +/-   ##
==========================================
+ Coverage    91.9%   91.93%   +0.03%     
==========================================
  Files         154      159       +5     
  Lines       49562    49734     +172     
==========================================
+ Hits        45549    45722     +173     
+ Misses       4013     4012       -1

Flag	Coverage Δ
#multiple	`90.31% <100%> (ø)`	⬆️
#single	`41.99% <0%> (+0.14%)`	⬆️

Impacted Files	Coverage Δ
pandas/core/generic.py	`96.21% <100%> (-0.01%)`	⬇️
pandas/core/indexes/datetimes.py	`95.45% <0%> (-0.22%)`	⬇️
pandas/core/indexes/timedeltas.py	`91.05% <0%> (-0.2%)`	⬇️
pandas/core/dtypes/cast.py	`88.36% <0%> (-0.13%)`	⬇️
pandas/core/indexes/accessors.py	`90.09% <0%> (-0.1%)`	⬇️
pandas/core/internals.py	`95.53% <0%> (-0.07%)`	⬇️
pandas/tseries/offsets.py	`97.15% <0%> (-0.02%)`	⬇️
pandas/core/frame.py	`97.19% <0%> (ø)`	⬆️
pandas/core/arrays/__init__.py	`100% <0%> (ø)`	⬆️
... and 31 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 36422a8...cede496. Read the comment docs.

jreback · 2018-06-25T11:00:42Z

doc/source/whatsnew/v0.24.0.txt

@@ -83,7 +83,7 @@ Deprecations
 ~~~~~~~~~~~~

 - :meth:`DataFrame.to_stata`, :meth:`read_stata`, :class:`StataReader` and :class:`StataWriter` have deprecated the ``encoding`` argument.  The encoding of a Stata dta file is determined by the file type and cannot be changed (:issue:`21244`).
-
+- :meth:`Series.ptp` is deprecated. Use numpy.ptp instead (:issue:`21614`)


you can put a reference to numpy.ptp as well

done - updated for all comments Thanks

jreback · 2018-06-25T11:01:07Z

pandas/core/generic.py

@@ -8871,8 +8871,15 @@ def _add_series_only_operations(cls):
        axis_descr, name, name2 = _doc_parms(cls)

        def nanptp(values, axis=0, skipna=True):
+            """
+            .. deprecated:: 0.24.0
+                Use numpy.ptp instead


I am not sure this is the right format for the doc-str, cc @jorisvandenbossche

Thanks - will wait for confirmation on right format from @jorisvandenbossche

Based on the other deprecation PRs I checked, this seemed to be the expected format - for other messages I had noted earlier I got Travis failures (example below from different PR submitted)

Check for deprecated messages without sphinx directive pandas/core/indexes/multi.py: DEPRECATED: to_hierarchical will be removed in a future version. Check for deprecated messages without sphinx directive DONE ... The command "ci/lint.sh" exited with 1.

Yes, this is the correct format. But, shouldn't this rather be in cls.ptp docstring passed to _make_stat_function below?
(didn't really check, but make sure that pd.Series.ptp? gives the correct docstring)

Did a quick check, and indeed adding the deprecation message does not update the actual docstring of Series.ptp, you need to add it to the argument passed to _make_stat_function a few lines below

jreback · 2018-06-25T11:01:56Z

pandas/tests/series/test_analytics.py

        s = Series([3, 5, np.nan, -3, 10])
+
+        # GH21614


make this another method. you need to catch any warnings for calling s.ptp() anywhere in the codebase, or just call np.ptp

PTP

jorisvandenbossche · 2018-06-26T07:35:58Z

pandas/core/generic.py

@@ -8871,8 +8871,15 @@ def _add_series_only_operations(cls):
        axis_descr, name, name2 = _doc_parms(cls)

        def nanptp(values, axis=0, skipna=True):
+            """
+            .. deprecated:: 0.24.0
+                Use numpy.ptp instead


Did a quick check, and indeed adding the deprecation message does not update the actual docstring of Series.ptp, you need to add it to the argument passed to _make_stat_function a few lines below

PTP

KalyanGokhale · 2018-06-26T16:55:48Z

Thanks @jorisvandenbossche have moved the docstring to _make_stat_function

jreback

can you remove from doc/api.rst as well, otherwise lgtm.

KalyanGokhale · 2018-06-28T13:11:58Z

@jreback thanks - done - all green

jreback · 2018-06-29T00:04:06Z

lgtm. @jorisvandenbossche

jorisvandenbossche · 2018-07-05T16:56:33Z

pandas/tests/series/test_analytics.py

        N = 1000
        arr = np.random.randn(N)
        ser = Series(arr)
        assert np.ptp(ser) == np.ptp(arr)

        # GH11163
        s = Series([3, 5, np.nan, -3, 10])
-        assert s.ptp() == 13
-        assert pd.isna(s.ptp(skipna=False))
+        with tm.assert_produces_warning(FutureWarning, check_stacklevel=False):


Is the check_stacklevel=False needed?

Yes - it seems to be required, not for this particular check(i.e. assert s.ptp() == 13), but for e.g. the following

tm.assert_series_equal(s.ptp(level=0), expected)

without it, this test was failing with AssertionError: Warning not set with correct stacklevel.

I also did trial-and-error with different stacklevels, without any success (though stacklevel=4 seems to be appropriate for where the warning is raised)

Any suggestions? Thanks

jorisvandenbossche · 2018-07-05T17:50:58Z

pandas/core/generic.py

+            """
+            .. deprecated:: 0.24.0
+                Use numpy.ptp instead
+            Returns the difference between the maximum value and the


This needs a blank line above this one. Can you also put the deprecated part below the text?

Thanks - Done - let me know if the deprecated note below main text needs any edits, have also added the line Use numpy.ptp instead again

jreback · 2018-07-06T02:36:34Z

pandas/core/generic.py

-            ``numpy.ndarray`` method ``ptp``.""",
+            ``numpy.ndarray`` method ``ptp``.
+
+            .. deprecated:: 0.24.0


hmm this is duplicated here

This is based on comment from @jorisvandenbossche
Can you also put the deprecated part below the text? - waiting for his reply if the edit was as expected

My bad - misinterpreted his review and duplicated in hurry - fixing now

Done thanks

2nd update removed duplicated deprecation comment

dragoljub · 2018-10-25T18:00:33Z

Just curious why Series.ptp() was deprecated? It was very useful shorthand for finding the period range of a DateTime column.

df.DATE_TIME.ptp()

Timedelta('56 days 01:04:15')

jreback · 2018-10-25T18:22:34Z

sure but it’s just one more method to maintain

KalyanGokhale added 3 commits June 24, 2018 18:54

Initial commit

6559bbf

PTP

Updated stacklevel

d643966

PTP

Updated issue number

9e72362

PTP

jreback requested changes Jun 25, 2018

View reviewed changes

jreback added the Deprecate Functionality to remove in pandas label Jun 25, 2018

jreback mentioned this pull request Jun 25, 2018

DEPR: let's deprecate #18262

Closed

34 tasks

jsexauer mentioned this pull request Jun 25, 2018

DEPR: Clean up list of deprecations from prior versions #6581

Closed

1 task

jreback added the Numeric Operations Arithmetic, Comparison, and Logical operations label Jun 25, 2018

Suppressed warnings, whatsnew

424a670

PTP

jorisvandenbossche requested changes Jun 26, 2018

View reviewed changes

KalyanGokhale added 2 commits June 26, 2018 21:41

Moved deprecation docstring, fixed tests

0028c7c

PTP

Merge branch 'master' into PTP

c25ea13

jreback added this to the 0.24.0 milestone Jun 28, 2018

jreback approved these changes Jun 28, 2018

View reviewed changes

jreback requested changes Jun 28, 2018

View reviewed changes

Update api.rst

2932a99

jreback approved these changes Jun 29, 2018

View reviewed changes

jorisvandenbossche reviewed Jul 5, 2018

View reviewed changes

Update generic.py

446c884

jreback requested changes Jul 6, 2018

View reviewed changes

Update generic.py

cede496

2nd update removed duplicated deprecation comment

jorisvandenbossche approved these changes Jul 6, 2018

View reviewed changes

jorisvandenbossche merged commit f8977a4 into pandas-dev:master Jul 6, 2018

KalyanGokhale deleted the PTP branch July 6, 2018 14:03

h-vetinari mentioned this pull request Jul 13, 2018

TST/CLN: series.duplicated; parametrisation; fix warning #21899

Merged

Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018

DEPR: Series.ptp() (pandas-dev#21614)

bd8607d

jreback mentioned this pull request Dec 26, 2019

DEPR: deprecations log for removed issues #13777

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DEPR: Series.ptp() #21614

DEPR: Series.ptp() #21614

KalyanGokhale commented Jun 24, 2018

codecov bot commented Jun 24, 2018 •

edited

Loading

jreback Jun 25, 2018

KalyanGokhale Jun 27, 2018

jreback Jun 25, 2018

KalyanGokhale Jun 25, 2018 •

edited

Loading

jorisvandenbossche Jun 25, 2018

jorisvandenbossche Jun 26, 2018

jreback Jun 25, 2018

jorisvandenbossche Jun 26, 2018

KalyanGokhale commented Jun 26, 2018

jreback left a comment

KalyanGokhale commented Jun 28, 2018

jreback commented Jun 29, 2018

jorisvandenbossche Jul 5, 2018

KalyanGokhale Jul 6, 2018 •

edited

Loading

jorisvandenbossche Jul 5, 2018

KalyanGokhale Jul 6, 2018

jreback Jul 6, 2018

KalyanGokhale Jul 6, 2018 •

edited

Loading

KalyanGokhale Jul 6, 2018

KalyanGokhale Jul 6, 2018

dragoljub commented Oct 25, 2018

jreback commented Oct 25, 2018

DEPR: Series.ptp() #21614

DEPR: Series.ptp() #21614

Conversation

KalyanGokhale commented Jun 24, 2018

codecov bot commented Jun 24, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KalyanGokhale Jun 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KalyanGokhale commented Jun 26, 2018

jreback left a comment

Choose a reason for hiding this comment

KalyanGokhale commented Jun 28, 2018

jreback commented Jun 29, 2018

Choose a reason for hiding this comment

KalyanGokhale Jul 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KalyanGokhale Jul 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dragoljub commented Oct 25, 2018

jreback commented Oct 25, 2018

codecov bot commented Jun 24, 2018 •

edited

Loading

KalyanGokhale Jun 25, 2018 •

edited

Loading

KalyanGokhale Jul 6, 2018 •

edited

Loading

KalyanGokhale Jul 6, 2018 •

edited

Loading