DEPR: deprecate integer add/sub with DTI/TDI/PI/Timestamp/Period

doc/source/whatsnew/v0.24.0.txt

@@ -990,17 +990,17 @@ Current Behavior:
 
 .. ipython:: python
 
-    In [3]: per = pd.Period('2016Q1')
-    In [4]: per + 3 * per.freq
+    per = pd.Period('2016Q1')
+    per + 3 * per.freq
 
-    In [5]: ts = pd.Timestamp('1994-05-06 12:15:16', freq=pd.offsets.Hour())
-    In [6]: ts + 2 * ts.freq
+    ts = pd.Timestamp('1994-05-06 12:15:16', freq=pd.offsets.Hour())
+    ts + 2 * ts.freq
 
-    In [7]: tdi = pd.timedelta_range('1D', periods=2)
-    In [8]: tdi - np.array([2 * tdi.freq, 1 * tdi.freq])
+    tdi = pd.timedelta_range('1D', periods=2)
+    tdi - np.array([2 * tdi.freq, 1 * tdi.freq])
 
-    In [9]: dti = pd.date_range('2001-01-01', periods=2, freq='7D')
-    In [10]: dti + pd.Index([1 * dti.freq, 2 * dti.freq])
+    dti = pd.date_range('2001-01-01', periods=2, freq='7D')
+    dti + pd.Index([1 * dti.freq, 2 * dti.freq])
 
 .. _whatsnew_0240.prior_deprecations:
 

pandas/_libs/tslibs/period.pyx

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 from datetime import datetime, date
-import warnings
 
 from cpython cimport (
     PyUnicode_Check,
@@ -34,7 +33,7 @@ cdef extern from "src/datetime/np_datetime.h":
 cimport util
 from util cimport is_period_object, is_string_object
 
-from timestamps import Timestamp
+from timestamps import Timestamp, int_op_deprecated
 from timezones cimport is_utc, is_tzlocal, get_dst_info
 from timedeltas import Timedelta
 from timedeltas cimport delta_to_nanoseconds
@@ -1646,12 +1645,7 @@ cdef class _Period(object):
             elif other is NaT:
                 return NaT
             elif util.is_integer_object(other):
-                warnings.warn("Addition of integers to {cls} is "
-                              "deprecated, will be removed in a future "
-                              "version.  Instead of adding `n`, add "
-                              "`n * self.freq`"
-                              .format(cls=type(self).__name__),
-                              FutureWarning)
+                int_op_deprecated(self)
 
                 ordinal = self.ordinal + other * self.freq.n
                 return Period(ordinal=ordinal, freq=self.freq)
@@ -1679,12 +1673,7 @@ cdef class _Period(object):
                 neg_other = -other
                 return self + neg_other
             elif util.is_integer_object(other):
-                warnings.warn("Subtraction of integers from {cls} is "
-                              "deprecated, will be removed in a future "
-                              "version.  Instead of subtracting `n`, subtract "
-                              "`n * self.freq`"
-                              .format(cls=type(self).__name__),
-                              FutureWarning)
+                int_op_deprecated(self)
 
                 ordinal = self.ordinal - other * self.freq.n
                 return Period(ordinal=ordinal, freq=self.freq)

pandas/_libs/tslibs/timestamps.pyx

@@ -40,8 +40,19 @@ from timezones cimport (
 _zero_time = datetime_time(0, 0)
 _no_input = object()
 
+
 # ----------------------------------------------------------------------
 
+def int_op_deprecated(obj):
+    # GH#22535 add/sub of integers and int-arrays is deprecated
+    if obj.freq is not None:
+        warnings.warn("Addition/subtraction of integers and integer-arrays "
+                      "to {cls} is deprecated, will be removed in a future "
+                      "version.  Instead of adding/subtracting `n`, use "
+                      "`n * self.freq`"
+                      .format(cls=type(obj).__name__),
+                      FutureWarning)
+
 
 cdef inline object create_timestamp_from_ts(int64_t value,
                                             npy_datetimestruct dts,
@@ -324,13 +335,7 @@ cdef class _Timestamp(datetime):
                              tz=self.tzinfo, freq=self.freq)
 
         elif is_integer_object(other):
-            if self.freq is not None:
-                warnings.warn("Addition of integers to {cls} is "
-                              "deprecated, will be removed in a future "
-                              "version.  Instead of adding `n`, add "
-                              "`n * self.freq`"
-                              .format(cls=type(self).__name__),
-                              FutureWarning)
+            int_op_deprecated(self)
 
             if self is NaT:
                 # to be compat with Period

pandas/core/arrays/datetimelike.py

@@ -8,6 +8,7 @@
 from pandas._libs import lib, iNaT, NaT
 from pandas._libs.tslibs import timezones
 from pandas._libs.tslibs.timedeltas import delta_to_nanoseconds, Timedelta
+from pandas._libs.tslibs.timestamps import int_op_deprecated
 from pandas._libs.tslibs.period import (
     Period, DIFFERENT_FREQ_INDEX, IncompatibleFrequency)
 
@@ -494,16 +495,8 @@ def _addsub_int_array(self, other, op, suppress=False):
         assert not is_period_dtype(self)
         assert op in [operator.add, operator.sub]
 
-        if self.freq is not None and not suppress:
-            # case with freq of None will raise
-            # we need to use a different stacklevel for Index vs Array
-            lvl = 3 + 1 * isinstance(self, ABCIndexClass)
-            warnings.warn("Addition/subtraction of integer array from {cls} "
-                          "is deprecated, will be removed in a future "
-                          "version.  Instead of adding `arr`, "
-                          "add `arr * self.freq`"
-                          .format(cls=type(self).__name__),
-                          FutureWarning, stacklevel=lvl)
+        if not suppress:
+            int_op_deprecated(self)
 
         if self.freq is None:
             # GH#19123
@@ -647,17 +640,7 @@ def __add__(self, other):
             elif lib.is_integer(other):
                 # This check must come after the check for np.timedelta64
                 # as is_integer returns True for these
-                if self.freq is not None:
-                    # case with freq of None will raise
-                    # we need to use a different stacklevel for Index vs Array
-                    lvl = 2 + 1 * isinstance(self, ABCIndexClass)
-                    warnings.warn("Addition of integers to {cls} is "
-                                  "deprecated, will be removed in a future "
-                                  "version.  Instead of adding `n`, "
-                                  "add `n * self.freq`"
-                                  .format(cls=type(self).__name__),
-                                  FutureWarning, stacklevel=lvl)
-
+                int_op_deprecated(self)
                 result = self._time_shift(other)
 
             # array-like others
@@ -716,17 +699,7 @@ def __sub__(self, other):
             elif lib.is_integer(other):
                 # This check must come after the check for np.timedelta64
                 # as is_integer returns True for these
-                if self.freq is not None:
-                    # case with freq of None will raise
-                    # we need to use a different stacklevel for Index vs Array
-                    lvl = 2 + 1 * isinstance(self, ABCIndexClass)
-                    warnings.warn("Subtraction of integers from {cls} is "
-                                  "deprecated, will be removed in a future "
-                                  "version.  Instead of subtracting `n`, "
-                                  "subtract `n * self.freq`"
-                                  .format(cls=type(self).__name__),
-                                  FutureWarning, stacklevel=lvl)
-
+                int_op_deprecated(self)
                 result = self._time_shift(-other)
 
             elif isinstance(other, Period):

pandas/core/arrays/period.py

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 from datetime import timedelta
 import operator
-import warnings
 
 import numpy as np
 
@@ -14,6 +13,7 @@
 )
 from pandas._libs.tslibs import period as libperiod
 from pandas._libs.tslibs.timedeltas import delta_to_nanoseconds, Timedelta
+from pandas._libs.tslibs.timestamps import int_op_deprecated
 from pandas._libs.tslibs.fields import isleapyear_arr
 from pandas.util._decorators import cache_readonly, Appender
 from pandas.util._validators import validate_fillna_kwargs
@@ -726,12 +726,7 @@ def _addsub_int_array(
         # type: (...) -> PeriodArray
 
         if not suppress:
-            warnings.warn("Addition/subtraction of integer array from {cls} "
-                          "is deprecated, will be removed in a future "
-                          "version.  Instead of adding `arr`, "
-                          "add `arr * self.freq`"
-                          .format(cls=type(self).__name__),
-                          FutureWarning, stacklevel=3)
+            int_op_deprecated(self)
 
         assert op in [operator.add, operator.sub]
         if op is operator.sub:

pandas/tests/indexes/datetimes/test_arithmetic.py

@@ -58,14 +58,14 @@ def test_dti_shift_freqs(self):
     def test_dti_shift_int(self):
         rng = date_range('1/1/2000', periods=20)
 
-        with tm.assert_produces_warning(FutureWarning):
+        with tm.assert_produces_warning(FutureWarning, check_stacklevel=False):
             # GH#22535
             result = rng + 5
 
         expected = rng.shift(5)
         tm.assert_index_equal(result, expected)
 
-        with tm.assert_produces_warning(FutureWarning):
+        with tm.assert_produces_warning(FutureWarning, check_stacklevel=False):
             # GH#22535
             result = rng - 5
 

pandas/tests/indexes/timedeltas/test_arithmetic.py

@@ -130,7 +130,7 @@ def test_ufunc_coercions(self):
     def test_tdi_add_int(self, one):
         # Variants of `one` for #19012
         rng = timedelta_range('1 days 09:00:00', freq='H', periods=10)
-        with tm.assert_produces_warning(FutureWarning):
+        with tm.assert_produces_warning(FutureWarning, check_stacklevel=False):
             # GH#22535
             result = rng + one
         expected = timedelta_range('1 days 10:00:00', freq='H', periods=10)
@@ -146,7 +146,7 @@ def test_tdi_iadd_int(self, one):
 
     def test_tdi_sub_int(self, one):
         rng = timedelta_range('1 days 09:00:00', freq='H', periods=10)
-        with tm.assert_produces_warning(FutureWarning):
+        with tm.assert_produces_warning(FutureWarning, check_stacklevel=False):
             # GH#22535
             result = rng - one
         expected = timedelta_range('1 days 08:00:00', freq='H', periods=10)
@@ -169,7 +169,7 @@ def test_tdi_add_integer_array(self, box):
         rng = timedelta_range('1 days 09:00:00', freq='H', periods=3)
         other = box([4, 3, 2])
         expected = TimedeltaIndex(['1 day 13:00:00'] * 3)
-        with tm.assert_produces_warning(FutureWarning):
+        with tm.assert_produces_warning(FutureWarning, check_stacklevel=False):
             # GH#22535
             result = rng + other
             tm.assert_index_equal(result, expected)
@@ -185,7 +185,7 @@ def test_tdi_sub_integer_array(self, box):
         rng = timedelta_range('9H', freq='H', periods=3)
         other = box([4, 3, 2])
         expected = TimedeltaIndex(['5H', '7H', '9H'])
-        with tm.assert_produces_warning(FutureWarning):
+        with tm.assert_produces_warning(FutureWarning, check_stacklevel=False):
             # GH#22535
             result = rng - other
             tm.assert_index_equal(result, expected)