dycw-utilities 0.160.2__py3-none-any.whl → 0.161.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: dycw-utilities
3
- Version: 0.160.2
3
+ Version: 0.161.0
4
4
  Author-email: Derek Wan <d.wan@icloud.com>
5
5
  License-File: LICENSE
6
6
  Requires-Python: >=3.12
@@ -1,4 +1,4 @@
1
- utilities/__init__.py,sha256=IAj-viBUBKVxxefxAPS4vALM-trPJYFDLnGsnwkKWCY,60
1
+ utilities/__init__.py,sha256=dkBuhBRSI04_W4zI0WhbkTCLLpj2sAVBYTV9S1qQi5g,60
2
2
  utilities/altair.py,sha256=92E2lCdyHY4Zb-vCw6rEJIsWdKipuu-Tu2ab1ufUfAk,9079
3
3
  utilities/asyncio.py,sha256=PUedzQ5deqlSECQ33sam9cRzI9TnygHz3FdOqWJWPTM,15288
4
4
  utilities/atomicwrites.py,sha256=tPo6r-Rypd9u99u66B9z86YBPpnLrlHtwox_8Z7T34Y,5790
@@ -22,7 +22,7 @@ utilities/getpass.py,sha256=DfN5UgMAtFCqS3dSfFHUfqIMZX2shXvwphOz_6J6f6A,103
22
22
  utilities/gzip.py,sha256=fkGP3KdsBfXlstodT4wtlp-PwNyUsogpbDCVVVGdsm4,781
23
23
  utilities/hashlib.py,sha256=SVTgtguur0P4elppvzOBbLEjVM3Pea0eWB61yg2ilxo,309
24
24
  utilities/http.py,sha256=TsavEfHlRtlLaeV21Z6KZh0qbPw-kvD1zsQdZ7Kep5Q,977
25
- utilities/hypothesis.py,sha256=OG8mxN6Y3fSEjRg4NiIjsO_JUHJBzh4g8fvpmKRoRU8,44370
25
+ utilities/hypothesis.py,sha256=MuaAruLcoM1Ka5nZUEWpSxCv1FWRrIINTWCEnFHYwj4,44362
26
26
  utilities/importlib.py,sha256=mV1xT_O_zt_GnZZ36tl3xOmMaN_3jErDWY54fX39F6Y,429
27
27
  utilities/inflect.py,sha256=v7YkOWSu8NAmVghPcf4F3YBZQoJCS47_DLf9jbfWIs0,581
28
28
  utilities/ipython.py,sha256=V2oMYHvEKvlNBzxDXdLvKi48oUq2SclRg5xasjaXStw,763
@@ -45,7 +45,7 @@ utilities/parse.py,sha256=JcJn5yXKhIWXBCwgBdPsyu7Hvcuw6kyEdqvaebCaI9k,17951
45
45
  utilities/pathlib.py,sha256=qGuU8XPmdgGpy8tOMUgelfXx3kxI8h9IaV3TI_06QGE,8428
46
46
  utilities/pickle.py,sha256=MBT2xZCsv0pH868IXLGKnlcqNx2IRVKYNpRcqiQQqxw,653
47
47
  utilities/platform.py,sha256=pTn7gw6N4T6LdKrf0virwarof_mze9WtoQlrGMzhGVI,2798
48
- utilities/polars.py,sha256=fYgoliw5aYwQXjaZSF6Qem1m5ajiuSPdn3y05_cPuyE,79808
48
+ utilities/polars.py,sha256=T-7GZtiw_LBhm3na0jyb8PBpgKGpszZ4zCbJhgc4w2M,79781
49
49
  utilities/polars_ols.py,sha256=Uc9V5kvlWZ5cU93lKZ-cfAKdVFFw81tqwLW9PxtUvMs,5618
50
50
  utilities/postgres.py,sha256=ynCTTaF-bVEOSW-KEAR-dlLh_hYjeVVjm__-4pEU8Zk,12269
51
51
  utilities/pottery.py,sha256=ggMN72Y7wx7Js8VN6eyNyodpm8TIYqZHGghkDPXIVWk,3949
@@ -74,21 +74,21 @@ utilities/threading.py,sha256=GvBOp4CyhHfN90wGXZuA2VKe9fGzMaEa7oCl4f3nnPU,1009
74
74
  utilities/timer.py,sha256=oXfTii6ymu57niP0BDGZjFD55LEHi2a19kqZKiTgaFQ,2588
75
75
  utilities/traceback.py,sha256=1k5JgumSMaqAGLd0dZ36CtPS0EGaglxTr29r2Dz4D60,9457
76
76
  utilities/typed_settings.py,sha256=SFWqS3lAzV7IfNRwqFcTk0YynTcQ7BmrcW2mr_KUnos,4466
77
- utilities/types.py,sha256=zVMapJd3i6xPrY4VagawVfBW_a-ygIKWffwXqxcH0bo,18604
77
+ utilities/types.py,sha256=oQtokry2-oxB-LI3yOkj-6U5FqucZMJTbncQgCM0Jqo,18702
78
78
  utilities/typing.py,sha256=7ZgCNZwA6oaiwpSJIS9Rj3i3MbRBYHMqbC3jMe5KiNg,13992
79
79
  utilities/tzdata.py,sha256=fgNVj66yUbCSI_-vrRVzSD3gtf-L_8IEJEPjP_Jel5Y,266
80
80
  utilities/tzlocal.py,sha256=KyCXEgCTjqGFx-389JdTuhMRUaT06U1RCMdWoED-qro,728
81
81
  utilities/uuid.py,sha256=nQZs6tFX4mqtc2Ku3KqjloYCqwpTKeTj8eKwQwh3FQI,1572
82
82
  utilities/version.py,sha256=ipBj5-WYY_nelp2uwFlApfWWCzTLzPwpovUi9x_OBMs,5085
83
83
  utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
84
- utilities/whenever.py,sha256=vsoVRd8-KXVn9Ik5PveIGgOCuIGnMNqSEoPCsR0sZ30,57755
84
+ utilities/whenever.py,sha256=0JiuKRnF2-mh8Lb5Yi0GlzcJRPFoiW-hI59Er88cs20,57235
85
85
  utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
86
- utilities/zoneinfo.py,sha256=FBMcUQ4662Aq8SsuCL1OAhDQiyANmVjtb-C30DRrWoE,1966
86
+ utilities/zoneinfo.py,sha256=phxGpBIE3KeAYjBnJNdKy9D2myPRQsPewsBA7z1gosI,3591
87
87
  utilities/pytest_plugins/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
88
88
  utilities/pytest_plugins/pytest_randomly.py,sha256=B1qYVlExGOxTywq2r1SMi5o7btHLk2PNdY_b1p98dkE,409
89
89
  utilities/pytest_plugins/pytest_regressions.py,sha256=9v8kAXDM2ycIXJBimoiF4EgrwbUvxTycFWJiGR_GHhM,1466
90
- dycw_utilities-0.160.2.dist-info/METADATA,sha256=NkmSQ_1zohTewn-M4585N-vcMowY-WOukzaTKXVa7CQ,1643
91
- dycw_utilities-0.160.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
92
- dycw_utilities-0.160.2.dist-info/entry_points.txt,sha256=BOD_SoDxwsfJYOLxhrSXhHP_T7iw-HXI9f2WVkzYxvQ,135
93
- dycw_utilities-0.160.2.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
94
- dycw_utilities-0.160.2.dist-info/RECORD,,
90
+ dycw_utilities-0.161.0.dist-info/METADATA,sha256=UHqQjpDjGhF42_1Ui_nvUxSUkJVZYkPPMns5mtiy03c,1643
91
+ dycw_utilities-0.161.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
92
+ dycw_utilities-0.161.0.dist-info/entry_points.txt,sha256=BOD_SoDxwsfJYOLxhrSXhHP_T7iw-HXI9f2WVkzYxvQ,135
93
+ dycw_utilities-0.161.0.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
94
+ dycw_utilities-0.161.0.dist-info/RECORD,,
utilities/__init__.py CHANGED
@@ -1,3 +1,3 @@
1
1
  from __future__ import annotations
2
2
 
3
- __version__ = "0.160.2"
3
+ __version__ = "0.161.0"
utilities/hypothesis.py CHANGED
@@ -101,7 +101,7 @@ from utilities.whenever import (
101
101
  to_days,
102
102
  to_nanoseconds,
103
103
  )
104
- from utilities.zoneinfo import UTC, ensure_time_zone
104
+ from utilities.zoneinfo import UTC, to_zone_info
105
105
 
106
106
  if TYPE_CHECKING:
107
107
  from collections.abc import Collection, Hashable, Iterable, Iterator
@@ -1509,7 +1509,7 @@ def zoned_date_times(
1509
1509
  ) -> ZonedDateTime:
1510
1510
  """Strategy for generating zoned date-times."""
1511
1511
  min_value_, max_value_ = [draw2(draw, v) for v in [min_value, max_value]]
1512
- time_zone_ = ensure_time_zone(draw2(draw, time_zone))
1512
+ time_zone_ = to_zone_info(draw2(draw, time_zone))
1513
1513
  match min_value_:
1514
1514
  case None | PlainDateTime():
1515
1515
  ...
utilities/polars.py CHANGED
@@ -104,7 +104,7 @@ from utilities.whenever import (
104
104
  ZonedDateTimePeriod,
105
105
  to_py_time_delta,
106
106
  )
107
- from utilities.zoneinfo import UTC, ensure_time_zone, get_time_zone_name
107
+ from utilities.zoneinfo import UTC, to_time_zone_name
108
108
 
109
109
  if TYPE_CHECKING:
110
110
  from collections.abc import Callable, Iterable, Iterator, Mapping, Sequence
@@ -834,7 +834,7 @@ def convert_time_zone(
834
834
 
835
835
  def _convert_time_zone_one(sr: Series, /, *, time_zone: TimeZoneLike = UTC) -> Series:
836
836
  if isinstance(sr.dtype, Datetime):
837
- return sr.dt.convert_time_zone(get_time_zone_name(time_zone))
837
+ return sr.dt.convert_time_zone(to_time_zone_name(time_zone))
838
838
  return sr
839
839
 
840
840
 
@@ -2110,7 +2110,7 @@ def period_range(
2110
2110
  eager: bool = False,
2111
2111
  ) -> Series | Expr:
2112
2112
  """Construct a period range."""
2113
- time_zone_use = None if time_zone is None else ensure_time_zone(time_zone).key
2113
+ time_zone_use = None if time_zone is None else to_time_zone_name(time_zone)
2114
2114
  match end_or_length:
2115
2115
  case ZonedDateTime() as end:
2116
2116
  ...
@@ -2127,7 +2127,7 @@ def period_range(
2127
2127
  time_zone=time_zone_use,
2128
2128
  eager=eager,
2129
2129
  ).alias("start")
2130
- ends = (starts.dt.offset_by(interval)).alias("end")
2130
+ ends = starts.dt.offset_by(interval).alias("end")
2131
2131
  period = struct(starts, ends)
2132
2132
  return try_reify_expr(period, starts, ends)
2133
2133
 
@@ -2220,7 +2220,7 @@ def _replace_time_zone_one(
2220
2220
  sr: Series, /, *, time_zone: TimeZoneLike | None = UTC
2221
2221
  ) -> Series:
2222
2222
  if isinstance(sr.dtype, Datetime):
2223
- time_zone_use = None if time_zone is None else get_time_zone_name(time_zone)
2223
+ time_zone_use = None if time_zone is None else to_time_zone_name(time_zone)
2224
2224
  return sr.dt.replace_time_zone(time_zone_use)
2225
2225
  return sr
2226
2226
 
@@ -2611,7 +2611,7 @@ def zoned_date_time_dtype(
2611
2611
  *, time_unit: TimeUnit = "us", time_zone: TimeZoneLike = UTC
2612
2612
  ) -> Datetime:
2613
2613
  """Create a zoned date-time data type."""
2614
- return Datetime(time_unit=time_unit, time_zone=get_time_zone_name(time_zone))
2614
+ return Datetime(time_unit=time_unit, time_zone=to_time_zone_name(time_zone))
2615
2615
 
2616
2616
 
2617
2617
  def zoned_date_time_period_dtype(
utilities/types.py CHANGED
@@ -15,6 +15,7 @@ from typing import (
15
15
  Literal,
16
16
  Protocol,
17
17
  TypeVar,
18
+ get_args,
18
19
  overload,
19
20
  runtime_checkable,
20
21
  )
@@ -271,12 +272,16 @@ type TimeZone = Literal[
271
272
  "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"
272
273
  ]
273
274
  # fmt: on
275
+ TIME_ZONES: list[TimeZone] = list(get_args(TimeZone.__value__))
276
+
277
+
274
278
  type TimeZoneLike = (
275
279
  ZoneInfo | ZonedDateTime | Literal["local"] | TimeZone | dt.tzinfo | dt.datetime
276
280
  )
277
281
 
278
282
 
279
283
  __all__ = [
284
+ "TIME_ZONES",
280
285
  "Coro",
281
286
  "Dataclass",
282
287
  "DateDeltaLike",
utilities/whenever.py CHANGED
@@ -39,7 +39,7 @@ from utilities.math import sign
39
39
  from utilities.platform import get_strftime
40
40
  from utilities.sentinel import Sentinel, sentinel
41
41
  from utilities.tzlocal import LOCAL_TIME_ZONE, LOCAL_TIME_ZONE_NAME
42
- from utilities.zoneinfo import UTC, ensure_time_zone, get_time_zone_name
42
+ from utilities.zoneinfo import UTC, to_time_zone_name
43
43
 
44
44
  if TYPE_CHECKING:
45
45
  from utilities.types import (
@@ -188,7 +188,7 @@ class DatePeriod:
188
188
  ...
189
189
  case never:
190
190
  assert_never(never)
191
- tz = ensure_time_zone(time_zone).key
191
+ tz = to_time_zone_name(time_zone)
192
192
  return ZonedDateTimePeriod(
193
193
  self.start.at(start).assume_tz(tz), self.end.at(end).assume_tz(tz)
194
194
  )
@@ -335,17 +335,17 @@ def format_compact(
335
335
 
336
336
  def from_timestamp(i: float, /, *, time_zone: TimeZoneLike = UTC) -> ZonedDateTime:
337
337
  """Get a zoned datetime from a timestamp."""
338
- return ZonedDateTime.from_timestamp(i, tz=get_time_zone_name(time_zone))
338
+ return ZonedDateTime.from_timestamp(i, tz=to_time_zone_name(time_zone))
339
339
 
340
340
 
341
341
  def from_timestamp_millis(i: int, /, *, time_zone: TimeZoneLike = UTC) -> ZonedDateTime:
342
342
  """Get a zoned datetime from a timestamp (in milliseconds)."""
343
- return ZonedDateTime.from_timestamp_millis(i, tz=get_time_zone_name(time_zone))
343
+ return ZonedDateTime.from_timestamp_millis(i, tz=to_time_zone_name(time_zone))
344
344
 
345
345
 
346
346
  def from_timestamp_nanos(i: int, /, *, time_zone: TimeZoneLike = UTC) -> ZonedDateTime:
347
347
  """Get a zoned datetime from a timestamp (in nanoseconds)."""
348
- return ZonedDateTime.from_timestamp_nanos(i, tz=get_time_zone_name(time_zone))
348
+ return ZonedDateTime.from_timestamp_nanos(i, tz=to_time_zone_name(time_zone))
349
349
 
350
350
 
351
351
  ##
@@ -353,7 +353,7 @@ def from_timestamp_nanos(i: int, /, *, time_zone: TimeZoneLike = UTC) -> ZonedDa
353
353
 
354
354
  def get_now(time_zone: TimeZoneLike = UTC, /) -> ZonedDateTime:
355
355
  """Get the current zoned datetime."""
356
- return ZonedDateTime.now(get_time_zone_name(time_zone))
356
+ return ZonedDateTime.now(to_time_zone_name(time_zone))
357
357
 
358
358
 
359
359
  NOW_UTC = get_now(UTC)
@@ -1703,24 +1703,7 @@ class WheneverLogRecord(LogRecord):
1703
1703
  )
1704
1704
  length = self._get_length()
1705
1705
  plain = format(get_now_local().to_plain().format_common_iso(), f"{length}s")
1706
- time_zone = self._get_time_zone_key()
1707
- self.zoned_datetime = f"{plain}[{time_zone}]"
1708
-
1709
- @classmethod
1710
- @cache
1711
- def _get_time_zone(cls) -> ZoneInfo:
1712
- """Get the local timezone."""
1713
- try:
1714
- from utilities.tzlocal import get_local_time_zone
1715
- except ModuleNotFoundError: # pragma: no cover
1716
- return UTC
1717
- return get_local_time_zone()
1718
-
1719
- @classmethod
1720
- @cache
1721
- def _get_time_zone_key(cls) -> str:
1722
- """Get the local timezone as a string."""
1723
- return cls._get_time_zone().key
1706
+ self.zoned_datetime = f"{plain}[{LOCAL_TIME_ZONE_NAME}]"
1724
1707
 
1725
1708
  @classmethod
1726
1709
  @cache
@@ -1878,7 +1861,7 @@ class ZonedDateTimePeriod:
1878
1861
 
1879
1862
  def to_tz(self, time_zone: TimeZoneLike, /) -> Self:
1880
1863
  """Convert the time zone."""
1881
- tz = get_time_zone_name(time_zone)
1864
+ tz = to_time_zone_name(time_zone)
1882
1865
  return self.replace(start=self.start.to_tz(tz), end=self.end.to_tz(tz))
1883
1866
 
1884
1867
 
utilities/zoneinfo.py CHANGED
@@ -7,7 +7,8 @@ from zoneinfo import ZoneInfo
7
7
 
8
8
  from whenever import ZonedDateTime
9
9
 
10
- from utilities.tzlocal import LOCAL_TIME_ZONE
10
+ from utilities.types import TIME_ZONES
11
+ from utilities.tzlocal import LOCAL_TIME_ZONE, LOCAL_TIME_ZONE_NAME
11
12
 
12
13
  if TYPE_CHECKING:
13
14
  from utilities.types import TimeZone, TimeZoneLike
@@ -19,13 +20,13 @@ UTC = ZoneInfo("UTC")
19
20
  ##
20
21
 
21
22
 
22
- def ensure_time_zone(obj: TimeZoneLike, /) -> ZoneInfo:
23
- """Ensure the object is a time zone."""
23
+ def to_zone_info(obj: TimeZoneLike, /) -> ZoneInfo:
24
+ """Convert to a time-zone."""
24
25
  match obj:
25
26
  case ZoneInfo() as zone_info:
26
27
  return zone_info
27
- case ZonedDateTime() as datetime:
28
- return ZoneInfo(datetime.tz)
28
+ case ZonedDateTime() as date_time:
29
+ return ZoneInfo(date_time.tz)
29
30
  case "local":
30
31
  return LOCAL_TIME_ZONE
31
32
  case str() as key:
@@ -33,43 +34,100 @@ def ensure_time_zone(obj: TimeZoneLike, /) -> ZoneInfo:
33
34
  case dt.tzinfo() as tzinfo:
34
35
  if tzinfo is dt.UTC:
35
36
  return UTC
36
- raise _EnsureTimeZoneInvalidTZInfoError(time_zone=obj)
37
- case dt.datetime() as datetime:
38
- if datetime.tzinfo is None:
39
- raise _EnsureTimeZonePlainDateTimeError(datetime=datetime)
40
- return ensure_time_zone(datetime.tzinfo)
37
+ raise _ToZoneInfoInvalidTZInfoError(time_zone=obj)
38
+ case dt.datetime() as date_time:
39
+ if date_time.tzinfo is None:
40
+ raise _ToZoneInfoPlainDateTimeError(date_time=date_time)
41
+ return to_zone_info(date_time.tzinfo)
41
42
  case never:
42
43
  assert_never(never)
43
44
 
44
45
 
45
46
  @dataclass(kw_only=True, slots=True)
46
- class EnsureTimeZoneError(Exception): ...
47
+ class ToTimeZoneError(Exception): ...
47
48
 
48
49
 
49
50
  @dataclass(kw_only=True, slots=True)
50
- class _EnsureTimeZoneInvalidTZInfoError(EnsureTimeZoneError):
51
+ class _ToZoneInfoInvalidTZInfoError(ToTimeZoneError):
51
52
  time_zone: dt.tzinfo
52
53
 
53
54
  @override
54
55
  def __str__(self) -> str:
55
- return f"Unsupported time zone: {self.time_zone}"
56
+ return f"Invalid time-zone: {self.time_zone}"
56
57
 
57
58
 
58
59
  @dataclass(kw_only=True, slots=True)
59
- class _EnsureTimeZonePlainDateTimeError(EnsureTimeZoneError):
60
- datetime: dt.datetime
60
+ class _ToZoneInfoPlainDateTimeError(ToTimeZoneError):
61
+ date_time: dt.datetime
61
62
 
62
63
  @override
63
64
  def __str__(self) -> str:
64
- return f"Plain datetime: {self.datetime}"
65
+ return f"Plain date-time: {self.date_time}"
65
66
 
66
67
 
67
68
  ##
68
69
 
69
70
 
70
- def get_time_zone_name(time_zone: TimeZoneLike, /) -> TimeZone:
71
- """Get the name of a time zone."""
72
- return cast("TimeZone", ensure_time_zone(time_zone).key)
71
+ def to_time_zone_name(obj: TimeZoneLike, /) -> TimeZone:
72
+ """Convert to a time zone name."""
73
+ match obj:
74
+ case ZoneInfo() as zone_info:
75
+ return cast("TimeZone", zone_info.key)
76
+ case ZonedDateTime() as date_time:
77
+ return cast("TimeZone", date_time.tz)
78
+ case "local":
79
+ return LOCAL_TIME_ZONE_NAME
80
+ case str() as time_zone:
81
+ if time_zone in TIME_ZONES:
82
+ return time_zone
83
+ raise _ToTimeZoneNameInvalidKeyError(time_zone=time_zone)
84
+ case dt.tzinfo() as tzinfo:
85
+ if tzinfo is dt.UTC:
86
+ return cast("TimeZone", UTC.key)
87
+ raise _ToTimeZoneNameInvalidTZInfoError(time_zone=obj)
88
+ case dt.datetime() as date_time:
89
+ if date_time.tzinfo is None:
90
+ raise _ToTimeZoneNamePlainDateTimeError(date_time=date_time)
91
+ return to_time_zone_name(date_time.tzinfo)
92
+ case never:
93
+ assert_never(never)
94
+
95
+
96
+ @dataclass(kw_only=True, slots=True)
97
+ class ToTimeZoneNameError(Exception): ...
98
+
99
+
100
+ @dataclass(kw_only=True, slots=True)
101
+ class _ToTimeZoneNameInvalidKeyError(ToTimeZoneNameError):
102
+ time_zone: str
103
+
104
+ @override
105
+ def __str__(self) -> str:
106
+ return f"Invalid time-zone: {self.time_zone!r}"
107
+
108
+
109
+ @dataclass(kw_only=True, slots=True)
110
+ class _ToTimeZoneNameInvalidTZInfoError(ToTimeZoneNameError):
111
+ time_zone: dt.tzinfo
112
+
113
+ @override
114
+ def __str__(self) -> str:
115
+ return f"Invalid time-zone: {self.time_zone}"
116
+
117
+
118
+ @dataclass(kw_only=True, slots=True)
119
+ class _ToTimeZoneNamePlainDateTimeError(ToTimeZoneNameError):
120
+ date_time: dt.datetime
121
+
122
+ @override
123
+ def __str__(self) -> str:
124
+ return f"Plain date-time: {self.date_time}"
73
125
 
74
126
 
75
- __all__ = ["UTC", "EnsureTimeZoneError", "ensure_time_zone", "get_time_zone_name"]
127
+ __all__ = [
128
+ "UTC",
129
+ "ToTimeZoneError",
130
+ "ToTimeZoneNameError",
131
+ "to_time_zone_name",
132
+ "to_zone_info",
133
+ ]