Deprecate series.nonzero (GH18262)

Author: makbigc

doc/source/whatsnew/v0.24.0.rst

@@ -1123,6 +1123,7 @@ Deprecations
 - :func:`pandas.types.is_period` is deprecated in favor of `pandas.types.is_period_dtype` (:issue:`23917`)
 - :func:`pandas.types.is_datetimetz` is deprecated in favor of `pandas.types.is_datetime64tz` (:issue:`23917`)
 - Creating a :class:`TimedeltaIndex` or :class:`DatetimeIndex` by passing range arguments `start`, `end`, and `periods` is deprecated in favor of :func:`timedelta_range` and :func:`date_range` (:issue:`23919`)
+- :meth:`Series.nonzero` is deprecated and will be removed in a future version (:issue:`18262`)
 
 .. _whatsnew_0240.deprecations.datetimelike_int_ops:
 

pandas/core/series.py

@@ -535,6 +535,8 @@ def nonzero(self):
         """
         Return the *integer* indices of the elements that are non-zero.
 
+        .. deprecated:: 0.24.0
+
         This method is equivalent to calling `numpy.nonzero` on the
         series data. For compatibility with NumPy, the return value is
         the same (a tuple with an array of indices for each dimension),
@@ -564,6 +566,9 @@ def nonzero(self):
         --------
         numpy.nonzero
         """
+        msg = ("Series.nonzero() is deprecated "
+               "and will be removed in a future version.")
+        warnings.warn(msg, FutureWarning, stacklevel=2)
         return self._values.nonzero()
 
     def put(self, *args, **kwargs):