dycw-utilities 0.131.10__py3-none-any.whl → 0.131.12__py3-none-any.whl

utilities/whenever2.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
 
 import datetime as dt
+from collections.abc import Callable
 from functools import cache
 from logging import LogRecord
-from typing import TYPE_CHECKING, Any, override
+from typing import TYPE_CHECKING, Any, assert_never, overload, override
 
 from whenever import (
     Date,
@@ -15,12 +16,19 @@ from whenever import (
     ZonedDateTime,
 )
 
+from utilities.datetime import maybe_sub_pct_y
+from utilities.sentinel import Sentinel, sentinel
+from utilities.tzlocal import LOCAL_TIME_ZONE_NAME
 from utilities.zoneinfo import UTC, get_time_zone_name
 
 if TYPE_CHECKING:
     from zoneinfo import ZoneInfo
 
-    from utilities.types import TimeZoneLike
+    from utilities.types import (
+        MaybeCallableDate,
+        MaybeCallableZonedDateTime,
+        TimeZoneLike,
+    )
 
 
 ## bounds
@@ -66,6 +74,15 @@ WEEK = DateDelta(weeks=1)
 ##
 
 
+def format_compact(datetime: ZonedDateTime, /) -> str:
+    """Convert a zoned datetime to the local time zone, then format."""
+    py_datetime = datetime.round().to_tz(LOCAL_TIME_ZONE_NAME).to_plain().py_datetime()
+    return py_datetime.strftime(maybe_sub_pct_y("%Y%m%dT%H%M%S"))
+
+
+##
+
+
 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))
@@ -118,6 +135,52 @@ def get_today_local() -> Date:
 
 TODAY_LOCAL = get_today_local()
 
+##
+
+
+@overload
+def to_date(*, date: MaybeCallableDate) -> Date: ...
+@overload
+def to_date(*, date: None) -> None: ...
+@overload
+def to_date(*, date: Sentinel) -> Sentinel: ...
+@overload
+def to_date(*, date: MaybeCallableDate | Sentinel) -> Date | Sentinel: ...
+@overload
+def to_date(
+    *, date: MaybeCallableDate | None | Sentinel = sentinel
+) -> Date | None | Sentinel: ...
+def to_date(
+    *, date: MaybeCallableDate | None | Sentinel = sentinel
+) -> Date | None | Sentinel:
+    """Get the date."""
+    match date:
+        case Date() | None | Sentinel():
+            return date
+        case Callable() as func:
+            return to_date(date=func())
+        case _ as never:
+            assert_never(never)
+
+
+@overload
+def to_zoned_date_time(*, date_time: MaybeCallableZonedDateTime) -> ZonedDateTime: ...
+@overload
+def to_zoned_date_time(*, date_time: None) -> None: ...
+@overload
+def to_zoned_date_time(*, date_time: Sentinel) -> Sentinel: ...
+def to_zoned_date_time(
+    *, date_time: MaybeCallableZonedDateTime | None | Sentinel = sentinel
+) -> ZonedDateTime | None | Sentinel:
+    """Resolve into a zoned date_time."""
+    match date_time:
+        case ZonedDateTime() | None | Sentinel():
+            return date_time
+        case Callable() as func:
+            return to_zoned_date_time(date_time=func())
+        case _ as never:
+            assert_never(never)
+
 
 ##
 
@@ -203,6 +266,7 @@ __all__ = [
     "ZONED_DATE_TIME_MAX",
     "ZONED_DATE_TIME_MIN",
     "WheneverLogRecord",
+    "format_compact",
     "from_timestamp",
     "from_timestamp_millis",
     "from_timestamp_nanos",
@@ -210,4 +274,6 @@ __all__ = [
     "get_now_local",
     "get_today",
     "get_today_local",
+    "to_date",
+    "to_zoned_date_time",
 ]