Drop support for pytz

Replace pytz with zoneinfo which is part of the Python standard library
since Python 3.9.

Bug-Ubuntu: https://launchpad.net/bugs/2101044

Author: bdrung

README.rst

@@ -109,6 +109,13 @@ About DST
 =========
 Be sure to init your croniter instance with a TZ aware datetime for this to work!
 
+Example using zoneinfo::
+
+    >>> import zoneinfo
+    >>> tz = zoneinfo.ZoneInfo("Europe/Berlin")
+    >>> local_date = datetime(2017, 3, 26, tzinfo=tz)
+    >>> val = croniter('0 0 * * *', local_date).get_next(datetime)
+
 Example using pytz::
 
     >>> import pytz
@@ -394,4 +401,3 @@ If you have contributed and your name is not listed below please let us know.
     - shazow
     - yuzawa-san
     - zed2015
-

src/croniter/tests/test_croniter.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 
 import unittest
+import zoneinfo
 from datetime import datetime, timedelta
 from functools import partial
 from time import sleep
@@ -727,7 +728,15 @@ def test_timezone(self):
         n1 = itr.get_next(datetime)
         self.assertEqual(n1.tzinfo, None)
 
+        tokyo = zoneinfo.ZoneInfo("Asia/Tokyo")
+        start = datetime(2013, 3, 4, 12, 15, tzinfo=tokyo)
+        itr2 = croniter("* * * * *", start)
+        n2 = itr2.get_next(datetime)
+        self.assertEqual(n2.tzinfo.key, "Asia/Tokyo")
+
+    def test_timezone_pytz(self):
         tokyo = pytz.timezone("Asia/Tokyo")
+        base = datetime(2013, 3, 4, 12, 15)
         itr2 = croniter("* * * * *", tokyo.localize(base))
         n2 = itr2.get_next(datetime)
         self.assertEqual(n2.tzinfo.zone, "Asia/Tokyo")
@@ -747,6 +756,30 @@ def test_init_no_start_time(self):
         self.assertTrue(itr2.cur > itr.cur)
 
     def test_timezone_winter_time(self):
+        """Test Athens jumps backwards: 2013-10-27 04:00 -> 03:00 (UTC+3 -> UTC+2)."""
+        tz = zoneinfo.ZoneInfo("Europe/Athens")
+
+        expected_schedule = [
+            "2013-10-27T02:30:00+03:00",
+            "2013-10-27T03:00:00+03:00",
+            "2013-10-27T03:30:00+03:00",
+            "2013-10-27T03:00:00+02:00",
+            "2013-10-27T03:30:00+02:00",
+            "2013-10-27T04:00:00+02:00",
+            "2013-10-27T04:30:00+02:00",
+        ]
+
+        start = datetime(2013, 10, 27, 2, 0, 0, tzinfo=tz)
+        ct = croniter("*/30 * * * *", start)
+        schedule = [ct.get_next(datetime).isoformat() for _ in range(7)]
+        self.assertEqual(schedule, expected_schedule)
+
+        start = datetime(2013, 10, 27, 5, 0, 0, tzinfo=tz)
+        ct = croniter("*/30 * * * *", start)
+        schedule = [ct.get_prev(datetime).isoformat() for _ in range(7)]
+        self.assertEqual(schedule, list(reversed(expected_schedule)))
+
+    def test_timezone_winter_time_pytz(self):
         """Test Athens jumps backwards: 2013-10-27 04:00 -> 03:00 (UTC+3 -> UTC+2)."""
         tz = pytz.timezone("Europe/Athens")
 
@@ -771,6 +804,28 @@ def test_timezone_winter_time(self):
         self.assertEqual(schedule, list(reversed(expected_schedule)))
 
     def test_timezone_summer_time(self):
+        """Test Athens jumps forward: 2013-03-31 03:00 -> 04:00 (UTC+2 -> UTC+3)."""
+        tz = zoneinfo.ZoneInfo("Europe/Athens")
+
+        expected_schedule = [
+            "2013-03-31T01:30:00+02:00",
+            "2013-03-31T02:00:00+02:00",
+            "2013-03-31T02:30:00+02:00",
+            "2013-03-31T04:00:00+03:00",
+            "2013-03-31T04:30:00+03:00",
+        ]
+
+        start = datetime(2013, 3, 31, 1, 0, 0, tzinfo=tz)
+        ct = croniter("*/30 * * * *", start)
+        schedule = [ct.get_next(datetime).isoformat() for _ in range(5)]
+        self.assertEqual(schedule, expected_schedule)
+
+        start = datetime(2013, 3, 31, 5, 0, 0, tzinfo=tz)
+        ct = croniter("*/30 * * * *", start)
+        schedule = [ct.get_prev(datetime).isoformat() for _ in range(5)]
+        self.assertEqual(schedule, list(reversed(expected_schedule)))
+
+    def test_timezone_summer_time_pytz(self):
         """Test Athens jumps forward: 2013-03-31 03:00 -> 04:00 (UTC+2 -> UTC+3)."""
         tz = pytz.timezone("Europe/Athens")
 
@@ -798,6 +853,41 @@ def test_std_dst(self):
 
         This fixes https://github.com/taichino/croniter/issues/82
 
+        """
+        tz = zoneinfo.ZoneInfo("Europe/Warsaw")
+        # -> 2017-03-26 01:59+1:00 -> 03:00+2:00
+        local_date = datetime(2017, 3, 26, tzinfo=tz)
+        val = croniter("0 0 * * *", local_date).get_next(datetime)
+        self.assertEqual(val.isoformat(), "2017-03-27T00:00:00+02:00")
+        #
+        local_date = datetime(2017, 3, 26, 1, tzinfo=tz)
+        cr = croniter("0 * * * *", local_date)
+        val = cr.get_next(datetime)
+        self.assertEqual(val.isoformat(), "2017-03-26T03:00:00+02:00")
+        val = cr.get_current(datetime)
+        self.assertEqual(val.isoformat(), "2017-03-26T03:00:00+02:00")
+
+        # -> 2017-10-29 02:59+2:00 -> 02:00+1:00
+        local_date = datetime(2017, 10, 29, tzinfo=tz)
+        val = croniter("0 0 * * *", local_date).get_next(datetime)
+        self.assertEqual(val.isoformat(), "2017-10-30T00:00:00+01:00")
+        local_date = datetime(2017, 10, 29, 1, 59, tzinfo=tz)
+        cr = croniter("0 * * * *", local_date)
+        schedule = [cr.get_next(datetime).isoformat() for _ in range(4)]
+        expected_schedule = [
+            "2017-10-29T02:00:00+02:00",
+            "2017-10-29T02:00:00+01:00",
+            "2017-10-29T03:00:00+01:00",
+            "2017-10-29T04:00:00+01:00",
+        ]
+        self.assertEqual(schedule, expected_schedule)
+
+    def test_std_dst_pytz(self):
+        """
+        DST tests
+
+        This fixes https://github.com/taichino/croniter/issues/82
+
         """
         tz = pytz.timezone("Europe/Warsaw")
         # -> 2017-03-26 01:59+1:00 -> 03:00+2:00
@@ -835,6 +925,39 @@ def test_std_dst2(self):
 
         São Paulo, Brazil: 18/02/2018 00:00 -> 17/02/2018 23:00
 
+        """
+        tz = zoneinfo.ZoneInfo("America/Sao_Paulo")
+        local_dates = [
+            # 17-22: 00 -> 18-00:00
+            (datetime(2018, 2, 17, 21, 0, 0, tzinfo=tz), "2018-02-18 00:00:00-03:00"),
+            # 17-23: 00 -> 18-00:00
+            (datetime(2018, 2, 17, 22, 0, 0, tzinfo=tz), "2018-02-18 00:00:00-03:00"),
+            # 17-23: 00 -> 18-00:00
+            (datetime(2018, 2, 17, 23, 0, 0, tzinfo=tz), "2018-02-18 00:00:00-03:00"),
+            # 18-00: 00 -> 19-00:00
+            (datetime(2018, 2, 18, 0, 0, 0, tzinfo=tz), "2018-02-19 00:00:00-03:00"),
+            # 17-22: 00 -> 18-00:00
+            (datetime(2018, 2, 17, 21, 5, 0, tzinfo=tz), "2018-02-18 00:00:00-03:00"),
+            # 17-23: 00 -> 18-00:00
+            (datetime(2018, 2, 17, 22, 5, 0, tzinfo=tz), "2018-02-18 00:00:00-03:00"),
+            # 17-23: 00 -> 18-00:00
+            (datetime(2018, 2, 17, 23, 5, 0, tzinfo=tz), "2018-02-18 00:00:00-03:00"),
+            # 18-00: 00 -> 19-00:00
+            (datetime(2018, 2, 18, 0, 5, 0, tzinfo=tz), "2018-02-19 00:00:00-03:00"),
+        ]
+        ret1 = [croniter("0 0 * * *", d[0]).get_next(datetime) for d in local_dates]
+        sret1 = [str(d) for d in ret1]
+        lret1 = [str(d[1]) for d in local_dates]
+        self.assertEqual(sret1, lret1)
+
+    def test_std_dst2_pytz(self):
+        """
+        DST tests
+
+        This fixes https://github.com/taichino/croniter/issues/87
+
+        São Paulo, Brazil: 18/02/2018 00:00 -> 17/02/2018 23:00
+
         """
         tz = pytz.timezone("America/Sao_Paulo")
         local_dates = [
@@ -870,6 +993,24 @@ def test_std_dst3(self):
 
         """
 
+        tz = zoneinfo.ZoneInfo("Australia/Adelaide")
+
+        schedule = croniter("0 0 24 * *", datetime(2020, 4, 15, tzinfo=tz))
+        val1 = schedule.get_prev(datetime)
+        self.assertEqual(val1.isoformat(), "2020-03-24T00:00:00+10:30")
+
+        val2 = schedule.get_next(datetime)
+        self.assertEqual(val2.isoformat(), "2020-04-24T00:00:00+09:30")
+
+    def test_std_dst3_pytz(self):
+        """
+        DST tests
+
+        This fixes https://github.com/taichino/croniter/issues/90
+
+        Adelaide, Australia: 15/04/2020 00:00 -> 15/03/2020
+
+        """
         tz = pytz.timezone("Australia/Adelaide")
 
         schedule = croniter("0 0 24 * *", tz.localize(datetime(2020, 4, 15)))
@@ -1169,6 +1310,75 @@ def test_dst_issue90_st31ny(self):
         Paris jumps forward: 2020-03-29 02:00 -> 03:00 (UTC+1 -> UTC+2).
         So 2020-03-29 02:01 does not exist in local time.
 
+        This fixes https://github.com/taichino/croniter/issues/90#issuecomment-605615205
+        """
+        tz = zoneinfo.ZoneInfo("Europe/Paris")
+        now = datetime(2020, 3, 29, 1, 59, 55, tzinfo=tz)
+        it = croniter("1 2 * * *", now)
+        ret = [
+            it.get_next(datetime).isoformat(),
+            it.get_prev(datetime).isoformat(),
+            it.get_prev(datetime).isoformat(),
+            it.get_next(datetime).isoformat(),
+            it.get_next(datetime).isoformat(),
+        ]
+        self.assertEqual(
+            ret,
+            [
+                "2020-03-30T02:01:00+02:00",
+                "2020-03-29T01:01:00+01:00",
+                "2020-03-28T03:01:00+01:00",
+                "2020-03-29T03:01:00+02:00",
+                "2020-03-30T02:01:00+02:00",
+            ],
+        )
+        #
+        nowp = datetime(2020, 3, 28, 1, 58, 55, tzinfo=tz)
+        itp = croniter("1 2 * * *", nowp)
+        retp = [
+            itp.get_next(datetime).isoformat(),
+            itp.get_prev(datetime).isoformat(),
+            itp.get_prev(datetime).isoformat(),
+            itp.get_next(datetime).isoformat(),
+            itp.get_next(datetime).isoformat(),
+        ]
+        self.assertEqual(
+            retp,
+            [
+                "2020-03-29T03:01:00+02:00",
+                "2020-03-29T01:01:00+01:00",
+                "2020-03-28T03:01:00+01:00",
+                "2020-03-29T03:01:00+02:00",
+                "2020-03-30T02:01:00+02:00",
+            ],
+        )
+        #
+        nowt = datetime(2020, 3, 29, 2, 0, 0, tzinfo=tz)
+        itt = croniter("1 2 * * *", nowt)
+        rett = [
+            itt.get_next(datetime).isoformat(),
+            itt.get_prev(datetime).isoformat(),
+            itt.get_prev(datetime).isoformat(),
+            itt.get_next(datetime).isoformat(),
+            itt.get_next(datetime).isoformat(),
+        ]
+        self.assertEqual(
+            rett,
+            [
+                "2020-03-30T02:01:00+02:00",
+                "2020-03-29T01:01:00+01:00",
+                "2020-03-28T03:01:00+01:00",
+                "2020-03-29T03:01:00+02:00",
+                "2020-03-30T02:01:00+02:00",
+            ],
+        )
+
+    def test_dst_issue90_st31ny_pytz(self):
+        """Test DST gap with cron job every day at 02:01.
+
+        Paris jumps forward: 2020-03-29 02:00 -> 03:00 (UTC+1 -> UTC+2).
+        So 2020-03-29 02:01 does not exist in local time.
+
         This fixes https://github.com/taichino/croniter/issues/90#issuecomment-605615205
         """
         tz = pytz.timezone("Europe/Paris")
@@ -1233,6 +1443,25 @@ def test_dst_issue90_st31ny(self):
         )
 
     def test_dst_iter(self):
+        """Test Hebron jumps one hour forward on 2022-03-27 00:00 (UTC+2 -> UTC+3)."""
+        tz = zoneinfo.ZoneInfo("Asia/Hebron")
+        now = datetime(2022, 3, 26, 0, 0, 0, tzinfo=tz)
+        it = croniter("0 0 * * *", now)
+        ret = [
+            it.get_next(datetime).isoformat(),
+            it.get_next(datetime).isoformat(),
+            it.get_next(datetime).isoformat(),
+        ]
+        self.assertEqual(
+            ret,
+            [
+                "2022-03-26T00:00:00+02:00",
+                "2022-03-27T01:00:00+03:00",
+                "2022-03-28T00:00:00+03:00",
+            ],
+        )
+
+    def test_dst_iter_pytz(self):
         """Test Hebron jumps one hour forward on 2022-03-27 00:00 (UTC+2 -> UTC+3)."""
         tz = pytz.timezone("Asia/Hebron")
         now = datetime(2022, 3, 26, 0, 0, 0, tzinfo=tz)
@@ -1761,15 +1990,15 @@ def test_issue_k6(self):
         self.assertRaises(CroniterBadCronError, croniter, "0 0 0 1 0")
 
     def test_issue_k11(self):
-        now = pytz.timezone("America/New_York").localize(datetime(2019, 1, 14, 11, 0, 59))
+        now = datetime(2019, 1, 14, 11, 0, 59, tzinfo=zoneinfo.ZoneInfo("America/New_York"))
         nextnow = croniter("* * * * * ").next(datetime, start_time=now)
         nextnow2 = croniter("* * * * * ", now).next(datetime)
         for nt in nextnow, nextnow2:
-            self.assertEqual(nt.tzinfo.zone, "America/New_York")
+            self.assertEqual(nt.tzinfo.key, "America/New_York")
             self.assertEqual(int(croniter._datetime_to_timestamp(nt)), 1547481660)
 
     def test_issue_k12(self):
-        tz = pytz.timezone("Europe/Athens")
+        tz = zoneinfo.ZoneInfo("Europe/Athens")
         base = datetime(2010, 1, 23, 12, 18, tzinfo=tz)
         itr = croniter("* * * * *")
         itr.set_current(start_time=base)

src/croniter/tests/test_croniter_range.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 
 import unittest
+import zoneinfo
 from datetime import datetime
 
 import pytz
@@ -79,8 +80,8 @@ def test_input_type_exceptions(self):
         with self.assertRaises(TypeError):
             list(croniter_range(f_start1, dt_stop1, "0 * * * *"))
 
-    def test_timezone_dst(self):
-        """Test across DST transition, which technically is a timzone change."""
+    def test_timezone_dst_pytz(self):
+        """Test across DST transition, which technically is a timzone change in pytz."""
         tz = pytz.timezone("America/New_York")
         start = tz.localize(datetime(2020, 10, 30))
         stop = tz.localize(datetime(2020, 11, 10))
@@ -90,6 +91,23 @@ def test_timezone_dst(self):
 
     def test_extra_hour_day_prio(self):
         """Test New York jumps forward: 2020-03-08 02:00 -> 03:00 (UTC-5 -> UTC-4)."""
+        tz = zoneinfo.ZoneInfo("America/New_York")
+        cron = "0 3 * * *"
+        start = datetime(2020, 3, 7, tzinfo=tz)
+        end = datetime(2020, 3, 11, tzinfo=tz)
+        ret = [i.isoformat() for i in croniter_range(start, end, cron)]
+        self.assertEqual(
+            ret,
+            [
+                "2020-03-07T03:00:00-05:00",
+                "2020-03-08T03:00:00-04:00",
+                "2020-03-09T03:00:00-04:00",
+                "2020-03-10T03:00:00-04:00",
+            ],
+        )
+
+    def test_extra_hour_day_prio_pytz(self):
+        """Test New York jumps forward: 2020-03-08 02:00 -> 03:00 (UTC-5 -> UTC-4)."""
 
         def datetime_tz(*args, **kw):
             """Defined this in another branch.  single-use-version"""

src/croniter/tests/test_croniter_speed.py

@@ -3,11 +3,10 @@
 import os
 import sys
 import unittest
+import zoneinfo
 from datetime import datetime
 from timeit import Timer
 
-import pytz
-
 from croniter import croniter
 from croniter.tests import base
 
@@ -85,7 +84,7 @@ def run_long_test(self, iterations=1):
             itr.get_prev(datetime)
 
         # dst regression test
-        tz = pytz.timezone("Europe/Bucharest")
+        tz = zoneinfo.ZoneInfo("Europe/Bucharest")
         offsets = set()
         dst_cron = "15 0,3 * 3 *"
         dst_iters = int(2 * 31 * (iterations / 40))