From 4e6e857d93d2e5988f311249f281480b10e5ece0 Mon Sep 17 00:00:00 2001 From: HH-MWB Date: Mon, 23 Mar 2020 17:49:09 -0400 Subject: [PATCH 1/8] update Appender to doc in period.py --- pandas/core/indexes/period.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pandas/core/indexes/period.py b/pandas/core/indexes/period.py index f6bf02b6df676..95bc9a817f828 100644 --- a/pandas/core/indexes/period.py +++ b/pandas/core/indexes/period.py @@ -10,7 +10,7 @@ from pandas._libs.tslibs.parsing import parse_time_string from pandas._libs.tslibs.period import Period from pandas._typing import DtypeObj, Label -from pandas.util._decorators import Appender, cache_readonly +from pandas.util._decorators import Appender, cache_readonly, doc from pandas.core.dtypes.common import ( ensure_platform_int, @@ -327,7 +327,7 @@ def _engine(self): period = weakref.ref(self) return self._engine_type(period, len(self)) - @Appender(Index.__contains__.__doc__) + @doc(Index.__contains__) def __contains__(self, key: Any) -> bool: if isinstance(key, Period): if key.freq != self.freq: @@ -405,7 +405,7 @@ def asof_locs(self, where, mask: np.ndarray) -> np.ndarray: return result - @Appender(Index.astype.__doc__) + @doc(Index.astype) def astype(self, dtype, copy=True, how="start"): dtype = pandas_dtype(dtype) From ed3ddae667d09603e39a9780be605014fd30ebf3 Mon Sep 17 00:00:00 2001 From: HH-MWB Date: Mon, 23 Mar 2020 18:16:09 -0400 Subject: [PATCH 2/8] update Appender to doc in frame.py --- pandas/core/frame.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/core/frame.py b/pandas/core/frame.py index 8deeb415c17c9..b3beaff5bff36 100644 --- a/pandas/core/frame.py +++ b/pandas/core/frame.py @@ -2300,7 +2300,7 @@ def to_html( ) # ---------------------------------------------------------------------- - @Appender(info.__doc__) + @doc(info) def info( self, verbose=None, buf=None, max_cols=None, memory_usage=None, null_counts=None ) -> None: From 99d7f6ec82279f971a34eef750de807b7415ee62 Mon Sep 17 00:00:00 2001 From: HH-MWB Date: Mon, 23 Mar 2020 18:18:18 -0400 Subject: [PATCH 3/8] update Appender to doc in generic.py --- pandas/core/generic.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 8c6a5c9d020b4..1b948d6fc4b79 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -1723,7 +1723,7 @@ def items(self): for h in self._info_axis: yield h, self[h] - @Appender(items.__doc__) + @doc(items) def iteritems(self): return self.items() @@ -10222,7 +10222,7 @@ def _add_series_or_dataframe_operations(cls): """ from pandas.core.window import EWM, Expanding, Rolling, Window - @Appender(Rolling.__doc__) + @doc(Rolling) def rolling( self, window, @@ -10260,14 +10260,14 @@ def rolling( cls.rolling = rolling - @Appender(Expanding.__doc__) + @doc(Expanding) def expanding(self, min_periods=1, center=False, axis=0): axis = self._get_axis_number(axis) return Expanding(self, min_periods=min_periods, center=center, axis=axis) cls.expanding = expanding - @Appender(EWM.__doc__) + @doc(EWM) def ewm( self, com=None, From fbe68adffc04d64700ad17b917f52d92b1f2f501 Mon Sep 17 00:00:00 2001 From: HH-MWB Date: Mon, 23 Mar 2020 18:19:59 -0400 Subject: [PATCH 4/8] update Appender to doc in resample.py --- pandas/core/resample.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pandas/core/resample.py b/pandas/core/resample.py index f19a82ab6f86a..a8d85f101c308 100644 --- a/pandas/core/resample.py +++ b/pandas/core/resample.py @@ -11,7 +11,7 @@ from pandas._libs.tslibs.period import IncompatibleFrequency from pandas.compat.numpy import function as nv from pandas.errors import AbstractMethodError -from pandas.util._decorators import Appender, Substitution +from pandas.util._decorators import Appender, Substitution, doc from pandas.core.dtypes.generic import ABCDataFrame, ABCSeries @@ -858,7 +858,7 @@ def var(self, ddof=1, *args, **kwargs): nv.validate_resampler_func("var", args, kwargs) return self._downsample("var", ddof=ddof) - @Appender(GroupBy.size.__doc__) + @doc(GroupBy.size) def size(self): result = self._downsample("size") if not len(self.ax): @@ -871,7 +871,7 @@ def size(self): result = Series([], index=result.index, dtype="int64", name=name) return result - @Appender(GroupBy.count.__doc__) + @doc(GroupBy.count) def count(self): result = self._downsample("count") if not len(self.ax): From fd6cb9fec40f3ad4a64240fdcff370344f9d33d5 Mon Sep 17 00:00:00 2001 From: HH-MWB Date: Mon, 23 Mar 2020 21:39:08 -0400 Subject: [PATCH 5/8] update Appender to doc in timedeltas --- pandas/core/indexes/timedeltas.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pandas/core/indexes/timedeltas.py b/pandas/core/indexes/timedeltas.py index 588cb3e37bced..6acf9562f9b80 100644 --- a/pandas/core/indexes/timedeltas.py +++ b/pandas/core/indexes/timedeltas.py @@ -2,7 +2,7 @@ from pandas._libs import NaT, Timedelta, index as libindex from pandas._typing import DtypeObj, Label -from pandas.util._decorators import Appender +from pandas.util._decorators import doc from pandas.core.dtypes.common import ( _TD_DTYPE, @@ -195,7 +195,7 @@ def _formatter_func(self): # ------------------------------------------------------------------- - @Appender(Index.astype.__doc__) + @doc(Index.astype) def astype(self, dtype, copy=True): dtype = pandas_dtype(dtype) if is_timedelta64_dtype(dtype) and not is_timedelta64_ns_dtype(dtype): From 0dc8ea74e7b37240fe7933dea41db42f05f41b37 Mon Sep 17 00:00:00 2001 From: HH-MWB Date: Mon, 23 Mar 2020 22:00:51 -0400 Subject: [PATCH 6/8] update Appender to doc in range.py --- pandas/core/indexes/range.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pandas/core/indexes/range.py b/pandas/core/indexes/range.py index 2c038564f4e6f..b463b8d738d30 100644 --- a/pandas/core/indexes/range.py +++ b/pandas/core/indexes/range.py @@ -11,7 +11,7 @@ from pandas._typing import Label import pandas.compat as compat from pandas.compat.numpy import function as nv -from pandas.util._decorators import Appender, cache_readonly +from pandas.util._decorators import Appender, cache_readonly, doc from pandas.core.dtypes.common import ( ensure_platform_int, @@ -342,7 +342,7 @@ def __contains__(self, key: Any) -> bool: return False return key in self._range - @Appender(Int64Index.get_loc.__doc__) + @doc(Int64Index.get_loc) def get_loc(self, key, method=None, tolerance=None): if method is None and tolerance is None: if is_integer(key) or (is_float(key) and key.is_integer()): @@ -386,7 +386,7 @@ def get_indexer(self, target, method=None, limit=None, tolerance=None): def tolist(self): return list(self._range) - @Appender(Int64Index._shallow_copy.__doc__) + @doc(Int64Index._shallow_copy) def _shallow_copy(self, values=None, name: Label = no_default): name = self.name if name is no_default else name @@ -397,7 +397,7 @@ def _shallow_copy(self, values=None, name: Label = no_default): else: return Int64Index._simple_new(values, name=name) - @Appender(Int64Index.copy.__doc__) + @doc(Int64Index.copy) def copy(self, name=None, deep=False, dtype=None, **kwargs): self._validate_dtype(dtype) if name is None: @@ -619,7 +619,7 @@ def _union(self, other, sort): return type(self)(start_r, end_r + step_o, step_o) return self._int64index._union(other, sort=sort) - @Appender(Int64Index.join.__doc__) + @doc(Int64Index.join) def join(self, other, how="left", level=None, return_indexers=False, sort=False): if how == "outer" and self is not other: # note: could return RangeIndex in more circumstances From 3afff8e385cb44947046215cd4f6f9891d5b73b8 Mon Sep 17 00:00:00 2001 From: HH-MWB Date: Mon, 23 Mar 2020 22:05:40 -0400 Subject: [PATCH 7/8] update Appender to doc in numeric.py --- pandas/core/indexes/numeric.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/pandas/core/indexes/numeric.py b/pandas/core/indexes/numeric.py index 3a6f3630c19e7..6025ea8aef5fd 100644 --- a/pandas/core/indexes/numeric.py +++ b/pandas/core/indexes/numeric.py @@ -4,7 +4,7 @@ from pandas._libs import index as libindex, lib from pandas._typing import Dtype, Label -from pandas.util._decorators import Appender, cache_readonly +from pandas.util._decorators import cache_readonly, doc from pandas.core.dtypes.cast import astype_nansafe from pandas.core.dtypes.common import ( @@ -95,14 +95,14 @@ def _validate_dtype(cls, dtype: Dtype) -> None: f"Incorrect `dtype` passed: expected {expected}, received {dtype}" ) - @Appender(Index._maybe_cast_slice_bound.__doc__) + @doc(Index._maybe_cast_slice_bound) def _maybe_cast_slice_bound(self, label, side, kind): assert kind in ["loc", "getitem", None] # we will try to coerce to integers return self._maybe_cast_indexer(label) - @Appender(Index._shallow_copy.__doc__) + @doc(Index._shallow_copy) def _shallow_copy(self, values=None, name: Label = lib.no_default): if values is not None and not self._can_hold_na and values.dtype.kind == "f": name = self.name if name is lib.no_default else name @@ -158,7 +158,7 @@ def is_all_dates(self) -> bool: """ return False - @Appender(Index.insert.__doc__) + @doc(Index.insert) def insert(self, loc: int, item): # treat NA values as nans: if is_scalar(item) and isna(item): @@ -295,7 +295,7 @@ class UInt64Index(IntegerIndex): _engine_type = libindex.UInt64Engine _default_dtype = np.dtype(np.uint64) - @Appender(Index._convert_arr_indexer.__doc__) + @doc(Index._convert_arr_indexer) def _convert_arr_indexer(self, keyarr): # Cast the indexer to uint64 if possible so that the values returned # from indexing are also uint64. @@ -307,7 +307,7 @@ def _convert_arr_indexer(self, keyarr): return com.asarray_tuplesafe(keyarr, dtype=dtype) - @Appender(Index._convert_index_indexer.__doc__) + @doc(Index._convert_index_indexer) def _convert_index_indexer(self, keyarr): # Cast the indexer to uint64 if possible so # that the values returned from indexing are @@ -357,7 +357,7 @@ def inferred_type(self) -> str: """ return "floating" - @Appender(Index.astype.__doc__) + @doc(Index.astype) def astype(self, dtype, copy=True): dtype = pandas_dtype(dtype) if needs_i8_conversion(dtype): @@ -375,11 +375,11 @@ def astype(self, dtype, copy=True): # ---------------------------------------------------------------- # Indexing Methods - @Appender(Index._should_fallback_to_positional.__doc__) + @doc(Index._should_fallback_to_positional) def _should_fallback_to_positional(self): return False - @Appender(Index._convert_slice_indexer.__doc__) + @doc(Index._convert_slice_indexer) def _convert_slice_indexer(self, key: slice, kind: str): assert kind in ["loc", "getitem"] @@ -433,7 +433,7 @@ def __contains__(self, other: Any) -> bool: return is_float(other) and np.isnan(other) and self.hasnans - @Appender(Index.get_loc.__doc__) + @doc(Index.get_loc) def get_loc(self, key, method=None, tolerance=None): if is_bool(key): # Catch this to avoid accidentally casting to 1.0 @@ -453,7 +453,7 @@ def get_loc(self, key, method=None, tolerance=None): def is_unique(self) -> bool: return super().is_unique and self._nan_idxs.size < 2 - @Appender(Index.isin.__doc__) + @doc(Index.isin) def isin(self, values, level=None): if level is not None: self._validate_index_level(level) From d83fb2e90803c6767ba5c081e82b8aae7aa3b553 Mon Sep 17 00:00:00 2001 From: HH-MWB Date: Tue, 24 Mar 2020 09:10:28 -0400 Subject: [PATCH 8/8] update Appender to doc in multi.py --- pandas/core/indexes/multi.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/pandas/core/indexes/multi.py b/pandas/core/indexes/multi.py index 1bcda72e77f2f..b00af4653dfe3 100644 --- a/pandas/core/indexes/multi.py +++ b/pandas/core/indexes/multi.py @@ -21,7 +21,7 @@ from pandas._typing import AnyArrayLike, Scalar from pandas.compat.numpy import function as nv from pandas.errors import PerformanceWarning, UnsortedIndexError -from pandas.util._decorators import Appender, cache_readonly +from pandas.util._decorators import Appender, cache_readonly, doc from pandas.core.dtypes.cast import coerce_indexer_dtype from pandas.core.dtypes.common import ( @@ -986,7 +986,7 @@ def _engine(self): def _constructor(self): return MultiIndex.from_tuples - @Appender(Index._shallow_copy.__doc__) + @doc(Index._shallow_copy) def _shallow_copy( self, values=None, @@ -1098,7 +1098,7 @@ def view(self, cls=None): result._id = self._id return result - @Appender(Index.__contains__.__doc__) + @doc(Index.__contains__) def __contains__(self, key: Any) -> bool: hash(key) try: @@ -1119,7 +1119,7 @@ def f(l): return any(f(l) for l in self._inferred_type_levels) - @Appender(Index.memory_usage.__doc__) + @doc(Index.memory_usage) def memory_usage(self, deep: bool = False) -> int: # we are overwriting our base class to avoid # computing .values here which could materialize @@ -1351,7 +1351,7 @@ def _set_names(self, names, level=None, validate=True): # -------------------------------------------------------------------- - @Appender(Index._get_grouper_for_level.__doc__) + @doc(Index._get_grouper_for_level) def _get_grouper_for_level(self, mapper, level): indexer = self.codes[level] level_index = self.levels[level] @@ -1462,7 +1462,7 @@ def _inferred_type_levels(self): """ return a list of the inferred types, one for each level """ return [i.inferred_type for i in self.levels] - @Appender(Index.duplicated.__doc__) + @doc(Index.duplicated) def duplicated(self, keep="first"): shape = map(len, self.levels) ids = get_group_index(self.codes, shape, sort=False, xnull=False) @@ -1475,7 +1475,7 @@ def fillna(self, value=None, downcast=None): """ raise NotImplementedError("isna is not defined for MultiIndex") - @Appender(Index.dropna.__doc__) + @doc(Index.dropna) def dropna(self, how="any"): nans = [level_codes == -1 for level_codes in self.codes] if how == "any": @@ -1548,7 +1548,7 @@ def get_level_values(self, level): values = self._get_level_values(level) return values - @Appender(Index.unique.__doc__) + @doc(Index.unique) def unique(self, level=None): if level is None: @@ -3423,7 +3423,7 @@ def _convert_can_do_setop(self, other): # -------------------------------------------------------------------- - @Appender(Index.astype.__doc__) + @doc(Index.astype) def astype(self, dtype, copy=True): dtype = pandas_dtype(dtype) if is_categorical_dtype(dtype): @@ -3498,7 +3498,7 @@ def _wrap_joined_index(self, joined, other): names = self.names if self.names == other.names else None return MultiIndex.from_tuples(joined, names=names) - @Appender(Index.isin.__doc__) + @doc(Index.isin) def isin(self, values, level=None): if level is None: values = MultiIndex.from_tuples(values, names=self.names)._values