dycw-utilities 0.160.2__tar.gz → 0.161.0__tar.gz

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.160.2
+Version: 0.161.0
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/pyproject.toml

@@ -227,7 +227,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.160.2"
+version = "0.161.0"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -259,7 +259,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.160.2"
+current_version = "0.161.0"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/src/tests/conftest.py

@@ -9,7 +9,7 @@ from hypothesis import HealthCheck
 from pytest import fixture, mark, param, skip
 
 from utilities.contextlib import enhanced_context_manager
-from utilities.platform import IS_MAC, IS_NOT_LINUX, IS_WINDOWS
+from utilities.platform import IS_LINUX, IS_MAC, IS_NOT_LINUX, IS_WINDOWS
 from utilities.re import ExtractGroupError, extract_group
 from utilities.whenever import MINUTE, get_now, parse_plain_local
 
@@ -29,11 +29,13 @@ SKIPIF_CI = mark.skipif(IS_CI, reason="Skipped for CI")
 IS_CI_AND_NOT_LINUX = IS_CI and IS_NOT_LINUX
 IS_CI_AND_WINDOWS = IS_CI and IS_WINDOWS
 IS_CI_AND_MAC = IS_CI and IS_MAC
+IS_CI_AND_LINUX = IS_CI and IS_LINUX
 SKIPIF_CI_AND_NOT_LINUX = mark.skipif(
     IS_CI_AND_NOT_LINUX, reason="Skipped for CI/non-Linux"
 )
 SKIPIF_CI_AND_WINDOWS = mark.skipif(IS_CI_AND_WINDOWS, reason="Skipped for CI/Windows")
 SKIPIF_CI_AND_MAC = mark.skipif(IS_CI_AND_MAC, reason="Skipped for CI/Mac")
+SKIPIF_CI_AND_LINUX = mark.skipif(IS_CI_AND_LINUX, reason="Skipped for CI/Linux")
 
 
 # hypothesis

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/src/tests/test_polars.py

@@ -222,7 +222,7 @@ from utilities.whenever import (
     get_now_plain,
     get_today,
 )
-from utilities.zoneinfo import UTC, get_time_zone_name
+from utilities.zoneinfo import UTC, to_time_zone_name
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterable, Mapping, Sequence
@@ -1426,18 +1426,18 @@ class TestDataClassToSchema:
 
 
 class TestDatetimeDTypes:
-    @given(
-        case=sampled_from([
-            (HongKong, DatetimeHongKong),
-            (Tokyo, DatetimeTokyo),
-            (USCentral, DatetimeUSCentral),
-            (USEastern, DatetimeUSEastern),
-            (UTC, DatetimeUTC),
-        ])
+    @mark.parametrize(
+        ("time_zone", "dtype"),
+        [
+            param(HongKong, DatetimeHongKong),
+            param(Tokyo, DatetimeTokyo),
+            param(USCentral, DatetimeUSCentral),
+            param(USEastern, DatetimeUSEastern),
+            param(UTC, DatetimeUTC),
+        ],
     )
-    def test_main(self, *, case: tuple[ZoneInfo, Datetime]) -> None:
-        time_zone, dtype = case
-        name = get_time_zone_name(time_zone)
+    def test_main(self, *, time_zone: ZoneInfo, dtype: Datetime) -> None:
+        name = to_time_zone_name(time_zone)
         expected = dtype.time_zone
         assert name == expected
 

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/src/tests/test_types.py

@@ -9,8 +9,7 @@ from hypothesis.strategies import sampled_from
 from pytest import mark, param
 
 from utilities.platform import SYSTEM
-from utilities.types import Dataclass, Number, PathLike, TimeZone
-from utilities.typing import get_literal_elements
+from utilities.types import TIME_ZONES, Dataclass, Number, PathLike
 
 
 class TestDataClassProtocol:
@@ -45,7 +44,7 @@ class TestPathLike:
 
 class TestTimeZone:
     def test_main(self) -> None:
-        result = set(get_literal_elements(TimeZone))
+        result = set(TIME_ZONES)
         expected = available_timezones()
         match SYSTEM:
             case "windows" | "mac":

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/src/tests/test_whenever.py

@@ -150,7 +150,7 @@ from utilities.whenever import (
     to_zoned_date_time,
     two_digit_year_month,
 )
-from utilities.zoneinfo import UTC, get_time_zone_name
+from utilities.zoneinfo import UTC
 
 if TYPE_CHECKING:
     from collections.abc import Callable
@@ -418,7 +418,8 @@ class TestGetNow:
 
     def test_constant(self) -> None:
         assert isinstance(NOW_UTC, ZonedDateTime)
-        assert NOW_UTC.tz == "UTC"
+        expected = UTC.key
+        assert NOW_UTC.tz == expected
 
 
 class TestGetNowLocal:
@@ -1466,12 +1467,6 @@ class TestWheneverLogRecord:
     def test_get_length(self) -> None:
         assert isinstance(WheneverLogRecord._get_length(), int)
 
-    def test_get_time_zone(self) -> None:
-        assert isinstance(WheneverLogRecord._get_time_zone(), ZoneInfo)
-
-    def test_get_time_zone_key(self) -> None:
-        assert isinstance(WheneverLogRecord._get_time_zone_key(), str)
-
 
 class TestZonedDateTimePeriod:
     @given(period=zoned_date_time_periods(), delta=time_deltas())
@@ -1669,7 +1664,7 @@ class TestZonedDateTimePeriod:
         with assume_does_not_raise(OverflowError, match="date value out of range"):
             result = period.to_tz(UTC)
         assert result.time_zone == UTC
-        name = get_time_zone_name(UTC)
+        name = UTC.key
         expected = ZonedDateTimePeriod(period.start.to_tz(name), period.end.to_tz(name))
         assert result == expected
 

dycw_utilities-0.161.0/src/tests/test_zoneinfo.py

@@ -0,0 +1,138 @@
+from __future__ import annotations
+
+import datetime as dt
+from typing import TYPE_CHECKING, cast
+from zoneinfo import ZoneInfo
+
+from hypothesis import given
+from hypothesis.strategies import (
+    DataObject,
+    data,
+    datetimes,
+    just,
+    sampled_from,
+    timezones,
+)
+from pytest import raises
+
+from tests.conftest import SKIPIF_CI_AND_LINUX
+from utilities.hypothesis import zoned_date_times
+from utilities.tzdata import HongKong, Tokyo
+from utilities.tzlocal import LOCAL_TIME_ZONE, LOCAL_TIME_ZONE_NAME
+from utilities.zoneinfo import (
+    UTC,
+    _ToTimeZoneNameInvalidKeyError,
+    _ToTimeZoneNameInvalidTZInfoError,
+    _ToTimeZoneNamePlainDateTimeError,
+    _ToZoneInfoInvalidTZInfoError,
+    _ToZoneInfoPlainDateTimeError,
+    to_time_zone_name,
+    to_zone_info,
+)
+
+if TYPE_CHECKING:
+    from utilities.types import TimeZoneLike
+
+
+class TestToZoneInfo:
+    @given(time_zone=timezones())
+    def test_zone_info(self, *, time_zone: ZoneInfo) -> None:
+        result = to_zone_info(time_zone)
+        assert result is time_zone
+
+    @given(data=data(), time_zone=timezones())
+    def test_zoned_date_time(self, *, data: DataObject, time_zone: ZoneInfo) -> None:
+        date_time = data.draw(zoned_date_times(time_zone=time_zone))
+        result = to_zone_info(date_time)
+        assert result is time_zone
+
+    def test_local(self) -> None:
+        result = to_zone_info("local")
+        assert result is LOCAL_TIME_ZONE
+
+    @given(time_zone=timezones())
+    def test_str(self, *, time_zone: ZoneInfo) -> None:
+        result = to_zone_info(cast("TimeZoneLike", time_zone.key))
+        assert result is time_zone
+
+    def test_tz_info(self) -> None:
+        result = to_zone_info(dt.UTC)
+        assert result is UTC
+
+    @given(data=data(), time_zone=timezones())
+    def test_py_zoned_date_time(self, *, data: DataObject, time_zone: ZoneInfo) -> None:
+        date_time = data.draw(datetimes(timezones=just(time_zone)))
+        result = to_zone_info(date_time)
+        assert result is time_zone
+
+    def test_error_invalid_tz_info(self) -> None:
+        time_zone = dt.timezone(dt.timedelta(hours=12))
+        with raises(
+            _ToZoneInfoInvalidTZInfoError, match=r"Invalid time-zone: UTC\+12:00"
+        ):
+            _ = to_zone_info(time_zone)
+
+    @given(date_time=datetimes())
+    def test_error_plain_date_time(self, *, date_time: dt.datetime) -> None:
+        with raises(_ToZoneInfoPlainDateTimeError, match="Plain date-time: .*"):
+            _ = to_zone_info(date_time)
+
+
+class TestToTimeZoneName:
+    @given(time_zone=timezones())
+    def test_zone_info(self, *, time_zone: ZoneInfo) -> None:
+        result = to_time_zone_name(time_zone)
+        expected = time_zone.key
+        assert result == expected
+
+    @given(data=data(), time_zone=timezones())
+    def test_zoned_date_time(self, *, data: DataObject, time_zone: ZoneInfo) -> None:
+        date_time = data.draw(zoned_date_times(time_zone=time_zone))
+        result = to_time_zone_name(date_time)
+        expected = time_zone.key
+        assert result == expected
+
+    def test_local(self) -> None:
+        result = to_time_zone_name("local")
+        assert result == LOCAL_TIME_ZONE_NAME
+
+    @given(time_zone=timezones())
+    @SKIPIF_CI_AND_LINUX
+    def test_str(self, *, time_zone: ZoneInfo) -> None:
+        result = to_time_zone_name(cast("TimeZoneLike", time_zone.key))
+        expected = time_zone.key
+        assert result == expected
+
+    def test_tz_info(self) -> None:
+        result = to_time_zone_name(dt.UTC)
+        expected = UTC.key
+        assert result == expected
+
+    @given(data=data(), time_zone=timezones())
+    def test_py_zoned_date_time(self, *, data: DataObject, time_zone: ZoneInfo) -> None:
+        date_time = data.draw(datetimes(timezones=just(time_zone)))
+        result = to_time_zone_name(date_time)
+        expected = time_zone.key
+        assert result == expected
+
+    def test_error_invalid_key(self) -> None:
+        with raises(
+            _ToTimeZoneNameInvalidKeyError, match="Invalid time-zone: 'invalid'"
+        ):
+            _ = to_time_zone_name(cast("TimeZoneLike", "invalid"))
+
+    def test_error_invalid_tz_info(self) -> None:
+        time_zone = dt.timezone(dt.timedelta(hours=12))
+        with raises(_ToTimeZoneNameInvalidTZInfoError, match="Invalid time-zone: .*"):
+            _ = to_time_zone_name(time_zone)
+
+    @given(date_time=datetimes())
+    def test_error_plain_date_time(self, *, date_time: dt.datetime) -> None:
+        with raises(_ToTimeZoneNamePlainDateTimeError, match="Plain date-time: .*"):
+            _ = to_time_zone_name(date_time)
+
+
+class TestTimeZones:
+    @given(time_zone=sampled_from([HongKong, Tokyo, UTC]))
+    def test_main(self, *, time_zone: ZoneInfo) -> None:
+        assert isinstance(time_zone, ZoneInfo)

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.160.2"
+__version__ = "0.161.0"

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/src/utilities/hypothesis.py

@@ -101,7 +101,7 @@ from utilities.whenever import (
     to_days,
     to_nanoseconds,
 )
-from utilities.zoneinfo import UTC, ensure_time_zone
+from utilities.zoneinfo import UTC, to_zone_info
 
 if TYPE_CHECKING:
     from collections.abc import Collection, Hashable, Iterable, Iterator
@@ -1509,7 +1509,7 @@ def zoned_date_times(
 ) -> ZonedDateTime:
     """Strategy for generating zoned date-times."""
     min_value_, max_value_ = [draw2(draw, v) for v in [min_value, max_value]]
-    time_zone_ = ensure_time_zone(draw2(draw, time_zone))
+    time_zone_ = to_zone_info(draw2(draw, time_zone))
     match min_value_:
         case None | PlainDateTime():
             ...

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/src/utilities/polars.py

@@ -104,7 +104,7 @@ from utilities.whenever import (
     ZonedDateTimePeriod,
     to_py_time_delta,
 )
-from utilities.zoneinfo import UTC, ensure_time_zone, get_time_zone_name
+from utilities.zoneinfo import UTC, to_time_zone_name
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterable, Iterator, Mapping, Sequence
@@ -834,7 +834,7 @@ def convert_time_zone(
 
 def _convert_time_zone_one(sr: Series, /, *, time_zone: TimeZoneLike = UTC) -> Series:
     if isinstance(sr.dtype, Datetime):
-        return sr.dt.convert_time_zone(get_time_zone_name(time_zone))
+        return sr.dt.convert_time_zone(to_time_zone_name(time_zone))
     return sr
 
 
@@ -2110,7 +2110,7 @@ def period_range(
     eager: bool = False,
 ) -> Series | Expr:
     """Construct a period range."""
-    time_zone_use = None if time_zone is None else ensure_time_zone(time_zone).key
+    time_zone_use = None if time_zone is None else to_time_zone_name(time_zone)
     match end_or_length:
         case ZonedDateTime() as end:
             ...
@@ -2127,7 +2127,7 @@ def period_range(
         time_zone=time_zone_use,
         eager=eager,
     ).alias("start")
-    ends = (starts.dt.offset_by(interval)).alias("end")
+    ends = starts.dt.offset_by(interval).alias("end")
     period = struct(starts, ends)
     return try_reify_expr(period, starts, ends)
 
@@ -2220,7 +2220,7 @@ def _replace_time_zone_one(
     sr: Series, /, *, time_zone: TimeZoneLike | None = UTC
 ) -> Series:
     if isinstance(sr.dtype, Datetime):
-        time_zone_use = None if time_zone is None else get_time_zone_name(time_zone)
+        time_zone_use = None if time_zone is None else to_time_zone_name(time_zone)
         return sr.dt.replace_time_zone(time_zone_use)
     return sr
 
@@ -2611,7 +2611,7 @@ def zoned_date_time_dtype(
     *, time_unit: TimeUnit = "us", time_zone: TimeZoneLike = UTC
 ) -> Datetime:
     """Create a zoned date-time data type."""
-    return Datetime(time_unit=time_unit, time_zone=get_time_zone_name(time_zone))
+    return Datetime(time_unit=time_unit, time_zone=to_time_zone_name(time_zone))
 
 
 def zoned_date_time_period_dtype(

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/src/utilities/types.py

@@ -15,6 +15,7 @@ from typing import (
     Literal,
     Protocol,
     TypeVar,
+    get_args,
     overload,
     runtime_checkable,
 )
@@ -271,12 +272,16 @@ type TimeZone = Literal[
     "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Nuuk", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Kyiv", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Factory", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kanton", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu"
 ]
 # fmt: on
+TIME_ZONES: list[TimeZone] = list(get_args(TimeZone.__value__))
+
+
 type TimeZoneLike = (
     ZoneInfo | ZonedDateTime | Literal["local"] | TimeZone | dt.tzinfo | dt.datetime
 )
 
 
 __all__ = [
+    "TIME_ZONES",
     "Coro",
     "Dataclass",
     "DateDeltaLike",

{dycw_utilities-0.160.2 → dycw_utilities-0.161.0}/src/utilities/whenever.py

@@ -39,7 +39,7 @@ from utilities.math import sign
 from utilities.platform import get_strftime
 from utilities.sentinel import Sentinel, sentinel
 from utilities.tzlocal import LOCAL_TIME_ZONE, LOCAL_TIME_ZONE_NAME
-from utilities.zoneinfo import UTC, ensure_time_zone, get_time_zone_name
+from utilities.zoneinfo import UTC, to_time_zone_name
 
 if TYPE_CHECKING:
     from utilities.types import (
@@ -188,7 +188,7 @@ class DatePeriod:
                 ...
             case never:
                 assert_never(never)
-        tz = ensure_time_zone(time_zone).key
+        tz = to_time_zone_name(time_zone)
         return ZonedDateTimePeriod(
             self.start.at(start).assume_tz(tz), self.end.at(end).assume_tz(tz)
         )
@@ -335,17 +335,17 @@ def format_compact(
 
 def from_timestamp(i: float, /, *, time_zone: TimeZoneLike = UTC) -> ZonedDateTime:
     """Get a zoned datetime from a timestamp."""
-    return ZonedDateTime.from_timestamp(i, tz=get_time_zone_name(time_zone))
+    return ZonedDateTime.from_timestamp(i, tz=to_time_zone_name(time_zone))
 
 
 def from_timestamp_millis(i: int, /, *, time_zone: TimeZoneLike = UTC) -> ZonedDateTime:
     """Get a zoned datetime from a timestamp (in milliseconds)."""
-    return ZonedDateTime.from_timestamp_millis(i, tz=get_time_zone_name(time_zone))
+    return ZonedDateTime.from_timestamp_millis(i, tz=to_time_zone_name(time_zone))
 
 
 def from_timestamp_nanos(i: int, /, *, time_zone: TimeZoneLike = UTC) -> ZonedDateTime:
     """Get a zoned datetime from a timestamp (in nanoseconds)."""
-    return ZonedDateTime.from_timestamp_nanos(i, tz=get_time_zone_name(time_zone))
+    return ZonedDateTime.from_timestamp_nanos(i, tz=to_time_zone_name(time_zone))
 
 
 ##
@@ -353,7 +353,7 @@ def from_timestamp_nanos(i: int, /, *, time_zone: TimeZoneLike = UTC) -> ZonedDa
 
 def get_now(time_zone: TimeZoneLike = UTC, /) -> ZonedDateTime:
     """Get the current zoned datetime."""
-    return ZonedDateTime.now(get_time_zone_name(time_zone))
+    return ZonedDateTime.now(to_time_zone_name(time_zone))
 
 
 NOW_UTC = get_now(UTC)
@@ -1703,24 +1703,7 @@ class WheneverLogRecord(LogRecord):
         )
         length = self._get_length()
         plain = format(get_now_local().to_plain().format_common_iso(), f"{length}s")
-        time_zone = self._get_time_zone_key()
-        self.zoned_datetime = f"{plain}[{time_zone}]"
-
-    @classmethod
-    @cache
-    def _get_time_zone(cls) -> ZoneInfo:
-        """Get the local timezone."""
-        try:
-            from utilities.tzlocal import get_local_time_zone
-        except ModuleNotFoundError:  # pragma: no cover
-            return UTC
-        return get_local_time_zone()
-
-    @classmethod
-    @cache
-    def _get_time_zone_key(cls) -> str:
-        """Get the local timezone as a string."""
-        return cls._get_time_zone().key
+        self.zoned_datetime = f"{plain}[{LOCAL_TIME_ZONE_NAME}]"
 
     @classmethod
     @cache
@@ -1878,7 +1861,7 @@ class ZonedDateTimePeriod:
 
     def to_tz(self, time_zone: TimeZoneLike, /) -> Self:
         """Convert the time zone."""
-        tz = get_time_zone_name(time_zone)
+        tz = to_time_zone_name(time_zone)
         return self.replace(start=self.start.to_tz(tz), end=self.end.to_tz(tz))
 
 

dycw_utilities-0.161.0/src/utilities/zoneinfo.py

@@ -0,0 +1,133 @@
+from __future__ import annotations
+
+import datetime as dt
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, assert_never, cast, override
+from zoneinfo import ZoneInfo
+
+from whenever import ZonedDateTime
+
+from utilities.types import TIME_ZONES
+from utilities.tzlocal import LOCAL_TIME_ZONE, LOCAL_TIME_ZONE_NAME
+
+if TYPE_CHECKING:
+    from utilities.types import TimeZone, TimeZoneLike
+
+
+UTC = ZoneInfo("UTC")
+
+
+##
+
+
+def to_zone_info(obj: TimeZoneLike, /) -> ZoneInfo:
+    """Convert to a time-zone."""
+    match obj:
+        case ZoneInfo() as zone_info:
+            return zone_info
+        case ZonedDateTime() as date_time:
+            return ZoneInfo(date_time.tz)
+        case "local":
+            return LOCAL_TIME_ZONE
+        case str() as key:
+            return ZoneInfo(key)
+        case dt.tzinfo() as tzinfo:
+            if tzinfo is dt.UTC:
+                return UTC
+            raise _ToZoneInfoInvalidTZInfoError(time_zone=obj)
+        case dt.datetime() as date_time:
+            if date_time.tzinfo is None:
+                raise _ToZoneInfoPlainDateTimeError(date_time=date_time)
+            return to_zone_info(date_time.tzinfo)
+        case never:
+            assert_never(never)
+
+
+@dataclass(kw_only=True, slots=True)
+class ToTimeZoneError(Exception): ...
+
+
+@dataclass(kw_only=True, slots=True)
+class _ToZoneInfoInvalidTZInfoError(ToTimeZoneError):
+    time_zone: dt.tzinfo
+
+    @override
+    def __str__(self) -> str:
+        return f"Invalid time-zone: {self.time_zone}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _ToZoneInfoPlainDateTimeError(ToTimeZoneError):
+    date_time: dt.datetime
+
+    @override
+    def __str__(self) -> str:
+        return f"Plain date-time: {self.date_time}"
+
+
+##
+
+
+def to_time_zone_name(obj: TimeZoneLike, /) -> TimeZone:
+    """Convert to a time zone name."""
+    match obj:
+        case ZoneInfo() as zone_info:
+            return cast("TimeZone", zone_info.key)
+        case ZonedDateTime() as date_time:
+            return cast("TimeZone", date_time.tz)
+        case "local":
+            return LOCAL_TIME_ZONE_NAME
+        case str() as time_zone:
+            if time_zone in TIME_ZONES:
+                return time_zone
+            raise _ToTimeZoneNameInvalidKeyError(time_zone=time_zone)
+        case dt.tzinfo() as tzinfo:
+            if tzinfo is dt.UTC:
+                return cast("TimeZone", UTC.key)
+            raise _ToTimeZoneNameInvalidTZInfoError(time_zone=obj)
+        case dt.datetime() as date_time:
+            if date_time.tzinfo is None:
+                raise _ToTimeZoneNamePlainDateTimeError(date_time=date_time)
+            return to_time_zone_name(date_time.tzinfo)
+        case never:
+            assert_never(never)
+
+
+@dataclass(kw_only=True, slots=True)
+class ToTimeZoneNameError(Exception): ...
+
+
+@dataclass(kw_only=True, slots=True)
+class _ToTimeZoneNameInvalidKeyError(ToTimeZoneNameError):
+    time_zone: str
+
+    @override
+    def __str__(self) -> str:
+        return f"Invalid time-zone: {self.time_zone!r}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _ToTimeZoneNameInvalidTZInfoError(ToTimeZoneNameError):
+    time_zone: dt.tzinfo
+
+    @override
+    def __str__(self) -> str:
+        return f"Invalid time-zone: {self.time_zone}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _ToTimeZoneNamePlainDateTimeError(ToTimeZoneNameError):
+    date_time: dt.datetime
+
+    @override
+    def __str__(self) -> str:
+        return f"Plain date-time: {self.date_time}"
+
+
+__all__ = [
+    "UTC",
+    "ToTimeZoneError",
+    "ToTimeZoneNameError",
+    "to_time_zone_name",
+    "to_zone_info",
+]