typelib 0.1.0__py3-none-any.whl

typelib/__init__.py

@@ -0,0 +1,33 @@
+"""The top-level API for typelib.
+
+Examples: Typical Usage
+    >>> import dataclasses
+    >>> import typelib
+    >>>
+    >>> @dataclasses.dataclass
+    ... class Data:
+    ...     attr: int
+    ...     key: str
+    ...
+    >>>
+    >>> typelib.unmarshal(Data, '{"key":"string","attr":"1"}')
+    Data(attr=1, key='string')
+    >>> typelib.marshal(Data(attr=1, key='string'))
+    {'attr': 1, 'key': 'string'}
+    >>> codec = typelib.codec(Data)
+    >>> codec.encode(Data(attr=1, key='string'))
+    b'{"attr":1,"key":"string"}'
+    >>> codec.decode(b'{"key":"string","attr":1}')
+    Data(attr=1, key='string')
+"""
+
+from __future__ import annotations
+
+import importlib.metadata
+
+from typelib.api import *
+
+__metadata__ = importlib.metadata.metadata("typelib")
+__version__ = __metadata__.get("version")
+__authors__ = __metadata__.get("authors")
+__license__ = __metadata__.get("license")

typelib/api.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+import typing as t
+
+from typelib.codecs import Codec, DecoderT, EncoderT, codec
+from typelib.marshals import AbstractMarshaller, marshal, marshaller
+from typelib.py import compat, refs
+from typelib.unmarshals import AbstractUnmarshaller, unmarshal, unmarshaller
+
+__all__ = (
+    "AbstractMarshaller",
+    "AbstractUnmarshaller",
+    "Codec",
+    "decode",
+    "encode",
+    "marshal",
+    "marshaller",
+    "unmarshal",
+    "unmarshaller",
+    "compat",
+    "refs",
+    "codec",
+)
+
+
+T = t.TypeVar("T")
+
+
+def encode(
+    value: T,
+    *,
+    t: type[T] | refs.ForwardRef | str | None = None,
+    encoder: EncoderT = compat.json.dumps,
+) -> bytes:
+    """Encode a value into a bytes object.
+
+    Args:
+        value: The value to encode.
+        t: A type hint for resolving the marshaller.
+        encoder: A callable that takes a value and returns a bytes object.
+    """
+    marshalled = marshal(value=value, t=t)
+    encoded = encoder(marshalled)
+    return encoded
+
+
+def decode(
+    t: type[T] | refs.ForwardRef | str,
+    value: bytes,
+    *,
+    decoder: DecoderT = compat.json.loads,
+) -> T:
+    """Decode a bytes object into an instance of `t`.
+
+    Args:
+        t: A type hint for resolving the unmarshaller.
+        value: The value to decode.
+        decoder: A callable that takes a bytes object and returns a Python value.
+    """
+    decoded = decoder(value)
+    unmarshalled = unmarshal(t=t, value=decoded)
+    return unmarshalled