[3.14] gh-138432: Improved invalid path checking in zoneinfo.reset_tzpath() (GH-138433) (GH-138777)

* Improve error messages for path-like relative paths and path-like bytes paths.
* TZPATH is now always a tuple of strings.
(cherry picked from commit 859aecc33b)

Co-authored-by: Stephen Morton <git@tungol.org>
This commit is contained in:
Miss Islington (bot) 2025-10-07 23:06:37 +02:00 committed by GitHub
parent 61d49a5d37
commit dfdda53e67
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 23 additions and 1 deletions

View file

@ -18,7 +18,7 @@
from functools import cached_property
from test.support import MISSING_C_DOCSTRINGS
from test.support.os_helper import EnvironmentVarGuard
from test.support.os_helper import EnvironmentVarGuard, FakePath
from test.test_zoneinfo import _support as test_support
from test.test_zoneinfo._support import TZPATH_TEST_LOCK, ZoneInfoTestBase
from test.support.import_helper import import_module, CleanImport
@ -1783,6 +1783,7 @@ def test_reset_tzpath_relative_paths(self):
("/usr/share/zoneinfo", "../relative/path",),
("path/to/somewhere", "../relative/path",),
("/usr/share/zoneinfo", "path/to/somewhere", "../relative/path",),
(FakePath("path/to/somewhere"),)
]
for input_paths in bad_values:
with self.subTest(input_paths=input_paths):
@ -1794,6 +1795,9 @@ def test_tzpath_type_error(self):
"/etc/zoneinfo:/usr/share/zoneinfo",
b"/etc/zoneinfo:/usr/share/zoneinfo",
0,
(b"/bytes/path", "/valid/path"),
(FakePath(b"/bytes/path"),),
(0,),
]
for bad_value in bad_values:
@ -1804,6 +1808,7 @@ def test_tzpath_type_error(self):
def test_tzpath_attribute(self):
tzpath_0 = [f"{DRIVE}/one", f"{DRIVE}/two"]
tzpath_1 = [f"{DRIVE}/three"]
tzpath_pathlike = (FakePath(f"{DRIVE}/usr/share/zoneinfo"),)
with self.tzpath_context(tzpath_0):
query_0 = self.module.TZPATH
@ -1811,8 +1816,12 @@ def test_tzpath_attribute(self):
with self.tzpath_context(tzpath_1):
query_1 = self.module.TZPATH
with self.tzpath_context(tzpath_pathlike):
query_pathlike = self.module.TZPATH
self.assertSequenceEqual(tzpath_0, query_0)
self.assertSequenceEqual(tzpath_1, query_1)
self.assertSequenceEqual(tuple([os.fspath(p) for p in tzpath_pathlike]), query_pathlike)
class CTzPathTest(TzPathTest):

View file

@ -13,6 +13,13 @@ def _reset_tzpath(to=None, stacklevel=4):
+ f"not {type(tzpaths)}: {tzpaths!r}"
)
tzpaths = [os.fspath(p) for p in tzpaths]
if not all(isinstance(p, str) for p in tzpaths):
raise TypeError(
"All elements of a tzpath sequence must be strings or "
"os.PathLike objects which convert to strings."
)
if not all(map(os.path.isabs, tzpaths)):
raise ValueError(_get_invalid_paths_message(tzpaths))
base_tzpath = tzpaths

View file

@ -0,0 +1,6 @@
:meth:`zoneinfo.reset_tzpath` will now convert any :class:`os.PathLike` objects
it receives into strings before adding them to ``TZPATH``. It will raise
``TypeError`` if anything other than a string is found after this conversion.
If given an :class:`os.PathLike` object that represents a relative path, it
will now raise ``ValueError`` instead of ``TypeError``, and present a more
informative error message.