Remove pytz

Author: waketzheng

.github/workflows/ci.yml

@@ -90,14 +90,6 @@ jobs:
         run: |
           uv pip uninstall typing-extensions
           uv run --no-sync python examples/basic.py
-      - name: Test No pytz
-        if: matrix.python-version == 'py3.12'
-        run: |
-          uv pip uninstall pytz
-          uv run --no-sync pytest $PYTEST_ARGS tests/
-        env:
-          PYTHONDEVMODE: 1
-          PYTEST_ARGS: "-n auto --cov=tortoise --cov-append --cov-branch --tb=native -q"
       - name: Upload Coverage
         run: |
           uvx coveralls --service=github

CHANGELOG.rst

@@ -43,7 +43,7 @@ Changed
 - **Shell command now uses optional dependencies**: Install with ``pip install tortoise-orm[ipython]`` (recommended) or ``pip install tortoise-orm[ptpython]`` to enable. IPython is preferred over ptpython. Both shells are supported.
 - **DatetimeField and TimeField behavior change**: Fields with ``auto_now=True`` no longer incorrectly set ``auto_now_add=True`` internally.
 - feat: foreignkey to model type (#2027)
-- refactor: move pytz to optional dependencies (#2023)
+- refactor: remove `pytz` and use standard library `zoneinfo` (#2023)
 
 Deprecated
 ^^^^^^^^^^

pyproject.toml

@@ -49,7 +49,6 @@ accel = [
     "ciso8601; sys_platform != 'win32' and implementation_name == 'cpython'",
     "uvloop; sys_platform != 'win32' and implementation_name == 'cpython'",
     "orjson",
-    "pytz",
 ]
 asyncpg = ["asyncpg"]
 aiomysql = ["aiomysql"]

tests/fields/test_time.py

@@ -3,17 +3,18 @@
 from datetime import timezone as dt_timezone
 from time import sleep
 from unittest.mock import patch
+from zoneinfo import ZoneInfoNotFoundError
 
 import pytest
 from iso8601 import ParseError
 
 from tests import testmodels
 from tortoise import fields, timezone
 from tortoise.contrib import test
-from tortoise.contrib.test.condition import NotIn
+from tortoise.contrib.test.condition import In, NotIn
 from tortoise.exceptions import ConfigurationError, IntegrityError
 from tortoise.expressions import F
-from tortoise.timezone import get_default_timezone, parse_timezone
+from tortoise.timezone import UTC, get_default_timezone, parse_timezone
 
 # ============================================================================
 # TestEmpty -> test_empty_*
@@ -229,8 +230,7 @@ async def test_datetime_filter_by_year_month_day(db):
 
 
 @pytest.mark.asyncio
-@test.requireCapability(dialect="sqlite")
-@test.requireCapability(dialect="postgres")
+@test.requireCapability(dialect=In("sqlite", "postgres"))
 async def test_time_create(db):
     """Test creating time fields (sqlite/postgres)."""
     model = testmodels.TimeFields
@@ -241,8 +241,7 @@ async def test_time_create(db):
 
 
 @pytest.mark.asyncio
-@test.requireCapability(dialect="sqlite")
-@test.requireCapability(dialect="postgres")
+@test.requireCapability(dialect=In("sqlite", "postgres"))
 async def test_time_cast(db):
     """Test time field accepts ISO format string (sqlite/postgres)."""
     model = testmodels.TimeFields
@@ -252,8 +251,7 @@ async def test_time_cast(db):
 
 
 @pytest.mark.asyncio
-@test.requireCapability(dialect="sqlite")
-@test.requireCapability(dialect="postgres")
+@test.requireCapability(dialect=In("sqlite", "postgres"))
 async def test_time_values(db):
     """Test time field in values() query (sqlite/postgres)."""
     model = testmodels.TimeFields
@@ -264,8 +262,7 @@ async def test_time_values(db):
 
 
 @pytest.mark.asyncio
-@test.requireCapability(dialect="sqlite")
-@test.requireCapability(dialect="postgres")
+@test.requireCapability(dialect=In("sqlite", "postgres"))
 async def test_time_values_list(db):
     """Test time field in values_list() query (sqlite/postgres)."""
     model = testmodels.TimeFields
@@ -276,8 +273,7 @@ async def test_time_values_list(db):
 
 
 @pytest.mark.asyncio
-@test.requireCapability(dialect="sqlite")
-@test.requireCapability(dialect="postgres")
+@test.requireCapability(dialect=In("sqlite", "postgres"))
 async def test_time_get(db):
     """Test getting by time field (sqlite/postgres)."""
     model = testmodels.TimeFields
@@ -503,3 +499,28 @@ async def test_timedelta_get(db):
     await model.create(timedelta=delta)
     obj = await model.get(timedelta=delta)
     assert obj.timedelta == delta
+
+
+def test_zoneinfo():
+    tz = parse_timezone("Asia/Shanghai")
+    tz2 = parse_timezone("asia/shanghai")
+    tz3 = parse_timezone("asia/ShangHai")
+    now = datetime.now()
+    assert now.replace(tzinfo=tz) == now.replace(tzinfo=tz2) == now.replace(tzinfo=tz3)
+    tz = parse_timezone("US/central")
+    tz2 = parse_timezone("US/Central")
+    assert now.replace(tzinfo=tz) == now.replace(tzinfo=tz2)
+    tz_utc = parse_timezone("UTC")
+    tz_utc2 = parse_timezone("utc")
+    tz_utc3 = parse_timezone("Utc")
+    assert tz_utc.key == tz_utc2.zone == "UTC"
+    assert (
+        now.replace(tzinfo=UTC)
+        == now.replace(tzinfo=tz_utc)
+        == now.replace(tzinfo=tz_utc2)
+        == now.replace(tzinfo=tz_utc3)
+    )
+    with pytest.raises(ZoneInfoNotFoundError):
+        parse_timezone("invalid-zone-name")
+    with pytest.raises(ZoneInfoNotFoundError):
+        parse_timezone("Invalid/Zonename")

tortoise/timezone.py

@@ -4,45 +4,40 @@
 import os
 import sys
 from datetime import datetime, time, tzinfo
+from zoneinfo import ZoneInfo as _ZoneInfo
+from zoneinfo import ZoneInfoNotFoundError
 
-try:
-    import pytz
-except ImportError:
-    from zoneinfo import ZoneInfo as _ZoneInfo
-    from zoneinfo import ZoneInfoNotFoundError
-
-    if sys.version_info >= (3, 12):
-        from datetime import UTC
-    else:
-        from datetime import timezone
-
-        UTC = timezone.utc
-
-    class ZoneInfo(_ZoneInfo):
-        @property
-        def zone(self) -> str:
-            # Compatible with pytz:
-            # >>> ZoneInfo('UTC').key == pytz.timezone('UTC').zone == 'UTC'
-            return self.key
-
-    def parse_timezone(zone: str) -> tzinfo:
-        if zone.upper() == "UTC":
-            return ZoneInfo("UTC")
-        try:
-            return ZoneInfo(zone)
-        except ZoneInfoNotFoundError as e:
-            words = zone.split("/")
-            # Compatible with `pytz.timezone`:
-            #   US/central -> US/Central
-            #   Europe/moscow -> Europe/Moscow
-            #   asia/ShangHai -> Asia/Shanghai
-            styled = "/".join([i if i.isupper() else i.title() for i in words])
-            if styled != zone:
-                return ZoneInfo(zone)
-            raise e
+if sys.version_info >= (3, 12):
+    from datetime import UTC
 else:
-    UTC = pytz.utc  # type: ignore[assignment]
-    parse_timezone = pytz.timezone
+    from datetime import timezone
+
+    UTC = timezone.utc
+
+
+class ZoneInfo(_ZoneInfo):
+    @property
+    def zone(self) -> str:
+        # Compatible with pytz:
+        # >>> ZoneInfo('UTC').key == pytz.timezone('UTC').zone == 'UTC'
+        return self.key
+
+
+def parse_timezone(zone: str) -> tzinfo:
+    if zone.upper() == "UTC":
+        return ZoneInfo("UTC")
+    try:
+        return ZoneInfo(zone)
+    except ZoneInfoNotFoundError as e:
+        words = zone.split("/")
+        # Compatible with `pytz.timezone`:
+        #   US/central -> US/Central
+        #   Europe/moscow -> Europe/Moscow
+        #   asia/ShangHai -> Asia/Shanghai
+        styled = "/".join([i if i.isupper() else i.title() for i in words])
+        if styled != zone:
+            return ZoneInfo(styled)
+        raise e
 
 
 @functools.cache