dycw-utilities 0.132.3__tar.gz → 0.132.4__tar.gz

{dycw_utilities-0.132.3 → dycw_utilities-0.132.4}/PKG-INFO

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

{dycw_utilities-0.132.3 → dycw_utilities-0.132.4}/pyproject.toml

@@ -102,7 +102,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.132.3"
+version = "0.132.4"
 
 [project.optional-dependencies]
 logging = [
@@ -128,7 +128,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.132.3"
+current_version = "0.132.4"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"
@@ -236,6 +236,7 @@ asyncio_mode = "auto"
 filterwarnings = [
   "error",
   "ignore:.*utcfromtimestamp.* is deprecated and scheduled for removal in a future version:DeprecationWarning",  # luigi
+  "ignore:Exception ignored in.* <coroutine object .* at .*>:pytest.PytestUnraisableExceptionWarning",
   "ignore:Implicitly cleaning up <TemporaryDirectory '.*'>:ResourceWarning",
   "ignore:ResourceTracker called reentrantly for resource cleanup, which is unsupported:UserWarning",
   "ignore:Task .* without outputs has no custom complete.* method:UserWarning",  # luigi

{dycw_utilities-0.132.3 → dycw_utilities-0.132.4}/src/tests/test_click.py

@@ -16,6 +16,7 @@ from hypothesis.strategies import (
     booleans,
     data,
     frozensets,
+    ip_addresses,
     lists,
     sampled_from,
 )
@@ -36,6 +37,8 @@ from utilities.click import (
     FrozenSetChoices,
     FrozenSetEnums,
     FrozenSetStrs,
+    IPv4Address,
+    IPv6Address,
     ListEnums,
     ListStrs,
     Month,
@@ -227,6 +230,8 @@ class TestParameters:
                 _lift_serializer(str, sort=True),
                 False,
             ),
+            param(IPv4Address(), "IPV4 ADDRESS", ip_addresses(v=4), str, True),
+            param(IPv6Address(), "IPV6 ADDRESS", ip_addresses(v=6), str, True),
             param(
                 ListEnums(_ExampleEnum),
                 "LIST[ENUM[_ExampleEnum]]",

{dycw_utilities-0.132.3 → dycw_utilities-0.132.4}/src/tests/test_parse.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Iterable
+from ipaddress import IPv4Address, IPv6Address
 from pathlib import Path
 from types import NoneType
 from typing import Final, Literal
@@ -12,6 +13,7 @@ from hypothesis.strategies import (
     floats,
     frozensets,
     integers,
+    ip_addresses,
     lists,
     none,
     sampled_from,
@@ -110,6 +112,18 @@ class TestSerializeAndParseObject:
         result = parse_object(int, serialized)
         assert result == int_
 
+    @given(address=ip_addresses(v=4))
+    def test_ipv4_address(self, *, address: IPv4Address) -> None:
+        serialized = serialize_object(address)
+        result = parse_object(IPv4Address, serialized)
+        assert result == address
+
+    @given(address=ip_addresses(v=6))
+    def test_ipv6_address(self, *, address: IPv6Address) -> None:
+        serialized = serialize_object(address)
+        result = parse_object(IPv6Address, serialized)
+        assert result == address
+
     @given(ints=lists(int64s()))
     def test_list(self, *, ints: list[int]) -> None:
         serialized = serialize_object(ints)

{dycw_utilities-0.132.3 → dycw_utilities-0.132.4}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.132.3"
+__version__ = "0.132.4"

{dycw_utilities-0.132.3 → dycw_utilities-0.132.4}/src/utilities/click.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import ipaddress
 import pathlib
 from typing import TYPE_CHECKING, Generic, TypedDict, TypeVar, assert_never, override
 
@@ -12,12 +13,15 @@ import utilities.whenever
 from utilities.enum import EnsureEnumError, ensure_enum
 from utilities.functions import EnsureStrError, ensure_str, get_class_name
 from utilities.iterables import is_iterable_not_str
+from utilities.parse import ParseObjectError, parse_object
 from utilities.text import split_str
 from utilities.types import (
     DateDeltaLike,
     DateLike,
     DateTimeDeltaLike,
     EnumLike,
+    IPv4AddressLike,
+    IPv6AddressLike,
     MaybeStr,
     PlainDateTimeLike,
     TEnum,
@@ -173,6 +177,58 @@ class Enum(ParamType, Generic[TEnum]):
         return _make_metavar(param, desc)
 
 
+class IPv4Address(ParamType):
+    """An IPv4 address-valued parameter."""
+
+    name = "ipv4 address"
+
+    @override
+    def __repr__(self) -> str:
+        return self.name.upper()
+
+    @override
+    def convert(
+        self, value: IPv4AddressLike, param: Parameter | None, ctx: Context | None
+    ) -> ipaddress.IPv4Address:
+        """Convert a value into the `IPv4Address` type."""
+        match value:
+            case ipaddress.IPv4Address():
+                return value
+            case str():
+                try:
+                    return parse_object(ipaddress.IPv4Address, value)
+                except ParseObjectError as error:
+                    self.fail(str(error), param, ctx)
+            case _ as never:
+                assert_never(never)
+
+
+class IPv6Address(ParamType):
+    """An IPv6 address-valued parameter."""
+
+    name = "ipv6 address"
+
+    @override
+    def __repr__(self) -> str:
+        return self.name.upper()
+
+    @override
+    def convert(
+        self, value: IPv6AddressLike, param: Parameter | None, ctx: Context | None
+    ) -> ipaddress.IPv6Address:
+        """Convert a value into the `IPv6Address` type."""
+        match value:
+            case ipaddress.IPv6Address():
+                return value
+            case str():
+                try:
+                    return parse_object(ipaddress.IPv6Address, value)
+                except ParseObjectError as error:
+                    self.fail(str(error), param, ctx)
+            case _ as never:
+                assert_never(never)
+
+
 class Month(ParamType):
     """A month-valued parameter."""
 
@@ -467,6 +523,8 @@ __all__ = [
     "FrozenSetEnums",
     "FrozenSetParameter",
     "FrozenSetStrs",
+    "IPv4Address",
+    "IPv6Address",
     "ListEnums",
     "ListParameter",
     "ListStrs",

{dycw_utilities-0.132.3 → dycw_utilities-0.132.4}/src/utilities/parse.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from contextlib import suppress
 from dataclasses import dataclass
 from enum import Enum
+from ipaddress import IPv4Address, IPv6Address
 from pathlib import Path
 from re import DOTALL
 from types import NoneType
@@ -176,14 +177,9 @@ def _parse_object_type(
             return parse_bool(text)
         except ParseBoolError:
             raise _ParseObjectParseError(type_=cls, text=text) from None
-    if is_subclass_gen(cls, int):
+    if is_subclass_gen(cls, int | float | IPv4Address | IPv6Address):
         try:
-            return int(text)
-        except ValueError:
-            raise _ParseObjectParseError(type_=cls, text=text) from None
-    if issubclass(cls, float):
-        try:
-            return float(text)
+            return cls(text)
         except ValueError:
             raise _ParseObjectParseError(type_=cls, text=text) from None
     if issubclass(cls, Enum):
@@ -443,7 +439,16 @@ def serialize_object(
         with suppress(_SerializeObjectSerializeError):
             return _serialize_object_extra(obj, extra)
     if (obj is None) or isinstance(
-        obj, bool | int | float | str | Path | Sentinel | Version
+        obj,
+        bool
+        | int
+        | float
+        | str
+        | IPv4Address
+        | IPv6Address
+        | Path
+        | Sentinel
+        | Version,
     ):
         return str(obj)
     if isinstance(

{dycw_utilities-0.132.3 → dycw_utilities-0.132.4}/src/utilities/types.py

@@ -4,6 +4,7 @@ import datetime as dt
 from asyncio import Event
 from collections.abc import Awaitable, Callable, Coroutine, Hashable, Iterable, Mapping
 from enum import Enum
+from ipaddress import IPv4Address, IPv6Address
 from logging import Logger
 from pathlib import Path
 from random import Random
@@ -112,6 +113,11 @@ THashable1 = TypeVar("THashable1", bound=Hashable)
 THashable2 = TypeVar("THashable2", bound=Hashable)
 
 
+# ipaddress
+IPv4AddressLike = MaybeStr[IPv4Address]
+IPv6AddressLike = MaybeStr[IPv6Address]
+
+
 # iterables
 type MaybeIterable[_T] = _T | Iterable[_T]
 type IterableHashable[_THashable: Hashable] = (
@@ -295,6 +301,8 @@ __all__ = [
     "DateTimeRoundUnit",
     "EnumLike",
     "ExcInfo",
+    "IPv4AddressLike",
+    "IPv6AddressLike",
     "IterableHashable",
     "LogLevel",
     "LoggerOrName",