dycw-utilities 0.111.0__tar.gz → 0.112.0__tar.gz

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/PKG-INFO

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

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/pyproject.toml

@@ -94,7 +94,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.111.0"
+version = "0.112.0"
 
 [project.optional-dependencies]
 test = [
@@ -337,7 +337,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.111.0"
+current_version = "0.112.0"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/tests/test_altair.py

@@ -33,7 +33,8 @@ from utilities.datetime import get_now
 from utilities.functions import ensure_class
 from utilities.hypothesis import text_ascii, zoned_datetimes
 from utilities.polars import DatetimeUTC, zoned_datetime
-from utilities.zoneinfo import UTC, HongKong, Tokyo
+from utilities.tzdata import HongKong, Tokyo
+from utilities.zoneinfo import UTC
 
 if TYPE_CHECKING:
     from pathlib import Path

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/tests/test_datetime.py

@@ -6,7 +6,6 @@ from math import isclose
 from operator import eq, gt, lt
 from re import search
 from typing import TYPE_CHECKING, Any, Self
-from zoneinfo import ZoneInfo
 
 from hypothesis import HealthCheck, assume, given, settings
 from hypothesis.strategies import (
@@ -38,13 +37,9 @@ from utilities.datetime import (
     MILLISECOND,
     MINUTE,
     MONTH,
-    NOW_HK,
-    NOW_TOKYO,
     NOW_UTC,
     QUARTER,
     SECOND,
-    TODAY_HK,
-    TODAY_TOKYO,
     TODAY_UTC,
     WEEK,
     YEAR,
@@ -98,14 +93,8 @@ from utilities.datetime import (
     get_half_years,
     get_months,
     get_now,
-    get_now_hk,
-    get_now_local,
-    get_now_tokyo,
     get_quarters,
     get_today,
-    get_today_hk,
-    get_today_local,
-    get_today_tokyo,
     get_years,
     is_integral_timedelta,
     is_local_datetime,
@@ -149,10 +138,12 @@ from utilities.hypothesis import (
 )
 from utilities.math import MAX_INT32, MIN_INT32, is_integral, round_to_float
 from utilities.sentinel import Sentinel, sentinel
-from utilities.zoneinfo import UTC, HongKong, Tokyo
+from utilities.tzdata import HongKong
+from utilities.zoneinfo import UTC
 
 if TYPE_CHECKING:
     from collections.abc import Callable
+    from zoneinfo import ZoneInfo
 
     from utilities.sentinel import Sentinel
     from utilities.types import (
@@ -686,24 +677,14 @@ class TestGetDateTime:
 
 class TestGetNow:
     @given(time_zone=timezones())
-    def test_main(self, *, time_zone: ZoneInfo) -> None:
+    def test_function(self, *, time_zone: ZoneInfo) -> None:
         now = get_now(time_zone=time_zone)
         assert isinstance(now, dt.datetime)
         assert now.tzinfo is time_zone
 
-    def test_local(self) -> None:
-        now = get_now(time_zone="local")
-        assert isinstance(now, dt.datetime)
-        ETC = ZoneInfo("Etc/UTC")  # noqa: N806
-        assert now.tzinfo in {ETC, HongKong, Tokyo, UTC}
-
-    @given(get_now=sampled_from([get_now, get_now_local, get_now_hk, get_now_tokyo]))
-    def test_getters(self, *, get_now: Callable[[], dt.datetime]) -> None:
-        assert isinstance(get_now(), dt.date)
-
-    @given(now=sampled_from([NOW_UTC, NOW_HK, NOW_TOKYO]))
-    def test_constants(self, *, now: dt.datetime) -> None:
-        assert isinstance(now, dt.date)
+    def test_constant(self) -> None:
+        assert isinstance(NOW_UTC, dt.datetime)
+        assert NOW_UTC.tzinfo is UTC
 
 
 class TestGetTimedelta:
@@ -729,24 +710,12 @@ class TestGetTimedelta:
 
 class TestGetToday:
     @given(time_zone=timezones())
-    def test_main(self, *, time_zone: ZoneInfo) -> None:
+    def test_function(self, *, time_zone: ZoneInfo) -> None:
         today = get_today(time_zone=time_zone)
         assert isinstance(today, dt.date)
 
-    @given(
-        get_today=sampled_from([
-            get_today,
-            get_today_local,
-            get_today_hk,
-            get_today_tokyo,
-        ])
-    )
-    def test_getters(self, *, get_today: Callable[[], dt.datetime]) -> None:
-        assert isinstance(get_today(), dt.date)
-
-    @given(today=sampled_from([TODAY_UTC, TODAY_HK, TODAY_TOKYO]))
-    def test_constants(self, *, today: dt.date) -> None:
-        assert isinstance(today, dt.date)
+    def test_constant(self) -> None:
+        assert isinstance(TODAY_UTC, dt.date)
 
 
 class TestIsIntegralTimeDelta:

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/tests/test_orjson.py

@@ -51,7 +51,7 @@ from tests.test_typing_funcs.with_future import (
     DataClassFutureTypeLiteral,
     DataClassFutureTypeLiteralNullable,
 )
-from utilities.datetime import MINUTE, SECOND, get_now, get_now_local
+from utilities.datetime import MINUTE, SECOND, get_now
 from utilities.functions import is_sequence_of
 from utilities.hypothesis import (
     assume_does_not_raise,
@@ -83,6 +83,7 @@ from utilities.polars import check_polars_dataframe, zoned_datetime
 from utilities.sentinel import Sentinel, sentinel
 from utilities.types import DateOrDateTime, LogLevel, MaybeIterable, PathLike
 from utilities.typing import get_args
+from utilities.tzlocal import get_now_local
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -124,7 +125,7 @@ class TestGetLogRecords:
         assert record.name == str(tmp_path)
         assert record.message == ""
         assert record.level == WARNING
-        assert record.line_num == approx(92, rel=0.1)
+        assert record.line_num == approx(102, rel=0.1)
         assert abs(record.datetime - get_now()) <= MINUTE
         assert record.func_name == "test_main"
         assert record.stack_info is None

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/tests/test_parse.py

@@ -300,6 +300,43 @@ class TestSerializeAndParseObject:
 
 
 class TestParseObject:
+    @given(text=sampled_from(["F_a_l_s_e", "T_r_u_e"]))
+    def test_bool_custom(self, *, text: str) -> None:
+        def parser(text: str, /) -> bool:
+            match text:
+                case "F_a_l_s_e":
+                    return False
+                case "T_r_u_e":
+                    return True
+                case _:
+                    raise ImpossibleCaseError(case=[f"{text=}"])
+
+        bool_ = parse_object(bool, text, extra={bool: parser})
+        match text:
+            case "F_a_l_s_e":
+                expected = False
+            case "T_r_u_e":
+                expected = True
+            case _:
+                raise ImpossibleCaseError(case=[f"{text=}"])
+        assert bool_ is expected
+
+    @given(text=sampled_from(["F_a_l_s_e", "T_r_u_e"]))
+    def test_bool_extra_not_used(self, *, text: str) -> None:
+        def parser(text: str, /) -> bool:
+            match text:
+                case "F_a_l_s_e":
+                    return False
+                case "T_r_u_e":
+                    return True
+                case _:
+                    raise ImpossibleCaseError(case=[f"{text=}"])
+
+        with raises(
+            _ParseObjectParseError, match="Unable to parse <class 'bool'>; got '.*'"
+        ):
+            _ = parse_object(bool, text, extra={int: parser})
+
     def test_error_bool(self) -> None:
         with raises(
             _ParseObjectParseError,
@@ -531,6 +568,32 @@ class TestParseObject:
 
 
 class TestSerializeObject:
+    @given(bool_=booleans())
+    def test_bool_custom(self, *, bool_: bool) -> None:
+        def serializer(bool_: bool, /) -> str:  # noqa: FBT001
+            match bool_:
+                case True:
+                    return "1"
+                case False:
+                    return "0"
+
+        serialized = serialize_object(bool_, extra={bool: serializer})
+        match bool_:
+            case True:
+                expected = "1"
+            case False:
+                expected = "0"
+        assert serialized == expected
+
+    @given(bool_=booleans())
+    def test_bool_extra_not_used(self, *, bool_: bool) -> None:
+        def serializer(int_: int, /) -> str:
+            return f"({int_})"
+
+        serialized = serialize_object(bool_, extra={int: serializer})
+        expected = str(bool_)
+        assert serialized == expected
+
     @given(int_=integers())
     def test_type_with_extra(self, *, int_: int) -> None:
         obj = DataClassFutureInt(int_=int_)

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/tests/test_polars.py

@@ -156,8 +156,8 @@ from utilities.polars import (
 )
 from utilities.random import get_state
 from utilities.sentinel import Sentinel, sentinel
-from utilities.tzdata import USCentral, USEastern
-from utilities.zoneinfo import UTC, HongKong, Tokyo, get_time_zone_name
+from utilities.tzdata import HongKong, Tokyo, USCentral, USEastern
+from utilities.zoneinfo import UTC, get_time_zone_name
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Mapping, Sequence

dycw_utilities-0.112.0/src/tests/test_tzdata.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+import datetime as dt
+from typing import TYPE_CHECKING
+from zoneinfo import ZoneInfo
+
+from hypothesis import given
+from hypothesis.strategies import sampled_from
+
+from utilities.tzdata import (
+    NOW_HONG_KONG,
+    NOW_TOKYO,
+    TODAY_HONG_KONG,
+    TODAY_TOKYO,
+    HongKong,
+    Tokyo,
+    USCentral,
+    USEastern,
+    get_now_hong_kong,
+    get_now_tokyo,
+    get_today_hong_kong,
+    get_today_tokyo,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+
+class TestGetNow:
+    @given(case=sampled_from([(get_now_hong_kong, HongKong), (get_now_tokyo, Tokyo)]))
+    def test_function(
+        self, *, case: tuple[Callable[[], dt.datetime], ZoneInfo]
+    ) -> None:
+        func, time_zone = case
+        self._assert(func(), time_zone)
+
+    @given(case=sampled_from([(NOW_HONG_KONG, HongKong), (NOW_TOKYO, Tokyo)]))
+    def test_constant(self, *, case: tuple[dt.datetime, ZoneInfo]) -> None:
+        datetime, time_zone = case
+        self._assert(datetime, time_zone)
+
+    def _assert(self, datetime: dt.datetime, time_zone: ZoneInfo, /) -> None:
+        assert isinstance(datetime, dt.datetime)
+        assert datetime.tzinfo is time_zone
+
+
+class TestGetToday:
+    @given(func=sampled_from([get_today_hong_kong, get_today_tokyo]))
+    def test_function(self, *, func: Callable[[], dt.date]) -> None:
+        assert isinstance(func(), dt.date)
+
+    @given(date=sampled_from([TODAY_HONG_KONG, TODAY_TOKYO]))
+    def test_constant(self, *, date: dt.date) -> None:
+        assert isinstance(date, dt.date)
+
+
+class TestTimeZones:
+    @given(time_zone=sampled_from([HongKong, Tokyo, USCentral, USEastern]))
+    def test_main(self, *, time_zone: ZoneInfo) -> None:
+        assert isinstance(time_zone, ZoneInfo)

dycw_utilities-0.112.0/src/tests/test_tzlocal.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+import datetime as dt
+from zoneinfo import ZoneInfo
+
+from utilities.tzdata import HongKong, Tokyo
+from utilities.tzlocal import (
+    NOW_LOCAL,
+    TODAY_LOCAL,
+    get_local_time_zone,
+    get_now_local,
+    get_today_local,
+)
+from utilities.zoneinfo import UTC
+
+
+class TestGetLocalTimeZone:
+    def test_main(self) -> None:
+        time_zone = get_local_time_zone()
+        assert isinstance(time_zone, ZoneInfo)
+
+
+class TestGetNowLocal:
+    def test_function(self) -> None:
+        self._assert(get_now_local())
+
+    def test_constant(self) -> None:
+        self._assert(NOW_LOCAL)
+
+    def _assert(self, datetime: dt.datetime, /) -> None:
+        assert isinstance(datetime, dt.datetime)
+        ETC = ZoneInfo("Etc/UTC")  # noqa: N806
+        assert datetime.tzinfo in {ETC, HongKong, Tokyo, UTC}
+
+
+class TestGetTodayLocal:
+    def test_function(self) -> None:
+        assert isinstance(get_today_local(), dt.date)
+
+    def test_constant(self) -> None:
+        assert isinstance(TODAY_LOCAL, dt.date)

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/tests/test_whenever.py

@@ -40,6 +40,7 @@ from utilities.hypothesis import (
     timedeltas_2w,
     zoned_datetimes,
 )
+from utilities.tzdata import HongKong
 from utilities.whenever import (
     MAX_SERIALIZABLE_TIMEDELTA,
     MIN_SERIALIZABLE_TIMEDELTA,
@@ -89,11 +90,12 @@ from utilities.whenever import (
     serialize_timedelta,
     serialize_zoned_datetime,
 )
-from utilities.zoneinfo import UTC, HongKong, get_time_zone_name
+from utilities.zoneinfo import UTC, get_time_zone_name
 
 if TYPE_CHECKING:
     from utilities.types import Duration
 
+
 _TIMEDELTA_MICROSECONDS = int(1e18) * MICROSECOND
 _TIMEDELTA_OVERFLOW = dt.timedelta(days=106751991, seconds=14454, microseconds=775808)
 

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/tests/test_zoneinfo.py

@@ -9,11 +9,10 @@ from hypothesis.strategies import DataObject, data, datetimes, sampled_from, tim
 from pytest import raises
 
 from utilities.hypothesis import zoned_datetimes
+from utilities.tzdata import HongKong, Tokyo
 from utilities.tzlocal import get_local_time_zone
 from utilities.zoneinfo import (
     UTC,
-    HongKong,
-    Tokyo,
     _EnsureTimeZoneInvalidTZInfoError,
     _EnsureTimeZoneLocalDateTimeError,
     ensure_time_zone,

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.111.0"
+__version__ = "0.112.0"

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/utilities/datetime.py

@@ -23,13 +23,7 @@ from utilities.platform import SYSTEM
 from utilities.sentinel import Sentinel, sentinel
 from utilities.types import MaybeStr
 from utilities.typing import is_instance_gen
-from utilities.zoneinfo import (
-    UTC,
-    HongKong,
-    Tokyo,
-    ensure_time_zone,
-    get_time_zone_name,
-)
+from utilities.zoneinfo import UTC, ensure_time_zone, get_time_zone_name
 
 if TYPE_CHECKING:
     from collections.abc import Iterator
@@ -525,28 +519,6 @@ def get_now(*, time_zone: TimeZoneLike = UTC) -> dt.datetime:
 NOW_UTC = get_now(time_zone=UTC)
 
 
-def get_now_hk() -> dt.datetime:
-    """Get the current time in Hong Kong."""
-    return dt.datetime.now(tz=HongKong)
-
-
-NOW_HK = get_now_hk()
-
-
-def get_now_local() -> dt.datetime:
-    """Get the current time in local."""
-    return get_now(time_zone="local")
-    # don't define `NOW_LOCAL` as this would require `tzlocal`
-
-
-def get_now_tokyo() -> dt.datetime:
-    """Get the current time in Tokyo."""
-    return dt.datetime.now(tz=Tokyo)
-
-
-NOW_TOKYO = get_now_tokyo()
-
-
 ##
 
 
@@ -570,27 +542,6 @@ def get_today(*, time_zone: TimeZoneLike = UTC) -> dt.date:
 TODAY_UTC = get_today(time_zone=UTC)
 
 
-def get_today_hk() -> dt.date:
-    """Get the current date in Hong Kong."""
-    return get_now_hk().date()
-
-
-TODAY_HK = get_today_hk()
-
-
-def get_today_local() -> dt.date:
-    """Get the current, timezone-aware local date."""
-    return get_now_local().date()
-
-
-def get_today_tokyo() -> dt.date:
-    """Get the current date in Tokyo."""
-    return get_now_tokyo().date()
-
-
-TODAY_TOKYO = get_today_tokyo()
-
-
 ##
 
 
@@ -1279,13 +1230,9 @@ __all__ = [
     "MIN_DATE_TWO_DIGIT_YEAR",
     "MIN_MONTH",
     "MONTH",
-    "NOW_HK",
-    "NOW_TOKYO",
     "NOW_UTC",
     "QUARTER",
     "SECOND",
-    "TODAY_HK",
-    "TODAY_TOKYO",
     "TODAY_UTC",
     "WEEK",
     "YEAR",
@@ -1335,14 +1282,8 @@ __all__ = [
     "get_half_years",
     "get_months",
     "get_now",
-    "get_now_hk",
-    "get_now_local",
-    "get_now_tokyo",
     "get_quarters",
     "get_today",
-    "get_today_hk",
-    "get_today_local",
-    "get_today_tokyo",
     "get_years",
     "is_integral_timedelta",
     "is_local_datetime",

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/utilities/fastapi.py

@@ -7,7 +7,7 @@ from fastapi import FastAPI
 from uvicorn import Config, Server
 
 from utilities.asyncio import AsyncService
-from utilities.datetime import SECOND, datetime_duration_to_float, get_now_local
+from utilities.datetime import SECOND, datetime_duration_to_float
 
 if TYPE_CHECKING:
     from utilities.types import Duration
@@ -26,6 +26,7 @@ class _PingerReceiverApp(FastAPI):
 
         @self.get("/ping")  # skipif-ci
         def ping() -> str:
+            from utilities.tzlocal import get_now_local  # skipif-ci
             from utilities.whenever import serialize_zoned_datetime  # skipif-ci
 
             now = serialize_zoned_datetime(get_now_local())  # skipif-ci

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/utilities/fpdf2.py

@@ -6,8 +6,6 @@ from typing import TYPE_CHECKING, override
 from fpdf import FPDF
 from fpdf.enums import XPos, YPos
 
-from utilities.datetime import get_now_local
-
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
@@ -45,6 +43,8 @@ def yield_pdf(*, header: str | None = None) -> Iterator[_BasePDF]:
 
         @override
         def footer(self) -> None:
+            from utilities.tzlocal import get_now_local
+
             self.set_y(-15)
             self.set_font(family="Helvetica", style="I", size=8)
             page_no, now = self.page_no(), get_now_local()

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/utilities/hypothesis.py

@@ -69,7 +69,6 @@ from utilities.datetime import (
     date_to_month,
     datetime_duration_to_float,
     datetime_duration_to_timedelta,
-    get_now_local,
     round_datetime,
 )
 from utilities.functions import ensure_int, ensure_str, max_nullable, min_nullable
@@ -1440,6 +1439,7 @@ def yield_test_redis(data: DataObject, /) -> AbstractAsyncContextManager[_TestRe
     from redis.exceptions import ResponseError  # skipif-ci-and-not-linux
 
     from utilities.redis import _TestRedis, yield_redis  #  skipif-ci-and-not-linux
+    from utilities.tzlocal import get_now_local  #  skipif-ci-and-not-linux
 
     now = get_now_local()  # skipif-ci-and-not-linux
     uuid = data.draw(uuids())  # skipif-ci-and-not-linux

{dycw_utilities-0.111.0 → dycw_utilities-0.112.0}/src/utilities/logging.py

@@ -37,11 +37,9 @@ from typing import (
     override,
 )
 
-from utilities.atomicwrites import move_many, writer
 from utilities.dataclasses import replace_non_sentinel
 from utilities.datetime import (
     SECOND,
-    get_now_local,
     maybe_sub_pct_y,
     parse_datetime_compact,
     round_datetime,
@@ -200,6 +198,8 @@ def _compute_rollover_actions(
     patterns: _RolloverPatterns | None = None,
     backup_count: int = 1,
 ) -> _RolloverActions:
+    from utilities.tzlocal import get_now_local  # skipif-ci-and-windows
+
     patterns = (  # skipif-ci-and-windows
         _compute_rollover_patterns(stem, suffix) if patterns is None else patterns
     )
@@ -244,6 +244,8 @@ class _RolloverActions:
     rotations: set[_Rotation] = field(default_factory=set)
 
     def do(self) -> None:
+        from utilities.atomicwrites import move_many  # skipif-ci-and-windows
+
         for deletion in self.deletions:  # skipif-ci-and-windows
             deletion.delete()
         move_many(  # skipif-ci-and-windows
@@ -388,6 +390,9 @@ class StandaloneFileHandler(Handler):
 
     @override
     def emit(self, record: LogRecord) -> None:
+        from utilities.atomicwrites import writer
+        from utilities.tzlocal import get_now_local
+
         try:
             path = (
                 resolve_path(path=self._path)