DOC: Run all doctests

.github/workflows/code-checks.yml

@@ -57,6 +57,8 @@ jobs:
       run: sudo apt-get update && sudo apt-get install -y libegl1 libopengl0
 
     - name: Run doctests
+      env:
+        PANDAS_SET_MODULE_DUNDER: 0
       run: cd ci && ./code_checks.sh doctests
       if: ${{ steps.build.outcome == 'success' && always() }}
 

pandas/_libs/interval.pyx

@@ -445,7 +445,6 @@ cdef class Interval(IntervalMixin):
     >>> interval.closed
     'left'
     """
-    __module__ = "pandas"
 
     def __init__(self, left, right, str closed="right"):
         # note: it is faster to just do these checks than to use a special

pandas/_libs/missing.pyx

@@ -394,7 +394,6 @@ class NAType(C_NAType):
     True
     """
     __module__ = "pandas.api.typing"
-
     _instance = None
 
     def __new__(cls, *args, **kwargs):

pandas/_libs/tslibs/nattype.pyx

@@ -371,7 +371,6 @@ class NaTType(_NaT):
     0  2023-01-01
     1         NaT
     """
-
     __module__ = "pandas.api.typing"
 
     def __new__(cls):

pandas/_libs/tslibs/np_datetime.pyx

@@ -193,7 +193,6 @@ class OutOfBoundsDatetime(ValueError):
     at position 0
     """
     __module__ = "pandas.errors"
-    pass
 
 
 class OutOfBoundsTimedelta(ValueError):
@@ -213,9 +212,8 @@ class OutOfBoundsTimedelta(ValueError):
     OutOfBoundsTimedelta: Cannot cast 139999 days 00:00:00
     to unit='ns' without overflow.
     """
-    __module__ = "pandas.errors"
     # Timedelta analogue to OutOfBoundsDatetime
-    pass
+    __module__ = "pandas.errors"
 
 
 cdef get_implementation_bounds(

pandas/_libs/tslibs/offsets.pyx

@@ -47,6 +47,7 @@ from pandas._libs.tslibs.ccalendar import (
     int_to_weekday,
     weekday_to_int,
 )
+from pandas.util._decorators import set_module
 from pandas.util._exceptions import find_stack_level
 
 from pandas._libs.tslibs.ccalendar cimport (
@@ -1695,6 +1696,7 @@ class OffsetMeta(type):
 
 
 # TODO: figure out a way to use a metaclass with a cdef class
+@set_module("pandas")
 class DateOffset(RelativeDeltaOffset, metaclass=OffsetMeta):
     """
     Standard kind of date increment used for a date range.
@@ -1822,8 +1824,6 @@ class DateOffset(RelativeDeltaOffset, metaclass=OffsetMeta):
     >>> ts + pd.DateOffset(hour=8)
     Timestamp('2017-01-01 08:10:11')
     """
-    __module__ = "pandas"
-
     def __setattr__(self, name, value):
         raise AttributeError("DateOffset objects are immutable.")
 

pandas/_libs/tslibs/period.pyx

@@ -1626,12 +1626,12 @@ DIFFERENT_FREQ = ("Input has different freq={other_freq} "
                   "from {cls}(freq={own_freq})")
 
 
+@set_module("pandas.errors")
 class IncompatibleFrequency(TypeError):
     """
     Raised when trying to compare or operate between Periods with different
     frequencies.
     """
-    __module__ = "pandas.errors"
     pass
 
 

pandas/core/apply.py

@@ -29,7 +29,10 @@
 )
 from pandas.compat._optional import import_optional_dependency
 from pandas.errors import SpecificationError
-from pandas.util._decorators import cache_readonly
+from pandas.util._decorators import (
+    cache_readonly,
+    set_module,
+)
 
 from pandas.core.dtypes.cast import is_nested_object
 from pandas.core.dtypes.common import (
@@ -75,6 +78,7 @@
 ResType: TypeAlias = dict[int, Any]
 
 
+@set_module("pandas.api.executors")
 class BaseExecutionEngine(abc.ABC):
     """
     Base class for execution engines for map and apply methods.
@@ -88,8 +92,6 @@ class BaseExecutionEngine(abc.ABC):
     simply runs the code with the Python interpreter and pandas.
     """
 
-    __module__ = "pandas.api.executors"
-
     @staticmethod
     @abc.abstractmethod
     def map(

pandas/core/arrays/arrow/array.py

@@ -36,7 +36,10 @@
     PYARROW_MIN_VERSION,
 )
 from pandas.errors import Pandas4Warning
-from pandas.util._decorators import doc
+from pandas.util._decorators import (
+    doc,
+    set_module,
+)
 from pandas.util._exceptions import find_stack_level
 
 from pandas.core.dtypes.cast import (
@@ -241,6 +244,7 @@ def to_pyarrow_type(
     return None
 
 
+@set_module("pandas.arrays")
 class ArrowExtensionArray(
     OpsMixin,
     ExtensionArraySupportsAnyAll,
@@ -296,8 +300,6 @@ class ArrowExtensionArray(
     Length: 3, dtype: int64[pyarrow]
     """  # noqa: E501 (http link too long)
 
-    __module__ = "pandas.arrays"
-
     _pa_array: pa.ChunkedArray
     _dtype: ArrowDtype
 

pandas/core/arrays/base.py

@@ -31,6 +31,7 @@
 from pandas.errors import AbstractMethodError
 from pandas.util._decorators import (
     cache_readonly,
+    set_module,
 )
 from pandas.util._validators import (
     validate_bool_kwarg,
@@ -105,6 +106,7 @@
 _extension_array_shared_docs: dict[str, str] = {}
 
 
+@set_module("pandas.api.extensions")
 class ExtensionArray:
     """
     Abstract base class for custom 1-D array types.
@@ -256,8 +258,6 @@ class ExtensionArray:
     https://github.com/pandas-dev/pandas/blob/main/pandas/tests/extension/list/array.py
     """
 
-    __module__ = "pandas.api.extensions"
-
     # '_typ' is for pandas.core.dtypes.generic.ABCExtensionArray.
     # Don't override this.
     _typ = "extension"
@@ -2788,6 +2788,7 @@ def _add_logical_ops(cls) -> None:
         setattr(cls, "__rxor__", cls._create_logical_method(roperator.rxor))
 
 
+@set_module("pandas.api.extensions")
 class ExtensionScalarOpsMixin(ExtensionOpsMixin):
     """
     A mixin for defining ops on an ExtensionArray.
@@ -2814,8 +2815,6 @@ class ExtensionScalarOpsMixin(ExtensionOpsMixin):
        with NumPy arrays.
     """
 
-    __module__ = "pandas.api.extensions"
-
     @classmethod
     def _create_method(cls, op, coerce_to_dtype: bool = True, result_dtype=None):
         """

pandas/core/arrays/boolean.py

@@ -262,6 +262,7 @@ def coerce_to_array(
     return values, mask
 
 
+@set_module("pandas.arrays")
 class BooleanArray(BaseMaskedArray):
     """
     Array of boolean (True/False) data with missing values.
@@ -321,8 +322,6 @@ class BooleanArray(BaseMaskedArray):
     Length: 3, dtype: boolean
     """
 
-    __module__ = "pandas.arrays"
-
     _TRUE_VALUES = {"True", "TRUE", "true", "1", "1.0"}
     _FALSE_VALUES = {"False", "FALSE", "false", "0", "0.0"}
 

pandas/core/arrays/categorical.py

@@ -26,6 +26,7 @@
 from pandas._libs.arrays import NDArrayBacked
 from pandas.compat.numpy import function as nv
 from pandas.errors import Pandas4Warning
+from pandas.util._decorators import set_module
 from pandas.util._exceptions import find_stack_level
 from pandas.util._validators import validate_bool_kwarg
 
@@ -245,6 +246,7 @@ def contains(cat, key, container) -> bool:
         return any(loc_ in container for loc_ in loc)
 
 
+@set_module("pandas")
 class Categorical(NDArrayBackedExtensionArray, PandasObject, ObjectStringArrayMixin):
     """
     Represent a categorical variable in classic R / S-plus fashion.
@@ -361,8 +363,6 @@ class Categorical(NDArrayBackedExtensionArray, PandasObject, ObjectStringArrayMi
     'c'
     """
 
-    __module__ = "pandas"
-
     # For comparisons, so that numpy uses our implementation if the compare
     # ops, which raise
     __array_priority__ = 1000

pandas/core/arrays/datetimes.py

@@ -46,6 +46,7 @@
 )
 from pandas._libs.tslibs.dtypes import abbrev_to_npy_unit
 from pandas.errors import PerformanceWarning
+from pandas.util._decorators import set_module
 from pandas.util._exceptions import find_stack_level
 from pandas.util._validators import validate_inclusive
 
@@ -171,6 +172,7 @@ def f(self):
     return property(f)
 
 
+@set_module("pandas.arrays")
 class DatetimeArray(dtl.TimelikeOps, dtl.DatelikeOps):
     """
     Pandas ExtensionArray for tz-naive or tz-aware datetime data.
@@ -223,8 +225,6 @@ class DatetimeArray(dtl.TimelikeOps, dtl.DatelikeOps):
     Length: 2, dtype: datetime64[s]
     """
 
-    __module__ = "pandas.arrays"
-
     _typ = "datetimearray"
     _internal_fill_value = np.datetime64("NaT", "ns")
     _recognized_scalars = (datetime, np.datetime64)

pandas/core/arrays/floating.py

@@ -63,6 +63,7 @@ def _safe_cast(cls, values: np.ndarray, dtype: np.dtype, copy: bool) -> np.ndarr
         return values.astype(dtype, copy=copy)
 
 
+@set_module("pandas.arrays")
 class FloatingArray(NumericArray):
     """
     Array of floating (optional missing) values.
@@ -129,8 +130,6 @@ class FloatingArray(NumericArray):
     Length: 3, dtype: Float32
     """
 
-    __module__ = "pandas.arrays"
-
     _dtype_cls = FloatingDtype
 
 

pandas/core/arrays/integer.py

@@ -71,6 +71,7 @@ def _safe_cast(cls, values: np.ndarray, dtype: np.dtype, copy: bool) -> np.ndarr
             ) from err
 
 
+@set_module("pandas.arrays")
 class IntegerArray(NumericArray):
     """
     Array of integer (optional missing) values.
@@ -142,8 +143,6 @@ class IntegerArray(NumericArray):
     Length: 3, dtype: UInt16
     """
 
-    __module__ = "pandas.arrays"
-
     _dtype_cls = IntegerDtype
 
 

pandas/core/arrays/interval.py

@@ -39,6 +39,7 @@
 )
 from pandas.compat.numpy import function as nv
 from pandas.errors import IntCastingNaNError
+from pandas.util._decorators import set_module
 
 from pandas.core.dtypes.cast import (
     LossySetitemError,
@@ -176,6 +177,7 @@
 """
 
 
+@set_module("pandas.arrays")
 class IntervalArray(IntervalMixin, ExtensionArray):
     """
     Pandas array for interval data that are closed on the same side.
@@ -243,8 +245,6 @@ class IntervalArray(IntervalMixin, ExtensionArray):
     :meth:`IntervalArray.from_breaks`, and :meth:`IntervalArray.from_tuples`.
     """
 
-    __module__ = "pandas.arrays"
-
     can_hold_na = True
     _na_value = _fill_value = np.nan
 

pandas/core/arrays/numpy_.py

@@ -13,6 +13,7 @@
 from pandas._libs import lib
 from pandas._libs.tslibs import is_supported_dtype
 from pandas.compat.numpy import function as nv
+from pandas.util._decorators import set_module
 
 from pandas.core.dtypes.astype import astype_array
 from pandas.core.dtypes.cast import (
@@ -52,12 +53,12 @@
     from pandas.arrays import StringArray
 
 
+@set_module("pandas.arrays")
 class NumpyExtensionArray(
     OpsMixin,
     NDArrayBackedExtensionArray,
     ObjectStringArrayMixin,
 ):
-    __module__ = "pandas.arrays"
     """
     A pandas ExtensionArray for NumPy data.
 

pandas/core/arrays/period.py

@@ -54,6 +54,7 @@
 from pandas.util._decorators import (
     cache_readonly,
     doc,
+    set_module,
 )
 
 from pandas.core.dtypes.common import (
@@ -120,6 +121,7 @@ def f(self):
     return property(f)
 
 
+@set_module("pandas.arrays")
 # error: Definition of "_concat_same_type" in base class "NDArrayBacked" is
 # incompatible with definition in base class "ExtensionArray"
 class PeriodArray(dtl.DatelikeOps, libperiod.PeriodMixin):  # type: ignore[misc]
@@ -177,8 +179,6 @@ class PeriodArray(dtl.DatelikeOps, libperiod.PeriodMixin):  # type: ignore[misc]
     Length: 2, dtype: period[D]
     """
 
-    __module__ = "pandas.arrays"
-
     # array priority higher than numpy scalars
     __array_priority__ = 1000
     _typ = "periodarray"  # ABCPeriodArray

pandas/core/arrays/sparse/array.py

@@ -31,7 +31,10 @@
 from pandas._libs.tslibs import NaT
 from pandas.compat.numpy import function as nv
 from pandas.errors import PerformanceWarning
-from pandas.util._decorators import doc
+from pandas.util._decorators import (
+    doc,
+    set_module,
+)
 from pandas.util._exceptions import find_stack_level
 from pandas.util._validators import (
     validate_bool_kwarg,
@@ -289,6 +292,7 @@ def _wrap_result(
     )
 
 
+@set_module("pandas.arrays")
 class SparseArray(OpsMixin, PandasObject, ExtensionArray):
     """
     An ExtensionArray for storing sparse data.
@@ -370,8 +374,6 @@ class SparseArray(OpsMixin, PandasObject, ExtensionArray):
     Indices: array([2, 3], dtype=int32)
     """
 
-    __module__ = "pandas.arrays"
-
     _subtyp = "sparse_array"  # register ABCSparseArray
     _hidden_attrs = PandasObject._hidden_attrs | frozenset([])
     _sparse_index: SparseIndex