Skip to content

Handle unhandled IsADirectoryError and PermissionError in ZoneInfo #86

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

Closed
bijij wants to merge 3 commits into from
Closed

Handle unhandled IsADirectoryError and PermissionError in ZoneInfo #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3010e7
Handle unhandled IsADirectoryError and PermissionError in ZoneInfo
bijij Aug 15, 2020
ab473af
Add example tests to ZoneInfoTest.test_bad_keys
bijij Aug 19, 2020
773802a
workaround importlib.resources.files
bijij Sep 3, 2020
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
23 changes: 22 additions & 1 deletion src/backports/zoneinfo/_common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ def load_tzdata(key):
try:
return importlib_resources.open_binary(package_name, resource_name)
except (ImportError, FileNotFoundError, UnicodeEncodeError):
# There are three types of exception that can be raised that all amount
# There are some types of exception that can be raised that all amount
# to "we cannot find this key":
#
# ImportError: If package_name doesn't exist (e.g. if tzdata is not
Expand All @@ -25,6 +25,27 @@ def load_tzdata(key):
# UnicodeEncodeError: If package_name or resource_name are not UTF-8,
# such as keys containing a surrogate character.
raise ZoneInfoNotFoundError(f"No time zone found with key {key}")
except (IsADirectoryError, PermissionError):
# A few exceptions inherited from OSError can be raised in various scenarios:
#
# IsADirectoryError: If the resource_name links to a directory
# (e.g. Australia)
# PermissionError: If the resource_name links to a directory on Windows
# (e.g. Pacific)
import pathlib
try:
import importlib.util as importlib_util
except ImportError:
raise

tzdata_spec = importlib_util.find_spec("tzdata")
tzdata_path = pathlib.Path(tzdata_spec.origin).parent
resource_path = tzdata_path / "zoneinfo" / key

if resource_path.is_dir():
raise ZoneInfoNotFoundError(f"No time zone found with key {key}")
else:
raise


def load_data(fobj):
Expand Down
2 changes: 2 additions & 0 deletions tests/test_zoneinfo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,7 @@ def test_bad_keys(self):
"America.Los_Angeles",
"🇨🇦", # Non-ascii
"America/New\ud800York", # Contains surrogate character
"America",
]

for bad_key in bad_keys:
Expand All @@ -239,6 +240,7 @@ def test_bad_keys_paths(self):
"../zoneinfo/America/Los_Angeles", # Traverses above TZPATH
"America/../America/Los_Angeles", # Not normalized
"America/./Los_Angeles",
"America/"
]

for bad_key in bad_keys:
Expand Down