pytypehint 1.2.1__tar.gz → 1.2.2__tar.gz

{pytypehint-1.2.1 → pytypehint-1.2.2}/CHANGELOG.md

@@ -1,11 +1,28 @@
 # Changelog
 
-## [1.2.1] — 2026-09-29
+## 1.2.2 - 2026-09-29
+
+### Changed
+
+- Documentation only: the README becomes a short entrance to the documentation
+  site at https://offerrall.github.io/pytypehint/, and `docs/overview.md` holds
+  the introduction.
+- Rename `docs/restrictions.md` to `docs/limits.md` ("Limits") and
+  `docs/philosophy.md` to `docs/design.md`. Merge
+  `docs/comparison.md` into Design and remove `docs/guarantees.md`, whose points
+  each live on their own page.
+- Add `[project.urls]` (documentation, repository, changelog) and Python
+  classifiers to the package metadata.
+- Fix the 1.1.0 release date in this changelog and date every entry.
+
+The code is the same as 1.2.1.
+
+## 1.2.1 - 2026-09-29
 
 - Documentation only: the README title no longer carries the version, and the
   1.2.0 entry below has its release date. The code is the same as 1.2.0.
 
-## [1.2.0] — 2026-09-20
+## 1.2.0 - 2026-09-20
 
 - Add `@immutable`: deeply immutable, slotted, keyword-only dataclasses with
   automatic validation on construction and `dataclasses.replace`.
@@ -18,7 +35,7 @@
 - Keep the implementation in `immutable.py`; existing schema operations retain
   their behavior. Add examples and the immutable model contract.
 
-## [1.1.0] — 2026-20-09
+## 1.1.0 - 2026-09-20
 
 - Add fixed tuples (`tuple[X, Y]`), variadic tuples (`tuple[X, ...]`) and empty
   tuples (`tuple[()]`), including nested types, unions and per-position atoms.
@@ -31,7 +48,7 @@
   `v: 1`; consumers need tuple support to read the new shape type.
 - Shorten the README and move detailed guarantees and API reference into docs.
 
-## [1.0.0] - 2026-08-10
+## 1.0.0 - 2026-08-10
 
 The core now owns the portable form of its own types. Until this release a
 compiled schema could only be read as Python objects, in the process that
@@ -98,7 +115,7 @@ then what validation and its errors guarantee.
   `date`, or one named `list[str]` beside a `list[str]` now fail at compilation
   with `Field 'x': duplicate discriminator name(s): str`. Each such pair left two
   options answering to one `$type`, with one of them unreachable — the rule
-  [restrictions.md](docs/restrictions.md) already stated, now enforced where the
+  [limits.md](docs/limits.md) already stated, now enforced where the
   implementation had only covered options sharing a runtime type. A dataclass and
   an enum of the same class name use different discriminators and remain
   admissible.
@@ -331,7 +348,7 @@ then what validation and its errors guarantee.
   while filling does not; `restrictions.md` documents the discriminator-name rule
   and the union options a portable tree cannot spell bare.
 
-## [0.0.7]
+## 0.0.7 - 2026-07-26
 
 - Breaking: `IsPathFile` now guarantees that the string names a real file at the
   moment of validation, not merely that its text ends in an accepted suffix. A
@@ -376,7 +393,7 @@ then what validation and its errors guarantee.
   exclusive to `Str`: no new shape, no `PathFile` type, and no compatibility
   switch (`exists=False`, `strict=False`) — the semantics are single and explicit.
 
-## [0.0.6]
+## 0.0.6 - 2026-07-24
 
 - Breaking: `datetime.time` values with non-zero microseconds are no longer
   accepted. Time precision is limited to whole seconds, so the effective range
@@ -393,7 +410,7 @@ then what validation and its errors guarantee.
   `exclusive bound at ... leaves no valid time`. A bound at `time.max` is instead
   rejected as sub-second precision.
 
-## [0.0.5]
+## 0.0.5 - 2026-07-23
 
 - Compilation now rejects a union of two enums that share a class name, e.g.
   two Enum classes both named `Color`, with `Field '<name>': duplicate
@@ -405,7 +422,7 @@ then what validation and its errors guarantee.
   a dataclass of the same name never collide and stay admissible. Previously the
   core admitted the pair and only a wrapper could catch it.
 
-## [0.0.4]
+## 0.0.4 - 2026-07-22
 
 - Enum fields now accept `Extra`, the same namespaced wrapper-notation channel
   the other leaf shapes already carry. `EnumShape` gains `_extras` and a
@@ -430,7 +447,7 @@ then what validation and its errors guarantee.
   degraded the whole line into the leaf and rendered `Field 'x': default <leaf>`.
   Only the message and its structure changed; no behaviour did.
 
-## [0.0.3]
+## 0.0.3 - 2026-07-20
 
 - Unions whose options share one runtime input type now compile. `list[str] |
   list[int]` was rejected as a duplicate; both options are valid Python and
@@ -453,13 +470,13 @@ then what validation and its errors guarantee.
 - No breaking change: every hint accepted by 0.0.2 compiles and behaves as
   before.
 
-## [0.0.2]
+## 0.0.2 - 2026-07-17
 
 - `Extra(value)` becomes `Extra(key, value)`, with a namespaced key
   (`"package.name"`) and any string value, empty included.
 - Shapes replace `extra` with `extras`, a read-only `dict[str, str]` merged from
   every `Extra` atom on the hint. Keys layer independently: the outer atom wins.
 
-## [0.0.1] - 2026-07-15
+## 0.0.1 - 2026-07-15
 
 - Initial release.

pytypehint-1.2.2/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.5
+Name: pytypehint
+Version: 1.2.2
+Summary: Compiles Python type hints into strict, inspectable, portable contracts
+Project-URL: Documentation, https://offerrall.github.io/pytypehint/
+Project-URL: Repository, https://github.com/offerrall/pytypehint
+Project-URL: Changelog, https://github.com/offerrall/pytypehint/blob/master/CHANGELOG.md
+Author: Beltrán Offerrall
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: hypothesis; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pytypehint
+
+Define data once with ordinary Python type hints and dataclasses. pytypehint
+compiles them into strict schemas that validate input with exact types and no
+implicit coercion, build nested dataclasses, and export a portable description
+another process can read.
+
+Use `@immutable` for deeply immutable models that validate themselves and reuse
+already validated children. pytypehint is the schema and validation core of
+[func-to-web](https://offerrall.github.io/func-to-web/).
+
+```python
+from dataclasses import dataclass
+from typing import Annotated
+from pytypehint import Min, struct_of
+
+@dataclass
+class Item:
+    name: str
+    quantity: Annotated[int, Min(1)] = 1
+
+schema = struct_of(Item)
+item = schema.build({"name": "Pen"})          # Item(name='Pen', quantity=1)
+schema.build({"name": "Pen", "quantity": 0})  # SchemaValueError: quantity
+```
+
+The full documentation is at https://offerrall.github.io/pytypehint/.
+
+## Documentation
+
+- [Overview](docs/overview.md): immutable models, portable data, field metadata and the four operations.
+- [Immutable models](docs/immutable.md): the `@immutable` contract, allowed fields, reuse and Python behavior.
+- [Types and API](docs/vocabulary.md): which hints compile to which shapes, and the public API.
+- [Atoms](docs/atoms.md): constraints and notation per shape, file names, layering and extras.
+- [Build](docs/build.md): validating and constructing instances or keyword arguments, union selection and errors.
+- [Resolve](docs/resolve.md): validated dictionaries with defaults filled at the current level.
+- [Decode](docs/decode.md): restoring portable values such as dates, enums and tuples before validation.
+- [Tuples](docs/tuples.md): fixed, variadic and empty tuples and the `Tuple` shape.
+- [Defaults](docs/defaults.md): certification and rematerialization of default values.
+- [Portable contract](docs/contract.md): the JSON-compatible schema document returned by `to_dict()`.
+- [Limits](docs/limits.md): rejected definitions, option identity and runtime limits.
+- [Design](docs/design.md): what the core owns, what consumers own, and why.

pytypehint-1.2.2/README.md

@@ -0,0 +1,42 @@
+# pytypehint
+
+Define data once with ordinary Python type hints and dataclasses. pytypehint
+compiles them into strict schemas that validate input with exact types and no
+implicit coercion, build nested dataclasses, and export a portable description
+another process can read.
+
+Use `@immutable` for deeply immutable models that validate themselves and reuse
+already validated children. pytypehint is the schema and validation core of
+[func-to-web](https://offerrall.github.io/func-to-web/).
+
+```python
+from dataclasses import dataclass
+from typing import Annotated
+from pytypehint import Min, struct_of
+
+@dataclass
+class Item:
+    name: str
+    quantity: Annotated[int, Min(1)] = 1
+
+schema = struct_of(Item)
+item = schema.build({"name": "Pen"})          # Item(name='Pen', quantity=1)
+schema.build({"name": "Pen", "quantity": 0})  # SchemaValueError: quantity
+```
+
+The full documentation is at https://offerrall.github.io/pytypehint/.
+
+## Documentation
+
+- [Overview](docs/overview.md): immutable models, portable data, field metadata and the four operations.
+- [Immutable models](docs/immutable.md): the `@immutable` contract, allowed fields, reuse and Python behavior.
+- [Types and API](docs/vocabulary.md): which hints compile to which shapes, and the public API.
+- [Atoms](docs/atoms.md): constraints and notation per shape, file names, layering and extras.
+- [Build](docs/build.md): validating and constructing instances or keyword arguments, union selection and errors.
+- [Resolve](docs/resolve.md): validated dictionaries with defaults filled at the current level.
+- [Decode](docs/decode.md): restoring portable values such as dates, enums and tuples before validation.
+- [Tuples](docs/tuples.md): fixed, variadic and empty tuples and the `Tuple` shape.
+- [Defaults](docs/defaults.md): certification and rematerialization of default values.
+- [Portable contract](docs/contract.md): the JSON-compatible schema document returned by `to_dict()`.
+- [Limits](docs/limits.md): rejected definitions, option identity and runtime limits.
+- [Design](docs/design.md): what the core owns, what consumers own, and why.

{pytypehint-1.2.1 → pytypehint-1.2.2}/docs/build.md

@@ -42,7 +42,7 @@ Dataclass discriminators use the class name. Other wrappers use
 Discriminators are accepted only where needed, including inside sequence items.
 A lone dataclass rejects `$type` as an unexpected key. When dataclass and wrapped
 options coexist, `$value` distinguishes the wrapper from a dataclass dictionary.
-See [option identities](restrictions.md#option-identity).
+See [option identities](limits.md#option-identity).
 
 `resolve` preserves validated discriminators; `build` removes them while
 constructing the selected values. Defaults are Python values and need no wrapper.

{pytypehint-1.2.1 → pytypehint-1.2.2}/docs/contract.md

@@ -37,8 +37,8 @@ used in data discriminators; consumers must not substitute the definition ID.
 
 `v` versions the format, not the library. Removing a key or changing its meaning
 raises `v`; additive keys do not. Ignore unknown keys and reject unsupported shape
-types. Tuple nodes were added in library 1.1.0 while retaining format version 1;
-consumers need tuple support to read them.
+types. Format version 1 includes `tuple` nodes; consumers need tuple support to
+read them.
 
 ## Fields and nodes
 
@@ -51,7 +51,7 @@ There are no `optional`, `required` or `nullable` keys: inspect `default` and
 Each node has `type`. In a slot containing several options, each also has `id`,
 its `Shape.option_id()`. IDs are unique within the dataclass namespace and within
 the other-option namespace, not across both. Preserve option positions; use IDs
-for discriminators. See [option identities](restrictions.md#option-identity).
+for discriminators. See [option identities](limits.md#option-identity).
 
 | `type` | Additional keys when applicable |
 |---|---|

pytypehint-1.2.1/docs/philosophy.md → pytypehint-1.2.2/docs/design.md

@@ -5,7 +5,17 @@ into inspectable shapes, validate exact values, and construct ordinary objects.
 
 The core owns types, constraints, defaults and their portable representation.
 Consumers own input coercion, presentation, JSON text, function invocation and
-checks requiring files, networks or application state.
+checks requiring files, networks or application state:
+
+| Task | Responsible layer |
+|---|---|
+| Define ordinary models | Python dataclasses and type hints |
+| Inspect/export schemas, validate values, restore portable types, construct models | pytypehint |
+| Parse JSON, coerce form/CLI input, render controls, collect multiple errors | Consumer |
+| Call functions, check files, manage persistence/authentication | Application |
+
+Direct dataclass construction is simpler for trusted internal objects. Use
+pytypehint when you need strict input validation or a shared inspectable contract.
 
 Keep union selection explicit when types or portable spellings collide. Keep
 missing values separate from `None`. Report the first error with its path.

pytypehint-1.2.1/docs/restrictions.md → pytypehint-1.2.2/docs/limits.md

@@ -1,4 +1,4 @@
-# Restrictions
+# Limits
 
 Only the [documented types](vocabulary.md) and [atoms](atoms.md) are supported.
 Unsupported hints and invalid schemas fail during compilation.
@@ -25,7 +25,9 @@ def search(query: str):
 ```
 
 `datetime`, path objects, mappings, sets and arbitrary classes are outside the
-vocabulary. Use dataclasses to represent additional structure or policy.
+vocabulary. Represent timestamp policy and other structure with a dataclass, and
+file names with a `str` annotated with [`FileHint`](atoms.md#file-names), which
+checks the suffix only.
 
 ## Option identity
 
@@ -66,8 +68,7 @@ contents never choose the variant.
 - Validation stops at the first error. Constructor exceptions propagate unchanged.
 - Cycles and excessive nesting may raise raw `RecursionError` in decode, resolve
   or build. Recursive schemas are supported; cyclic input values are not.
-- Factories must be pure, and input must not change during construction.
-
-`FileHint` checks the string's suffix only; existence, kind and size require
-consumer checks. Portable spelling collisions need [decode wrappers](decode.md#unions),
-even when their restored Python types would be distinct.
+- [Default recipes](defaults.md) must be pure, and input must not change during
+  construction.
+- Portable spelling collisions need [decode wrappers](decode.md#unions), even
+  when their restored Python types would be distinct.

pytypehint-1.2.2/docs/overview.md

@@ -0,0 +1,105 @@
+# Overview
+
+pytypehint turns a dataclass or a function signature into a compiled schema:
+`struct_of(Item)` returns a `Struct`, `signature_of(fn)` a `Signature`. Compile
+once and reuse. Validation is exact: `float` rejects `int`, `int` rejects `bool`,
+and nothing is coerced. The first error raises `SchemaTypeError` or
+`SchemaValueError` with the failing field or index in its `path`.
+
+## Immutable models
+
+Declare constraints once. Normal construction and `dataclasses.replace` validate
+automatically; nested instances keep their identity.
+
+```python
+from dataclasses import replace
+from typing import Annotated
+from pytypehint import Max, Min, immutable
+
+Positive = Annotated[int, Min(1)]
+Channel = Annotated[float, Min(0.0), Max(1.0)]
+
+@immutable
+class Exposure:
+    stops: float = 0.0
+
+@immutable
+class Grayscale:
+    pass
+
+@immutable
+class Layer:
+    name: Annotated[str, Min(1)]
+    effect: Exposure | Grayscale
+    color: tuple[Channel, Channel, Channel, Channel] = (0.0, 0.0, 0.0, 1.0)
+
+@immutable
+class Document:
+    size: tuple[Positive, Positive]
+    layers: tuple[Layer, ...] = ()
+
+photo = Layer(name="Photo", effect=Exposure(stops=1.5))
+original = Document(size=(1920, 1080), layers=(photo,))
+resized = replace(original, size=(3840, 2160))
+
+assert resized.layers[0] is photo
+assert original.size == (1920, 1080)
+```
+
+The new document checks its size and layer references, without revisiting the
+existing layer's fields. Tuples are checked; existing immutable children are reused.
+
+```python
+replace(photo, color=(1.0, 0.0, 0.0, 2.0))  # SchemaValueError, path: ('color', 3)
+Exposure(stops="1.5")                       # SchemaTypeError
+original.size = (800, 600)                  # FrozenInstanceError
+```
+
+Fields are restricted to immutable scalars, tuples and other `@immutable` models;
+see [Immutable models](immutable.md) for the full contract, inheritance and defaults.
+
+## Portable data and inspection
+
+The same models work with the schema API. `decode` restores portable values such
+as JSON arrays and discriminated unions, and `to_dict` describes the schema for a
+UI or another process:
+
+```python
+from pytypehint import struct_of
+
+schema = struct_of(Document)
+loaded = schema.build(schema.decode({
+    "size": [1920, 1080],
+    "layers": [{
+        "name": "Photo",
+        "effect": {"$type": "Exposure", "stops": 1.5},
+    }],
+}))
+
+assert loaded == original
+contract = schema.to_dict()  # Portable description for a UI or another process
+```
+
+Type constraints and interface metadata live on the same field:
+
+```python
+from pytypehint import Label, Slider, Step
+
+@immutable
+class Brush:
+    size: Annotated[int, Min(1), Max(256), Label("Brush size"), Step(1), Slider()] = 32
+
+size_field, = struct_of(Brush).fields
+size_shape, = size_field.shape
+assert size_field.label.value == "Brush size"
+assert size_shape.max.value == 256
+```
+
+## The four operations
+
+| Method | Result |
+|---|---|
+| [`build(data)`](build.md) | Dataclass instance; `signature_of(fn)` returns kwargs for `fn(**kwargs)` |
+| [`resolve(data)`](resolve.md) | Validated dictionary with missing defaults filled at this level |
+| [`decode(data)`](decode.md) | Portable values restored to Python types |
+| [`to_dict()`](contract.md) | Portable schema description |

{pytypehint-1.2.1 → pytypehint-1.2.2}/docs/vocabulary.md

@@ -32,10 +32,7 @@ either: list[str] | list[int]  # needs {"$type": "list[str]", "$value": ["a"]}
 Union options retain declaration order. Put type constraints on the option:
 `Annotated[int, Min(0)] | str`. Field notation such as `Label` belongs on the
 outer field. See [atoms](atoms.md), [tuples](tuples.md) and
-[restrictions](restrictions.md).
-
-There is no `datetime` or path shape. Represent timestamp policy with a dataclass;
-use a `str` annotated with `FileHint` for file names.
+[limits](limits.md).
 
 ## Public API
 
@@ -51,10 +48,11 @@ Everything public is exported from `pytypehint`:
   `Extra`, `OptionalToggle`;
 - `MISSING`.
 
-`Struct` and `Signature` expose `.build(data)`, `.resolve(data)`, `.decode(data)`
-and `.to_dict()`. `Struct.fields` and `Signature.params` contain `Field` objects;
-`Field.shape` contains the available shapes, and `Field.default` is `MISSING`
-when no default exists. `Shape.option_id()` gives the discriminator identity.
+`Struct` and `Signature` expose the [four operations](overview.md#the-four-operations):
+`.build(data)`, `.resolve(data)`, `.decode(data)` and `.to_dict()`.
+`Struct.fields` and `Signature.params` contain `Field` objects; `Field.shape`
+contains the available shapes, and `Field.default` is `MISSING` when no default
+exists. `Shape.option_id()` gives the discriminator identity.
 `Struct`, `Field` and `Signature` compare by identity; compile once and reuse.
 
 `@immutable` creates deeply immutable, automatically validated dataclasses with a

{pytypehint-1.2.1 → pytypehint-1.2.2}/pyproject.toml

@@ -12,6 +12,20 @@ license = "MIT"
 license-files = ["LICENSE"]
 authors = [{ name = "Beltrán Offerrall" }]
 dependencies = []
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+]
+
+[project.urls]
+Documentation = "https://offerrall.github.io/pytypehint/"
+Repository = "https://github.com/offerrall/pytypehint"
+Changelog = "https://github.com/offerrall/pytypehint/blob/master/CHANGELOG.md"
 
 [project.optional-dependencies]
 dev = ["mypy", "pytest", "hypothesis"]

{pytypehint-1.2.1 → pytypehint-1.2.2}/src/pytypehint/__init__.py

@@ -13,7 +13,7 @@ from pytypehint.shapes import (
 )
 from pytypehint.utils import MISSING
 
-__version__ = "1.2.1"
+__version__ = "1.2.2"
 
 __all__ = [
     "immutable",

{pytypehint-1.2.1 → pytypehint-1.2.2}/tests/test_hardening_a.py

@@ -505,7 +505,7 @@ def test_no_module_level_name_escapes_all_by_accident():
 
 
 def test_the_version_is_the_one_this_release_claims():
-    assert pytypehint.__version__ == "1.2.1"
+    assert pytypehint.__version__ == "1.2.2"
     assert "__version__" not in pytypehint.__all__
 
 

pytypehint-1.2.1/PKG-INFO

@@ -1,162 +0,0 @@
-Metadata-Version: 2.5
-Name: pytypehint
-Version: 1.2.1
-Summary: Compiles Python type hints into strict, inspectable, portable contracts
-Author: Beltrán Offerrall
-License-Expression: MIT
-License-File: LICENSE
-Requires-Python: >=3.11
-Provides-Extra: dev
-Requires-Dist: hypothesis; extra == 'dev'
-Requires-Dist: mypy; extra == 'dev'
-Requires-Dist: pytest; extra == 'dev'
-Description-Content-Type: text/markdown
-
-# pytypehint
-
-[![PyPI](https://img.shields.io/pypi/v/pytypehint.svg)](https://pypi.org/project/pytypehint/)
-
-Define data with Python type hints. Validate input, build nested dataclasses,
-inspect their fields or export a portable schema.
-
-Use **`@immutable`** for deeply immutable models that validate themselves and
-reuse validated children without checking their contents again.
-
-Exact types, no implicit coercion. Python 3.11+, standard library only.
-The schema and validation core of [FuncToWeb](https://github.com/offerrall/FuncToWeb).
-
-```bash
-pip install pytypehint
-```
-
-## Validate input into ordinary dataclasses
-
-```python
-from dataclasses import dataclass
-from typing import Annotated
-from pytypehint import Min, struct_of
-
-@dataclass
-class Item:
-    name: str
-    quantity: Annotated[int, Min(1)] = 1
-
-schema = struct_of(Item)
-item = schema.build({"name": "Pen"})  # Item(name='Pen', quantity=1)
-schema.build({"name": "Pen", "quantity": 0})  # SchemaValueError: quantity
-```
-
-Compile once and reuse. Errors include the failing field or index in their `path`.
-
-## Immutable models
-
-Declare constraints once. Normal construction and `dataclasses.replace` validate
-automatically; nested instances keep their identity.
-
-```python
-from dataclasses import replace
-from typing import Annotated
-from pytypehint import Max, Min, immutable
-
-Positive = Annotated[int, Min(1)]
-Channel = Annotated[float, Min(0.0), Max(1.0)]
-
-@immutable
-class Exposure:
-    stops: float = 0.0
-
-@immutable
-class Grayscale:
-    pass
-
-@immutable
-class Layer:
-    name: Annotated[str, Min(1)]
-    effect: Exposure | Grayscale
-    color: tuple[Channel, Channel, Channel, Channel] = (0.0, 0.0, 0.0, 1.0)
-
-@immutable
-class Document:
-    size: tuple[Positive, Positive]
-    layers: tuple[Layer, ...] = ()
-
-photo = Layer(name="Photo", effect=Exposure(stops=1.5))
-original = Document(size=(1920, 1080), layers=(photo,))
-resized = replace(original, size=(3840, 2160))
-
-assert resized.layers[0] is photo
-assert original.size == (1920, 1080)
-```
-
-The new document checks its size and layer references, without revisiting the
-existing layer's fields. Tuples are checked; existing immutable children are reused.
-
-```python
-replace(photo, color=(1.0, 0.0, 0.0, 2.0))  # SchemaValueError, path: ('color', 3)
-Exposure(stops="1.5")                      # SchemaTypeError
-original.size = (800, 600)                  # FrozenInstanceError
-```
-
-Allowed fields are immutable scalars, tuples and other `@immutable` models.
-Mutable containers, ordinary dataclasses and enums are rejected. The guarantee
-covers declared fields through normal Python use; deliberate low-level mutation
-can bypass it. [Full contract, inheritance and defaults](docs/immutable.md).
-
-## Load portable data and inspect the same definition
-
-The models above also work with the existing schema API:
-
-```python
-from pytypehint import struct_of
-
-schema = struct_of(Document)
-loaded = schema.build(schema.decode({
-    "size": [1920, 1080],
-    "layers": [{
-        "name": "Photo",
-        "effect": {"$type": "Exposure", "stops": 1.5},
-    }],
-}))
-
-assert loaded == original
-contract = schema.to_dict()  # Portable description for a UI or another process
-```
-
-Type constraints and interface metadata live on the same field:
-
-```python
-from pytypehint import Label, Slider, Step
-
-@immutable
-class Brush:
-    size: Annotated[int, Min(1), Max(256), Label("Brush size"), Step(1), Slider()] = 32
-
-size_field, = struct_of(Brush).fields
-size_shape, = size_field.shape
-assert size_field.label.value == "Brush size"
-assert size_shape.max.value == 256
-```
-
-| Method | Result |
-|---|---|
-| `build(data)` | Dataclass instance; `signature_of(fn)` returns kwargs for `fn(**kwargs)` |
-| `resolve(data)` | Validated dictionary with missing defaults filled at this level |
-| `decode(data)` | Portable values restored to Python types |
-| `to_dict()` | Portable schema description |
-
-## Documentation
-
-- [Immutable models](docs/immutable.md)
-- [Types and API](docs/vocabulary.md)
-- [Atoms](docs/atoms.md)
-- [Build](docs/build.md)
-- [Resolve](docs/resolve.md)
-- [Decode](docs/decode.md)
-- [Tuples](docs/tuples.md)
-- [Defaults](docs/defaults.md)
-- [Portable contract](docs/contract.md)
-- [Restrictions](docs/restrictions.md)
-- [Guarantees](docs/guarantees.md)
-- [Design](docs/philosophy.md)
-- [Comparison](docs/comparison.md)
-- [Changelog](CHANGELOG.md)

pytypehint-1.2.1/README.md

@@ -1,148 +0,0 @@
-# pytypehint
-
-[![PyPI](https://img.shields.io/pypi/v/pytypehint.svg)](https://pypi.org/project/pytypehint/)
-
-Define data with Python type hints. Validate input, build nested dataclasses,
-inspect their fields or export a portable schema.
-
-Use **`@immutable`** for deeply immutable models that validate themselves and
-reuse validated children without checking their contents again.
-
-Exact types, no implicit coercion. Python 3.11+, standard library only.
-The schema and validation core of [FuncToWeb](https://github.com/offerrall/FuncToWeb).
-
-```bash
-pip install pytypehint
-```
-
-## Validate input into ordinary dataclasses
-
-```python
-from dataclasses import dataclass
-from typing import Annotated
-from pytypehint import Min, struct_of
-
-@dataclass
-class Item:
-    name: str
-    quantity: Annotated[int, Min(1)] = 1
-
-schema = struct_of(Item)
-item = schema.build({"name": "Pen"})  # Item(name='Pen', quantity=1)
-schema.build({"name": "Pen", "quantity": 0})  # SchemaValueError: quantity
-```
-
-Compile once and reuse. Errors include the failing field or index in their `path`.
-
-## Immutable models
-
-Declare constraints once. Normal construction and `dataclasses.replace` validate
-automatically; nested instances keep their identity.
-
-```python
-from dataclasses import replace
-from typing import Annotated
-from pytypehint import Max, Min, immutable
-
-Positive = Annotated[int, Min(1)]
-Channel = Annotated[float, Min(0.0), Max(1.0)]
-
-@immutable
-class Exposure:
-    stops: float = 0.0
-
-@immutable
-class Grayscale:
-    pass
-
-@immutable
-class Layer:
-    name: Annotated[str, Min(1)]
-    effect: Exposure | Grayscale
-    color: tuple[Channel, Channel, Channel, Channel] = (0.0, 0.0, 0.0, 1.0)
-
-@immutable
-class Document:
-    size: tuple[Positive, Positive]
-    layers: tuple[Layer, ...] = ()
-
-photo = Layer(name="Photo", effect=Exposure(stops=1.5))
-original = Document(size=(1920, 1080), layers=(photo,))
-resized = replace(original, size=(3840, 2160))
-
-assert resized.layers[0] is photo
-assert original.size == (1920, 1080)
-```
-
-The new document checks its size and layer references, without revisiting the
-existing layer's fields. Tuples are checked; existing immutable children are reused.
-
-```python
-replace(photo, color=(1.0, 0.0, 0.0, 2.0))  # SchemaValueError, path: ('color', 3)
-Exposure(stops="1.5")                      # SchemaTypeError
-original.size = (800, 600)                  # FrozenInstanceError
-```
-
-Allowed fields are immutable scalars, tuples and other `@immutable` models.
-Mutable containers, ordinary dataclasses and enums are rejected. The guarantee
-covers declared fields through normal Python use; deliberate low-level mutation
-can bypass it. [Full contract, inheritance and defaults](docs/immutable.md).
-
-## Load portable data and inspect the same definition
-
-The models above also work with the existing schema API:
-
-```python
-from pytypehint import struct_of
-
-schema = struct_of(Document)
-loaded = schema.build(schema.decode({
-    "size": [1920, 1080],
-    "layers": [{
-        "name": "Photo",
-        "effect": {"$type": "Exposure", "stops": 1.5},
-    }],
-}))
-
-assert loaded == original
-contract = schema.to_dict()  # Portable description for a UI or another process
-```
-
-Type constraints and interface metadata live on the same field:
-
-```python
-from pytypehint import Label, Slider, Step
-
-@immutable
-class Brush:
-    size: Annotated[int, Min(1), Max(256), Label("Brush size"), Step(1), Slider()] = 32
-
-size_field, = struct_of(Brush).fields
-size_shape, = size_field.shape
-assert size_field.label.value == "Brush size"
-assert size_shape.max.value == 256
-```
-
-| Method | Result |
-|---|---|
-| `build(data)` | Dataclass instance; `signature_of(fn)` returns kwargs for `fn(**kwargs)` |
-| `resolve(data)` | Validated dictionary with missing defaults filled at this level |
-| `decode(data)` | Portable values restored to Python types |
-| `to_dict()` | Portable schema description |
-
-## Documentation
-
-- [Immutable models](docs/immutable.md)
-- [Types and API](docs/vocabulary.md)
-- [Atoms](docs/atoms.md)
-- [Build](docs/build.md)
-- [Resolve](docs/resolve.md)
-- [Decode](docs/decode.md)
-- [Tuples](docs/tuples.md)
-- [Defaults](docs/defaults.md)
-- [Portable contract](docs/contract.md)
-- [Restrictions](docs/restrictions.md)
-- [Guarantees](docs/guarantees.md)
-- [Design](docs/philosophy.md)
-- [Comparison](docs/comparison.md)
-- [Changelog](CHANGELOG.md)

pytypehint-1.2.1/docs/comparison.md

@@ -1,18 +0,0 @@
-# Scope and ecosystem
-
-| Task | Responsible layer |
-|---|---|
-| Define ordinary models | Python dataclasses and type hints |
-| Inspect/export schemas, validate values, restore portable types, construct models | pytypehint |
-| Parse JSON, coerce form/CLI input, render controls, collect multiple errors | Consumer |
-| Call functions, check files, manage persistence/authentication | Application |
-
-Direct dataclass construction is simpler for trusted internal objects. Use
-pytypehint when you need strict input validation or a shared inspectable contract.
-Compile once and reuse schemas.
-
-Optional consumers, maintained separately:
-
-- [pytypehintweb](https://github.com/offerrall/pytypehintweb): browser forms.
-- [FuncToWeb](https://github.com/offerrall/FuncToWeb): web interfaces for functions.
-- [pytypehintstore](https://github.com/offerrall/pytypehintstore): validated storage.

pytypehint-1.2.1/docs/guarantees.md

@@ -1,24 +0,0 @@
-# Guarantees
-
-- Exact validation, with explicit selection for ambiguous unions; no guessing
-  from contents or implicit coercion. See [build](build.md).
-- The first schema error includes its full field/index path in both its message
-  and `path`, with the reason in `leaf`.
-- Defaults are certified at compilation and validated at every missing-key
-  serving. Reconstructed contents are fresh; factories must honor the author's
-  [purity requirements](defaults.md).
-- `resolve` validates recursively, preserves supplied values by reference and
-  fills defaults only at the current level. `build` constructs nested instances.
-- `decode` does not mutate input, fill defaults or discard unknown keys. It
-  rebuilds traversed plain containers; actual tuples and subclasses pass through.
-- `to_dict()` returns a fresh tree with deterministic ordering. Deterministic
-  defaults and matching interpreter configuration are required for equal output.
-- The core's checks depend on the schema and value. File access and other external
-  checks belong to the consumer; user factories and constructors remain user code.
-- `Signature.build` prepares kwargs and never calls the function.
-
-`@immutable` additionally validates construction and restricts fields to deeply
-immutable values, allowing already validated children to be reused without
-traversing them again. See [its contract and limits](immutable.md).
-
-For accepted definitions and runtime limits, see [restrictions](restrictions.md).