dataclass-extensions 0.1.0__py3-none-any.whl

dataclass_extensions/__init__.py

@@ -0,0 +1,13 @@
+from .decode import decode
+from .encode import encode
+from .registrable import Registrable
+from .types import Dataclass
+from .utils import required_field
+
+__all__ = [
+    "Dataclass",
+    "Registrable",
+    "required_field",
+    "encode",
+    "decode",
+]

dataclass_extensions/decode.py

@@ -0,0 +1,184 @@
+from __future__ import annotations
+
+import collections.abc
+import dataclasses
+import types
+import typing
+from datetime import datetime
+from enum import Enum
+from typing import Any, Callable, ClassVar, Type, TypeVar
+
+from .types import *
+
+C = TypeVar("C", bound=Dataclass)
+
+
+class Decoder:
+    custom_handlers: ClassVar[dict[Any, Callable[[Any], Any]]] = {}
+
+    def register_decoder(self, encoder_fun: Callable[[Any], Any], *target_types: Any):
+        for type in target_types:
+            self.custom_handlers[type] = encoder_fun
+
+    def __call__(self, config_class: Type[C], data: dict[str, Any]) -> C:
+        """
+        Decode a dataset from a JSON-safe dictionary. The inverse of :func:`encode()`.
+        """
+        type_hints = typing.get_type_hints(config_class)
+        kwargs = {k: _coerce(v, type_hints[k], self.custom_handlers, k) for k, v in data.items()}
+        return config_class(**kwargs)
+
+
+decode = Decoder()
+
+
+def _get_types(type_hint: Any) -> tuple[Any, ...]:
+    # NOTE: 'types.UnionType' doesn't cover union types with 'typing.*' types.
+    if _safe_isinstance(type_hint, (types.UnionType, type(typing.List | None))):
+        return type_hint.__args__
+    elif _safe_isinstance(type_hint, dataclasses.InitVar):
+        return _get_types(type_hint.type)
+    # TypeAliasType added in 3.12
+    elif hasattr(typing, "TypeAliasType") and _safe_isinstance(type_hint, typing.TypeAliasType):  # type: ignore
+        return _get_types(type_hint.__value__)
+    else:
+        return (type_hint,)
+
+
+def _safe_isinstance(a, b) -> bool:
+    try:
+        return isinstance(a, b)
+    except TypeError:
+        return False
+
+
+def _safe_issubclass(a, b) -> bool:
+    try:
+        return issubclass(a, b)
+    except TypeError:
+        return False
+
+
+def _coerce(
+    value: Any, type_hint: Any, custom_handlers: dict[Any, Callable[[Any], Any]], key: str
+) -> Any:
+    if value is MISSING:
+        raise ValueError(f"Missing required field at '{key}'")
+
+    if type_hint in custom_handlers:
+        return custom_handlers[type_hint](value)
+
+    allowed_types = _get_types(type_hint)
+    for allowed_type in allowed_types:
+        if allowed_type in custom_handlers:
+            return custom_handlers[allowed_type](value)
+
+        if _safe_isinstance(value, allowed_type):
+            return value
+
+        if _safe_issubclass(allowed_type, Enum):
+            try:
+                return allowed_type(value)
+            except TypeError:
+                pass
+
+        # e.g. typing.NamedTuple
+        if _safe_issubclass(allowed_type, tuple) and _safe_isinstance(value, (list, tuple)):
+            try:
+                return allowed_type(*value)
+            except TypeError:
+                pass
+
+        if _safe_issubclass(allowed_type, datetime) and _safe_isinstance(value, (int, float)):
+            try:
+                return datetime.fromtimestamp(value)
+            except TypeError:
+                pass
+
+        origin = getattr(allowed_type, "__origin__", None)
+        args = getattr(allowed_type, "__args__", None)
+        if (origin is list or origin is collections.abc.MutableSequence) and _safe_isinstance(
+            value, (list, tuple)
+        ):
+            if args:
+                return [
+                    _coerce(v, args[0], custom_handlers, f"{key}.{i}") for i, v in enumerate(value)
+                ]
+            else:
+                return list(value)
+        elif (
+            origin is set or origin is collections.abc.Set or origin is collections.abc.MutableSet
+        ) and _safe_isinstance(value, (list, tuple, set)):
+            if args:
+                return set(
+                    _coerce(v, args[0], custom_handlers, f"{key}.{i}") for i, v in enumerate(value)
+                )
+            else:
+                return set(value)
+        elif origin is collections.abc.Sequence and _safe_isinstance(value, (list, tuple)):
+            if args:
+                return tuple(
+                    [
+                        _coerce(v, args[0], custom_handlers, f"{key}.{i}")
+                        for i, v in enumerate(value)
+                    ]
+                )
+            else:
+                return tuple(value)
+        elif origin is tuple and _safe_isinstance(value, (list, tuple)):
+            if args and ... in args:
+                return tuple(
+                    [
+                        _coerce(v, args[0], custom_handlers, f"{key}.{i}")
+                        for i, v in enumerate(value)
+                    ]
+                )
+            elif args:
+                return tuple(
+                    [
+                        _coerce(v, arg, custom_handlers, f"{key}.{i}")
+                        for i, (v, arg) in enumerate(zip(value, args))
+                    ]
+                )
+            else:
+                return tuple(value)
+        elif (
+            origin is dict
+            or origin is collections.abc.Mapping
+            or origin is collections.abc.MutableMapping
+        ) and _safe_isinstance(value, dict):
+            if args:
+                return {
+                    _coerce(k, args[0], custom_handlers, f"{key}.{k}"): _coerce(
+                        v, args[1], custom_handlers, f"{key}.{k}"
+                    )
+                    for k, v in value.items()
+                }
+            else:
+                return value
+        elif origin is typing.Literal and args and value in args:
+            return value
+        elif (
+            dataclasses.is_dataclass(allowed_type)
+            # e.g. TypedDict
+            or _safe_issubclass(allowed_type, dict)
+        ) and _safe_isinstance(value, dict):
+            type_hints = typing.get_type_hints(allowed_type)
+            kwargs = {}
+            for k, v in value.items():
+                try:
+                    type_hint = type_hints[k]
+                except KeyError as e:
+                    raise KeyError(
+                        f"type {allowed_type} has no field '{k}' (full key '{key}.{k}')"
+                    ) from e
+                kwargs[k] = _coerce(v, type_hint, custom_handlers, f"{key}.{k}")
+            return allowed_type(**kwargs)
+
+    if Any in allowed_types:
+        return value
+
+    raise TypeError(
+        f"Not sure how to coerce value {value} at key '{key}' to any "
+        f"of {allowed_types} from type hint '{type_hint}'"
+    )

dataclass_extensions/encode.py

@@ -0,0 +1,91 @@
+from __future__ import annotations
+
+import dataclasses
+import pathlib
+from datetime import datetime
+from typing import Any, Callable, ClassVar, Generator, Type, TypeVar
+
+from .registrable import Registrable
+from .types import *
+
+C = TypeVar("C", bound=Dataclass)
+
+
+class Encoder:
+    custom_handlers: ClassVar[dict[Type, Callable[[Any], Any]]] = {}
+
+    def register_encoder(self, encoder_fun: Callable[[Any], Any], *target_types: Type):
+        for type in target_types:
+            self.custom_handlers[type] = encoder_fun
+
+    def __call__(
+        self,
+        data: Any,
+        *,
+        exclude_none: bool = False,
+        exclude_private_fields: bool = False,
+        recurse: bool = True,
+        strict: bool = True,
+    ) -> Any:
+        """
+        Encode a Python object into JSON-safe dictionary. The inverse of :func:`decode()`.
+
+        :param exclude_none: Don't include values that are ``None``.
+        :param exclude_private_fields: Don't include private fields.
+        :param recurse: Recurse into fields that are also configs/dataclasses.
+        :param strict: If ``True`` a ``TypeError`` is raised when a type is encountered that doesn't
+            have a safe encoding method. Otherwise ``str(value)`` is used.
+        """
+
+        def iter_fields(d) -> Generator[tuple[str, Any], None, None]:
+            for field in dataclasses.fields(d):
+                value = getattr(d, field.name)
+                if exclude_none and value is None:
+                    continue
+                elif exclude_private_fields and field.name.startswith("_"):
+                    continue
+                else:
+                    yield (field.name, value)
+
+        def as_dict(d: Any, recurse: bool = True) -> Any:
+            if type(d) in self.custom_handlers:
+                return self.custom_handlers[type(d)](d)
+            elif dataclasses.is_dataclass(d):
+                if recurse:
+                    out = {k: as_dict(v) for k, v in iter_fields(d)}
+                else:
+                    out = {k: v for k, v in iter_fields(d)}
+                if isinstance(d, Registrable):
+                    try:
+                        registered_name = d.get_registered_name()
+                        out["type"] = registered_name
+                    except ValueError:
+                        pass
+                return out
+            elif isinstance(d, dict):
+                return {k: as_dict(v) for k, v in d.items()}
+            elif isinstance(d, (list, tuple, set)):
+                return [as_dict(x) for x in d]
+            elif isinstance(d, datetime):
+                return d.timestamp()
+            elif isinstance(d, pathlib.Path):
+                return str(d)
+            elif d is None or isinstance(d, (float, int, bool, str)):
+                return d
+
+            for t, h in self.custom_handlers.items():
+                try:
+                    if isinstance(d, t):
+                        return h(d)
+                except TypeError:
+                    continue
+
+            if strict:
+                raise TypeError(f"not sure how to encode '{d}' of type {type(d)}")
+            else:
+                return str(d)
+
+        return as_dict(data, recurse=recurse)
+
+
+encode = Encoder()

dataclass_extensions/registrable.py

@@ -0,0 +1,96 @@
+from __future__ import annotations
+
+import dataclasses
+import typing
+from dataclasses import dataclass
+from typing import Callable, ClassVar, Type, TypeVar
+
+R = TypeVar("R", bound="Registrable")
+
+
+@dataclass
+class Registrable:
+    _registry: ClassVar[dict[str, Type[Registrable]]]
+
+    type: dataclasses.InitVar[str | None] = dataclasses.field(
+        default=None, kw_only=True, repr=False
+    )
+
+    def __new__(cls, *args, type: str | None = None, **kwargs):
+        del args, kwargs
+        if type is not None and (
+            not hasattr(cls, "registered_name") or type != cls.registered_name  # type: ignore
+        ):
+            if type not in cls._registry:
+                raise KeyError(
+                    f"'{type}' is not registered name for {cls.__name__}. "
+                    f"Available choices are: {list(cls._registry.keys())}"
+                )
+            return super().__new__(cls._registry[type])
+        else:
+            return super().__new__(cls)
+
+    def __init_subclass__(cls, **kwargs):
+        super().__init_subclass__(**kwargs)
+        if not hasattr(cls, "_choice_registry"):
+            cls._registry = {}
+
+    @classmethod
+    def register(cls, name: str) -> Callable[[Type[R]], Type[R]]:
+        def register_subclass(subclass: Type[R]) -> Type[R]:
+            if not issubclass(subclass, cls):
+                raise TypeError(
+                    f"class {subclass.__name__} must be a subclass of {cls.__name__} in order to register it"
+                )
+            if not dataclasses.is_dataclass(subclass):
+                raise TypeError(
+                    f"class {subclass.__name__} must be a dataclass in order to register it"
+                )
+
+            fields = [
+                (f.name, f.type, f) for f in dataclasses.fields(subclass) if f.name != "type"  # type: ignore
+            ] + [
+                ("registered_name", ClassVar[str], name),  # type: ignore
+                ("registered_base", ClassVar[R], cls),  # type: ignore
+                ("type", dataclasses.InitVar[str | None], dataclasses.field(default=name, kw_only=True, repr=False)),  # type: ignore
+            ]
+            subclass = dataclasses.make_dataclass(
+                subclass.__name__,
+                fields,  # type: ignore
+                bases=(subclass,),
+            )
+            cls._registry[name] = subclass
+            return subclass
+
+        return register_subclass
+
+    @classmethod
+    def get_registered_name(cls: Type[R], subclass: Type[R] | None = None) -> str:
+        if subclass is None:
+            if hasattr(cls, "registered_name"):
+                return cls.registered_name  # type: ignore
+            else:
+                raise ValueError(
+                    f"class {cls.__name__} is not a registered subclass of any base registrable class"
+                )
+
+        for name, registered_subclass in cls._registry.items():
+            if registered_subclass == subclass:
+                return name
+
+        raise ValueError(
+            f"class {subclass.__name__} is not a registered subclass of {cls.__name__}"
+        )
+
+    @classmethod
+    def get_registered_class(cls: Type[R], type: str) -> Type[R]:
+        if type not in cls._registry:
+            raise KeyError(
+                f"'{type}' is not registered name for {cls.__name__}. "
+                f"Available choices are: {cls.get_registered_names()}"
+            )
+        return typing.cast(Type[R], cls._registry[type])
+
+    @classmethod
+    def get_registered_names(cls) -> list[str]:
+        return list(cls._registry.keys())

dataclass_extensions/types.py

@@ -0,0 +1,15 @@
+import os
+from typing import Any, ClassVar, Protocol
+
+__all__ = [
+    "MISSING",
+    "PathOrStr",
+    "Dataclass",
+]
+
+MISSING = object()
+PathOrStr = os.PathLike | str
+
+
+class Dataclass(Protocol):
+    __dataclass_fields__: ClassVar[dict[str, Any]]

dataclass_extensions/utils.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+import dataclasses
+import typing
+from typing import Type, TypeVar
+
+from .types import *
+
+T = TypeVar("T")
+
+
+@typing.overload
+def required_field(name: str, *, strict: bool = False) -> T:  # type: ignore[type-var]
+    ...
+
+
+@typing.overload
+def required_field() -> T:  # type: ignore[type-var]
+    ...
+
+
+def required_field(name: str | None = None, *, strict: bool = False, _: Type[T] | None = None) -> T:
+    """
+    Can be used in place of ``dataclasses.field()`` to mark a field required when non-default
+    fields are not allowed.
+    """
+    if strict:
+        if name is None:
+            raise ValueError("'name' is required for a required_field with 'strict=True'")
+
+        def err_out():
+            raise ValueError(f"missing required field '{name}'")
+
+        return typing.cast(T, dataclasses.field(default_factory=err_out))
+
+    return typing.cast(T, dataclasses.field(default=MISSING))

dataclass_extensions/version.py

@@ -0,0 +1 @@
+VERSION = "0.1.0"

dataclass_extensions-0.1.0.dist-info/METADATA

@@ -0,0 +1,300 @@
+Metadata-Version: 2.4
+Name: dataclass-extensions
+Version: 0.1.0
+Summary: Additional functionality for Python dataclasses
+Author-email: Pete Walsh <epwalsh10@gmail.com>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                https://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "{}"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright {yyyy} {name of copyright owner}
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               https://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: Homepage, https://github.com/epwalsh/dataclass-extensions
+Project-URL: Changelog, https://github.com/epwalsh/dataclass-extensions/blob/main/CHANGELOG.md
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: black<24.0,>=23.1; extra == "dev"
+Requires-Dist: isort<5.14,>=5.12; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: twine>=1.11.0; extra == "dev"
+Requires-Dist: setuptools; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Provides-Extra: all
+Requires-Dist: dataclass-extensions[dev]; extra == "all"
+Dynamic: license-file
+
+dataclass-extensions
+====================
+
+Additional functionality for Python dataclasses
+
+## Installation
+
+```fish
+pip install dataclass-extensions
+```
+
+## Features
+
+### Encode/decode to/from JSON-safe dictionaries
+
+```python
+from dataclasses import dataclass
+from dataclass_extensions import decode, encode
+
+
+@dataclass
+class Fruit:
+    calories: int
+    price: float
+
+
+@dataclass
+class FruitBasket:
+    fruit: Fruit
+    count: int
+
+
+basket = FruitBasket(fruit=Fruit(calories=200, price=1.0), count=2)
+assert encode(basket) == {"fruit": {"calories": 200, "price": 1.0}, "count": 2}
+assert decode(FruitBasket, encode(basket)) == basket
+```
+
+### Registrable subclasses
+
+```python
+from dataclasses import dataclass
+from dataclass_extensions import Registrable, decode, encode
+
+
+@dataclass
+class Fruit(Registrable):
+    calories: int
+    price: float
+
+
+@Fruit.register("banana")
+@dataclass
+class Banana(Fruit):
+    calories: int = 200
+    price: float = 1.25
+
+
+@Fruit.register("apple")
+@dataclass
+class Apple(Fruit):
+    calories: int = 150
+    price: float = 1.50
+
+
+@dataclass
+class FruitBasket:
+    fruit: Fruit
+    count: int
+
+
+basket = FruitBasket(fruit=Apple(), count=2)
+assert encode(basket) == {"fruit": {"calories": 150, "price": 1.5, "type": "apple"}, "count": 2}
+assert decode(FruitBasket, encode(basket)) == basket
+```

dataclass_extensions-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+dataclass_extensions/__init__.py,sha256=jpgRh5jjj9jM1tkhTVvB-aDThI2v4tAlq_WpR0-NOSI,255
+dataclass_extensions/decode.py,sha256=dstNb-RU8i3jGoTlo165UlSbyG3MhAgbc-O54mdlxqo,6329
+dataclass_extensions/encode.py,sha256=rctJHAwlSnjOw0rTGbHRWigb2BT4DI3FYGiDzAjDmEQ,3233
+dataclass_extensions/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dataclass_extensions/registrable.py,sha256=QJN-QSzxC-vxm1w_wqzRkhRr-GcPFAlIGfbbw5m1o68,3572
+dataclass_extensions/types.py,sha256=UwSV0MKjFDaK4dlgm72vJHHr6-8QNe8jMhbTZGOMIJM,247
+dataclass_extensions/utils.py,sha256=8cigzY9JDEWexWXlcMxXyf27S50-1ZPMNmn4zUSrc6k,935
+dataclass_extensions/version.py,sha256=CpXi3jGlx23RvRyU7iytOMZrnspdWw4yofS8lpP1AJU,18
+dataclass_extensions-0.1.0.dist-info/licenses/LICENSE,sha256=YvuKOpYh3COIF0yqq-nCMXtpS7mh1GyYvPVlW2j1G-M,11359
+dataclass_extensions-0.1.0.dist-info/METADATA,sha256=UwZk8Z5EKDiN_rdxjsDqjYcNwQHiT7qpIVVPJxUsfqY,15215
+dataclass_extensions-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dataclass_extensions-0.1.0.dist-info/top_level.txt,sha256=njfdeqLtTThNGwqnoKu4JV8J1287xGAeEwyESpoU-k8,21
+dataclass_extensions-0.1.0.dist-info/RECORD,,

dataclass_extensions-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

dataclass_extensions-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dataclass_extensions-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+dataclass_extensions