make writing tests easier for contributors

Author: cmp0xff

.gitignore

@@ -136,5 +136,5 @@ dmypy.json
 /poetry.lock
 .idea/**/*
 
-# duplication of stub specific objects for testing
-tests/_typing.py
+# duplication of stub specific objects upon testing
+tests/_typing.pyi

tests/_typing.py

@@ -0,0 +1,84 @@
+# Committed content should be import-only. At runtime of tests, this file will
+# be replaced by pandas-stubs/_typing.pyi.
+
+from pandas._typing import (
+    BooleanDtypeArg,
+    BytesDtypeArg,
+    CategoryDtypeArg,
+    ComplexDtypeArg,
+    Dtype,
+    FloatDtypeArg,
+    IntDtypeArg,
+    ObjectDtypeArg,
+    PandasAstypeComplexDtypeArg,
+    PandasAstypeFloatDtypeArg,
+    PandasAstypeTimedeltaDtypeArg,
+    PandasAstypeTimestampDtypeArg,
+    PandasFloatDtypeArg,
+    StrDtypeArg,
+    TimedeltaDtypeArg,
+    TimestampDtypeArg,
+    UIntDtypeArg,
+    VoidDtypeArg,
+    np_1darray,
+    np_1darray_anyint,
+    np_1darray_bool,
+    np_1darray_bytes,
+    np_1darray_complex,
+    np_1darray_dt,
+    np_1darray_float,
+    np_1darray_int64,
+    np_1darray_intp,
+    np_1darray_object,
+    np_1darray_td,
+    np_2darray,
+    np_ndarray,
+    np_ndarray_bool,
+    np_ndarray_dt,
+    np_ndarray_num,
+    np_ndarray_str,
+    np_ndarray_td,
+)
+
+__all__ = [
+    "np_1darray",
+    "np_2darray",
+    "np_ndarray",
+    "np_1darray_bool",
+    "BooleanDtypeArg",
+    "BytesDtypeArg",
+    "CategoryDtypeArg",
+    "ComplexDtypeArg",
+    "IntDtypeArg",
+    "np_ndarray_str",
+    "ObjectDtypeArg",
+    "PandasAstypeComplexDtypeArg",
+    "PandasAstypeTimedeltaDtypeArg",
+    "PandasAstypeTimestampDtypeArg",
+    "StrDtypeArg",
+    "TimedeltaDtypeArg",
+    "TimestampDtypeArg",
+    "UIntDtypeArg",
+    "PandasFloatDtypeArg",
+    "VoidDtypeArg",
+    "np_1darray",
+    "np_1darray_anyint",
+    "np_1darray_bool",
+    "np_1darray_bytes",
+    "np_1darray_complex",
+    "np_1darray_dt",
+    "np_1darray_float",
+    "np_ndarray_bool",
+    "np_ndarray_dt",
+    "np_1darray_object",
+    "np_1darray_td",
+    "np_1darray_int64",
+    "np_ndarray_num",
+    "FloatDtypeArg",
+    "PandasAstypeFloatDtypeArg",
+    "np_ndarray_bool",
+    "np_ndarray_dt",
+    "np_ndarray_td",
+    "np_1darray_intp",
+    "Dtype",
+]

tests/arrays/test_extension_array.py

@@ -1,5 +1,4 @@
 # Test common ExtensionArray methods
-from typing import TYPE_CHECKING
 
 import numpy as np
 import pandas as pd
@@ -14,17 +13,10 @@
 from pandas._typing import ArrayLike
 
 from tests import check
-
-if TYPE_CHECKING:
-    from pandas._typing import (
-        np_1darray,
-        np_1darray_intp,
-    )
-else:
-    from tests._typing import (
-        np_1darray,
-        np_1darray_intp,
-    )
+from tests._typing import (
+    np_1darray,
+    np_1darray_intp,
+)
 
 
 def test_ea_common() -> None:

tests/arrays/test_floating_array.py

@@ -11,9 +11,7 @@
     check,
     exception_on_platform,
 )
-
-if TYPE_CHECKING:
-    from pandas._typing import PandasFloatDtypeArg
+from tests._typing import PandasFloatDtypeArg
 
 
 def test_constructor() -> None:
@@ -29,7 +27,7 @@ def test_constructor() -> None:
 
 
 @pytest.mark.parametrize(("dtype", "target_dtype"), PANDAS_FLOAT_ARGS.items(), ids=repr)
-def test_constructor_dtype(dtype: "PandasFloatDtypeArg", target_dtype: type) -> None:
+def test_constructor_dtype(dtype: PandasFloatDtypeArg, target_dtype: type) -> None:
     exc = exception_on_platform(dtype)
     if exc:
         with pytest.raises(exc, match=rf"data type {dtype!r} not understood"):

tests/conftest.py

@@ -4,12 +4,18 @@
 
 import pytest
 
+# Use pandas._testing from the stubs for testing
+groundtruth = Path(__file__).parents[1] / "pandas-stubs" / "_typing.pyi"
 target = Path(__file__).parent / "_typing.py"
-copyfile(Path(__file__).parents[1] / "pandas-stubs" / "_typing.pyi", target)
+staging = Path(__file__).parent / "_typing.pyi"
+copyfile(target, staging)
+copyfile(groundtruth, target)
 
 
 @pytest.fixture(autouse=True, scope="session")
 def setup_typing_module() -> Generator[None, None, None]:
-    """Ensure that tests._typing is removed after running tests"""
+    """Ensure that tests._typing is recovered after running tests"""
     yield
-    target.unlink()
+
+    copyfile(staging, target)
+    staging.unlink()

tests/extension/decimal/array.py

@@ -11,7 +11,6 @@
 import numbers
 import sys
 from typing import (
-    TYPE_CHECKING,
     Any,
     cast,
     overload,
@@ -53,18 +52,11 @@
     pandas_dtype,
 )
 
-if TYPE_CHECKING:
-    from pandas._typing import (
-        np_1darray,
-        np_1darray_bool,
-        np_ndarray,
-    )
-else:
-    from tests._typing import (
-        np_1darray,
-        np_1darray_bool,
-        np_ndarray,
-    )
+from tests._typing import (
+    np_1darray,
+    np_1darray_bool,
+    np_ndarray,
+)
 
 
 @register_extension_dtype

tests/indexes/test_categoricalindex.py

@@ -1,18 +1,12 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
-
 import pandas as pd
 from typing_extensions import (
     assert_type,
 )
 
 from tests import check
-
-if TYPE_CHECKING:
-    from pandas._typing import np_1darray_intp
-else:
-    from tests._typing import np_1darray_intp
+from tests._typing import np_1darray_intp
 
 
 def test_categoricalindex_unique() -> None:

tests/indexes/test_datetime_index.py

@@ -1,24 +1,16 @@
 from __future__ import annotations
 
 from datetime import time
-from typing import TYPE_CHECKING
 
 import numpy as np
 import pandas as pd
 from typing_extensions import assert_type
 
 from tests import check
-
-if TYPE_CHECKING:
-    from pandas._typing import (
-        np_1darray_bool,
-        np_1darray_intp,
-    )
-else:
-    from tests._typing import (
-        np_1darray_bool,
-        np_1darray_intp,
-    )
+from tests._typing import (
+    np_1darray_bool,
+    np_1darray_intp,
+)
 
 
 def test_index_relops() -> None:

tests/indexes/test_index_float.py

@@ -11,12 +11,11 @@
     check,
     exception_on_platform,
 )
+from tests._typing import PandasAstypeFloatDtypeArg
 
 if TYPE_CHECKING:
     from pandas.core.indexes.base import FloatNotNumpy16DtypeArg
 
-    from pandas._typing import PandasAstypeFloatDtypeArg
-
 
 def test_constructor() -> None:
     check(assert_type(pd.Index([1.0]), "pd.Index[float]"), pd.Index, np.floating)

tests/indexes/test_indexes.py

@@ -3,7 +3,6 @@
 from collections.abc import Hashable
 import datetime as dt
 from typing import (
-    TYPE_CHECKING,
     Any,
     cast,
 )
@@ -23,31 +22,21 @@
     assert_type,
 )
 
+from pandas._typing import Dtype  # noqa: F401
+
 from tests import (
     PD_LTE_23,
     TYPE_CHECKING_INVALID_USAGE,
     check,
     pytest_warns_bounded,
 )
-
-if TYPE_CHECKING:
-    from pandas._typing import (
-        Dtype,
-        np_1darray,
-        np_1darray_bool,
-        np_1darray_int64,
-        np_1darray_intp,
-        np_ndarray_dt,
-    )
-else:
-    from tests._typing import (
-        np_1darray,
-        np_1darray_bool,
-        np_1darray_int64,
-        np_1darray_intp,
-        np_ndarray_dt,
-    )
-    from tests._typing import Dtype  # noqa: F401
+from tests._typing import (
+    np_1darray,
+    np_1darray_bool,
+    np_1darray_int64,
+    np_1darray_intp,
+    np_ndarray_dt,
+)
 
 
 def test_index_unique() -> None: