DOC: Run all doctests

Author: rhshadrach

.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):
         """