Skip to content

Don't show stdlib paths for user_level_warnings #8625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
max-sixty merged 2 commits into from
Jan 21, 2024
Merged

Don't show stdlib paths for user_level_warnings #8625

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54dae1b
Don't show stdlib paths for `user_level_warnings`
max-sixty Jan 19, 2024
d9674a2
Merge branch 'main' into stack-level-fix
max-sixty Jan 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions xarray/core/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
ValuesView,
)
from enum import Enum
from pathlib import Path
from typing import (
TYPE_CHECKING,
Any,
Expand Down Expand Up @@ -1224,12 +1225,12 @@ def module_available(module: str, minversion: str | None = None) -> bool:


def find_stack_level(test_mode=False) -> int:
"""Find the first place in the stack that is not inside xarray.
"""Find the first place in the stack that is not inside xarray or the Python standard library.

This is unless the code emanates from a test, in which case we would prefer
to see the xarray source.

This function is taken from pandas.
This function is taken from pandas and modified to exclude standard library paths.

Parameters
----------
Expand All @@ -1240,19 +1241,27 @@ def find_stack_level(test_mode=False) -> int:
Returns
-------
stacklevel : int
First level in the stack that is not part of xarray.
First level in the stack that is not part of xarray or the Python standard library.
"""
import xarray as xr

pkg_dir = os.path.dirname(xr.__file__)
test_dir = os.path.join(pkg_dir, "tests")
pkg_dir = Path(xr.__file__).parent
test_dir = pkg_dir / "tests"

std_lib_dir = Path(sys.modules["os"].__file__).parent # Standard library path

# https://stackoverflow.com/questions/17407119/python-inspect-stack-is-slow
frame = inspect.currentframe()
n = 0
while frame:
fname = inspect.getfile(frame)
if fname.startswith(pkg_dir) and (not fname.startswith(test_dir) or test_mode):
if (
fname.startswith(str(pkg_dir))
and (not fname.startswith(str(test_dir)) or test_mode)
) or (
fname.startswith(str(std_lib_dir))
and "site-packages" not in fname
and "dist-packages" not in fname
):
frame = frame.f_back
n += 1
else:
Expand Down