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.

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
merged 10 commits into from
Feb 6, 2024
Merged

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

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ea9954f
gh-106233: Fix stacklevel in `zoneinfo.InvalidTZPathWarning`
sobolevn Jun 29, 2023
5d4dc18
Merge branch 'main' into issue-106233
AlexWaygood Aug 28, 2023
4ce9123
Use explicit `stacklevel` argument
sobolevn Feb 5, 2024
7572618
Merge branch 'main' into issue-106233
sobolevn Feb 5, 2024
303255f
Add test
sobolevn Feb 5, 2024
ccdbaa6
Better use `__file__`
sobolevn Feb 5, 2024
0a2800e
Address review
sobolevn Feb 6, 2024
2f9dbf4
Address review
sobolevn Feb 6, 2024
62b1fb2
Address review
sobolevn Feb 6, 2024
0ab22a4
Address review
sobolevn Feb 6, 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
25 changes: 23 additions & 2 deletions Lib/test/test_zoneinfo/test_zoneinfo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@
import struct
import tempfile
import unittest
import warnings
from datetime import date, datetime, time, timedelta, timezone
from functools import cached_property

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 @@ -1717,11 +1718,31 @@ def test_env_variable_relative_paths(self):
for input_paths, expected_paths in test_cases:
path_var = os.pathsep.join(input_paths)
with self.python_tzpath_context(path_var):
with self.subTest("module-level warning", path_var=path_var):
with CleanImport("zoneinfo", "zoneinfo._tzpath"):
with warnings.catch_warnings(record=True) as wlog:
import zoneinfo
self.assertEqual(len(wlog), 1)
# Since we use import hacks, we cannot just use `isinstance`
self.assertEqual(
type(wlog[0].message).__qualname__,
"InvalidTZPathWarning",
)
# It should represent the current file:
self.assertTrue(
wlog[0].filename.endswith("test_zoneinfo.py"),
msg=wlog[0].filename,
)

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.assertTrue(
w.warnings[0].filename.endswith("test_zoneinfo.py"),
msg=w.warnings[0].filename,
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not simply:

Suggested change
self.assertTrue(
w.warnings[0].filename.endswith("test_zoneinfo.py"),
msg=w.warnings[0].filename,
)
self.assertEqual(w.warnings[0].filename, __file__)

?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've already done that in ccdbaa6 :)


tzpath = self.module.TZPATH
with self.subTest("filtered", path_var=path_var):
Expand Down
24 changes: 15 additions & 9 deletions Lib/zoneinfo/_tzpath.py
View file
Open in desktop
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)
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2023-06-29-14-26-56.gh-issue-106233.Aqw2HI.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Fix stacklevel in ``InvalidTZPathWarning`` during :mod:`zoneinfo` module
import.
0