dycw-utilities 0.133.0__py3-none-any.whl → 0.133.1__py3-none-any.whl

{dycw_utilities-0.133.0.dist-info → dycw_utilities-0.133.1.dist-info}/METADATA

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

{dycw_utilities-0.133.0.dist-info → dycw_utilities-0.133.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=YfKvUqWoneovoyLwbO-FdwUu0a33vS1nujwBMcawq9Y,60
+utilities/__init__.py,sha256=Z40RN6IDVR495cIDu4FY4lG1K8hcbWIcPkM_PM_rASQ,60
 utilities/aiolimiter.py,sha256=mD0wEiqMgwpty4XTbawFpnkkmJS6R4JRsVXFUaoitSU,628
 utilities/altair.py,sha256=HeZBVUocjkrTNwwKrClppsIqgNFF-ykv05HfZSoHYno,9104
 utilities/arq.py,sha256=YkwvWoL930hgeU9VP8iuP3RhMf0t8sm7O8qsD9TiyWo,4688
@@ -6,7 +6,7 @@ utilities/asyncio.py,sha256=USWMMrHqPVRr20vlIn_n5JLimyqa-5xLhuqDYWJed8A,37586
 utilities/atomicwrites.py,sha256=geFjn9Pwn-tTrtoGjDDxWli9NqbYfy3gGL6ZBctiqSo,5393
 utilities/atools.py,sha256=-bFGIrwYMFR7xl39j02DZMsO_u5x5_Ph7bRlBUFVYyw,1048
 utilities/cachetools.py,sha256=uBtEv4hD-TuCPX_cQy1lOpLF-QqfwnYGSf0o4Soqydc,2826
-utilities/click.py,sha256=DI8yJFlpBpRvnc90Xc0kfLKGQRpFCvj797oOJiaE4k8,14998
+utilities/click.py,sha256=2k7Ss2qKwYb1JCDB5IWpNf-B2WTyjKR1GxDW-Y6anPs,15736
 utilities/concurrent.py,sha256=s2scTEd2AhXVTW4hpASU2qxV_DiVLALfms55cCQzCvM,2886
 utilities/contextlib.py,sha256=lpaLJBy3X0UGLWjM98jkQZZq8so4fRmoK-Bheq0uOW4,1027
 utilities/contextvars.py,sha256=RsSGGrbQqqZ67rOydnM7WWIsM2lIE31UHJLejnHJPWY,505
@@ -24,7 +24,7 @@ utilities/getpass.py,sha256=DfN5UgMAtFCqS3dSfFHUfqIMZX2shXvwphOz_6J6f6A,103
 utilities/git.py,sha256=oi7-_l5e9haSANSCvQw25ufYGoNahuUPHAZ6114s3JQ,1191
 utilities/hashlib.py,sha256=SVTgtguur0P4elppvzOBbLEjVM3Pea0eWB61yg2ilxo,309
 utilities/http.py,sha256=WcahTcKYRtZ04WXQoWt5EGCgFPcyHD3EJdlMfxvDt-0,946
-utilities/hypothesis.py,sha256=MS0UgZjevC9QuJAUlGa8ozcbAhlq1qZnSRiSk_1KsXg,35204
+utilities/hypothesis.py,sha256=LWEcjL0ip0cwawcIHhnWPVnB1OEH1GJnYEwYU6xtFpo,36259
 utilities/importlib.py,sha256=mV1xT_O_zt_GnZZ36tl3xOmMaN_3jErDWY54fX39F6Y,429
 utilities/inflect.py,sha256=DbqB5Q9FbRGJ1NbvEiZBirRMxCxgrz91zy5jCO9ZIs0,347
 utilities/ipython.py,sha256=V2oMYHvEKvlNBzxDXdLvKi48oUq2SclRg5xasjaXStw,763
@@ -78,7 +78,7 @@ utilities/text.py,sha256=ymBFlP_cA8OgNnZRVNs7FAh7OG8HxE6YkiLEMZv5g_A,11297
 utilities/threading.py,sha256=GvBOp4CyhHfN90wGXZuA2VKe9fGzMaEa7oCl4f3nnPU,1009
 utilities/timer.py,sha256=oYqRQ-G-DMOOHB6a4yP5-PJDVimLnbNkMnkOj_jUmFg,2474
 utilities/traceback.py,sha256=i-790AQbTrDA8MiYyOcYPFpm48I558VR_kL_7x4ypfY,8503
-utilities/typed_settings.py,sha256=DqJsJjSit9wd_OA3KyMDpx2zatKIi5QhuARI9TPl3rk,3701
+utilities/typed_settings.py,sha256=io3bhnglxO5FRNuTz1vpgbbGgvyj6VGJ5pytPRUeJo4,3769
 utilities/types.py,sha256=ZvD16TobtB47IgMo2CK_CCdJsvhrTqAZgqgqbCME2T0,19223
 utilities/typing.py,sha256=kVWK6ciV8T0MKxnFQcMSEr_XlRisspH5aBTTosMUh30,13872
 utilities/tzdata.py,sha256=fgNVj66yUbCSI_-vrRVzSD3gtf-L_8IEJEPjP_Jel5Y,266
@@ -86,10 +86,10 @@ utilities/tzlocal.py,sha256=KyCXEgCTjqGFx-389JdTuhMRUaT06U1RCMdWoED-qro,728
 utilities/uuid.py,sha256=jJTFxz-CWgltqNuzmythB7iEQ-Q1mCwPevUfKthZT3c,611
 utilities/version.py,sha256=ufhJMmI6KPs1-3wBI71aj5wCukd3sP_m11usLe88DNA,5117
 utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
-utilities/whenever.py,sha256=tArX9unVEKhRYdvbUFa83e4hrzdtMKKCEN4QWTaYd8c,19524
+utilities/whenever.py,sha256=A-yoOqBqrcVD1yDINDsTFDw7dq9-zgUGn_f8CxVUQJs,23332
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=oEH-nL3t4h9uawyZqWDtNtDAl6M-CLpLYGI_nI6DulM,1971
-dycw_utilities-0.133.0.dist-info/METADATA,sha256=8N2dkPiAUTKwY281OkaOGdvSP52CcijVTnjX9L63ctY,1522
-dycw_utilities-0.133.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.133.0.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.133.0.dist-info/RECORD,,
+dycw_utilities-0.133.1.dist-info/METADATA,sha256=fZj3XXeQfb7y2obavSG6zSthc-oG_Zt-I33T3RVsHOE,1522
+dycw_utilities-0.133.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.133.1.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.133.1.dist-info/RECORD,,

utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.133.0"
+__version__ = "0.133.1"

utilities/click.py

@@ -29,7 +29,7 @@ from utilities.types import (
     TimeLike,
     ZonedDateTimeLike,
 )
-from utilities.whenever import _MonthParseCommonISOError
+from utilities.whenever import FreqLike, _FreqParseError, _MonthParseCommonISOError
 
 if TYPE_CHECKING:
     from collections.abc import Iterable, Sequence
@@ -177,6 +177,30 @@ class Enum(ParamType, Generic[TEnum]):
         return _make_metavar(param, desc)
 
 
+class Freq(ParamType):
+    """An frequency-valued parameter."""
+
+    @override
+    def __repr__(self) -> str:
+        return "FREQ"
+
+    @override
+    def convert(
+        self, value: FreqLike, param: Parameter | None, ctx: Context | None
+    ) -> utilities.whenever.Freq:
+        """Convert a value into the `Freq` type."""
+        match value:
+            case utilities.whenever.Freq():
+                return value
+            case str():
+                try:
+                    return utilities.whenever.Freq.parse(value)
+                except _FreqParseError as error:
+                    self.fail(str(error), param, ctx)
+            case _ as never:
+                assert_never(never)
+
+
 class IPv4Address(ParamType):
     """An IPv4 address-valued parameter."""
 
@@ -519,6 +543,7 @@ __all__ = [
     "ExistingDirPath",
     "ExistingFilePath",
     "FilePath",
+    "Freq",
     "FrozenSetChoices",
     "FrozenSetEnums",
     "FrozenSetParameter",

utilities/hypothesis.py

@@ -77,6 +77,8 @@ from utilities.pathlib import temp_cwd
 from utilities.platform import IS_WINDOWS
 from utilities.sentinel import Sentinel, sentinel
 from utilities.tempfile import TEMP_DIR, TemporaryDirectory
+from utilities.types import DateTimeRoundUnit
+from utilities.typing import get_literal_elements
 from utilities.version import Version
 from utilities.whenever import (
     DATE_DELTA_MAX,
@@ -100,6 +102,7 @@ from utilities.whenever import (
     TIME_DELTA_MIN,
     TIME_MAX,
     TIME_MIN,
+    Freq,
     Month,
     to_date_time_delta,
     to_days,
@@ -502,6 +505,38 @@ def floats_extra(
 ##
 
 
+@composite
+def freqs(
+    draw: DrawFn, /, *, unit: MaybeSearchStrategy[DateTimeRoundUnit | None] = None
+) -> Freq:
+    unit_ = draw2(draw, unit, _freq_units())
+    match unit_:
+        case "day":
+            return Freq(unit=unit_)
+        case "hour":
+            return Freq(unit=unit_, increment=draw(_freq_increments(24)))
+        case "minute" | "second":
+            return Freq(unit=unit_, increment=draw(_freq_increments(60)))
+        case "millisecond" | "microsecond" | "nanosecond":
+            return Freq(unit=unit_, increment=draw(_freq_increments(1000)))
+        case _ as never:
+            assert_never(never)
+
+
+@composite
+def _freq_units(draw: DrawFn, /) -> DateTimeRoundUnit:
+    return draw(sampled_from(get_literal_elements(DateTimeRoundUnit)))
+
+
+@composite
+def _freq_increments(draw: DrawFn, n: int, /) -> int:
+    divisors = [i for i in range(1, n) if n % i == 0]
+    return draw(sampled_from(divisors))
+
+
+##
+
+
 @composite
 def git_repos(draw: DrawFn, /) -> Path:
     path = draw(temp_paths())
@@ -1264,6 +1299,7 @@ __all__ = [
     "float64s",
     "float_arrays",
     "floats_extra",
+    "freqs",
     "git_repos",
     "hashables",
     "int32s",

utilities/typed_settings.py

@@ -21,6 +21,7 @@ from whenever import (
 )
 
 from utilities.iterables import always_iterable
+from utilities.whenever import Freq
 
 if TYPE_CHECKING:
     from collections.abc import Callable
@@ -52,6 +53,7 @@ class ExtendedTSConverter(TSConverter):
             (Date, Date.parse_common_iso),
             (DateDelta, DateDelta.parse_common_iso),
             (DateTimeDelta, DateTimeDelta.parse_common_iso),
+            (Freq, Freq.parse),
             (IPv4Address, IPv4Address),
             (IPv6Address, IPv6Address),
             (PlainDateTime, PlainDateTime.parse_common_iso),

utilities/whenever.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from collections.abc import Callable, Iterable
+from collections.abc import Callable, Iterable, Mapping
 from dataclasses import dataclass, replace
 from functools import cache
 from logging import LogRecord
@@ -8,9 +8,12 @@ from statistics import fmean
 from typing import (
     TYPE_CHECKING,
     Any,
+    ClassVar,
+    Literal,
     Self,
     SupportsFloat,
     assert_never,
+    cast,
     overload,
     override,
 )
@@ -28,7 +31,7 @@ from utilities.math import sign
 from utilities.platform import get_strftime
 from utilities.re import ExtractGroupsError, extract_groups
 from utilities.sentinel import Sentinel, sentinel
-from utilities.types import MaybeStr
+from utilities.types import DateTimeRoundUnit, MaybeStr
 from utilities.tzlocal import LOCAL_TIME_ZONE, LOCAL_TIME_ZONE_NAME
 from utilities.zoneinfo import UTC, get_time_zone_name
 
@@ -166,6 +169,127 @@ def format_compact(datetime: ZonedDateTime, /) -> str:
 ##
 
 
+class Freq:
+    """A rounding frequency."""
+
+    unit: DateTimeRoundUnit
+    increment: int
+    _mapping: ClassVar[Mapping[DateTimeRoundUnit, _DateTimeRoundUnitAbbrev]] = {
+        "day": "D",
+        "hour": "H",
+        "minute": "M",
+        "second": "S",
+        "millisecond": "ms",
+        "microsecond": "us",
+        "nanosecond": "ns",
+    }
+
+    def __init__(
+        self, *, unit: DateTimeRoundUnit = "second", increment: int = 1
+    ) -> None:
+        super().__init__()
+        if (unit == "day") and (increment != 1):
+            raise _FreqDayIncrementError(increment=increment)
+        if (unit == "hour") and not ((0 < increment < 24) and (24 % increment == 0)):
+            raise _FreqIncrementError(unit=unit, increment=increment, divisor=24)
+        if (unit in {"minute", "second"}) and not (
+            (0 < increment < 60) and (60 % increment == 0)
+        ):
+            raise _FreqIncrementError(unit=unit, increment=increment, divisor=60)
+        if (unit in {"millisecond", "microsecond", "nanosecond"}) and not (
+            (0 < increment < 1000) and (1000 % increment == 0)
+        ):
+            raise _FreqIncrementError(unit=unit, increment=increment, divisor=1000)
+        self.unit = unit
+        self.increment = increment
+
+    @override
+    def __eq__(self, other: object, /) -> bool:
+        if not isinstance(other, Freq):
+            return NotImplemented
+        return (self.unit == other.unit) and (self.increment == other.increment)
+
+    @override
+    def __hash__(self) -> int:
+        return hash((self.unit, self.increment))
+
+    @override
+    def __repr__(self) -> str:
+        return f"{type(self).__name__}(unit={self.unit!r}, increment={self.increment})"
+
+    @classmethod
+    def parse(cls, text: str, /) -> Self:
+        try:
+            increment, abbrev = extract_groups(r"^(\d*)(D|H|M|S|ms|us|ns)$", text)
+        except ExtractGroupsError:
+            raise _FreqParseError(text=text) from None
+        return cls(
+            unit=cls._expand(cast("_DateTimeRoundUnitAbbrev", abbrev)),
+            increment=int(increment) if len(increment) >= 1 else 1,
+        )
+
+    def serialize(self) -> str:
+        if self.increment == 1:
+            return self._abbreviation
+        return f"{self.increment}{self._abbreviation}"
+
+    @classmethod
+    def _abbreviate(cls, unit: DateTimeRoundUnit, /) -> _DateTimeRoundUnitAbbrev:
+        return cls._mapping[unit]
+
+    @property
+    def _abbreviation(self) -> _DateTimeRoundUnitAbbrev:
+        return self._mapping[self.unit]
+
+    @classmethod
+    def _expand(cls, unit: _DateTimeRoundUnitAbbrev, /) -> DateTimeRoundUnit:
+        values: set[DateTimeRoundUnit] = {
+            k for k, v in cls._mapping.items() if v == unit
+        }
+        (value,) = values
+        return value
+
+
+type FreqLike = MaybeStr[Freq]
+type _DateTimeRoundUnitAbbrev = Literal["D", "H", "M", "S", "ms", "us", "ns"]
+
+
+@dataclass(kw_only=True, slots=True)
+class FreqError(Exception): ...
+
+
+@dataclass(kw_only=True, slots=True)
+class _FreqDayIncrementError(FreqError):
+    increment: int
+
+    @override
+    def __str__(self) -> str:
+        return f"Increment must be 1 for the 'day' unit; got {self.increment}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _FreqIncrementError(FreqError):
+    unit: DateTimeRoundUnit
+    increment: int
+    divisor: int
+
+    @override
+    def __str__(self) -> str:
+        return f"Increment must be a proper divisor of {self.divisor} for the {self.unit!r} unit; got {self.increment}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _FreqParseError(FreqError):
+    text: str
+
+    @override
+    def __str__(self) -> str:
+        return f"Unable to parse frequency; got {self.text!r}"
+
+
+##
+
+
 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))
@@ -736,6 +860,9 @@ __all__ = [
     "ZONED_DATE_TIME_MAX",
     "ZONED_DATE_TIME_MIN",
     "DateOrMonth",
+    "Freq",
+    "FreqError",
+    "FreqLike",
     "MeanDateTimeError",
     "MinMaxDateError",
     "Month",