lean-python 0.1.0__tar.gz

lean_python-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+/result
+/.lake/
+/test-out/
+/.claude-dev/
+**/.lean-python/
+__pycache__/
+/.venv/
+/dist/

lean_python-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://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.

lean_python-0.1.0/PKG-INFO

@@ -0,0 +1,231 @@
+Metadata-Version: 2.5
+Name: lean-python
+Version: 0.1.0
+Summary: Run Lean 4 code as Python: a runtime for code generated from Lean's IR, Lean blocks in Python files, and pydantic models for Lean types
+Project-URL: Repository, https://github.com/conao3/lean-py
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Framework :: Pydantic :: 2
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Compilers
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.11
+Description-Content-Type: text/markdown
+
+# lean-py
+
+Write and prove functions in Lean 4, run them as Python, and pass pydantic models across.
+
+```python
+from pydantic import BaseModel, Field
+from lean_python import lean
+
+
+class LineItem(BaseModel):
+    sku: str
+    qty: int = Field(ge=1)
+    unitPrice: int = Field(ge=0)
+
+
+pricing = lean("pricing", r"""
+inductive Discount where
+  | none
+  | percent (p : Nat) (h : p ≤ 100)
+  | fixed (amount : Nat)
+
+def subtotal (items : List LineItem) : Nat :=
+  items.foldl (fun acc i => acc + i.qty * i.unitPrice) 0
+
+def total (items : List LineItem) (d : Discount) : Nat :=
+  match d with
+  | .none => subtotal items
+  | .percent p _ => subtotal items - subtotal items * p / 100
+  | .fixed a => subtotal items - a
+
+theorem total_le (items : List LineItem) (d : Discount) : total items d ≤ subtotal items := by
+  unfold total; split <;> omega
+""", models=[LineItem])
+
+items = [LineItem(sku="a", qty=2, unitPrice=100)]
+pricing.total(items, pricing.Discount.percent(p=10))  # 180
+pricing.Discount.percent(p=150)                       # pydantic.ValidationError: p: Input should be less than or equal to 100
+```
+
+- `lean-py sync` checks the proofs with Lake and compiles the Lean code from Lean's IR to plain
+  Python. The generated modules are written to `<package>/_lean/` and ship with your package; running
+  them needs only the `lean-python` wheel (and pydantic), not Lean.
+- The generated Python computes what the C backend computes: a diff test runs the same Lean
+  programs natively and as Python and compares the output byte for byte. Reference counting is
+  kept, so `Array` updates happen in place as in C.
+- Lean structures and inductive types become pydantic models. A proof field (`h : p ≤ 100`) becomes
+  a validator that runs a decision procedure compiled from the proposition, so every value that
+  reaches Lean satisfies the invariants the proofs rely on; a comparison with a constant also becomes
+  an annotated-types constraint (`Le(100)`), checked by pydantic-core and shown in the JSON Schema. The JSON of the models is the JSON of
+  Lean's `deriving ToJson, FromJson`.
+- Your own pydantic models can be used from Lean (`models=[...]`). Their field constraints
+  (`ge`, `gt`, `le`, `lt`, `min_length`, `max_length`) become proof fields that Lean proofs may assume.
+- The models work wherever pydantic does: `TypeAdapter`, `model_validate_json`, JSON Schema, FastAPI
+  request and response types.
+
+## Install
+
+The Python package and the Lean CLI:
+
+```sh
+uv add lean-python                            # the runtime, lean(), lean-py sync
+nix profile install github:conao3/lean-py     # the Lean CLI `lean-python`
+```
+
+`lean-py sync` also needs `lake` and the Lean toolchain of `lean-toolchain` (v4.35.0) on `PATH`.
+
+## Lean blocks
+
+`lean(name, source, *, imports=(), uses=(), models=())` defines a Lean block of the calling module
+(which must belong to a package). The block's definitions are in the namespace
+`LeanPythonEmbed.<module>.<name>`; the returned module exposes them under their names relative to it
+(`Discount.percent`, `total`).
+
+```sh
+lean-py sync --package src/myapp
+```
+
+imports every module of the package, writes each block to a Lake workspace in
+`.lean-python/workspace/`, builds it, and generates `src/myapp/_lean/<module>__<name>.py` and
+`src/myapp/_lean/blocks.json`. Lean errors point at the Python file:
+
+```
+lean-py: src/myapp/m.py:6: error: (lean block m, Lean 4:28) Tactic `rfl` failed: ...
+```
+
+Add `.lean-python/` to `.gitignore` and commit `<package>/_lean/`.
+
+At run time `lean(...)` compares a hash of the block (its source, imports, uses, the Lean structures
+of its models and the generator version) with `blocks.json` and raises `LeanBlockStale` when the
+block changed since the last sync. With `LEAN_PYTHON_AUTO_SYNC=1` it runs `lean-py sync` instead.
+
+- `imports=["Std.Data.HashMap"]`: Lean modules to import.
+- `uses=["geometry"]`: other blocks of the module (or `"pkg.mod:name"`), imported and opened; their
+  types are shared, not generated again.
+- `models=[LineItem]`: pydantic models available as Lean structures (below).
+
+## Values
+
+| Lean | Python |
+|---|---|
+| `Nat` | `int` (`lean_python.types.Nat` = `Annotated[int, Ge(0)]`) |
+| `Int` | `int` |
+| `UInt8` … `UInt64`, `USize`, `Int8` … `Int64` | `int` with the range as `Ge`/`Le` |
+| `Fin n` | `Annotated[int, Ge(0), Lt(n)]` |
+| `Bool` | `bool` |
+| `Char` | `str` of one character |
+| `String` | `str` |
+| `Float`, `Float32` | `float` |
+| `Unit` | `None` |
+| `Option α` | `α \| None` |
+| `List α`, `Array α` | `list[α]` |
+| `α × β` | `tuple[α, β]` |
+| `{x : α // p x}` | `Annotated[α, AfterValidator(p)]` |
+| structure | a frozen, strict pydantic model |
+| inductive type, constructors without arguments | `enum.StrEnum` |
+| other inductive type | a model per constructor, subclasses of the type's class |
+| `IO α` | `α`; an `IO.Error` is raised as `LeanIOError` (an `OSError`) |
+
+Arguments are checked while they are converted (`pub.double(-1)` raises `ValidationError` with the
+location of the bad value). Constants are functions without arguments (`answer()`).
+
+Constructors and structures take keyword arguments (`Shape.rect(width=1, height=2)`); unnamed
+constructor arguments are `a0`, `a1`, …. Inductive values work with `match`:
+
+```python
+match shape:
+    case geometry.Shape.rect(width=w, height=h):
+        ...
+```
+
+### JSON
+
+The JSON of a generated model is the JSON of Lean's derived `ToJson`: a structure is an object, a
+constructor without arguments is its name (`"dot"`), a constructor with named arguments is
+`{"rect": {"width": 1, "height": 2}}`, with unnamed arguments `{"num": 7}` or `{"pair": [1, "x"]}`.
+`tests/test_json.py` compares the generated models with a native Lean program that prints `toJson`.
+
+### Your pydantic models in Lean
+
+`models=[LineItem]` writes a Lean structure for each model (and the models its fields use) to the
+namespace `LeanPythonModels.<python module>`, opened in the block:
+
+```lean
+structure LineItem where
+  sku : String
+  qty : Nat
+  qty_ge : 1 ≤ qty
+  unitPrice : Nat
+```
+
+`int` with a lower bound of at least 0 becomes `Nat`; the other bounds and `min_length`/`max_length`
+become proof fields. Field types: `int`, `bool`, `str`, `float`, `list[T]`, `tuple[...]`, `T | None`,
+other models, enums (an inductive type `LeanPythonModels.<module>.<Enum>` with a constructor per
+member), `Literal["a", "b"]` (`LeanPythonLiterals.<module>.<Model>_<field>`), and unions of models
+(`LeanPythonUnions.<module>.<Model>_<field>`, a constructor per model holding it as `val`). `multiple_of`, `pattern` and validators are not assumed in Lean; the structure's
+docstring lists them. Generated functions take and return your classes; values that did not go
+through validation (`model_construct`) are checked again on the way to Lean.
+
+## The CLI
+
+```
+lean-python module generate --module-name <Name> [--roots <Name> ...] [--namespace <Name>]
+  [--search-path <dir> ...] [--output-file <path>] [--internal-only] [--output json|text]
+  [--type-module <Name>=<module> ...] [--model-module <Name>=<module> ...] [--batch <file>]
+lean-python --version | --generator-version | help
+```
+
+`module generate` writes one Python module with the IR of the roots and of everything they call
+(Init and Std included), and public functions and types for the roots. Definitions it cannot expose
+(polymorphic functions, functions over functions) are reported as skipped. Exit codes: 0 success,
+252 invalid parameters, 254 input that cannot be converted, 255 other errors.
+
+## Performance
+
+`make bench` (CPython 3.14, x86_64; the native column is the C backend):
+
+| workload | n | Python (s) | native C (s) |
+|---|---|---|---|
+| `Array.push`, `set!`, sum | 10⁴ | 0.017 | 0.005 |
+| `Array.push`, `set!`, sum | 10⁵ | 0.179 | 0.006 |
+| `Array.push`, `set!`, sum | 10⁶ | 1.796 | 0.017 |
+| `fib` (loop) | 10⁵ | 0.176 | 0.074 |
+| `naiveFib` | 25 | 0.149 | 0.005 |
+| `String.push` | 10⁴ | 0.012 | 0.005 |
+| `String.push` | 10⁵ | 0.227 | 0.006 |
+| `Array.qsort` | 10⁵ | 1.929 | 0.020 |
+
+Passing 10⁴ models to a Lean function takes 0.036 s (pydantic's `TypeAdapter(list[Model])` validates
+10⁴ dicts in 0.009 s).
+
+## Development
+
+```sh
+nix develop -c make check   # treefmt, the diff tests against the C backend, pytest
+nix develop -c make bench
+```
+
+- `LeanPython/EmitPy.lean`: IR → Python. `LeanPython/Marshal.lean`, `LeanPython/Generate.lean`: public
+  types and functions. `Main.lean`: the CLI.
+- `src/lean_python/runtime.py`, `io_externs.py`: the runtime (`lean_*` are the C names of Lean's
+  externs). `marshal.py`, `types.py`: pydantic types. `embed.py`, `sync.py`, `models.py`, `cli.py`:
+  `lean(...)` and `lean-py sync`.
+- `LeanPythonTest/`: Lean programs of the tests; `test-diff.sh` runs `Vectors` and `Io` natively and
+  as Python.
+
+## Limitations
+
+- Polymorphic functions, functions taking or returning functions, `Thunk`/`Task`/`IO.Ref`/
+  `ByteArray` in public signatures are not exposed (they still run inside Lean code).
+- `Task`s run synchronously.
+- Building a `String` with `String.push` copies the string each time (Python `bytes`), so it grows
+  quadratically.
+- Python's own functions are not verified in Lean yet.
+
+## License
+
+Apache-2.0

lean_python-0.1.0/README.md

@@ -0,0 +1,217 @@
+# lean-py
+
+Write and prove functions in Lean 4, run them as Python, and pass pydantic models across.
+
+```python
+from pydantic import BaseModel, Field
+from lean_python import lean
+
+
+class LineItem(BaseModel):
+    sku: str
+    qty: int = Field(ge=1)
+    unitPrice: int = Field(ge=0)
+
+
+pricing = lean("pricing", r"""
+inductive Discount where
+  | none
+  | percent (p : Nat) (h : p ≤ 100)
+  | fixed (amount : Nat)
+
+def subtotal (items : List LineItem) : Nat :=
+  items.foldl (fun acc i => acc + i.qty * i.unitPrice) 0
+
+def total (items : List LineItem) (d : Discount) : Nat :=
+  match d with
+  | .none => subtotal items
+  | .percent p _ => subtotal items - subtotal items * p / 100
+  | .fixed a => subtotal items - a
+
+theorem total_le (items : List LineItem) (d : Discount) : total items d ≤ subtotal items := by
+  unfold total; split <;> omega
+""", models=[LineItem])
+
+items = [LineItem(sku="a", qty=2, unitPrice=100)]
+pricing.total(items, pricing.Discount.percent(p=10))  # 180
+pricing.Discount.percent(p=150)                       # pydantic.ValidationError: p: Input should be less than or equal to 100
+```
+
+- `lean-py sync` checks the proofs with Lake and compiles the Lean code from Lean's IR to plain
+  Python. The generated modules are written to `<package>/_lean/` and ship with your package; running
+  them needs only the `lean-python` wheel (and pydantic), not Lean.
+- The generated Python computes what the C backend computes: a diff test runs the same Lean
+  programs natively and as Python and compares the output byte for byte. Reference counting is
+  kept, so `Array` updates happen in place as in C.
+- Lean structures and inductive types become pydantic models. A proof field (`h : p ≤ 100`) becomes
+  a validator that runs a decision procedure compiled from the proposition, so every value that
+  reaches Lean satisfies the invariants the proofs rely on; a comparison with a constant also becomes
+  an annotated-types constraint (`Le(100)`), checked by pydantic-core and shown in the JSON Schema. The JSON of the models is the JSON of
+  Lean's `deriving ToJson, FromJson`.
+- Your own pydantic models can be used from Lean (`models=[...]`). Their field constraints
+  (`ge`, `gt`, `le`, `lt`, `min_length`, `max_length`) become proof fields that Lean proofs may assume.
+- The models work wherever pydantic does: `TypeAdapter`, `model_validate_json`, JSON Schema, FastAPI
+  request and response types.
+
+## Install
+
+The Python package and the Lean CLI:
+
+```sh
+uv add lean-python                            # the runtime, lean(), lean-py sync
+nix profile install github:conao3/lean-py     # the Lean CLI `lean-python`
+```
+
+`lean-py sync` also needs `lake` and the Lean toolchain of `lean-toolchain` (v4.35.0) on `PATH`.
+
+## Lean blocks
+
+`lean(name, source, *, imports=(), uses=(), models=())` defines a Lean block of the calling module
+(which must belong to a package). The block's definitions are in the namespace
+`LeanPythonEmbed.<module>.<name>`; the returned module exposes them under their names relative to it
+(`Discount.percent`, `total`).
+
+```sh
+lean-py sync --package src/myapp
+```
+
+imports every module of the package, writes each block to a Lake workspace in
+`.lean-python/workspace/`, builds it, and generates `src/myapp/_lean/<module>__<name>.py` and
+`src/myapp/_lean/blocks.json`. Lean errors point at the Python file:
+
+```
+lean-py: src/myapp/m.py:6: error: (lean block m, Lean 4:28) Tactic `rfl` failed: ...
+```
+
+Add `.lean-python/` to `.gitignore` and commit `<package>/_lean/`.
+
+At run time `lean(...)` compares a hash of the block (its source, imports, uses, the Lean structures
+of its models and the generator version) with `blocks.json` and raises `LeanBlockStale` when the
+block changed since the last sync. With `LEAN_PYTHON_AUTO_SYNC=1` it runs `lean-py sync` instead.
+
+- `imports=["Std.Data.HashMap"]`: Lean modules to import.
+- `uses=["geometry"]`: other blocks of the module (or `"pkg.mod:name"`), imported and opened; their
+  types are shared, not generated again.
+- `models=[LineItem]`: pydantic models available as Lean structures (below).
+
+## Values
+
+| Lean | Python |
+|---|---|
+| `Nat` | `int` (`lean_python.types.Nat` = `Annotated[int, Ge(0)]`) |
+| `Int` | `int` |
+| `UInt8` … `UInt64`, `USize`, `Int8` … `Int64` | `int` with the range as `Ge`/`Le` |
+| `Fin n` | `Annotated[int, Ge(0), Lt(n)]` |
+| `Bool` | `bool` |
+| `Char` | `str` of one character |
+| `String` | `str` |
+| `Float`, `Float32` | `float` |
+| `Unit` | `None` |
+| `Option α` | `α \| None` |
+| `List α`, `Array α` | `list[α]` |
+| `α × β` | `tuple[α, β]` |
+| `{x : α // p x}` | `Annotated[α, AfterValidator(p)]` |
+| structure | a frozen, strict pydantic model |
+| inductive type, constructors without arguments | `enum.StrEnum` |
+| other inductive type | a model per constructor, subclasses of the type's class |
+| `IO α` | `α`; an `IO.Error` is raised as `LeanIOError` (an `OSError`) |
+
+Arguments are checked while they are converted (`pub.double(-1)` raises `ValidationError` with the
+location of the bad value). Constants are functions without arguments (`answer()`).
+
+Constructors and structures take keyword arguments (`Shape.rect(width=1, height=2)`); unnamed
+constructor arguments are `a0`, `a1`, …. Inductive values work with `match`:
+
+```python
+match shape:
+    case geometry.Shape.rect(width=w, height=h):
+        ...
+```
+
+### JSON
+
+The JSON of a generated model is the JSON of Lean's derived `ToJson`: a structure is an object, a
+constructor without arguments is its name (`"dot"`), a constructor with named arguments is
+`{"rect": {"width": 1, "height": 2}}`, with unnamed arguments `{"num": 7}` or `{"pair": [1, "x"]}`.
+`tests/test_json.py` compares the generated models with a native Lean program that prints `toJson`.
+
+### Your pydantic models in Lean
+
+`models=[LineItem]` writes a Lean structure for each model (and the models its fields use) to the
+namespace `LeanPythonModels.<python module>`, opened in the block:
+
+```lean
+structure LineItem where
+  sku : String
+  qty : Nat
+  qty_ge : 1 ≤ qty
+  unitPrice : Nat
+```
+
+`int` with a lower bound of at least 0 becomes `Nat`; the other bounds and `min_length`/`max_length`
+become proof fields. Field types: `int`, `bool`, `str`, `float`, `list[T]`, `tuple[...]`, `T | None`,
+other models, enums (an inductive type `LeanPythonModels.<module>.<Enum>` with a constructor per
+member), `Literal["a", "b"]` (`LeanPythonLiterals.<module>.<Model>_<field>`), and unions of models
+(`LeanPythonUnions.<module>.<Model>_<field>`, a constructor per model holding it as `val`). `multiple_of`, `pattern` and validators are not assumed in Lean; the structure's
+docstring lists them. Generated functions take and return your classes; values that did not go
+through validation (`model_construct`) are checked again on the way to Lean.
+
+## The CLI
+
+```
+lean-python module generate --module-name <Name> [--roots <Name> ...] [--namespace <Name>]
+  [--search-path <dir> ...] [--output-file <path>] [--internal-only] [--output json|text]
+  [--type-module <Name>=<module> ...] [--model-module <Name>=<module> ...] [--batch <file>]
+lean-python --version | --generator-version | help
+```
+
+`module generate` writes one Python module with the IR of the roots and of everything they call
+(Init and Std included), and public functions and types for the roots. Definitions it cannot expose
+(polymorphic functions, functions over functions) are reported as skipped. Exit codes: 0 success,
+252 invalid parameters, 254 input that cannot be converted, 255 other errors.
+
+## Performance
+
+`make bench` (CPython 3.14, x86_64; the native column is the C backend):
+
+| workload | n | Python (s) | native C (s) |
+|---|---|---|---|
+| `Array.push`, `set!`, sum | 10⁴ | 0.017 | 0.005 |
+| `Array.push`, `set!`, sum | 10⁵ | 0.179 | 0.006 |
+| `Array.push`, `set!`, sum | 10⁶ | 1.796 | 0.017 |
+| `fib` (loop) | 10⁵ | 0.176 | 0.074 |
+| `naiveFib` | 25 | 0.149 | 0.005 |
+| `String.push` | 10⁴ | 0.012 | 0.005 |
+| `String.push` | 10⁵ | 0.227 | 0.006 |
+| `Array.qsort` | 10⁵ | 1.929 | 0.020 |
+
+Passing 10⁴ models to a Lean function takes 0.036 s (pydantic's `TypeAdapter(list[Model])` validates
+10⁴ dicts in 0.009 s).
+
+## Development
+
+```sh
+nix develop -c make check   # treefmt, the diff tests against the C backend, pytest
+nix develop -c make bench
+```
+
+- `LeanPython/EmitPy.lean`: IR → Python. `LeanPython/Marshal.lean`, `LeanPython/Generate.lean`: public
+  types and functions. `Main.lean`: the CLI.
+- `src/lean_python/runtime.py`, `io_externs.py`: the runtime (`lean_*` are the C names of Lean's
+  externs). `marshal.py`, `types.py`: pydantic types. `embed.py`, `sync.py`, `models.py`, `cli.py`:
+  `lean(...)` and `lean-py sync`.
+- `LeanPythonTest/`: Lean programs of the tests; `test-diff.sh` runs `Vectors` and `Io` natively and
+  as Python.
+
+## Limitations
+
+- Polymorphic functions, functions taking or returning functions, `Thunk`/`Task`/`IO.Ref`/
+  `ByteArray` in public signatures are not exposed (they still run inside Lean code).
+- `Task`s run synchronously.
+- Building a `String` with `String.push` copies the string each time (Python `bytes`), so it grows
+  quadratically.
+- Python's own functions are not verified in Lean yet.
+
+## License
+
+Apache-2.0