-
-
Notifications
You must be signed in to change notification settings - Fork 33.1k
gh-140039: Improve error message in zoneinfo when tzdata is missing #140040
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
Open
daram62
wants to merge
4
commits into
python:main
Choose a base branch
from
daram62:improve-zoneinfo-error-message
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+25
−6
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
38c814a
gh-140039: Improve error message in zoneinfo when tzdata is missing
daram62 bad8647
gh-140039: Improve ZoneInfo error messages with detailed guidance
daram62 43da66c
Merge branch 'main' into improve-zoneinfo-error-message
daram62 36677ba
Address review feedback: simplify error message wording
daram62 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,13 +14,28 @@ def load_tzdata(key): | |
if path.is_dir(): | ||
raise IsADirectoryError | ||
return path.open("rb") | ||
except (ImportError, FileNotFoundError, UnicodeEncodeError, IsADirectoryError): | ||
# There are four types of exception that can be raised that all amount | ||
# to "we cannot find this key": | ||
except ImportError: | ||
# If package_name doesn't exist, it means tzdata is not installed | ||
# or there's an error in the folder name like Amrica/New_York | ||
exc = ZoneInfoNotFoundError(f"No time zone found with key {key}") | ||
|
||
# Check if tzdata is actually missing | ||
try: | ||
import tzdata | ||
except ImportError: | ||
# tzdata is not installed, provide installation instructions | ||
exc.add_note("This error may occur if timezone data is not available.") | ||
exc.add_note("Try:") | ||
exc.add_note(" - Installing the tzdata package: python -m pip install tzdata") | ||
exc.add_note(" - Verifying the timezone key is correct (for example, 'America/New_York')") | ||
exc.add_note("") | ||
exc.add_note("For more information, see:") | ||
exc.add_note("https://docs.python.org/3/library/zoneinfo.html") | ||
Comment on lines
+27
to
+33
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Shouldn't we just add one note with a multiline string? |
||
|
||
raise exc | ||
except (FileNotFoundError, UnicodeEncodeError, IsADirectoryError): | ||
# Other errors that amount to "we cannot find this key": | ||
# | ||
# ImportError: If package_name doesn't exist (e.g. if tzdata is not | ||
# installed, or if there's an error in the folder name like | ||
# Amrica/New_York) | ||
# FileNotFoundError: If resource_name doesn't exist in the package | ||
# (e.g. Europe/Krasnoy) | ||
# UnicodeEncodeError: If package_name or resource_name are not UTF-8, | ||
|
4 changes: 4 additions & 0 deletions
4
Misc/NEWS.d/next/Library/2025-10-13-21-42-05.gh-issue-140039.abcdef.rst
daram62 marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Improve error message in :mod:`zoneinfo` when timezone data is not found due | ||
to missing :pypi:`tzdata` package. The new error message provides clear | ||
instructions on how to resolve the issue, including installing the package | ||
and links to documentation. Patch by daram62. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also delete the tab spaces to pass the CI lint test here and line 34.