Skip to content

Commit 8eff6a8

Browse files
authored
CLN: Use set_module decorator (#63164)
1 parent 11a5e3b commit 8eff6a8

36 files changed

+85
-93
lines changed

ci/code_checks.sh

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,10 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7373
-i "pandas.Period.freq GL08" \
7474
-i "pandas.Period.ordinal GL08" \
7575
-i "pandas.errors.IncompatibleFrequency SA01,SS06,EX01" \
76-
-i "pandas.errors.InvalidVersion GL08" \
7776
-i "pandas.api.extensions.ExtensionArray.value_counts EX01,RT03,SA01" \
7877
-i "pandas.api.typing.DataFrameGroupBy.plot PR02" \
7978
-i "pandas.api.typing.SeriesGroupBy.plot PR02" \
8079
-i "pandas.api.typing.Resampler.quantile PR01,PR07" \
81-
-i "pandas.arrays.NumpyExtensionArray GL08" \
8280
-i "pandas.tseries.offsets.BDay PR02,SA01" \
8381
-i "pandas.tseries.offsets.BHalfYearBegin.is_on_offset GL08" \
8482
-i "pandas.tseries.offsets.BHalfYearBegin.n GL08" \

pandas/_libs/interval.pyx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,6 @@ cdef class Interval(IntervalMixin):
445445
>>> interval.closed
446446
'left'
447447
"""
448-
__module__ = "pandas"
449448

450449
def __init__(self, left, right, str closed="right"):
451450
# note: it is faster to just do these checks than to use a special

pandas/_libs/tslibs/offsets.pyx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ from pandas._libs.tslibs.ccalendar import (
4747
int_to_weekday,
4848
weekday_to_int,
4949
)
50+
from pandas.util._decorators import set_module
5051
from pandas.util._exceptions import find_stack_level
5152

5253
from pandas._libs.tslibs.ccalendar cimport (
@@ -1695,6 +1696,7 @@ class OffsetMeta(type):
16951696

16961697

16971698
# TODO: figure out a way to use a metaclass with a cdef class
1699+
@set_module("pandas")
16981700
class DateOffset(RelativeDeltaOffset, metaclass=OffsetMeta):
16991701
"""
17001702
Standard kind of date increment used for a date range.
@@ -1822,8 +1824,6 @@ class DateOffset(RelativeDeltaOffset, metaclass=OffsetMeta):
18221824
>>> ts + pd.DateOffset(hour=8)
18231825
Timestamp('2017-01-01 08:10:11')
18241826
"""
1825-
__module__ = "pandas"
1826-
18271827
def __setattr__(self, name, value):
18281828
raise AttributeError("DateOffset objects are immutable.")
18291829

pandas/_libs/tslibs/period.pyx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1626,12 +1626,12 @@ DIFFERENT_FREQ = ("Input has different freq={other_freq} "
16261626
"from {cls}(freq={own_freq})")
16271627

16281628

1629+
@set_module("pandas.errors")
16291630
class IncompatibleFrequency(TypeError):
16301631
"""
16311632
Raised when trying to compare or operate between Periods with different
16321633
frequencies.
16331634
"""
1634-
__module__ = "pandas.errors"
16351635
pass
16361636

16371637

pandas/core/apply.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@
2929
)
3030
from pandas.compat._optional import import_optional_dependency
3131
from pandas.errors import SpecificationError
32-
from pandas.util._decorators import cache_readonly
32+
from pandas.util._decorators import (
33+
cache_readonly,
34+
set_module,
35+
)
3336

3437
from pandas.core.dtypes.cast import is_nested_object
3538
from pandas.core.dtypes.common import (
@@ -75,6 +78,7 @@
7578
ResType: TypeAlias = dict[int, Any]
7679

7780

81+
@set_module("pandas.api.executors")
7882
class BaseExecutionEngine(abc.ABC):
7983
"""
8084
Base class for execution engines for map and apply methods.
@@ -88,8 +92,6 @@ class BaseExecutionEngine(abc.ABC):
8892
simply runs the code with the Python interpreter and pandas.
8993
"""
9094

91-
__module__ = "pandas.api.executors"
92-
9395
@staticmethod
9496
@abc.abstractmethod
9597
def map(

pandas/core/arrays/arrow/array.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,10 @@
3636
PYARROW_MIN_VERSION,
3737
)
3838
from pandas.errors import Pandas4Warning
39-
from pandas.util._decorators import doc
39+
from pandas.util._decorators import (
40+
doc,
41+
set_module,
42+
)
4043
from pandas.util._exceptions import find_stack_level
4144

4245
from pandas.core.dtypes.cast import (
@@ -242,6 +245,7 @@ def to_pyarrow_type(
242245
return None
243246

244247

248+
@set_module("pandas.arrays")
245249
class ArrowExtensionArray(
246250
OpsMixin,
247251
ExtensionArraySupportsAnyAll,
@@ -297,8 +301,6 @@ class ArrowExtensionArray(
297301
Length: 3, dtype: int64[pyarrow]
298302
""" # noqa: E501 (http link too long)
299303

300-
__module__ = "pandas.arrays"
301-
302304
_pa_array: pa.ChunkedArray
303305
_dtype: ArrowDtype
304306

pandas/core/arrays/base.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
from pandas.errors import AbstractMethodError
3232
from pandas.util._decorators import (
3333
cache_readonly,
34+
set_module,
3435
)
3536
from pandas.util._validators import (
3637
validate_bool_kwarg,
@@ -106,6 +107,7 @@
106107
_extension_array_shared_docs: dict[str, str] = {}
107108

108109

110+
@set_module("pandas.api.extensions")
109111
class ExtensionArray:
110112
"""
111113
Abstract base class for custom 1-D array types.
@@ -257,8 +259,6 @@ class ExtensionArray:
257259
https://github.com/pandas-dev/pandas/blob/main/pandas/tests/extension/list/array.py
258260
"""
259261

260-
__module__ = "pandas.api.extensions"
261-
262262
# '_typ' is for pandas.core.dtypes.generic.ABCExtensionArray.
263263
# Don't override this.
264264
_typ = "extension"
@@ -2804,6 +2804,7 @@ def _add_logical_ops(cls) -> None:
28042804
setattr(cls, "__rxor__", cls._create_logical_method(roperator.rxor))
28052805

28062806

2807+
@set_module("pandas.api.extensions")
28072808
class ExtensionScalarOpsMixin(ExtensionOpsMixin):
28082809
"""
28092810
A mixin for defining ops on an ExtensionArray.
@@ -2830,8 +2831,6 @@ class ExtensionScalarOpsMixin(ExtensionOpsMixin):
28302831
with NumPy arrays.
28312832
"""
28322833

2833-
__module__ = "pandas.api.extensions"
2834-
28352834
@classmethod
28362835
def _create_method(cls, op, coerce_to_dtype: bool = True, result_dtype=None):
28372836
"""

pandas/core/arrays/boolean.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,7 @@ def coerce_to_array(
262262
return values, mask
263263

264264

265+
@set_module("pandas.arrays")
265266
class BooleanArray(BaseMaskedArray):
266267
"""
267268
Array of boolean (True/False) data with missing values.
@@ -321,8 +322,6 @@ class BooleanArray(BaseMaskedArray):
321322
Length: 3, dtype: boolean
322323
"""
323324

324-
__module__ = "pandas.arrays"
325-
326325
_TRUE_VALUES = {"True", "TRUE", "true", "1", "1.0"}
327326
_FALSE_VALUES = {"False", "FALSE", "false", "0", "0.0"}
328327

pandas/core/arrays/categorical.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
from pandas._libs.arrays import NDArrayBacked
2727
from pandas.compat.numpy import function as nv
2828
from pandas.errors import Pandas4Warning
29+
from pandas.util._decorators import set_module
2930
from pandas.util._exceptions import find_stack_level
3031
from pandas.util._validators import validate_bool_kwarg
3132

@@ -245,6 +246,7 @@ def contains(cat, key, container) -> bool:
245246
return any(loc_ in container for loc_ in loc)
246247

247248

249+
@set_module("pandas")
248250
class Categorical(NDArrayBackedExtensionArray, PandasObject, ObjectStringArrayMixin):
249251
"""
250252
Represent a categorical variable in classic R / S-plus fashion.
@@ -361,8 +363,6 @@ class Categorical(NDArrayBackedExtensionArray, PandasObject, ObjectStringArrayMi
361363
'c'
362364
"""
363365

364-
__module__ = "pandas"
365-
366366
# For comparisons, so that numpy uses our implementation if the compare
367367
# ops, which raise
368368
__array_priority__ = 1000

pandas/core/arrays/datetimes.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
)
4747
from pandas._libs.tslibs.dtypes import abbrev_to_npy_unit
4848
from pandas.errors import PerformanceWarning
49+
from pandas.util._decorators import set_module
4950
from pandas.util._exceptions import find_stack_level
5051
from pandas.util._validators import validate_inclusive
5152

@@ -171,6 +172,7 @@ def f(self):
171172
return property(f)
172173

173174

175+
@set_module("pandas.arrays")
174176
class DatetimeArray(dtl.TimelikeOps, dtl.DatelikeOps):
175177
"""
176178
Pandas ExtensionArray for tz-naive or tz-aware datetime data.
@@ -223,8 +225,6 @@ class DatetimeArray(dtl.TimelikeOps, dtl.DatelikeOps):
223225
Length: 2, dtype: datetime64[us]
224226
"""
225227

226-
__module__ = "pandas.arrays"
227-
228228
_typ = "datetimearray"
229229
_internal_fill_value = np.datetime64("NaT", "ns")
230230
_recognized_scalars = (datetime, np.datetime64)

0 commit comments

Comments
 (0)