dycw-utilities 0.109.3__py3-none-any.whl → 0.109.5__py3-none-any.whl

{dycw_utilities-0.109.3.dist-info → dycw_utilities-0.109.5.dist-info}/METADATA

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

{dycw_utilities-0.109.3.dist-info → dycw_utilities-0.109.5.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=XHS4BHXBA86Rjy07zPtJwGLkB2QC4JUa0pQjTRZS2zE,60
+utilities/__init__.py,sha256=WUcAfLjgcNNeAm9q3alKWOcT4CjZ3liYuA1SFSky9Ng,60
 utilities/altair.py,sha256=NSyDsm8QlkAGmsGdxVwCkHnPxt_35yJBa9Lg7bz9Ays,9054
 utilities/astor.py,sha256=xuDUkjq0-b6fhtwjhbnebzbqQZAjMSHR1IIS5uOodVg,777
 utilities/asyncio.py,sha256=41oQUurWMvadFK5gFnaG21hMM0Vmfn2WS6OpC0R9mas,14757
@@ -11,7 +11,7 @@ utilities/contextlib.py,sha256=OOIIEa5lXKGzFAnauaul40nlQnQko6Na4ryiMJcHkIg,478
 utilities/contextvars.py,sha256=RsSGGrbQqqZ67rOydnM7WWIsM2lIE31UHJLejnHJPWY,505
 utilities/cryptography.py,sha256=HyOewI20cl3uRXsKivhIaeLVDInQdzgXZGaly7hS5dE,771
 utilities/cvxpy.py,sha256=Rv1-fD-XYerosCavRF8Pohop2DBkU3AlFaGTfD8AEAA,13776
-utilities/dataclasses.py,sha256=4siQUalzjYckhJ7R9Cn4Pmerxzx18_mjPIwUmeuwwKs,23049
+utilities/dataclasses.py,sha256=Rh5QajjwyXGpQqndeOFRT-VnPJXF0jWI515GjCSprS0,23326
 utilities/datetime.py,sha256=GOs-MIEW_A49kzqa1yhIoeNeSqqPVgGO-h2AThtgTDk,37326
 utilities/enum.py,sha256=HoRwVCWzsnH0vpO9ZEcAAIZLMv0Sn2vJxxA4sYMQgDs,5793
 utilities/errors.py,sha256=BtSNP0JC3ik536ddPyTerLomCRJV9f6kdMe6POz0QHM,361
@@ -40,7 +40,7 @@ utilities/operator.py,sha256=0M2yZJ0PODH47ogFEnkGMBe_cfxwZR02T_92LZVZvHo,3715
 utilities/optuna.py,sha256=loyJGWTzljgdJaoLhP09PT8Jz6o_pwBOwehY33lHkhw,1923
 utilities/orjson.py,sha256=Wj5pzG_VdgoAy14a7Luhem-BgYrRtRFvvl_POiszRd0,36930
 utilities/os.py,sha256=D_FyyT-6TtqiN9KSS7c9g1fnUtgxmyMtzAjmYLkk46A,3587
-utilities/parse.py,sha256=-rnx9qBKo9UZbE1HtvBwYOs4vF7YiJiciPAM6IKmfRc,5183
+utilities/parse.py,sha256=q1A1-bsXltdAh8We5Acy-lPuVIClWTxsRXQWq5wYyKk,6382
 utilities/pathlib.py,sha256=31WPMXdLIyXgYOMMl_HOI2wlo66MGSE-cgeelk-Lias,1410
 utilities/period.py,sha256=ikHXsWtDLr553cfH6p9mMaiCnIAP69B7q84ckWV3HaA,10884
 utilities/pickle.py,sha256=Bhvd7cZl-zQKQDFjUerqGuSKlHvnW1K2QXeU5UZibtg,657
@@ -53,7 +53,7 @@ utilities/pyinstrument.py,sha256=ROq2txPwbe2ZUuYJ2IDNbfT97lu2ca0v5_C_yn6sSlM,800
 utilities/pyrsistent.py,sha256=TLJfiiKO4cKNU_pCoM3zDqmSM421qpuoaeaBNnyC_Ac,2489
 utilities/pytest.py,sha256=85QUax4g2VBBAqAHtM9wekcSLB7_9O8AKFTaCshztL8,7989
 utilities/pytest_regressions.py,sha256=-SVT9647Dg6-JcdsiaDKXe3NdOmmrvGevLKWwGjxq3c,5088
-utilities/python_dotenv.py,sha256=10DHEB7AVeZqH7I4wr6nACdJQYQJanlEj6EsyLvCN9w,3059
+utilities/python_dotenv.py,sha256=ZIz45FjpwoMs5fdYr9kRM6f4qEp2GNM5rKLnrRe8_7c,3218
 utilities/random.py,sha256=lYdjgxB7GCfU_fwFVl5U-BIM_HV3q6_urL9byjrwDM8,4157
 utilities/re.py,sha256=5J4d8VwIPFVrX2Eb8zfoxImDv7IwiN_U7mJ07wR2Wvs,3958
 utilities/redis.py,sha256=CsDQqc9V6ASLzLQwtbQXZQEndyG9pJiCOhPlPeszt7Y,21203
@@ -84,7 +84,7 @@ utilities/warnings.py,sha256=yUgjnmkCRf6QhdyAXzl7u0qQFejhQG3PrjoSwxpbHrs,1819
 utilities/whenever.py,sha256=5x2t47VJmJRWcd_NLFy54NkB3uom-XQYxEbLtEfL1bs,17775
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=-DQz5a0Ikw9jfSZtL0BEQkXOMC9yGn_xiJYNCLMiqEc,1989
-dycw_utilities-0.109.3.dist-info/METADATA,sha256=TF66WIpVFJnaJA80lxa_GKBZKZUzfz8VWd95FQW8v4A,13004
-dycw_utilities-0.109.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.109.3.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.109.3.dist-info/RECORD,,
+dycw_utilities-0.109.5.dist-info/METADATA,sha256=MlQJX_ZNWyT78qMBJR7P1Evz8nzMaBTjTR3PYh2v07A,13004
+dycw_utilities-0.109.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.109.5.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.109.5.dist-info/RECORD,,

utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.109.3"
+__version__ = "0.109.5"

utilities/dataclasses.py

@@ -453,7 +453,8 @@ def text_to_dataclass(
     warn_name_errors: bool = False,
     head: bool = False,
     case_sensitive: bool = False,
-    allow_extra: bool = False,
+    allow_extra_keys: bool = False,
+    extra_parsers: Mapping[type[_T], Callable[[str], _T]] | None = None,
 ) -> TDataclass:
     """Construct a dataclass from a string or a mapping or strings."""
     match text_or_mapping:
@@ -477,10 +478,12 @@ def text_to_dataclass(
         warn_name_errors=warn_name_errors,
         head=head,
         case_sensitive=case_sensitive,
-        allow_extra=allow_extra,
+        allow_extra=allow_extra_keys,
     )
     field_names_to_values = {
-        f.name: _text_to_dataclass_parse(f, t, cls, case_sensitive=case_sensitive)
+        f.name: _text_to_dataclass_parse(
+            f, t, cls, head=head, case_sensitive=case_sensitive, extra=extra_parsers
+        )
         for f, t in fields_to_serializes.items()
     }
     return mapping_to_dataclass(
@@ -492,7 +495,7 @@ def text_to_dataclass(
         warn_name_errors=warn_name_errors,
         head=head,
         case_sensitive=case_sensitive,
-        allow_extra=allow_extra,
+        allow_extra=allow_extra_keys,
     )
 
 
@@ -519,10 +522,14 @@ def _text_to_dataclass_parse(
     cls: type[Dataclass],
     /,
     *,
+    head: bool = False,
     case_sensitive: bool = False,
+    extra: Mapping[type[_T], Callable[[str], _T]] | None = None,
 ) -> Any:
     try:
-        return parse_text(field.type_, text, case_sensitive=case_sensitive)
+        return parse_text(
+            field.type_, text, head=head, case_sensitive=case_sensitive, extra=extra
+        )
     except ParseTextError:
         raise _TextToDataClassParseValueError(cls=cls, field=field, text=text) from None
 

utilities/parse.py

@@ -7,30 +7,42 @@ from enum import Enum
 from pathlib import Path
 from re import DOTALL
 from types import NoneType
-from typing import Any, override
+from typing import TYPE_CHECKING, Any, TypeVar, override
 
 from utilities.datetime import is_subclass_date_not_datetime
 from utilities.enum import ParseEnumError, parse_enum
 from utilities.functions import is_subclass_int_not_bool
-from utilities.iterables import one, one_str
+from utilities.iterables import OneEmptyError, OneNonUniqueError, one, one_str
 from utilities.re import ExtractGroupError, extract_group
 from utilities.sentinel import ParseSentinelError, Sentinel, parse_sentinel
 from utilities.text import ParseBoolError, ParseNoneError, parse_bool, parse_none
 from utilities.typing import get_args, is_literal_type, is_optional_type, is_tuple_type
 from utilities.version import ParseVersionError, Version, parse_version
 
+if TYPE_CHECKING:
+    from collections.abc import Callable, Mapping
+
+
+_T = TypeVar("_T")
+
 
 def parse_text(
-    obj: Any, text: str, /, *, case_sensitive: bool = False, head: bool = False
+    obj: Any,
+    text: str,
+    /,
+    *,
+    case_sensitive: bool = False,
+    head: bool = False,
+    extra: Mapping[type[_T], Callable[[str], _T]] | None = None,
 ) -> Any:
     """Parse text."""
     if obj is None:
         try:
             return parse_none(text)
         except ParseNoneError:
-            raise ParseTextError(obj=obj, text=text) from None
+            raise _ParseTextParseError(obj=obj, text=text) from None
     if isinstance(obj, type):
-        return _parse_text_type(obj, text, case_sensitive=case_sensitive)
+        return _parse_text_type(obj, text, case_sensitive=case_sensitive, extra=extra)
     if is_literal_type(obj):
         return one_str(get_args(obj), text, head=head, case_sensitive=case_sensitive)
     if is_optional_type(obj):
@@ -42,95 +54,111 @@ def parse_text(
         ):
             try:
                 return _parse_text_type(inner, text, case_sensitive=case_sensitive)
-            except ParseTextError:
-                raise ParseTextError(obj=obj, text=text) from None
+            except _ParseTextParseError:
+                raise _ParseTextParseError(obj=obj, text=text) from None
     if is_tuple_type(obj):
         args = get_args(obj)
         try:
             texts = extract_group(r"^\((.*)\)$", text, flags=DOTALL).split(", ")
         except ExtractGroupError:
-            raise ParseTextError(obj=obj, text=text) from None
+            raise _ParseTextParseError(obj=obj, text=text) from None
         if len(args) != len(texts):
-            raise ParseTextError(obj=obj, text=text)
+            raise _ParseTextParseError(obj=obj, text=text)
         return tuple(
             parse_text(arg, text, case_sensitive=case_sensitive, head=head)
             for arg, text in zip(args, texts, strict=True)
         )
-    raise ParseTextError(obj=obj, text=text) from None
+    raise _ParseTextParseError(obj=obj, text=text) from None
 
 
 def _parse_text_type(
-    cls: type[Any], text: str, /, *, case_sensitive: bool = False
+    cls: type[Any],
+    text: str,
+    /,
+    *,
+    case_sensitive: bool = False,
+    extra: Mapping[type[_T], Callable[[str], _T]] | None = None,
 ) -> Any:
     """Parse text."""
     if issubclass(cls, NoneType):
         try:
             return parse_none(text)
         except ParseNoneError:
-            raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
     if issubclass(cls, str):
         return text
     if issubclass(cls, bool):
         try:
             return parse_bool(text)
         except ParseBoolError:
-            raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
     if is_subclass_int_not_bool(cls):
         try:
             return int(text)
         except ValueError:
-            raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
     if issubclass(cls, float):
         try:
             return float(text)
         except ValueError:
-            raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
     if issubclass(cls, Enum):
         try:
             return parse_enum(text, cls, case_sensitive=case_sensitive)
         except ParseEnumError:
-            raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
     if issubclass(cls, Path):
         return Path(text).expanduser()
     if issubclass(cls, Sentinel):
         try:
             return parse_sentinel(text)
         except ParseSentinelError:
-            raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
     if issubclass(cls, Version):
         try:
             return parse_version(text)
         except ParseVersionError:
-            raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
     if is_subclass_date_not_datetime(cls):
         from utilities.whenever import ParseDateError, parse_date
 
         try:
             return parse_date(text)
         except ParseDateError:
-            raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
     if issubclass(cls, dt.datetime):
         from utilities.whenever import ParseDateTimeError, parse_datetime
 
         try:
             return parse_datetime(text)
         except ParseDateTimeError:
-            raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
     if issubclass(cls, dt.time):
         from utilities.whenever import ParseTimeError, parse_time
 
         try:
             return parse_time(text)
         except ParseTimeError:
-            raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
     if issubclass(cls, dt.timedelta):
         from utilities.whenever import ParseTimedeltaError, parse_timedelta
 
         try:
             return parse_timedelta(text)
         except ParseTimedeltaError:
-            raise ParseTextError(obj=cls, text=text) from None
-    raise ParseTextError(obj=cls, text=text) from None
+            raise _ParseTextParseError(obj=cls, text=text) from None
+    if extra is not None:
+        try:
+            parser = one(p for c, p in extra.items() if issubclass(cls, c))
+        except OneEmptyError:
+            pass
+        except OneNonUniqueError as error:
+            raise _ParseTextExtraNonUniqueError(
+                obj=cls, text=text, first=error.first, second=error.second
+            ) from None
+        else:
+            return parser(text)
+    raise _ParseTextParseError(obj=cls, text=text) from None
 
 
 @dataclass
@@ -138,6 +166,19 @@ class ParseTextError(Exception):
     obj: Any
     text: str
 
+
+@dataclass
+class _ParseTextParseError(ParseTextError):
     @override
     def __str__(self) -> str:
         return f"Unable to parse {self.obj!r}; got {self.text!r}"
+
+
+@dataclass
+class _ParseTextExtraNonUniqueError(ParseTextError):
+    first: type[Any]
+    second: type[Any]
+
+    @override
+    def __str__(self) -> str:
+        return f"Unable to parse {self.obj!r} since `extra` must contain exactly one parent class; got {self.first!r}, {self.second!r} and perhaps more"

utilities/python_dotenv.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from os import environ
-from typing import TYPE_CHECKING, override
+from typing import TYPE_CHECKING, TypeVar, override
 
 from dotenv import dotenv_values
 
@@ -13,13 +13,16 @@ from utilities.pathlib import PWD
 from utilities.reprlib import get_repr
 
 if TYPE_CHECKING:
-    from collections.abc import Mapping
+    from collections.abc import Callable, Mapping
     from collections.abc import Set as AbstractSet
     from pathlib import Path
 
     from utilities.types import PathLike, StrMapping, TDataclass
 
 
+_T = TypeVar("_T")
+
+
 def load_settings(
     cls: type[TDataclass],
     /,
@@ -30,6 +33,7 @@ def load_settings(
     warn_name_errors: bool = False,
     head: bool = False,
     case_sensitive: bool = False,
+    extra_parsers: Mapping[type[_T], Callable[[str], _T]] | None = None,
 ) -> TDataclass:
     """Load a set of settings from the `.env` file."""
     path = get_repo_root(cwd=cwd).joinpath(".env")
@@ -57,7 +61,8 @@ def load_settings(
             warn_name_errors=warn_name_errors,
             head=head,
             case_sensitive=case_sensitive,
-            allow_extra=True,
+            allow_extra_keys=True,
+            extra_parsers=extra_parsers,
         )
     except MappingToDataclassError as error:
         raise _LoadSettingsMissingKeysError(path=path, fields=error.fields) from None