structtype 0.4.0__tar.gz → 0.5.0__tar.gz

{structtype-0.4.0 → structtype-0.5.0}/Makefile

@@ -23,7 +23,7 @@ wheels: ## build wheels
 
 ##@ Quality
 .PHONY: test-cov
-test-cov: ## Run tests with coverage
+test-cov: build ## Run tests with coverage
 	uv run pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=structtype
 
 .PHONY: test-lf
@@ -37,7 +37,7 @@ test-doc: ## Run doctests
 .PHONY: test-all
 test-all: ## Run tests in all supporte Python versions
 	for py_v in $(PY_VERSIONS); do \
-		uv run --isolated -p $$py_v pytest; \
+		uv run --isolated --reinstall-package structtype -p $$py_v pytest; \
 	done
 
 UNAME_S := $(shell uname -s)

{structtype-0.4.0/src/structtype.egg-info → structtype-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: structtype
-Version: 0.4.0
+Version: 0.5.0
 Summary: Fast Struct type with validation and JSON serialization for Python.
 Maintainer-email: Wolfgang Langner <tds333@mailbox.org>
 License-Expression: BSD-3-Clause
@@ -72,7 +72,13 @@ Full documentation is available at **https://tds333.github.io/structtype/**.
 
 ## Benchmarks
 
-structtype is as fast as msgspec and about 3-5x faster than pydantic.
+structtype is as fast as msgspec and about 3-5x faster than pydantic. See the
+[benchmarks page](https://tds333.github.io/structtype/benchmarks.html) for the full numbers.
+
+## Links
+
+- [Changelog](https://tds333.github.io/structtype/changelog.html)
+- [Source code](https://github.com/tds333/structtype)
 
 ## License
 

{structtype-0.4.0 → structtype-0.5.0}/README.md

@@ -49,7 +49,13 @@ Full documentation is available at **https://tds333.github.io/structtype/**.
 
 ## Benchmarks
 
-structtype is as fast as msgspec and about 3-5x faster than pydantic.
+structtype is as fast as msgspec and about 3-5x faster than pydantic. See the
+[benchmarks page](https://tds333.github.io/structtype/benchmarks.html) for the full numbers.
+
+## Links
+
+- [Changelog](https://tds333.github.io/structtype/changelog.html)
+- [Source code](https://github.com/tds333/structtype)
 
 ## License
 

{structtype-0.4.0 → structtype-0.5.0}/src/structtype/__init__.py

@@ -5,6 +5,7 @@ from ._core import (
     UNSET,
     DecodeError,
     EncodeError,
+    Factory,
     Field,
     Raw,
     Struct,

{structtype-0.4.0 → structtype-0.5.0}/src/structtype/__init__.pyi

@@ -110,7 +110,6 @@ class Struct(metaclass=StructMeta):
     def struct_dump_json(
         self,
         *,
-        enc_hook: Callable[[Any], Any] | None = None,
         decimal_format: Literal["string", "number"]
         | Callable[[Any], Any]
         | None = None,
@@ -120,7 +119,6 @@ class Struct(metaclass=StructMeta):
     def struct_dump(
         self,
         *,
-        enc_hook: Callable[[Any], Any] | None = None,
         sort_keys: bool = False,
         str_keys: bool = False,
         builtin_types: Iterable[type] | None = None,
@@ -132,7 +130,6 @@ class Struct(metaclass=StructMeta):
         buf: str | Buffer,
         *,
         strict: bool = True,
-        dec_hook: Callable[[type[Any], Any], Any] | None = None,
     ) -> _T: ...
     @classmethod
     def struct_validate(
@@ -141,7 +138,6 @@ class Struct(metaclass=StructMeta):
         *,
         strict: bool = True,
         from_attributes: bool = False,
-        dec_hook: Callable[[type[Any], Any], Any] | None = None,
     ) -> _T: ...
 
 # Lie and say `Raw` is a subclass of `bytes`, so mypy will accept it in most
@@ -157,6 +153,11 @@ class Raw(bytes):
 #: We can't represent this in types, only via a name:
 _NonNegativeInt: TypeAlias = int
 
+@final
+class Factory:
+    def __init__(self, factory: Callable[[], Any]) -> None: ...
+    factory: Final[Callable[[], Any]]
+
 @final
 class Field:
     # Numeric:
@@ -167,13 +168,14 @@ class Field:
         gt: int | float | None = None,
         lt: int | float | None = None,
         multiple_of: int | float | None = None,
-        default: Any = NODEFAULT,
-        default_factory: Callable[[], Any] | None = None,
         alias: str | None = None,
         title: str | None = None,
         description: str | None = None,
         json_schema_extra: dict[str, Any] | None = None,
         examples: list[Any] | None = None,
+        deprecated: bool | None = None,
+        dump: Callable[[Any], Any] | None = None,
+        validate: Callable[[Any], Any] | None = None,
     ) -> None: ...
     @overload
     def __init__(
@@ -182,13 +184,14 @@ class Field:
         gt: int | float | None = None,
         le: int | float | None = None,
         multiple_of: int | float | None = None,
-        default: Any = NODEFAULT,
-        default_factory: Callable[[], Any] | None = None,
         alias: str | None = None,
         title: str | None = None,
         description: str | None = None,
         json_schema_extra: dict[str, Any] | None = None,
         examples: list[Any] | None = None,
+        deprecated: bool | None = None,
+        dump: Callable[[Any], Any] | None = None,
+        validate: Callable[[Any], Any] | None = None,
     ) -> None: ...
     @overload
     def __init__(
@@ -197,13 +200,14 @@ class Field:
         ge: int | float | None = None,
         lt: int | float | None = None,
         multiple_of: int | float | None = None,
-        default: Any = NODEFAULT,
-        default_factory: Callable[[], Any] | None = None,
         alias: str | None = None,
         title: str | None = None,
         description: str | None = None,
         json_schema_extra: dict[str, Any] | None = None,
         examples: list[Any] | None = None,
+        deprecated: bool | None = None,
+        dump: Callable[[Any], Any] | None = None,
+        validate: Callable[[Any], Any] | None = None,
     ) -> None: ...
     @overload
     def __init__(
@@ -212,13 +216,14 @@ class Field:
         ge: int | float | None = None,
         le: int | float | None = None,
         multiple_of: int | float | None = None,
-        default: Any = NODEFAULT,
-        default_factory: Callable[[], Any] | None = None,
         alias: str | None = None,
         title: str | None = None,
         description: str | None = None,
         json_schema_extra: dict[str, Any] | None = None,
         examples: list[Any] | None = None,
+        deprecated: bool | None = None,
+        dump: Callable[[Any], Any] | None = None,
+        validate: Callable[[Any], Any] | None = None,
     ) -> None: ...
     # Other (string/datetime):
     @overload
@@ -229,16 +234,15 @@ class Field:
         min_length: _NonNegativeInt | None = None,
         max_length: _NonNegativeInt | None = None,
         tz: bool | None = None,
-        default: Any = NODEFAULT,
-        default_factory: Callable[[], Any] | None = None,
         alias: str | None = None,
         title: str | None = None,
         description: str | None = None,
         json_schema_extra: dict[str, Any] | None = None,
         examples: list[Any] | None = None,
+        deprecated: bool | None = None,
+        dump: Callable[[Any], Any] | None = None,
+        validate: Callable[[Any], Any] | None = None,
     ) -> None: ...
-    default: Final[Any]
-    default_factory: Final[Callable[[], Any] | None]
     alias: Final[str | None]
     gt: Final[int | float | None]
     ge: Final[int | float | None]
@@ -252,7 +256,10 @@ class Field:
     title: Final[str | None]
     description: Final[str | None]
     examples: Final[list[Any] | None]
+    deprecated: Final[bool | None]
     json_schema_extra: Final[dict[str, Any] | None]
+    dump: Final[Callable[[Any], Any] | None]
+    validate: Final[Callable[[Any], Any] | None]
     def __rich_repr__(self) -> list[tuple[str, Any]]: ...
 
 class StructConfig:
@@ -308,13 +315,11 @@ class StructAdapter:
         buf: str | Buffer,
         *,
         strict: bool = True,
-        dec_hook: Callable[[type[Any], Any], Any] | None = None,
     ) -> Any: ...
     def struct_dump_json(
         self,
         obj: Any,
         *,
-        enc_hook: Callable[[Any], Any] | None = None,
         decimal_format: Literal["string", "number"]
         | Callable[[Any], Any]
         | None = None,
@@ -326,14 +331,12 @@ class StructAdapter:
         obj: Any,
         *,
         strict: bool = True,
-        dec_hook: Callable[[type[Any], Any], Any] | None = None,
         from_attributes: bool = False,
     ) -> Any: ...
     def struct_dump(
         self,
         obj: Any,
         *,
-        enc_hook: Callable[[Any], Any] | None = None,
         sort_keys: bool = False,
         str_keys: bool = False,
         builtin_types: Iterable[type] | None = None,

{structtype-0.4.0 → structtype-0.5.0}/src/structtype/_adapter.py

@@ -1,6 +1,32 @@
-from typing import Any
-
-from ._core import _dump, _json_decode, _json_encode, _validate
+from typing import Any, get_args
+
+from ._core import (  # type: ignore
+    Field as _Field,
+)
+from ._core import (
+    _dump,
+    _json_decode,
+    _json_encode,
+    _validate,
+)
+
+
+def _has_codec(ann):
+    """True if the annotation carries a ``Field`` with ``dump``/``validate``."""
+    metadata = getattr(ann, "__metadata__", None)
+    if metadata is not None:
+        for meta in metadata:
+            if isinstance(meta, _Field) and (
+                meta.dump is not None or meta.validate is not None
+            ):
+                return True
+    supertype = getattr(ann, "__supertype__", None)  # NewType
+    if supertype is not None and _has_codec(supertype):
+        return True
+    value = getattr(ann, "__value__", None)  # PEP 695 type alias
+    if value is not None and _has_codec(value):
+        return True
+    return any(_has_codec(arg) for arg in get_args(ann))
 
 
 class StructAdapter:
@@ -9,6 +35,11 @@ class StructAdapter:
     Useful when you want to validate or serialize plain Python types
     (e.g. ``list[int]``) without defining a full ``Struct`` subclass.
 
+    ``Field(dump=...)`` / ``Field(validate=...)`` codecs are not supported on
+    ``StructAdapter`` — annotations carrying one are rejected. Implement the
+    ``struct_dump`` / ``struct_validate`` protocol methods on the custom type,
+    or use a ``Struct``.
+
     >>> from structtype import StructAdapter
     >>> adapter = StructAdapter(list[int])
     >>> adapter.struct_validate_json(b"[1, 2, 3]")
@@ -18,9 +49,15 @@ class StructAdapter:
     __slots__ = ("_type",)
 
     def __init__(self, type: Any):
+        if _has_codec(type):
+            raise TypeError(
+                "`Field(dump=...)`/`Field(validate=...)` codecs are not supported "
+                "on StructAdapter; define `struct_dump`/`struct_validate` methods "
+                "on the custom type, or use a `Struct` instead"
+            )
         self._type = type
 
-    def struct_validate_json(self, buf, *, strict=True, dec_hook=None):
+    def struct_validate_json(self, buf, *, strict=True):
         """Validate JSON bytes and decode into the adapter's type.
 
         Parameters
@@ -29,16 +66,13 @@ class StructAdapter:
             The JSON message to decode.
         strict : bool, optional
             If True (default), unmatched fields cause an error.
-        dec_hook : callable, optional
-            A callback for customizing decoding of specific types.
         """
-        return _json_decode(buf, type=self._type, strict=strict, dec_hook=dec_hook)
+        return _json_decode(buf, type=self._type, strict=strict)
 
     def struct_dump_json(
         self,
         obj,
         *,
-        enc_hook=None,
         decimal_format=None,
         uuid_format=None,
         sort_keys=False,
@@ -49,8 +83,6 @@ class StructAdapter:
         ----------
         obj : Any
             A value to encode. Must match the adapter's type.
-        enc_hook : callable, optional
-            A callback for customizing encoding of specific types.
         decimal_format : str or callable, optional
             Controls how ``Decimal`` values are encoded.
         uuid_format : str, optional
@@ -60,15 +92,12 @@ class StructAdapter:
         """
         return _json_encode(
             obj,
-            enc_hook=enc_hook,
             decimal_format=decimal_format,
             uuid_format=uuid_format,
             sort_keys=sort_keys,
         )
 
-    def struct_validate(
-        self, obj, *, strict=True, dec_hook=None, from_attributes=False
-    ):
+    def struct_validate(self, obj, *, strict=True, from_attributes=False):
         """Validate a Python object against the adapter's type.
 
         Parameters
@@ -77,8 +106,6 @@ class StructAdapter:
             A Python object to validate and convert.
         strict : bool, optional
             If True (default), unmatched fields cause an error.
-        dec_hook : callable, optional
-            A callback for customizing decoding of specific types.
         from_attributes : bool, optional
             If True, accept objects with attributes instead of dict keys.
         """
@@ -86,7 +113,6 @@ class StructAdapter:
             obj,
             self._type,
             strict=strict,
-            dec_hook=dec_hook,
             from_attributes=from_attributes,
         )
 
@@ -94,7 +120,6 @@ class StructAdapter:
         self,
         obj,
         *,
-        enc_hook=None,
         sort_keys=False,
         str_keys=False,
         builtin_types=None,
@@ -104,7 +129,6 @@ class StructAdapter:
             obj,
             builtin_types=builtin_types,
             str_keys=str_keys,
-            enc_hook=enc_hook,
             sort_keys=sort_keys,
         )