8000 gh-106233: Fix stacklevel in `zoneinfo.InvalidTZPathWarning` by sobolevn · Pull Request #106234 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

gh-106233: Fix stacklevel in zoneinfo.InvalidTZPathWarning #106234

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.

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
merged 10 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
26 changes: 24 additions & 2 deletions Lib/test/test_zoneinfo/test_zoneinfo.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
from test.support import MISSING_C_DOCSTRINGS
from test.test_zoneinfo import _support as test_support
from test.test_zoneinfo._support import OS_ENV_LOCK, TZPATH_TEST_LOCK, ZoneInfoTestBase
from test.support.import_helper import import_module
from test.support.import_helper import import_module, CleanImport

lzma = import_module('lzma')
py_zoneinfo, c_zoneinfo = test_support.get_modules()
Expand Down Expand Up @@ -1720,13 +1720,35 @@ def test_env_variable_relative_paths(self):
with self.subTest("warning", path_var=path_var):
# Note: Per PEP 615 the warning is implementation-defined
# behavior, other implementations need not warn.
with self.assertWarns(self.module.InvalidTZPathWarning):
with self.assertWarns(self.module.InvalidTZPathWarning) as w:
self.module.reset_tzpath()
self.assertEqual(w.warnings[0].filename, __file__)

tzpath = self.module.TZPATH
with self.subTest("filtered", path_var=path_var):
self.assertSequenceEqual(tzpath, expected_paths)

def test_env_variable_relative_paths_warning_location(self):
path_var = "path/to/somewhere"

with self.python_tzpath_context(path_var):
with self.subTest("module-level warning"):
with CleanImport("zoneinfo", "zoneinfo._tzpath"):
with self.assertWarns(RuntimeWarning) as w:
import zoneinfo
# Since we use import hacks, we cannot just use `isinstance`
self.assertEqual(
type(w.warnings[0].message).__qualname__,
"InvalidTZPathWarning",
)
# It should represent the current file:
self.assertEqual(w.warnings[0].filename, __file__)

with self.subTest("warning"):
with self.assertWarns(self.module.InvalidTZPathWarning) as w:
self.module.reset_tzpath()
self.assertEqual(w.warnings[0].filename, __file__)

def test_reset_tzpath_kwarg(self):
self.module.reset_tzpath(to=[f"{DRIVE}/a/b/c"])

Expand Down
24 changes: 15 additions & 9 deletions Lib/zoneinfo/_tzpath.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import sysconfig


def reset_tzpath(to=None):
def _reset_tzpath(to=None, stacklevel=4):
global TZPATH

tzpaths = to
Expand All @@ -18,17 +18,22 @@ def reset_tzpath(to=None):
base_tzpath = tzpaths
else:
env_var = os.environ.get("PYTHONTZPATH", None)
if env_var is not None:
base_tzpath = _parse_python_tzpath(env_var)
else:
base_tzpath = _parse_python_tzpath(
sysconfig.get_config_var("TZPATH")
)
if env_var is None:
env_var = sysconfig.get_config_var("TZPATH")
base_tzpath = _parse_python_tzpath(env_var, stacklevel)

TZPATH = tuple(base_tzpath)


def _parse_python_tzpath(env_var):
def reset_tzpath(to=None):
"""Reset global TZPATH."""
# We need `_reset_tzpath` helper function because it produces a warning,
# it is used as both a module-level call and a public API.
# This is how we equalize the stacklevel for both calls.
_reset_tzpath(to)


def _parse_python_tzpath(env_var, stacklevel):
if not env_var:
return ()

Expand All @@ -45,6 +50,7 @@ def _parse_python_tzpath(env_var):
"Invalid paths specified in PYTHONTZPATH environment variable. "
+ msg,
InvalidTZPathWarning,
stacklevel=stacklevel,
)

return new_tzpath
Expand Down Expand Up @@ -172,4 +178,4 @@ class InvalidTZPathWarning(RuntimeWarning):


TZPATH = ()
reset_tzpath()
_reset_tzpath(stacklevel=5)
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix stacklevel in ``InvalidTZPathWarning`` during :mod:`zoneinfo` module
import.
0