structtype 0.4.0__tar.gz → 0.6.0__tar.gz

{structtype-0.4.0 → structtype-0.6.0}/AGENTS.md

@@ -3,7 +3,7 @@
 ## Project
 
 Fast struct validation + JSON serialization for Python.
-Core is a monolithic C extension (`src/structtype/_core.c`, ~20K lines).
+Core is a monolithic C extension (`src/structtype/_core.c`, ~19K lines).
 No runtime deps.
 
 ## Setup
@@ -47,11 +47,11 @@ All commands go through `make`.
 
 ### Struct Methods
 
-- `obj.struct_dump_json(*, enc_hook=None, decimal_format=None, uuid_format=None, order=None)` — serialize to JSON bytes
-- `obj.struct_dump()` — convert to built-in Python types (uses `encode_name` for keys)
+- `obj.struct_dump_json(*, decimal_format=None, uuid_format=None, sort_keys=False)` — serialize to JSON bytes
+- `obj.struct_dump(*, sort_keys=False, str_keys=False, builtin_types=None)` — convert to built-in Python types (uses `alias` for keys)
 - `obj.struct_validate_self()` — validate field values against types + constraints
-- `cls.struct_validate_json(buf, *, strict=True, dec_hook=None)` — deserialize from JSON
-- `cls.struct_validate(obj, *, strict=True, from_attributes=False, dec_hook=None)` — convert built-in types to struct
+- `cls.struct_validate_json(buf, *, strict=True)` — deserialize from JSON
+- `cls.struct_validate(obj, *, strict=True, from_attributes=False)` — convert built-in types to struct
 
 ### Dict & Iteration Protocol
 
@@ -61,7 +61,8 @@ Struct instances support the mapping protocol:
 
 ## Gotchas
 
-- `make test-lf` reinstalls the C extension before running (last-failed first)
+- `make test-cov` reinstalls the C extension before running (last-failed first)
+- Validation matches keys by the **alias** name only, except `struct_validate(obj, from_attributes=True)` on a **non-dict object**, which matches by both the python field name and the alias. Dict/JSON input (even with `from_attributes=True`) and all dump/serialization use only the alias name.
 
 ## graphify
 

{structtype-0.4.0 → structtype-0.6.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
@@ -34,11 +34,17 @@ test-lf: ## Run tests in current Python
 test-doc: ## Run doctests
 	uv run pytest --doctest-modules --pyargs structtype
 
-.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; \
-	done
+TEST_ALL_TARGETS = $(PY_VERSIONS:%=test-all-%)
+
+.PHONY: test-all $(TEST_ALL_TARGETS)
+test-all: $(TEST_ALL_TARGETS) ## Run tests in all supported Python versions (parallel: make -j$(nproc) test-all)
+
+define test-all-rule
+.PHONY: test-all-$(1)
+test-all-$(1): ## Run tests for Python $(1)
+	uv run --isolated --reinstall-package structtype -p $(1) pytest
+endef
+$(foreach py_v,$(PY_VERSIONS),$(eval $(call test-all-rule,$(py_v))))
 
 UNAME_S := $(shell uname -s)
 ifeq ($(UNAME_S),Darwin)
@@ -74,6 +80,12 @@ type-check: ## Type check with
 	-uvx ty check ${SOURCE_DIR}
 	uvx pyrefly check ${SOURCE_DIR}
 
+.PHONY: typecheck-tests
+typecheck-tests: ## Type check tests/typecheck fixtures (skipped when tools unavailable)
+	@if uvx ty --version >/dev/null 2>&1; then uvx ty check tests/typecheck; else echo "skip: ty unavailable"; fi
+	@if uvx pyrefly --version >/dev/null 2>&1; then uvx pyrefly check tests/typecheck; else echo "skip: pyrefly unavailable"; fi
+	@if uvx mypy --version >/dev/null 2>&1; then uvx mypy --python-executable .venv/bin/python tests/typecheck; else echo "skip: mypy unavailable"; fi
+
 .PHONY: format
 format: ## Format files using ruff format
 	uvx ruff format ${SOURCE_DIR}

{structtype-0.4.0 → structtype-0.6.0}/PKG-INFO

@@ -1,12 +1,14 @@
 Metadata-Version: 2.4
 Name: structtype
-Version: 0.4.0
+Version: 0.6.0
 Summary: Fast Struct type with validation and JSON serialization for Python.
 Maintainer-email: Wolfgang Langner <tds333@mailbox.org>
 License-Expression: BSD-3-Clause
-Project-URL: Homepage, https://github.com/tds333/structtype
+Project-URL: Homepage, https://tds333.github.io/structtype/
+Project-URL: Documentation, https://tds333.github.io/structtype/
+Project-URL: Repository, https://github.com/tds333/structtype
+Project-URL: Changelog, https://tds333.github.io/structtype/changelog.html
 Project-URL: Issue Tracker, https://github.com/tds333/structtype/issues
-Project-URL: Source, https://github.com/tds333/structtype
 Keywords: JSON,schema,serialization,struct,validation
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: WebAssembly :: Emscripten
@@ -23,7 +25,11 @@ Dynamic: license-file
 
 # structtype
 
-Fast Struct type with validation + JSON serialization for Python.
+[![PyPI version](https://img.shields.io/pypi/v/structtype)](https://pypi.org/project/structtype/)
+[![Python versions](https://img.shields.io/pypi/pyversions/structtype)](https://pypi.org/project/structtype/)
+[![Build status](https://img.shields.io/github/actions/workflow/status/tds333/structtype/build.yml?branch=main)](https://github.com/tds333/structtype/actions/workflows/build.yml)
+
+Fast data struct type with validation + JSON serialization for Python.
 
 - **High performance** — 5-60x faster than dataclasses, attrs, or pydantic for common operations
 - **Schema validation** — familiar Python type annotations, enforced at decode time
@@ -72,7 +78,16 @@ 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
+
+- [Documentation](https://tds333.github.io/structtype/)
+- [Changelog](https://tds333.github.io/structtype/changelog.html)
+- [PyPI](https://pypi.org/project/structtype/)
+- [Source code](https://github.com/tds333/structtype)
+- [Issue tracker](https://github.com/tds333/structtype/issues)
 
 ## License
 

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

@@ -1,6 +1,10 @@
 # structtype
 
-Fast Struct type with validation + JSON serialization for Python.
+[![PyPI version](https://img.shields.io/pypi/v/structtype)](https://pypi.org/project/structtype/)
+[![Python versions](https://img.shields.io/pypi/pyversions/structtype)](https://pypi.org/project/structtype/)
+[![Build status](https://img.shields.io/github/actions/workflow/status/tds333/structtype/build.yml?branch=main)](https://github.com/tds333/structtype/actions/workflows/build.yml)
+
+Fast data struct type with validation + JSON serialization for Python.
 
 - **High performance** — 5-60x faster than dataclasses, attrs, or pydantic for common operations
 - **Schema validation** — familiar Python type annotations, enforced at decode time
@@ -49,7 +53,16 @@ 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
+
+- [Documentation](https://tds333.github.io/structtype/)
+- [Changelog](https://tds333.github.io/structtype/changelog.html)
+- [PyPI](https://pypi.org/project/structtype/)
+- [Source code](https://github.com/tds333/structtype)
+- [Issue tracker](https://github.com/tds333/structtype/issues)
 
 ## License
 

{structtype-0.4.0 → structtype-0.6.0}/pyproject.toml

@@ -4,19 +4,9 @@ description = "Fast Struct type with validation and JSON serialization for Pytho
 readme = "README.md"
 requires-python = ">=3.10"
 license = "BSD-3-Clause"
-license-files = [
-  "LICENSE",
-]
-maintainers = [
-  { name = "Wolfgang Langner", email = "tds333@mailbox.org" },
-]
-keywords = [
-  "JSON",
-  "schema",
-  "serialization",
-  "struct",
-  "validation",
-]
+license-files = ["LICENSE"]
+maintainers = [{ name = "Wolfgang Langner", email = "tds333@mailbox.org" }]
+keywords = ["JSON", "schema", "serialization", "struct", "validation"]
 classifiers = [
   "Development Status :: 4 - Beta",
   "Environment :: WebAssembly :: Emscripten",
@@ -28,23 +18,24 @@ classifiers = [
   "Programming Language :: Python :: 3.15",
 ]
 dependencies = []
-dynamic = [
-  "version",
-]
+dynamic = ["version"]
 
 [project.urls]
-Homepage = "https://github.com/tds333/structtype"
+Homepage = "https://tds333.github.io/structtype/"
+Documentation = "https://tds333.github.io/structtype/"
+Repository = "https://github.com/tds333/structtype"
+Changelog = "https://tds333.github.io/structtype/changelog.html"
 "Issue Tracker" = "https://github.com/tds333/structtype/issues"
-Source = "https://github.com/tds333/structtype"
 
 [dependency-groups]
 dev = [
   "attrs",
   "coverage",
   "msgspec",
-  "pydantic; python_version < '3.15'",
+  "pydantic; python_version < '3.16'",
   "pytest>=9",
   "pytest-coverage>=0.0",
+  "typing_extensions",
 ]
 docs = [
   "furo",
@@ -56,10 +47,7 @@ docs = [
 ]
 
 [build-system]
-requires = [
-  "setuptools>=80",
-  "setuptools-scm>=8",
-]
+requires = ["setuptools>=80", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools]
@@ -69,10 +57,7 @@ packages = ["structtype"]
 "" = "src"
 
 [tool.setuptools.exclude-package-data]
-structtype = [
-  "*.c",
-  "*.h",
-]
+structtype = ["*.c", "*.h"]
 
 [tool.setuptools_scm]
 version_file = "src/structtype/_version.py"
@@ -88,3 +73,12 @@ test-command = "pip install pytest>=9 && pytest {project}/tests"
 
 [tool.ruff]
 target-version = "py310"
+
+[tool.coverage.report]
+exclude_lines = [
+  'pragma: no cover',
+  'if (typing\.)?TYPE_CHECKING:',
+  'if sys\.version_info',
+  'except ImportError:',
+  '# noqa: F821',
+]

structtype-0.6.0/src/structtype/__init__.py

@@ -0,0 +1,42 @@
+from ._adapter import StructAdapter
+from ._core import (  # type: ignore
+    ALL_BUILTIN_TYPES,
+    NODEFAULT,
+    UNSET,
+    DecodeError,
+    EncodeError,
+    Factory,
+    Field,
+    Raw,
+    Struct,
+    StructConfig,
+    StructMeta,
+    UnsetType,
+    ValidationError,
+)
+from ._inspect import FieldInfo, fields
+from ._json_schema import json_schema, json_schema_components, json_schema_dump
+from ._version import __version__
+
+__all__ = [
+    "ALL_BUILTIN_TYPES",
+    "NODEFAULT",
+    "UNSET",
+    "DecodeError",
+    "EncodeError",
+    "Factory",
+    "Field",
+    "FieldInfo",
+    "Raw",
+    "Struct",
+    "StructAdapter",
+    "StructConfig",
+    "StructMeta",
+    "UnsetType",
+    "ValidationError",
+    "__version__",
+    "fields",
+    "json_schema",
+    "json_schema_components",
+    "json_schema_dump",
+]

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

@@ -1,11 +1,34 @@
+# ruff: noqa: PYI041, PYI015, PYI020, UP037
 import enum
 from collections.abc import Callable, Iterable, Iterator, Mapping
 from inspect import Signature
-from typing import Any, ClassVar, Final, Literal, TypeAlias, TypeVar, final, overload
+from typing import (
+    Any,
+    ClassVar,
+    Final,
+    Literal,
+    TypeAlias,
+    TypeVar,
+    final,
+    overload,
+)
 
 from typing_extensions import Buffer, Self, dataclass_transform
 
-from . import StructConfig
+class StructConfig:
+    frozen: bool
+    eq: bool
+    order: bool
+    array_like: bool
+    repr_omit_defaults: bool
+    omit_defaults: bool
+    forbid_unknown_fields: bool
+    validate_on_init: bool
+    weakref: bool
+    dict: bool
+    cache_hash: bool
+    tag: str | int | None
+    tag_field: str | None
 
 # PEP 673 explicitly rejects using Self in metaclass definitions:
 # https://peps.python.org/pep-0673/#valid-locations-for-self
@@ -17,8 +40,8 @@ _SM = TypeVar("_SM", bound="StructMeta")
 class StructMeta(type):
     __struct_fields__: ClassVar[tuple[str, ...]]
     __struct_defaults__: ClassVar[tuple[Any, ...]]
-    __struct_encode_fields__: ClassVar[tuple[str, ...]]
-    __match_args__: ClassVar[tuple[str, ...]]
+    __struct_alias_fields__: ClassVar[tuple[str, ...]]
+    __match_args__: ClassVar[tuple[str, ...]] = ...
     @property
     def __signature__(self) -> Signature: ...
     @property
@@ -46,15 +69,12 @@ class StructMeta(type):
         kw_only: bool = False,
         repr_omit_defaults: bool = False,
         array_like: bool = False,
-        gc: bool = True,
         weakref: bool = False,
         dict: bool = False,
         cache_hash: bool = False,
         validate_on_init: bool = False,
     ) -> _SM: ...
 
-_T = TypeVar("_T")
-
 @final
 class UnsetType(enum.Enum):
     UNSET = "UNSET"
@@ -68,13 +88,13 @@ class _NoDefault(enum.Enum):
 
 NODEFAULT: Final = _NoDefault.NODEFAULT
 
-@dataclass_transform(field_specifiers=("Field",))
+@dataclass_transform(field_specifiers=("Field",))  # type: ignore
 class Struct(metaclass=StructMeta):
     __struct_fields__: ClassVar[tuple[str, ...]]
     __struct_config__: ClassVar[StructConfig]
-    __struct_encode_fields__: ClassVar[tuple[str, ...]]
+    __struct_alias_fields__: ClassVar[tuple[str, ...]]
     __struct_defaults__: ClassVar[tuple[Any, ...]]
-    __match_args__: ClassVar[tuple[str, ...]]
+    __match_args__: ClassVar[tuple[str, ...]] = ...
     # A default __init__ so that Structs with unknown field types
     # won't error on every call to `__init__`
     def __init__(self, *args: Any, **kwargs: Any) -> None: ...
@@ -96,7 +116,6 @@ class Struct(metaclass=StructMeta):
         kw_only: bool = False,
         repr_omit_defaults: bool = False,
         array_like: bool = False,
-        gc: bool = True,
         weakref: bool = False,
         dict: bool = False,
         cache_hash: bool = False,
@@ -110,7 +129,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 +138,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,
@@ -128,21 +145,19 @@ class Struct(metaclass=StructMeta):
     def struct_validate_self(self) -> None: ...
     @classmethod
     def struct_validate_json(
-        cls: type[_T],
+        cls,
         buf: str | Buffer,
         *,
         strict: bool = True,
-        dec_hook: Callable[[type[Any], Any], Any] | None = None,
-    ) -> _T: ...
+    ) -> Self: ...
     @classmethod
     def struct_validate(
-        cls: type[_T],
+        cls,
         obj: Any,
         *,
         strict: bool = True,
         from_attributes: bool = False,
-        dec_hook: Callable[[type[Any], Any], Any] | None = None,
-    ) -> _T: ...
+    ) -> Self: ...
 
 # Lie and say `Raw` is a subclass of `bytes`, so mypy will accept it in most
 # places where an object that implements the buffer protocol is valid
@@ -157,6 +172,11 @@ class Raw(bytes):
 #: We can't represent this in types, only via a name:
 _NonNegativeInt: TypeAlias = int
 
+@final
+class Factory:
+    def __new__(cls, factory: Callable[[], Any]) -> Any: ...
+    factory: Final[Callable[[], Any]]
+
 @final
 class Field:
     # Numeric:
@@ -167,13 +187,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 +203,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 +219,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 +235,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 +253,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,28 +275,15 @@ 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:
-    frozen: bool
-    eq: bool
-    order: bool
-    array_like: bool
-    gc: bool
-    repr_omit_defaults: bool
-    omit_defaults: bool
-    forbid_unknown_fields: bool
-    validate_on_init: bool
-    weakref: bool
-    dict: bool
-    cache_hash: bool
-    tag: str | int | None
-    tag_field: str | None
-
 class FieldInfo(Struct):
     name: str
-    encode_name: str
+    alias: str
     type: Any
     default: Any = NODEFAULT
     default_factory: Any = NODEFAULT
@@ -308,13 +318,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,22 +334,17 @@ 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,
     ) -> Any: ...
 
-class StrAdapter:
-    def __new__(cls, type: type[Any]) -> type[str]: ...
-
 class EncodeError(ValueError): ...
 class DecodeError(ValueError): ...
 class ValidationError(ValueError): ...