Skip to content

gh-114713: Handle case of an empty bytes object passed to zoneinfo.ZoneInfo #132582

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

gh-114713: Handle case of an empty bytes object passed to zoneinfo.ZoneInfo #132582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aa165bc
Fix error message for empty bytes object; adjust the check for an emp…
Eclips4 Apr 16, 2025
1dcee41
Add isinstance check to bypass warning about string and bytes comparison
Eclips4 Apr 16, 2025
df20358
same for string
Eclips4 Apr 16, 2025
6e690a8
Fix typo
Eclips4 Apr 16, 2025
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
1 change: 1 addition & 0 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 @@ -237,6 +237,7 @@ def test_bad_keys_paths(self):
"America/../America/Los_Angeles", # Not normalized
"America/./Los_Angeles",
"",
b"",
]

for bad_key in bad_keys:
Expand Down
6 changes: 5 additions & 1 deletion Lib/zoneinfo/_tzpath.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,14 @@ def find_tzfile(key):


def _validate_tzfile_path(path, _base=_TEST_PATH):
if not path:
Copy link
Member Author

Choose a reason for hiding this comment

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

This wasn't correct.
If we pass None, instead of a TypeError we'll get a ValueError, so we need more exact check here.

if isinstance(path, str) and path == "":
raise ValueError(
"ZoneInfo key must not be an empty string"
)
elif isinstance(path, bytes) and path == b"":
raise ValueError(
"ZoneInfo key must not be an empty bytes object"
)
Comment on lines +90 to +93
Copy link
Contributor

@WolframAlph WolframAlph Apr 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Does it make sense maybe to just emit ZoneInfo key must not be empty for both string and bytes? Also, since we check for passed data types, does it make sense to also restrict them to str/bytes? Currently, passing for instance [] results in TypeError: unhashable type: 'list' somewhere down the road. Maybe worth returning meaningful exception saying what allowed types are? We anyway check passed in types.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, that makes sense. Though I think that the current approach is wrong.
We should insert these two checks (actually, bytes objects shouldn't be passed to the zoneinfo.ZoneInfo) to C and Python implementation of ZoneInfo.__new__:

  1. Check that key is string (or subclass of string)
  2. Check that key is a non-empty string.
    WDYM?


if os.path.isabs(path):
raise ValueError(
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2025-04-16-11-58-20.gh-issue-114713.asdj1k.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Handle case of an empty bytes object passed to :class:`zoneinfo.ZoneInfo`.

Loading