tigrbl_model 0.4.5__tar.gz

tigrbl_model-0.4.5/LICENSE

@@ -0,0 +1,17 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/
+
+Copyright 2025-2026 Jacob Stewart
+
+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.

tigrbl_model-0.4.5/NOTICE

@@ -0,0 +1,4 @@
+tigrbl_model
+Copyright 2025-2026 Jacob Stewart
+
+Licensed under the Apache License, Version 2.0.

tigrbl_model-0.4.5/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: tigrbl_model
+Version: 0.4.5
+Summary: Pydantic-independent validation, serialization, and JSON Schema models for Tigrbl.
+License: Apache License
+         Version 2.0, January 2004
+         https://www.apache.org/licenses/
+         
+         Copyright 2025-2026 Jacob Stewart
+         
+         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.
+License-File: LICENSE
+License-File: NOTICE
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.15
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: pyyaml (>=6.0)
+Requires-Dist: tomli (>=2.0.1) ; python_version < "3.11"
+Requires-Dist: tomli-w (>=1.0)
+Requires-Dist: typing-extensions (>=4.0) ; python_version < "3.11"
+Project-URL: Issues, https://github.com/tigrbl/tigrbl/issues
+Project-URL: Organization, https://github.com/tigrbl
+Project-URL: Repository, https://github.com/tigrbl/tigrbl/tree/master/pkgs/02_model/tigrbl_model
+Description-Content-Type: text/markdown
+
+<div align="center">
+<h1>tigrbl_model</h1>
+<p><strong>Pydantic-independent model validation, schema generation, and JSON, YAML, and TOML serialization for Tigrbl.</strong></p>
+<a href="https://pypi.org/project/tigrbl-model/"><img src="https://img.shields.io/pypi/v/tigrbl-model?label=PyPI" alt="PyPI version for tigrbl_model"/></a>
+<a href="https://discord.gg/K4YTAPapjR"><img src="https://img.shields.io/badge/Discord-Join%20chat-5865F2?logo=discord&logoColor=white" alt="Discord community for tigrbl_model"/></a>
+<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-525252" alt="Apache 2.0 license"/></a>
+<a href="pyproject.toml"><img src="https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-3776ab" alt="Python versions 3.10 | 3.11 | 3.12 | 3.13 | 3.14 for tigrbl_model"/></a>
+</div>
+
+## What is tigrbl_model?
+
+`tigrbl_model` is Tigrbl's Pydantic-independent model engine. It owns field metadata, validation, serialization, dynamic model construction, forward-reference rebuilding, and JSON Schema generation.
+
+## Why use tigrbl_model?
+
+Use it when code needs the Pydantic v2 surface validated by the package tests for Tigrbl without taking a runtime dependency on Pydantic.
+
+## When should I install tigrbl_model?
+
+Install it when building Tigrbl extensions, reusable schema models, or applications that need the same model contract as Tigrbl.
+
+## Who is tigrbl_model for?
+
+Tigrbl maintainers, extension authors, and application developers who need validated models and portable serialization.
+
+## Where does tigrbl_model fit?
+
+It is a foundational package under `pkgs/02_model`, below Tigrbl packages that consume models, validation, and JSON Schema.
+
+## How does tigrbl_model work?
+
+Type annotations and `Field` metadata are compiled into an internal field graph. The graph drives validation, dumping, JSON Schema, and the JSON, YAML, and TOML mixins.
+
+## Install
+
+```bash
+uv add tigrbl-model
+```
+
+```bash
+pip install tigrbl-model
+```
+
+## Surface Coverage
+
+| Surface | Value |
+|---|---|
+| PyPI package | `tigrbl-model` |
+| Repository path | `pkgs/02_model/tigrbl_model` |
+| Python import root | `tigrbl_model` |
+| Console scripts | none |
+| Public mixins | `JsonMixin`, `YamlMixin`, `TomlMixin`, `SerdeMixin` |
+| Runtime Pydantic dependency | none |
+| Legal files | `LICENSE`, `NOTICE` |
+| Supported Python | `3.10 | 3.11 | 3.12 | 3.13 | 3.14` |
+
+## What It Owns
+
+- Runtime model construction and field metadata.
+- Annotation-driven validation and structured errors.
+- Dictionary and JSON serialization.
+- JSON Schema generation.
+- Independently composable JSON, YAML, and TOML mixins.
+- `SerdeMixin`, which aggregates all three format mixins.
+
+## Public API and Import Surface
+
+The primary imports are `Model`/`BaseModel`, `RootModel`, `Field`, `ConfigDict`, `ValidationError`, `create_model`, `field_validator`, `model_validator`, and the four serialization mixins. See `tigrbl_model.__all__` for the complete supported surface.
+
+## Usage Examples
+
+```python
+from tigrbl_model import Field, Model
+
+class Widget(Model):
+    name: str
+    quantity: int = Field(default=0, ge=0)
+
+widget = Widget.model_validate_json('{"name":"bolt","quantity":2}')
+assert widget.model_dump() == {"name": "bolt", "quantity": 2}
+assert Widget.model_validate_yaml(widget.model_dump_yaml()) == widget
+assert Widget.model_validate_toml(widget.model_dump_toml()) == widget
+```
+
+Plain dataclasses can inherit `SerdeMixin` when validation and schema-model behavior are unnecessary.
+
+## How To Choose This Package
+
+Choose `tigrbl_model` for the focused model and serialization boundary. Choose the `tigrbl` facade when building a complete API application. Keep Pydantic installed only when independently comparing behavior during development.
+
+## Related Packages
+
+- `tigrbl`
+- `tigrbl-core`
+- `tigrbl-base`
+- `tigrbl-runtime`
+
+## Documentation Links
+
+- [Supported parity boundary](PARITY.md)
+- [Workspace documentation](https://github.com/tigrbl/tigrbl/blob/master/docs/README.md)
+- [Package catalog](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_CATALOG.md)
+- [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json)
+
+## Support
+
+- Community: [Discord](https://discord.gg/K4YTAPapjR)
+- Issues: [GitHub Issues](https://github.com/tigrbl/tigrbl/issues)
+- Repository: [tigrbl/tigrbl](https://github.com/tigrbl/tigrbl)
+
+## Certification Status
+
+The package's automated suite compares the supported contract with Pydantic v2 and scans first-party Tigrbl runtime usage. `PARITY.md` records intentional boundaries; Pydantic is a development-only parity oracle and is not a runtime dependency.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See `LICENSE` and `NOTICE`.
+
+## Workspace documentation
+
+This README is the package-local distribution entry point. See [workspace documentation](../../../docs/README.md), [current conformance target](../../../docs/conformance/CURRENT_TARGET.md), [package catalog](../../../docs/developer/PACKAGE_CATALOG.md), [package layout](../../../docs/developer/PACKAGE_LAYOUT.md), and [SSOT registry](../../../.ssot/registry.json).
+

tigrbl_model-0.4.5/README.md

@@ -0,0 +1,121 @@
+<div align="center">
+<h1>tigrbl_model</h1>
+<p><strong>Pydantic-independent model validation, schema generation, and JSON, YAML, and TOML serialization for Tigrbl.</strong></p>
+<a href="https://pypi.org/project/tigrbl-model/"><img src="https://img.shields.io/pypi/v/tigrbl-model?label=PyPI" alt="PyPI version for tigrbl_model"/></a>
+<a href="https://discord.gg/K4YTAPapjR"><img src="https://img.shields.io/badge/Discord-Join%20chat-5865F2?logo=discord&logoColor=white" alt="Discord community for tigrbl_model"/></a>
+<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-525252" alt="Apache 2.0 license"/></a>
+<a href="pyproject.toml"><img src="https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-3776ab" alt="Python versions 3.10 | 3.11 | 3.12 | 3.13 | 3.14 for tigrbl_model"/></a>
+</div>
+
+## What is tigrbl_model?
+
+`tigrbl_model` is Tigrbl's Pydantic-independent model engine. It owns field metadata, validation, serialization, dynamic model construction, forward-reference rebuilding, and JSON Schema generation.
+
+## Why use tigrbl_model?
+
+Use it when code needs the Pydantic v2 surface validated by the package tests for Tigrbl without taking a runtime dependency on Pydantic.
+
+## When should I install tigrbl_model?
+
+Install it when building Tigrbl extensions, reusable schema models, or applications that need the same model contract as Tigrbl.
+
+## Who is tigrbl_model for?
+
+Tigrbl maintainers, extension authors, and application developers who need validated models and portable serialization.
+
+## Where does tigrbl_model fit?
+
+It is a foundational package under `pkgs/02_model`, below Tigrbl packages that consume models, validation, and JSON Schema.
+
+## How does tigrbl_model work?
+
+Type annotations and `Field` metadata are compiled into an internal field graph. The graph drives validation, dumping, JSON Schema, and the JSON, YAML, and TOML mixins.
+
+## Install
+
+```bash
+uv add tigrbl-model
+```
+
+```bash
+pip install tigrbl-model
+```
+
+## Surface Coverage
+
+| Surface | Value |
+|---|---|
+| PyPI package | `tigrbl-model` |
+| Repository path | `pkgs/02_model/tigrbl_model` |
+| Python import root | `tigrbl_model` |
+| Console scripts | none |
+| Public mixins | `JsonMixin`, `YamlMixin`, `TomlMixin`, `SerdeMixin` |
+| Runtime Pydantic dependency | none |
+| Legal files | `LICENSE`, `NOTICE` |
+| Supported Python | `3.10 | 3.11 | 3.12 | 3.13 | 3.14` |
+
+## What It Owns
+
+- Runtime model construction and field metadata.
+- Annotation-driven validation and structured errors.
+- Dictionary and JSON serialization.
+- JSON Schema generation.
+- Independently composable JSON, YAML, and TOML mixins.
+- `SerdeMixin`, which aggregates all three format mixins.
+
+## Public API and Import Surface
+
+The primary imports are `Model`/`BaseModel`, `RootModel`, `Field`, `ConfigDict`, `ValidationError`, `create_model`, `field_validator`, `model_validator`, and the four serialization mixins. See `tigrbl_model.__all__` for the complete supported surface.
+
+## Usage Examples
+
+```python
+from tigrbl_model import Field, Model
+
+class Widget(Model):
+    name: str
+    quantity: int = Field(default=0, ge=0)
+
+widget = Widget.model_validate_json('{"name":"bolt","quantity":2}')
+assert widget.model_dump() == {"name": "bolt", "quantity": 2}
+assert Widget.model_validate_yaml(widget.model_dump_yaml()) == widget
+assert Widget.model_validate_toml(widget.model_dump_toml()) == widget
+```
+
+Plain dataclasses can inherit `SerdeMixin` when validation and schema-model behavior are unnecessary.
+
+## How To Choose This Package
+
+Choose `tigrbl_model` for the focused model and serialization boundary. Choose the `tigrbl` facade when building a complete API application. Keep Pydantic installed only when independently comparing behavior during development.
+
+## Related Packages
+
+- `tigrbl`
+- `tigrbl-core`
+- `tigrbl-base`
+- `tigrbl-runtime`
+
+## Documentation Links
+
+- [Supported parity boundary](PARITY.md)
+- [Workspace documentation](https://github.com/tigrbl/tigrbl/blob/master/docs/README.md)
+- [Package catalog](https://github.com/tigrbl/tigrbl/blob/master/docs/developer/PACKAGE_CATALOG.md)
+- [SSOT registry](https://github.com/tigrbl/tigrbl/blob/master/.ssot/registry.json)
+
+## Support
+
+- Community: [Discord](https://discord.gg/K4YTAPapjR)
+- Issues: [GitHub Issues](https://github.com/tigrbl/tigrbl/issues)
+- Repository: [tigrbl/tigrbl](https://github.com/tigrbl/tigrbl)
+
+## Certification Status
+
+The package's automated suite compares the supported contract with Pydantic v2 and scans first-party Tigrbl runtime usage. `PARITY.md` records intentional boundaries; Pydantic is a development-only parity oracle and is not a runtime dependency.
+
+## License
+
+Licensed under the Apache License, Version 2.0. See `LICENSE` and `NOTICE`.
+
+## Workspace documentation
+
+This README is the package-local distribution entry point. See [workspace documentation](../../../docs/README.md), [current conformance target](../../../docs/conformance/CURRENT_TARGET.md), [package catalog](../../../docs/developer/PACKAGE_CATALOG.md), [package layout](../../../docs/developer/PACKAGE_LAYOUT.md), and [SSOT registry](../../../.ssot/registry.json).

tigrbl_model-0.4.5/pyproject.toml

@@ -0,0 +1,45 @@
+[project]
+name = "tigrbl_model"
+version = "0.4.5"
+description = "Pydantic-independent validation, serialization, and JSON Schema models for Tigrbl."
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.10,<3.15"
+authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "pyyaml>=6.0",
+    "tomli-w>=1.0",
+    "tomli>=2.0.1; python_version < '3.11'",
+    "typing-extensions>=4.0; python_version < '3.11'",
+]
+
+[project.urls]
+Organization = "https://github.com/tigrbl"
+Repository = "https://github.com/tigrbl/tigrbl/tree/master/pkgs/02_model/tigrbl_model"
+Issues = "https://github.com/tigrbl/tigrbl/issues"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+packages = [{ include = "tigrbl_model" }]
+include = ["tigrbl_model/py.typed"]
+
+[dependency-groups]
+dev = [
+    "pydantic>=2.10,<3",
+    "pytest>=8.0",
+    "ruff>=0.9.9",
+]

tigrbl_model-0.4.5/tigrbl_model/__init__.py

@@ -0,0 +1,35 @@
+"""Pydantic-independent models for Tigrbl."""
+
+from .config import ConfigDict, ModelConfig
+from .errors import ErrorDetails, ModelUserError, ValidationError
+from .factory import create_model
+from .fields import AliasChoices, Field, FieldInfo, PydanticUndefined, Undefined
+from .mixins import JsonMixin, SerdeMixin, TomlMixin, YamlMixin
+from .model import BaseModel, Model
+from .root import RootModel
+from .validators import field_validator, model_validator
+
+__version__ = "0.4.5.dev4"
+
+__all__ = [
+    "AliasChoices",
+    "BaseModel",
+    "ConfigDict",
+    "ErrorDetails",
+    "Field",
+    "FieldInfo",
+    "JsonMixin",
+    "Model",
+    "ModelConfig",
+    "ModelUserError",
+    "PydanticUndefined",
+    "RootModel",
+    "SerdeMixin",
+    "TomlMixin",
+    "Undefined",
+    "ValidationError",
+    "YamlMixin",
+    "create_model",
+    "field_validator",
+    "model_validator",
+]

tigrbl_model-0.4.5/tigrbl_model/config.py

@@ -0,0 +1,36 @@
+"""Model configuration primitives."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class ConfigDict(dict[str, Any]):
+    """Dictionary configuration compatible with Tigrbl's Pydantic usage."""
+
+
+ModelConfig = ConfigDict
+
+
+DEFAULT_CONFIG = ConfigDict(
+    extra="ignore",
+    populate_by_name=False,
+    from_attributes=False,
+    arbitrary_types_allowed=False,
+    validate_default=False,
+    use_enum_values=False,
+    json_schema_extra=None,
+)
+
+
+def merge_config(*configs: dict[str, Any] | None) -> ConfigDict:
+    """Merge model configuration from oldest base to newest declaration."""
+
+    merged = ConfigDict(DEFAULT_CONFIG)
+    for config in configs:
+        if config:
+            merged.update(config)
+    return merged
+
+
+__all__ = ["ConfigDict", "ModelConfig"]

tigrbl_model-0.4.5/tigrbl_model/errors.py

@@ -0,0 +1,98 @@
+"""Structured model validation errors."""
+
+from __future__ import annotations
+
+import json
+from dataclasses import dataclass
+from typing import Any, Iterable
+
+
+@dataclass(frozen=True, slots=True)
+class ErrorDetails:
+    """One validation failure with a stable location and machine-readable type."""
+
+    type: str
+    loc: tuple[str | int, ...]
+    msg: str
+    input: Any = None
+    ctx: dict[str, Any] | None = None
+
+    def as_dict(self, *, include_url: bool = True) -> dict[str, Any]:
+        result: dict[str, Any] = {
+            "type": self.type,
+            "loc": self.loc,
+            "msg": self.msg,
+            "input": self.input,
+        }
+        if self.ctx:
+            result["ctx"] = dict(self.ctx)
+        if include_url:
+            result["url"] = f"https://errors.tigrbl.dev/model/{self.type}"
+        return result
+
+
+class ValidationError(ValueError):
+    """Aggregate validation failures for a model operation."""
+
+    def __init__(self, title: str, errors: Iterable[ErrorDetails | dict[str, Any]]):
+        self.title = title
+        self._errors = tuple(
+            error
+            if isinstance(error, ErrorDetails)
+            else ErrorDetails(
+                type=str(error.get("type", "value_error")),
+                loc=tuple(error.get("loc", ())),
+                msg=str(error.get("msg", "Invalid value")),
+                input=error.get("input"),
+                ctx=error.get("ctx"),
+            )
+            for error in errors
+        )
+        super().__init__(str(self))
+
+    @classmethod
+    def from_exception_data(
+        cls, title: str, line_errors: Iterable[dict[str, Any]]
+    ) -> "ValidationError":
+        return cls(title, line_errors)
+
+    def error_count(self) -> int:
+        return len(self._errors)
+
+    def errors(
+        self,
+        *,
+        include_url: bool = True,
+        include_context: bool = True,
+        include_input: bool = True,
+    ) -> list[dict[str, Any]]:
+        values = [error.as_dict(include_url=include_url) for error in self._errors]
+        for value in values:
+            if not include_context:
+                value.pop("ctx", None)
+            if not include_input:
+                value.pop("input", None)
+        return values
+
+    def json(self, *, indent: int | None = None, **_: Any) -> str:
+        return json.dumps(self.errors(), indent=indent, default=str)
+
+    def __str__(self) -> str:
+        count = len(self._errors)
+        heading = f"{count} validation error{'s' if count != 1 else ''} for {self.title}"
+        lines = [heading]
+        for error in self._errors:
+            location = ".".join(str(item) for item in error.loc) or "__root__"
+            lines.extend((location, f"  {error.msg} [type={error.type}]"))
+        return "\n".join(lines)
+
+
+class ModelUserError(TypeError):
+    """Raised when a declaration uses a removed or unsupported model option."""
+
+    def __init__(self, message: str, *, code: str = "model-user-error") -> None:
+        self.code = code
+        super().__init__(message)
+
+
+__all__ = ["ErrorDetails", "ModelUserError", "ValidationError"]

tigrbl_model-0.4.5/tigrbl_model/factory.py

@@ -0,0 +1,53 @@
+"""Dynamic model construction."""
+
+from __future__ import annotations
+
+import sys
+from typing import Any
+
+from .config import ConfigDict
+from .fields import FieldInfo, PydanticUndefined
+from .model import Model
+
+
+def create_model(
+    model_name: str,
+    *,
+    __config__: ConfigDict | dict[str, Any] | None = None,
+    __base__: type[Model] | tuple[type[Model], ...] | None = None,
+    __module__: str | None = None,
+    __validators__: dict[str, Any] | None = None,
+    __doc__: str | None = None,
+    **field_definitions: Any,
+) -> type[Model]:
+    """Create a model class from `(annotation, default)` field definitions."""
+
+    bases = __base__ or Model
+    if not isinstance(bases, tuple):
+        bases = (bases,)
+    annotations: dict[str, Any] = {}
+    namespace: dict[str, Any] = {
+        "__annotations__": annotations,
+        "__module__": __module__ or sys._getframe(1).f_globals.get("__name__", "__main__"),
+    }
+    if __doc__ is not None:
+        namespace["__doc__"] = __doc__
+    if __config__ is not None:
+        namespace["model_config"] = ConfigDict(__config__)
+    namespace.update(__validators__ or {})
+    for name, definition in field_definitions.items():
+        if isinstance(definition, tuple) and len(definition) == 2:
+            annotation, default = definition
+        else:
+            annotation, default = definition, PydanticUndefined
+        annotations[name] = annotation
+        if default is Ellipsis:
+            default = PydanticUndefined
+        if isinstance(default, FieldInfo):
+            namespace[name] = default
+        elif default is not PydanticUndefined:
+            namespace[name] = default
+    return type(model_name, bases, namespace)
+
+
+__all__ = ["create_model"]