Use zoneinfo for timezone handling instead of pytz #1179
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1179 +/- ##
===========================================
- Coverage 100.00% 99.91% -0.09%
===========================================
Files 10 10
Lines 2326 2324 -2
Branches 400 400
===========================================
- Hits 2326 2322 -4
- Misses 0 1 +1
- Partials 0 1 +1 ☔ View full report in Codecov by Sentry. |
pyproject.toml
Outdated
| @@ -46,7 +46,6 @@ test = [ | |||
| "pytest", | |||
| "pytest-cov", | |||
| "pytest-mock", | |||
| "pytz==2021.1", | |||
| "simplejson==3.*", | |||
There was a problem hiding this comment.
we need to add a dependency on the backport like this:
backports.zoneinfo = {version = "0.2.1", markers = "python_version < '3.9'"}
| from dateutil.zoneinfo import get_zonefile_instance | ||
|
|
||
|
|
||
| def make_full_tz_list(): | ||
| dateutil_zones = set(get_zonefile_instance().zones) | ||
| pytz_zones = set(pytz.all_timezones) | ||
| return dateutil_zones.union(pytz_zones) | ||
| zoneinfo_zones = set(zoneinfo.available_timezones()) |
There was a problem hiding this comment.
Does this have the proper coverage for all timezones? We primarily used pytz to get greater coverage of time zones for the sake of tests
There was a problem hiding this comment.
I just compared them and it does have the same coverage as pytz (Windows 11). However, from the zoneinfo docs:
The zoneinfo module does not directly provide time zone data, and instead pulls time zone information from the system time zone database or the first-party PyPI package tzdata, if available. Some systems, including notably Windows systems, do not have an IANA database available, and so for projects targeting cross-platform compatibility that require time zone data, it is recommended to declare a dependency on tzdata. If neither system data nor tzdata are available, all calls to ZoneInfo will raise ZoneInfoNotFoundError.
tests/test_arrow.py
Outdated
| @@ -57,9 +56,9 @@ def test_init(self): | |||
| assert result._datetime == self.expected | |||
|
|
|||
| # regression tests for issue #626 | |||
| def test_init_pytz_timezone(self): | |||
There was a problem hiding this comment.
Can we add a separate test for pytz and another for zoneinfo? I don't think we should be removing pytz and closing the open issue for the sake of the tests. There is still a use-case for passing in a pytz timezone into Arrow, especially if someone has not yet adopted zoneinfo.
If pytz is not used in the core arrow code and only in the test code (it is only pulled in via requirements-tests.txt, I think we need another CR that focuses on adding support for Zoneinfo natively throughout rather than using dateutil, which is our primary means of doing timezones.
Pull Request Checklist
Thank you for taking the time to improve Arrow! Before submitting your pull request, please check all appropriate boxes:
toxormake testto find out!).tox -e lintormake lintto find out!).masterbranch.If you have any questions about your code changes or any of the points above, please submit your questions along with the pull request and we will try our best to help!
Description of Changes
Closes #1175. Remove all pytz code and replace it with the equivalent from zoneinfo and use a backport for python versions <3.9.