dycw-utilities 0.148.4__py3-none-any.whl → 0.174.12__py3-none-any.whl

utilities/zoneinfo.py

@@ -7,7 +7,8 @@ from zoneinfo import ZoneInfo
 
 from whenever import ZonedDateTime
 
-from utilities.tzlocal import LOCAL_TIME_ZONE
+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
@@ -19,57 +20,114 @@ UTC = ZoneInfo("UTC")
 ##
 
 
-def ensure_time_zone(obj: TimeZoneLike, /) -> ZoneInfo:
-    """Ensure the object is a time zone."""
+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 datetime:
-            return ZoneInfo(datetime.tz)
-        case "local":
+        case ZonedDateTime() as date_time:
+            return ZoneInfo(date_time.tz)
+        case "local" | "localtime":
             return LOCAL_TIME_ZONE
         case str() as key:
             return ZoneInfo(key)
         case dt.tzinfo() as tzinfo:
             if tzinfo is dt.UTC:
                 return UTC
-            raise _EnsureTimeZoneInvalidTZInfoError(time_zone=obj)
-        case dt.datetime() as datetime:
-            if datetime.tzinfo is None:
-                raise _EnsureTimeZonePlainDateTimeError(datetime=datetime)
-            return ensure_time_zone(datetime.tzinfo)
-        case _ as never:
+            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 EnsureTimeZoneError(Exception): ...
+class ToTimeZoneError(Exception): ...
 
 
 @dataclass(kw_only=True, slots=True)
-class _EnsureTimeZoneInvalidTZInfoError(EnsureTimeZoneError):
+class _ToZoneInfoInvalidTZInfoError(ToTimeZoneError):
     time_zone: dt.tzinfo
 
     @override
     def __str__(self) -> str:
-        return f"Unsupported time zone: {self.time_zone}"
+        return f"Invalid time-zone: {self.time_zone}"
 
 
 @dataclass(kw_only=True, slots=True)
-class _EnsureTimeZonePlainDateTimeError(EnsureTimeZoneError):
-    datetime: dt.datetime
+class _ToZoneInfoPlainDateTimeError(ToTimeZoneError):
+    date_time: dt.datetime
 
     @override
     def __str__(self) -> str:
-        return f"Plain datetime: {self.datetime}"
+        return f"Plain date-time: {self.date_time}"
 
 
 ##
 
 
-def get_time_zone_name(time_zone: TimeZoneLike, /) -> TimeZone:
-    """Get the name of a time zone."""
-    return cast("TimeZone", ensure_time_zone(time_zone).key)
+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" | "localtime":
+            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", "EnsureTimeZoneError", "ensure_time_zone", "get_time_zone_name"]
+__all__ = [
+    "UTC",
+    "ToTimeZoneError",
+    "ToTimeZoneNameError",
+    "to_time_zone_name",
+    "to_zone_info",
+]

dycw_utilities-0.148.4.dist-info/METADATA

@@ -1,41 +0,0 @@
-Metadata-Version: 2.4
-Name: dycw-utilities
-Version: 0.148.4
-Author-email: Derek Wan <d.wan@icloud.com>
-License-File: LICENSE
-Requires-Python: >=3.12
-Requires-Dist: atomicwrites<1.5,>=1.4.1
-Requires-Dist: typing-extensions<4.15,>=4.14.0
-Requires-Dist: tzlocal<5.4,>=5.3.1
-Requires-Dist: whenever<0.9,>=0.8.6
-Provides-Extra: logging
-Requires-Dist: coloredlogs<15.1,>=15.0.1; extra == 'logging'
-Provides-Extra: test
-Requires-Dist: dycw-pytest-only<2.2,>=2.1.1; extra == 'test'
-Requires-Dist: hypothesis<6.136,>=6.135.24; extra == 'test'
-Requires-Dist: pudb<2025.2,>=2025.1; extra == 'test'
-Requires-Dist: pytest-asyncio<1.2,>=1.1.0; extra == 'test'
-Requires-Dist: pytest-cov<6.3,>=6.2.1; extra == 'test'
-Requires-Dist: pytest-instafail<0.6,>=0.5.0; extra == 'test'
-Requires-Dist: pytest-lazy-fixtures<1.2,>=1.1.4; extra == 'test'
-Requires-Dist: pytest-randomly<3.17,>=3.16.0; extra == 'test'
-Requires-Dist: pytest-regressions<2.9,>=2.8.1; extra == 'test'
-Requires-Dist: pytest-repeat<0.10,>=0.9.4; extra == 'test'
-Requires-Dist: pytest-rerunfailures<16,>=15.1; extra == 'test'
-Requires-Dist: pytest-rng<1.1,>=1.0.0; extra == 'test'
-Requires-Dist: pytest-timeout<2.5,>=2.4.0; extra == 'test'
-Requires-Dist: pytest-xdist<3.9,>=3.8.0; extra == 'test'
-Requires-Dist: pytest<8.5,>=8.4.1; extra == 'test'
-Description-Content-Type: text/markdown
-
-[![PyPI version](https://badge.fury.io/py/dycw-utilities.svg)](https://badge.fury.io/py/dycw-utilities)
-
-# `dycw-utilities`
-
-[All the Python functions I don't want to write twice.](https://github.com/nvim-lua/plenary.nvim)
-
-## Installation
-
-- `pip install dycw-utilities`
-
-or with [extras](https://github.com/dycw/python-utilities/blob/master/pyproject.toml).

dycw_utilities-0.148.4.dist-info/RECORD

@@ -1,95 +0,0 @@
-utilities/__init__.py,sha256=VDgRGy8SY-uljlJ76REYaNomUoE5yqIY42dKSUSpjuY,60
-utilities/altair.py,sha256=92E2lCdyHY4Zb-vCw6rEJIsWdKipuu-Tu2ab1ufUfAk,9079
-utilities/asyncio.py,sha256=z0w3fb-U5Ml5YXVaFFPClizXaQmjDO6YgZg-V9QL0VQ,16021
-utilities/atomicwrites.py,sha256=xcOWenTBRS0oat3kg7Sqe51AohNThMQ2ixPL7QCG8hw,5795
-utilities/atools.py,sha256=9im2g8OCf-Iynqa8bAv8N0Ycj9QvrJmGO7yLCZEdgII,986
-utilities/cachetools.py,sha256=v1-9sXHLdOLiwmkq6NB0OUbxeKBuVVN6wmAWefWoaHI,2744
-utilities/click.py,sha256=AyM__WPPvsIFaZZ5wyVrYvWCdK-mTH1nmlcX0sHDTz8,16668
-utilities/concurrent.py,sha256=ZdhcNeBl1-HaAPY3h7bZ5ccuYdfdq2ATHplvZdnzlhk,2858
-utilities/contextlib.py,sha256=THWVU14w3kgVM7TSxn2oHqVdBbdeliABR9gRXiPpo2U,7440
-utilities/contextvars.py,sha256=RsSGGrbQqqZ67rOydnM7WWIsM2lIE31UHJLejnHJPWY,505
-utilities/cryptography.py,sha256=_CiK_K6c_-uQuUhsUNjNjTL-nqxAh4_1zTfS11Xe120,972
-utilities/cvxpy.py,sha256=Rv1-fD-XYerosCavRF8Pohop2DBkU3AlFaGTfD8AEAA,13776
-utilities/dataclasses.py,sha256=1-REGxtzCo2BbGkjLw5idjbTaiItpOiWvMNbVkJrFXM,32663
-utilities/enum.py,sha256=IEPMGiNJBcofGPuoGZErf4bMNSBE4SLs32nvm2r81h0,5791
-utilities/errors.py,sha256=k_VvqSi6geTYhlzRRQaGN2j6ZGng-AD8SnX7Znrirm4,1484
-utilities/eventkit.py,sha256=s9p3WjGc7h7TdbSgVfHrRNNiuOXcQoVQ5sFCbJyqg48,12646
-utilities/fastapi.py,sha256=3wpd63Tw9paSyy7STpAD7GGe8fLkLaRC6TPCwIGm1BU,1361
-utilities/fpdf2.py,sha256=776PkEX5xEK-whFOzqaVaQVHPy1Xf01kCSyj7TEp80g,1886
-utilities/functions.py,sha256=qefAfW0zz7OEiRuBtKF-3tI3NaufcwAULRIFv24gZ2Q,28533
-utilities/functools.py,sha256=I00ru2gQPakZw2SHVeKIKXfTv741655s6HI0lUoE0D4,1552
-utilities/getpass.py,sha256=DfN5UgMAtFCqS3dSfFHUfqIMZX2shXvwphOz_6J6f6A,103
-utilities/gzip.py,sha256=fkGP3KdsBfXlstodT4wtlp-PwNyUsogpbDCVVVGdsm4,781
-utilities/hashlib.py,sha256=SVTgtguur0P4elppvzOBbLEjVM3Pea0eWB61yg2ilxo,309
-utilities/http.py,sha256=TsavEfHlRtlLaeV21Z6KZh0qbPw-kvD1zsQdZ7Kep5Q,977
-utilities/hypothesis.py,sha256=GisBvkK1qTjNWWJlVZLHrOlws2vDM-92lOtOUqsua4w,38067
-utilities/importlib.py,sha256=mV1xT_O_zt_GnZZ36tl3xOmMaN_3jErDWY54fX39F6Y,429
-utilities/inflect.py,sha256=UWOsMRJUJXqcR3rgrQmb35mat-Theu5xo-M9E33eTIE,586
-utilities/ipython.py,sha256=V2oMYHvEKvlNBzxDXdLvKi48oUq2SclRg5xasjaXStw,763
-utilities/iterables.py,sha256=y7ymCCjCrc-RYwwE3xWWKJO_2zn-_pPe_z2ybM5kpkY,43952
-utilities/json.py,sha256=DiqnVZbDVmm0fohQCvFYg-B0QPFI02jaN7wmMjntaoQ,2107
-utilities/jupyter.py,sha256=ft5JA7fBxXKzP-L9W8f2-wbF0QeYc_2uLQNFDVk4Z-M,2917
-utilities/libcst.py,sha256=XTT8cCYAYfI9ZIdxjiTCqbF45cN-viDNDa7GE5mR2T4,5615
-utilities/lightweight_charts.py,sha256=YM3ojBvJxuCSUBu_KrhFBmaMCvRPvupKC3qkm-UVZq4,2751
-utilities/logging.py,sha256=6Rv6Mt7peHWPZ-wYNUvXQt67QXCOpVXdnkgT88XKiKQ,19416
-utilities/math.py,sha256=_6vrDyjtaqE_OFE-F2DNWrDG_J_kMl3nFAJsok9v_bY,26862
-utilities/memory_profiler.py,sha256=XzN56jDCa5aqXS_DxEjb_K4L6aIWh_5zyKi6OhcIxw0,853
-utilities/modules.py,sha256=iuvLluJya-hvl1Q25-Jk3dLgx2Es3ck4SjJiEkAlVTs,3195
-utilities/more_itertools.py,sha256=NEGXDT8COaxziaJFTiXYKX0gffwfKhCAMrq-Kgh0w8c,10937
-utilities/numpy.py,sha256=Xn23sA2ZbVNqwUYEgNJD3XBYH6IbCri_WkHSNhg3NkY,26122
-utilities/operator.py,sha256=nhxn5q6CFNzUm1wpTwWPCu9JGCqVHSlaJf0o1-efoII,3616
-utilities/optuna.py,sha256=C-fhWYiXHVPo1l8QctYkFJ4DyhbSrGorzP1dJb_qvd8,1933
-utilities/orjson.py,sha256=iJho5gCkTlT2KWSXqopvi24WCxEhM5_fiz17mbNvkGg,40113
-utilities/os.py,sha256=y25oqJoyrkdQ7aU5ShePPXKk6YTwd97x6yEx4UcRYu4,3788
-utilities/parse.py,sha256=JcJn5yXKhIWXBCwgBdPsyu7Hvcuw6kyEdqvaebCaI9k,17951
-utilities/pathlib.py,sha256=FnteXeVeMOSc6QTN7oF6UrobjOX9gXv_5tG1slg83W8,8496
-utilities/period.py,sha256=REuz2xaChNa5Iw69xNnbUPlUSLdUgmhOu4YEOiPeTrg,8328
-utilities/pickle.py,sha256=MBT2xZCsv0pH868IXLGKnlcqNx2IRVKYNpRcqiQQqxw,653
-utilities/platform.py,sha256=Ue9LSxYvg9yUXGKuz5aZoy_qkUEXde-v6B09exgSctU,2813
-utilities/polars.py,sha256=BgiDryAVOapi41ddfJqN0wYh_sDj8BNEYtPB36LaHdo,71824
-utilities/polars_ols.py,sha256=Uc9V5kvlWZ5cU93lKZ-cfAKdVFFw81tqwLW9PxtUvMs,5618
-utilities/postgres.py,sha256=Q1auvVqwUrIP6yhwvjCXg7zQbWgQ9czuJIa99eK6soM,8993
-utilities/pottery.py,sha256=w2X80PXWwzdHdqSYJP6ESrPNNDP3xzpyuJn-fp-Vt3M,5969
-utilities/pqdm.py,sha256=BTsYPtbKQWwX-iXF4qCkfPG7DPxIB54J989n83bXrIo,3092
-utilities/psutil.py,sha256=KUlu4lrUw9Zg1V7ZGetpWpGb9DB8l_SSDWGbANFNCPU,2104
-utilities/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-utilities/pyinstrument.py,sha256=E3U4T6qzTGVcGzAiShl9BL3acO-uu_dHZVgSbkSBd7A,864
-utilities/pytest.py,sha256=TUguQEeUiftUWW-aLJEQmZr-J6W2bwpkUt9Y-q2ua14,7904
-utilities/pytest_regressions.py,sha256=50h6hqX60U6dkYaB6tW-XEDhSH4y_FQ5LgJ0pGF1Wo4,4102
-utilities/random.py,sha256=YWYzWxQDeyJRiuHGnO1OxF6dDucpq7qc1tH_ealwCRg,4130
-utilities/re.py,sha256=6qxeV0rQZaBDKWcB7apSBmxtg_XzoGY-EdegTkMn-ZY,4578
-utilities/redis.py,sha256=MNxDTbTQTkUOtIikJY9UbfozTC3zuJpAUBsw02LLXTA,28377
-utilities/reprlib.py,sha256=ssYTcBW-TeRh3fhCJv57sopTZHF5FrPyyUg9yp5XBlo,3953
-utilities/scipy.py,sha256=wZJM7fEgBAkLSYYvSmsg5ac-QuwAI0BGqHVetw1_Hb0,947
-utilities/sentinel.py,sha256=3jIwgpMekWgDAxPDA_hXMP2St43cPhciKN3LWiZ7kv0,1248
-utilities/shelve.py,sha256=HZsMwK4tcIfg3sh0gApx4-yjQnrY4o3V3ZRimvRhoW0,738
-utilities/slack_sdk.py,sha256=ppFBvKgfg5IRWiIoKPtpTyzBtBF4XmwEvU3I5wLJikM,2140
-utilities/socket.py,sha256=K77vfREvzoVTrpYKo6MZakol0EYu2q1sWJnnZqL0So0,118
-utilities/sqlalchemy.py,sha256=q2aYUDAC3SE88Lt6XaKa3CLzT_ePaWvQu_OuRk19x9g,35520
-utilities/sqlalchemy_polars.py,sha256=18AoEbeNJUKF3-5hroNy9J5LQwS_QJAXbMfKc9sChtk,14250
-utilities/statsmodels.py,sha256=koyiBHvpMcSiBfh99wFUfSggLNx7cuAw3rwyfAhoKpQ,3410
-utilities/string.py,sha256=MB0X6UPTUc06JdAdj-PctZ238IXeCjE5dAJibNw6ZrU,587
-utilities/tempfile.py,sha256=VqmZJAhTJ1OaVywFzk5eqROV8iJbW9XQ_QYAV0bpdRo,1384
-utilities/text.py,sha256=ymBFlP_cA8OgNnZRVNs7FAh7OG8HxE6YkiLEMZv5g_A,11297
-utilities/threading.py,sha256=GvBOp4CyhHfN90wGXZuA2VKe9fGzMaEa7oCl4f3nnPU,1009
-utilities/timer.py,sha256=oXfTii6ymu57niP0BDGZjFD55LEHi2a19kqZKiTgaFQ,2588
-utilities/traceback.py,sha256=zofhzIedpUHrzDNiRJDVzm_wuu_tlTQvVqK4quxVlgM,9151
-utilities/typed_settings.py,sha256=-mzQP5ZCIGWOhm7nPxlajWQhgtX657HVnRCfUYGKQKs,4433
-utilities/types.py,sha256=iDfk_Z96v7cIxPlgGYMap0fYmjgRUJ7uQzPPCQe1odY,18115
-utilities/typing.py,sha256=Z-_XDaWyT_6wIo3qfNK-hvRlzxP2Jxa9PgXzm5rDYRA,13790
-utilities/tzdata.py,sha256=fgNVj66yUbCSI_-vrRVzSD3gtf-L_8IEJEPjP_Jel5Y,266
-utilities/tzlocal.py,sha256=KyCXEgCTjqGFx-389JdTuhMRUaT06U1RCMdWoED-qro,728
-utilities/uuid.py,sha256=32p7DGHGM2Btx6PcBvCZvERSWbpupMXqx6FppPoSoTU,612
-utilities/version.py,sha256=ufhJMmI6KPs1-3wBI71aj5wCukd3sP_m11usLe88DNA,5117
-utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
-utilities/whenever.py,sha256=nG9IbFcJTKQJuRxoS35I7ww7pRwKHc1MHxff7vVmJls,44131
-utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
-utilities/zoneinfo.py,sha256=oEH-nL3t4h9uawyZqWDtNtDAl6M-CLpLYGI_nI6DulM,1971
-utilities/pytest_plugins/__init__.py,sha256=U4S_2y3zgLZVfMenHRaJFBW8yqh2mUBuI291LGQVOJ8,35
-utilities/pytest_plugins/pytest_randomly.py,sha256=NXzCcGKbpgYouz5yehKb4jmxmi2SexKKpgF4M65bi10,414
-utilities/pytest_plugins/pytest_regressions.py,sha256=Iwhfv_OJH7UCPZCfoh7ugZ2Xjqjil-BBBsOb8sDwiGI,1471
-dycw_utilities-0.148.4.dist-info/METADATA,sha256=VH2ptiCLL6fP3q4XBpXw-0nsTyTeHnHrxpuyT0A5tFE,1697
-dycw_utilities-0.148.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.148.4.dist-info/entry_points.txt,sha256=BOD_SoDxwsfJYOLxhrSXhHP_T7iw-HXI9f2WVkzYxvQ,135
-dycw_utilities-0.148.4.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.148.4.dist-info/RECORD,,

dycw_utilities-0.148.4.dist-info/WHEEL

@@ -1,4 +0,0 @@
-Wheel-Version: 1.0
-Generator: hatchling 1.27.0
-Root-Is-Purelib: true
-Tag: py3-none-any

dycw_utilities-0.148.4.dist-info/licenses/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Derek Wan
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

utilities/period.py

@@ -1,237 +0,0 @@
-from __future__ import annotations
-
-from dataclasses import dataclass
-from typing import TYPE_CHECKING, Any, Self, TypedDict, overload, override
-from zoneinfo import ZoneInfo
-
-from whenever import Date, DateDelta, PlainDateTime, TimeDelta, ZonedDateTime
-
-from utilities.dataclasses import replace_non_sentinel
-from utilities.functions import get_class_name
-from utilities.sentinel import Sentinel, sentinel
-from utilities.whenever import format_compact
-from utilities.zoneinfo import get_time_zone_name
-
-if TYPE_CHECKING:
-    from utilities.types import TimeZoneLike
-
-
-class _PeriodAsDict[T: (Date, ZonedDateTime)](TypedDict):
-    start: T
-    end: T
-
-
-@dataclass(repr=False, order=True, unsafe_hash=True, kw_only=False)
-class DatePeriod:
-    """A period of dates."""
-
-    start: Date
-    end: Date
-
-    def __post_init__(self) -> None:
-        if self.start > self.end:
-            raise _PeriodInvalidError(start=self.start, end=self.end)
-
-    def __add__(self, other: DateDelta, /) -> Self:
-        """Offset the period."""
-        return self.replace(start=self.start + other, end=self.end + other)
-
-    def __contains__(self, other: Date, /) -> bool:
-        """Check if a date/datetime lies in the period."""
-        return self.start <= other <= self.end
-
-    @override
-    def __repr__(self) -> str:
-        cls = get_class_name(self)
-        return f"{cls}({self.start}, {self.end})"
-
-    def __sub__(self, other: DateDelta, /) -> Self:
-        """Offset the period."""
-        return self.replace(start=self.start - other, end=self.end - other)
-
-    @property
-    def delta(self) -> DateDelta:
-        """The delta of the period."""
-        return self.end - self.start
-
-    def format_compact(self) -> str:
-        """Format the period in a compact fashion."""
-        fc, start, end = format_compact, self.start, self.end
-        if self.start == self.end:
-            return f"{fc(start)}="
-        if self.start.year_month() == self.end.year_month():
-            return f"{fc(start)}-{fc(end, fmt='%d')}"
-        if self.start.year == self.end.year:
-            return f"{fc(start)}-{fc(end, fmt='%m%d')}"
-        return f"{fc(start)}-{fc(end)}"
-
-    def replace(
-        self, *, start: Date | Sentinel = sentinel, end: Date | Sentinel = sentinel
-    ) -> Self:
-        """Replace elements of the period."""
-        return replace_non_sentinel(self, start=start, end=end)
-
-    def to_dict(self) -> _PeriodAsDict[Date]:
-        """Convert the period to a dictionary."""
-        return _PeriodAsDict(start=self.start, end=self.end)
-
-
-@dataclass(repr=False, order=True, unsafe_hash=True, kw_only=False)
-class ZonedDateTimePeriod:
-    """A period of time."""
-
-    start: ZonedDateTime
-    end: ZonedDateTime
-
-    def __post_init__(self) -> None:
-        if self.start > self.end:
-            raise _PeriodInvalidError(start=self.start, end=self.end)
-        if self.start.tz != self.end.tz:
-            raise _PeriodTimeZoneError(
-                start=ZoneInfo(self.start.tz), end=ZoneInfo(self.end.tz)
-            )
-
-    def __add__(self, other: TimeDelta, /) -> Self:
-        """Offset the period."""
-        return self.replace(start=self.start + other, end=self.end + other)
-
-    def __contains__(self, other: ZonedDateTime, /) -> bool:
-        """Check if a date/datetime lies in the period."""
-        return self.start <= other <= self.end
-
-    @override
-    def __repr__(self) -> str:
-        cls = get_class_name(self)
-        return f"{cls}({self.start.to_plain()}, {self.end.to_plain()}[{self.time_zone.key}])"
-
-    def __sub__(self, other: TimeDelta, /) -> Self:
-        """Offset the period."""
-        return self.replace(start=self.start - other, end=self.end - other)
-
-    @property
-    def delta(self) -> TimeDelta:
-        """The duration of the period."""
-        return self.end - self.start
-
-    @overload
-    def exact_eq(self, period: ZonedDateTimePeriod, /) -> bool: ...
-    @overload
-    def exact_eq(self, start: ZonedDateTime, end: ZonedDateTime, /) -> bool: ...
-    @overload
-    def exact_eq(
-        self, start: PlainDateTime, end: PlainDateTime, time_zone: ZoneInfo, /
-    ) -> bool: ...
-    def exact_eq(self, *args: Any) -> bool:
-        """Check if a period is exactly equal to another."""
-        if (len(args) == 1) and isinstance(args[0], ZonedDateTimePeriod):
-            return self.start.exact_eq(args[0].start) and self.end.exact_eq(args[0].end)
-        if (
-            (len(args) == 2)
-            and isinstance(args[0], ZonedDateTime)
-            and isinstance(args[1], ZonedDateTime)
-        ):
-            return self.exact_eq(ZonedDateTimePeriod(args[0], args[1]))
-        if (
-            (len(args) == 3)
-            and isinstance(args[0], PlainDateTime)
-            and isinstance(args[1], PlainDateTime)
-            and isinstance(args[2], ZoneInfo)
-        ):
-            return self.exact_eq(
-                ZonedDateTimePeriod(
-                    args[0].assume_tz(args[2].key), args[1].assume_tz(args[2].key)
-                )
-            )
-        raise _PeriodExactEqArgumentsError(args=args)
-
-    def format_compact(self) -> str:
-        """Format the period in a compact fashion."""
-        fc, start, end = format_compact, self.start, self.end
-        if start == end:
-            if end.second != 0:
-                return f"{fc(start)}="
-            if end.minute != 0:
-                return f"{fc(start, fmt='%Y%m%dT%H%M')}="
-            return f"{fc(start, fmt='%Y%m%dT%H')}="
-        if start.date() == end.date():
-            if end.second != 0:
-                return f"{fc(start.to_plain())}-{fc(end, fmt='%H%M%S')}"
-            if end.minute != 0:
-                return f"{fc(start.to_plain())}-{fc(end, fmt='%H%M')}"
-            return f"{fc(start.to_plain())}-{fc(end, fmt='%H')}"
-        if start.date().year_month() == end.date().year_month():
-            if end.second != 0:
-                return f"{fc(start.to_plain())}-{fc(end, fmt='%dT%H%M%S')}"
-            if end.minute != 0:
-                return f"{fc(start.to_plain())}-{fc(end, fmt='%dT%H%M')}"
-            return f"{fc(start.to_plain())}-{fc(end, fmt='%dT%H')}"
-        if start.year == end.year:
-            if end.second != 0:
-                return f"{fc(start.to_plain())}-{fc(end, fmt='%m%dT%H%M%S')}"
-            if end.minute != 0:
-                return f"{fc(start.to_plain())}-{fc(end, fmt='%m%dT%H%M')}"
-            return f"{fc(start.to_plain())}-{fc(end, fmt='%m%dT%H')}"
-        if end.second != 0:
-            return f"{fc(start.to_plain())}-{fc(end)}"
-        if end.minute != 0:
-            return f"{fc(start.to_plain())}-{fc(end, fmt='%Y%m%dT%H%M')}"
-        return f"{fc(start.to_plain())}-{fc(end, fmt='%Y%m%dT%H')}"
-
-    def replace(
-        self,
-        *,
-        start: ZonedDateTime | Sentinel = sentinel,
-        end: ZonedDateTime | Sentinel = sentinel,
-    ) -> Self:
-        """Replace elements of the period."""
-        return replace_non_sentinel(self, start=start, end=end)
-
-    @property
-    def time_zone(self) -> ZoneInfo:
-        """The time zone of the period."""
-        return ZoneInfo(self.start.tz)
-
-    def to_dict(self) -> _PeriodAsDict[ZonedDateTime]:
-        """Convert the period to a dictionary."""
-        return _PeriodAsDict(start=self.start, end=self.end)
-
-    def to_tz(self, time_zone: TimeZoneLike, /) -> Self:
-        """Convert the time zone."""
-        tz = get_time_zone_name(time_zone)
-        return self.replace(start=self.start.to_tz(tz), end=self.end.to_tz(tz))
-
-
-@dataclass(kw_only=True, slots=True)
-class PeriodError(Exception): ...
-
-
-@dataclass(kw_only=True, slots=True)
-class _PeriodInvalidError[T: (Date, ZonedDateTime)](PeriodError):
-    start: T
-    end: T
-
-    @override
-    def __str__(self) -> str:
-        return f"Invalid period; got {self.start} > {self.end}"
-
-
-@dataclass(kw_only=True, slots=True)
-class _PeriodTimeZoneError(PeriodError):
-    start: ZoneInfo
-    end: ZoneInfo
-
-    @override
-    def __str__(self) -> str:
-        return f"Period must contain exactly one time zone; got {self.start} and {self.end}"
-
-
-@dataclass(kw_only=True, slots=True)
-class _PeriodExactEqArgumentsError(PeriodError):
-    args: tuple[Any, ...]
-
-    @override
-    def __str__(self) -> str:
-        return f"Invalid arguments; got {self.args}"
-
-
-__all__ = ["DatePeriod", "PeriodError", "ZonedDateTimePeriod"]