pytypehint 1.2.2__tar.gz → 1.2.3__tar.gz

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

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.2.3 - 2026-09-29
+
+### Changed
+
+- Documentation only: the README's Documentation list links each page on the
+  documentation site, so readers on GitHub and PyPI land there. The code is the same as 1.2.2.
+
 ## 1.2.2 - 2026-09-29
 
 ### Changed

{pytypehint-1.2.2 → pytypehint-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pytypehint
-Version: 1.2.2
+Version: 1.2.3
 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
@@ -52,15 +52,15 @@ 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.
+- [Overview](https://offerrall.github.io/pytypehint/): immutable models, portable data, field metadata and the four operations.
+- [Immutable models](https://offerrall.github.io/pytypehint/immutable/): the `@immutable` contract, allowed fields, reuse and Python behavior.
+- [Types and API](https://offerrall.github.io/pytypehint/vocabulary/): which hints compile to which shapes, and the public API.
+- [Atoms](https://offerrall.github.io/pytypehint/atoms/): constraints and notation per shape, file names, layering and extras.
+- [Build](https://offerrall.github.io/pytypehint/build/): validating and constructing instances or keyword arguments, union selection and errors.
+- [Resolve](https://offerrall.github.io/pytypehint/resolve/): validated dictionaries with defaults filled at the current level.
+- [Decode](https://offerrall.github.io/pytypehint/decode/): restoring portable values such as dates, enums and tuples before validation.
+- [Tuples](https://offerrall.github.io/pytypehint/tuples/): fixed, variadic and empty tuples and the `Tuple` shape.
+- [Defaults](https://offerrall.github.io/pytypehint/defaults/): certification and rematerialization of default values.
+- [Portable contract](https://offerrall.github.io/pytypehint/contract/): the JSON-compatible schema document returned by `to_dict()`.
+- [Limits](https://offerrall.github.io/pytypehint/limits/): rejected definitions, option identity and runtime limits.
+- [Design](https://offerrall.github.io/pytypehint/design/): what the core owns, what consumers own, and why.

pytypehint-1.2.3/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](https://offerrall.github.io/pytypehint/): immutable models, portable data, field metadata and the four operations.
+- [Immutable models](https://offerrall.github.io/pytypehint/immutable/): the `@immutable` contract, allowed fields, reuse and Python behavior.
+- [Types and API](https://offerrall.github.io/pytypehint/vocabulary/): which hints compile to which shapes, and the public API.
+- [Atoms](https://offerrall.github.io/pytypehint/atoms/): constraints and notation per shape, file names, layering and extras.
+- [Build](https://offerrall.github.io/pytypehint/build/): validating and constructing instances or keyword arguments, union selection and errors.
+- [Resolve](https://offerrall.github.io/pytypehint/resolve/): validated dictionaries with defaults filled at the current level.
+- [Decode](https://offerrall.github.io/pytypehint/decode/): restoring portable values such as dates, enums and tuples before validation.
+- [Tuples](https://offerrall.github.io/pytypehint/tuples/): fixed, variadic and empty tuples and the `Tuple` shape.
+- [Defaults](https://offerrall.github.io/pytypehint/defaults/): certification and rematerialization of default values.
+- [Portable contract](https://offerrall.github.io/pytypehint/contract/): the JSON-compatible schema document returned by `to_dict()`.
+- [Limits](https://offerrall.github.io/pytypehint/limits/): rejected definitions, option identity and runtime limits.
+- [Design](https://offerrall.github.io/pytypehint/design/): what the core owns, what consumers own, and why.

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

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

{pytypehint-1.2.2 → pytypehint-1.2.3}/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.2"
+    assert pytypehint.__version__ == "1.2.3"
     assert "__version__" not in pytypehint.__all__
 
 

pytypehint-1.2.2/README.md

@@ -1,42 +0,0 @@
-# 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.