Merge branch 'future-fix' of github.com:bashtage/pandas-stubs into future-fix

Author: bashtage

tests/__init__.py

@@ -1,5 +1,9 @@
 from __future__ import annotations
 
+from contextlib import (
+    AbstractContextManager,
+    nullcontext,
+)
 import os
 import platform
 from typing import (
@@ -9,6 +13,7 @@
 
 from packaging.version import parse
 import pandas as pd
+import pytest
 
 from pandas._typing import T
 
@@ -32,3 +37,59 @@ def check(actual: T, klass: type, dtype: type | None = None, attr: str = "left")
     if not isinstance(value, dtype):
         raise RuntimeError(f"Expected type '{dtype}' but got '{type(value)}'")
     return actual  # type: ignore[return-value]
+
+
+def pytest_warns_bounded(
+    warning: type[Warning],
+    match: str,
+    lower: str | None = None,
+    upper: str | None = None,
+) -> AbstractContextManager:
+    """
+    Version conditional pytet.warns context manager
+
+    Returns a context manager that will raise an error if
+    the warning is not issued when pandas version is
+    between the lower and upper version given.
+
+    Parameters
+    ----------
+    warning : type[Warning]
+        The warning class to check for.
+    match : str
+        The string to match in the warning message.
+    lower : str, optional
+        The lower bound of the version to check for the warning.
+    upper : str, optional
+        The upper bound of the version to check for the warning.
+
+    Notes
+    -----
+    The lower and upper bounds are exclusive so that a pytest.warns context
+    manager is returned if lower < pd.__version__ < upper.
+
+    Examples
+    --------
+    with pytest_warns_bounded(UserWarning, match="foo", lower="1.2.99"):
+        # Versions 1.3.0 and above will raise an error
+        # if the warning is not issued
+        pass
+
+    with pytest_warns_bounded(UserWarning, match="foo", upper="1.5.99"):
+        # Versions 1.6.0 and below will raise an error
+        # if the warning is not issued
+        pass
+
+    with pytest_warns_bounded(
+        UserWarning, match="foo", lower="1.2.99", upper="1.5.99"
+    ):
+        # Versions between 1.3.x and 1.5.x will raise an error
+        pass
+    """
+    lb = parse("0.0.0") if lower is None else parse(lower)
+    ub = parse("9999.0.0") if upper is None else parse(upper)
+    current = parse(pd.__version__)
+    if lb < current < ub:
+        return pytest.warns(warning, match=match)
+    else:
+        return nullcontext()

tests/test_frame.py

@@ -39,6 +39,7 @@
     PD_LTE_15,
     TYPE_CHECKING_INVALID_USAGE,
     check,
+    pytest_warns_bounded,
 )
 
 from pandas.io.formats.style import Styler
@@ -934,16 +935,11 @@ def test_types_describe() -> None:
         }
     )
     df.describe()
-    if PD_LTE_15:
-        with pytest.warns(FutureWarning, match="Treating datetime data as categorical"):
-            df.describe(percentiles=[0.5], include="all")
-    else:
-        df.describe(percentiles=[0.5], include="all")
-    if PD_LTE_15:
-        with pytest.warns(FutureWarning, match="Treating datetime data as categorical"):
-            df.describe(exclude=[np.number])
-    else:
+    with pytest_warns_bounded(
+        FutureWarning, match="Treating datetime data as categorical", upper="1.5.999"
+    ):
         df.describe(percentiles=[0.5], include="all")
+        df.describe(exclude=[np.number])
     if PD_LTE_15:
         # datetime_is_numeric param added in 1.1.0
         # https://pandas.pydata.org/docs/whatsnew/v1.1.0.html

tests/test_series.py

@@ -649,7 +649,6 @@ def test_types_describe() -> None:
         s.describe(percentiles=[0.5], include="all")
     with pytest.warns(DeprecationWarning, match="elementwise comparison failed"):
         s.describe(exclude=np.number)
-    # datetime_is_numeric param added in 1.1.0 https://pandas.pydata.org/docs/whatsnew/v1.1.0.html
     if PD_LTE_15:
         # datetime_is_numeric param added in 1.1.0
         # https://pandas.pydata.org/docs/whatsnew/v1.1.0.html