WARN,TST check stacklevel for all warnings (#47998)

* use find_stack_level everywhere

* fixup

* pyx fixups

* fixup test_optional_dependency

* fixup api

* set check_stacklevel=False for some tests

* use lru_cache for currentframe

* fixup import in __init__

* add missing imports to pyx files

* add missing import

* fixup import in conversion

* revert some __init__ changes

* start n=1

* temporarily dont check stacklevel in _check_plot_works

* catch some more warnings

* dont check stacklevel in check_plot_works

* fixup

* ignore stacklevel in check_plot_works

Author: MarcoGorelli

doc/source/development/contributing_codebase.rst

@@ -122,6 +122,7 @@ Otherwise, you need to do it manually:
 .. code-block:: python
 
     import warnings
+    from pandas.util._exceptions import find_stack_level
 
 
     def old_func():
@@ -130,7 +131,11 @@ Otherwise, you need to do it manually:
         .. deprecated:: 1.1.0
            Use new_func instead.
         """
-        warnings.warn('Use new_func instead.', FutureWarning, stacklevel=2)
+        warnings.warn(
+            'Use new_func instead.',
+            FutureWarning,
+            stacklevel=find_stack_level(inspect.currentframe()),
+        )
         new_func()
 
 

pandas/_config/config.py

@@ -54,6 +54,7 @@
     ContextDecorator,
     contextmanager,
 )
+import inspect
 import re
 from typing import (
     Any,
@@ -70,6 +71,7 @@
     F,
     T,
 )
+from pandas.util._exceptions import find_stack_level
 
 
 class DeprecatedOption(NamedTuple):
@@ -657,7 +659,11 @@ def _warn_if_deprecated(key: str) -> bool:
     d = _get_deprecated_option(key)
     if d:
         if d.msg:
-            warnings.warn(d.msg, FutureWarning)
+            warnings.warn(
+                d.msg,
+                FutureWarning,
+                stacklevel=find_stack_level(inspect.currentframe()),
+            )
         else:
             msg = f"'{key}' is deprecated"
             if d.removal_ver:
@@ -667,7 +673,9 @@ def _warn_if_deprecated(key: str) -> bool:
             else:
                 msg += ", please refrain from using it."
 
-            warnings.warn(msg, FutureWarning)
+            warnings.warn(
+                msg, FutureWarning, stacklevel=find_stack_level(inspect.currentframe())
+            )
         return True
     return False
 

pandas/_libs/interval.pyx

@@ -230,7 +230,7 @@ def _warning_interval(inclusive: str | None = None, closed: None | lib.NoDefault
         warnings.warn(
             "Argument `closed` is deprecated in favor of `inclusive`.",
             FutureWarning,
-            stacklevel=2,
+            stacklevel=find_stack_level(inspect.currentframe()),
         )
         if closed is None:
             inclusive = "right"

pandas/_libs/lib.pyx

@@ -1,6 +1,7 @@
 from collections import abc
 from decimal import Decimal
 from enum import Enum
+import inspect
 from typing import Literal
 import warnings
 
@@ -30,6 +31,8 @@ from cython cimport (
     floating,
 )
 
+from pandas.util._exceptions import find_stack_level
+
 import_datetime()
 
 import numpy as np
@@ -352,6 +355,7 @@ def fast_unique_multiple(list arrays, sort: bool = True):
                 "The values in the array are unorderable. "
                 "Pass `sort=False` to suppress this warning.",
                 RuntimeWarning,
+                stacklevel=find_stack_level(inspect.currentframe()),
             )
             pass
 

pandas/_libs/parsers.pyx

@@ -8,10 +8,13 @@ from csv import (
     QUOTE_NONNUMERIC,
 )
 from errno import ENOENT
+import inspect
 import sys
 import time
 import warnings
 
+from pandas.util._exceptions import find_stack_level
+
 cimport cython
 from cpython.bytes cimport (
     PyBytes_AsString,
@@ -958,7 +961,7 @@ cdef class TextReader:
                     "Defining usecols with out of bounds indices is deprecated "
                     "and will raise a ParserError in a future version.",
                     FutureWarning,
-                    stacklevel=6,
+                    stacklevel=find_stack_level(inspect.currentframe()),
                 )
 
         results = {}
@@ -1009,7 +1012,7 @@ cdef class TextReader:
                     warnings.warn((f"Both a converter and dtype were specified "
                                    f"for column {name} - only the converter will "
                                    f"be used."), ParserWarning,
-                                  stacklevel=5)
+                                  stacklevel=find_stack_level(inspect.currentframe()))
                 results[i] = _apply_converter(conv, self.parser, i, start, end)
                 continue
 

pandas/_libs/tslib.pyx

@@ -1,3 +1,4 @@
+import inspect
 import warnings
 
 cimport cython
@@ -9,6 +10,8 @@ from cpython.datetime cimport (
     tzinfo,
 )
 
+from pandas.util._exceptions import find_stack_level
+
 # import datetime C API
 import_datetime()
 
@@ -845,7 +848,7 @@ cdef inline bint _parse_today_now(str val, int64_t* iresult, bint utc):
                 "deprecated. In a future version, this will match Timestamp('now') "
                 "and Timestamp.now()",
                 FutureWarning,
-                stacklevel=1,
+                stacklevel=find_stack_level(inspect.currentframe()),
             )
 
         return True

pandas/_libs/tslibs/conversion.pyx

@@ -1,9 +1,13 @@
+import inspect
+
 cimport cython
 
 import warnings
 
 import numpy as np
 
+from pandas.util._exceptions import find_stack_level
+
 cimport numpy as cnp
 from cpython.object cimport PyObject
 from numpy cimport (
@@ -287,7 +291,7 @@ cdef _TSObject convert_to_tsobject(object ts, tzinfo tz, str unit,
                         "Conversion of non-round float with unit={unit} is ambiguous "
                         "and will raise in a future version.",
                         FutureWarning,
-                        stacklevel=1,
+                        stacklevel=find_stack_level(inspect.currentframe()),
                     )
 
             ts = cast_from_unit(ts, unit)

pandas/_libs/tslibs/nattype.pyx

@@ -1,5 +1,8 @@
+import inspect
 import warnings
 
+from pandas.util._exceptions import find_stack_level
+
 from cpython.datetime cimport (
     PyDate_Check,
     PyDateTime_Check,
@@ -135,7 +138,7 @@ cdef class _NaT(datetime):
                 "order to match the standard library behavior. "
                 "In a future version these will be considered non-comparable.",
                 FutureWarning,
-                stacklevel=1,
+                stacklevel=find_stack_level(inspect.currentframe()),
             )
             return False
 
@@ -379,7 +382,7 @@ class NaTType(_NaT):
         warnings.warn(
             "NaT.freq is deprecated and will be removed in a future version.",
             FutureWarning,
-            stacklevel=1,
+            stacklevel=find_stack_level(inspect.currentframe()),
         )
         return None
 

pandas/_libs/tslibs/offsets.pyx

@@ -1,8 +1,11 @@
+import inspect
 import operator
 import re
 import time
 import warnings
 
+from pandas.util._exceptions import find_stack_level
+
 cimport cython
 from cpython.datetime cimport (
     PyDate_Check,
@@ -499,7 +502,7 @@ cdef class BaseOffset:
             "DateOffset.__call__ is deprecated and will be removed in a future "
             "version.  Use `offset + other` instead.",
             FutureWarning,
-            stacklevel=1,
+            stacklevel=find_stack_level(inspect.currentframe()),
         )
         return self._apply(other)
 
@@ -509,7 +512,7 @@ cdef class BaseOffset:
             f"{type(self).__name__}.apply is deprecated and will be removed "
             "in a future version. Use `offset + other` instead",
             FutureWarning,
-            stacklevel=2,
+            stacklevel=find_stack_level(inspect.currentframe()),
         )
         return self._apply(other)
 
@@ -820,15 +823,15 @@ cdef class BaseOffset:
         warnings.warn(
             "onOffset is a deprecated, use is_on_offset instead.",
             FutureWarning,
-            stacklevel=1,
+            stacklevel=find_stack_level(inspect.currentframe()),
         )
         return self.is_on_offset(dt)
 
     def isAnchored(self) -> bool:
         warnings.warn(
             "isAnchored is a deprecated, use is_anchored instead.",
             FutureWarning,
-            stacklevel=1,
+            stacklevel=find_stack_level(inspect.currentframe()),
         )
         return self.is_anchored()
 

pandas/_libs/tslibs/parsing.pyx

@@ -1,10 +1,13 @@
 """
 Parsing functions for datetime and datetime-like strings.
 """
+import inspect
 import re
 import time
 import warnings
 
+from pandas.util._exceptions import find_stack_level
+
 cimport cython
 from cpython.datetime cimport (
     datetime,
@@ -214,15 +217,15 @@ cdef inline object _parse_delimited_date(str date_string, bint dayfirst):
                     format='MM/DD/YYYY',
                     dayfirst='True',
                 ),
-                stacklevel=4,
+                stacklevel=find_stack_level(inspect.currentframe()),
             )
         elif not dayfirst and swapped_day_and_month:
             warnings.warn(
                 PARSING_WARNING_MSG.format(
                     format='DD/MM/YYYY',
                     dayfirst='False (the default)',
                 ),
-                stacklevel=4,
+                stacklevel=find_stack_level(inspect.currentframe()),
             )
         # In Python <= 3.6.0 there is no range checking for invalid dates
         # in C api, thus we call faster C version for 3.6.1 or newer