leanfran 0.6.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- leanfran/__init__.py +6 -0
- leanfran/check.py +292 -0
- leanfran/cli.py +73 -0
- leanfran/embed.py +131 -0
- leanfran/io.py +15 -0
- leanfran/io_externs.py +1192 -0
- leanfran/lean/LeanPythonLib/Py.lean +52 -0
- leanfran/marshal.py +729 -0
- leanfran/models.py +297 -0
- leanfran/runtime.py +1400 -0
- leanfran/sync.py +265 -0
- leanfran/translate.py +469 -0
- leanfran/types.py +33 -0
- leanfran/verify.py +147 -0
- leanfran-0.6.0.dist-info/METADATA +388 -0
- leanfran-0.6.0.dist-info/RECORD +19 -0
- leanfran-0.6.0.dist-info/WHEEL +4 -0
- leanfran-0.6.0.dist-info/entry_points.txt +2 -0
- leanfran-0.6.0.dist-info/licenses/LICENSE +202 -0
|
@@ -0,0 +1,388 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: leanfran
|
|
3
|
+
Version: 0.6.0
|
|
4
|
+
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
|
|
5
|
+
Project-URL: Repository, https://github.com/conao3/lean-leanfran/tree/master/Python
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
License-File: LICENSE
|
|
8
|
+
Classifier: Framework :: Pydantic :: 2
|
|
9
|
+
Classifier: Programming Language :: Python :: 3
|
|
10
|
+
Classifier: Topic :: Software Development :: Compilers
|
|
11
|
+
Requires-Python: >=3.12
|
|
12
|
+
Requires-Dist: pydantic>=2.11
|
|
13
|
+
Description-Content-Type: text/markdown
|
|
14
|
+
|
|
15
|
+
<p align="center">
|
|
16
|
+
<img src="https://raw.githubusercontent.com/conao3/lean-leanfran/master/Python/docs/assets/banner.png" alt="leanfran: write and prove functions in Lean 4, run them as Python" width="880">
|
|
17
|
+
</p>
|
|
18
|
+
|
|
19
|
+
<p align="center"><strong>Write and prove functions in Lean 4, run them as Python</strong></p>
|
|
20
|
+
|
|
21
|
+
<p align="center">
|
|
22
|
+
<a href="https://pypi.org/project/leanfran/"><img src="https://img.shields.io/pypi/v/leanfran" alt="PyPI version"></a>
|
|
23
|
+
<a href="https://github.com/conao3/lean-leanfran/actions/workflows/ci.yml"><img src="https://github.com/conao3/lean-leanfran/actions/workflows/ci.yml/badge.svg?branch=master" alt="CI"></a>
|
|
24
|
+
<a href="https://github.com/conao3/lean-leanfran/blob/master/Python/LICENSE"><img src="https://img.shields.io/github/license/conao3/lean-leanfran" alt="License: Apache-2.0"></a>
|
|
25
|
+
<a href="https://github.com/conao3/lean-leanfran/blob/master/Python/pyproject.toml"><img src="https://img.shields.io/badge/Python-%3E%3D3.12-blue" alt="Python >=3.12"></a>
|
|
26
|
+
<a href="https://github.com/conao3/lean-leanfran/blob/master/Python/lean-toolchain"><img src="https://img.shields.io/badge/Lean-v4.35.0-blue" alt="Lean v4.35.0"></a>
|
|
27
|
+
<a href="https://github.com/conao3/lean-leanfran/stargazers"><img src="https://img.shields.io/github/stars/conao3/lean-leanfran?style=flat" alt="GitHub stars"></a>
|
|
28
|
+
</p>
|
|
29
|
+
|
|
30
|
+
<p align="center">
|
|
31
|
+
<a href="#install">Install</a> ·
|
|
32
|
+
<a href="#lean-blocks">Lean blocks</a> ·
|
|
33
|
+
<a href="#values">Values</a> ·
|
|
34
|
+
<a href="#verifying-python-functions">Verifying Python functions</a> ·
|
|
35
|
+
<a href="#examples">Examples</a> ·
|
|
36
|
+
<a href="#performance">Performance</a> ·
|
|
37
|
+
<a href="https://pypi.org/project/leanfran/">PyPI</a>
|
|
38
|
+
</p>
|
|
39
|
+
|
|
40
|
+
# leanfran
|
|
41
|
+
|
|
42
|
+
leanfran lets you write functions in Lean 4, prove theorems about them, and call them from Python
|
|
43
|
+
with pydantic models as arguments and results. The PyPI distribution is `leanfran`; you import
|
|
44
|
+
it as `leanfran`.
|
|
45
|
+
|
|
46
|
+
```python
|
|
47
|
+
from pydantic import BaseModel, Field
|
|
48
|
+
from leanfran import lean
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
class LineItem(BaseModel):
|
|
52
|
+
sku: str
|
|
53
|
+
qty: int = Field(ge=1)
|
|
54
|
+
unitPrice: int = Field(ge=0)
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
pricing = lean("pricing", r"""
|
|
58
|
+
inductive Discount where
|
|
59
|
+
| none
|
|
60
|
+
| percent (p : Nat) (h : p ≤ 100)
|
|
61
|
+
| fixed (amount : Nat)
|
|
62
|
+
|
|
63
|
+
def subtotal (items : List LineItem) : Nat :=
|
|
64
|
+
items.foldl (fun acc i => acc + i.qty * i.unitPrice) 0
|
|
65
|
+
|
|
66
|
+
def total (items : List LineItem) (d : Discount) : Nat :=
|
|
67
|
+
match d with
|
|
68
|
+
| .none => subtotal items
|
|
69
|
+
| .percent p _ => subtotal items - subtotal items * p / 100
|
|
70
|
+
| .fixed a => subtotal items - a
|
|
71
|
+
|
|
72
|
+
theorem total_le (items : List LineItem) (d : Discount) : total items d ≤ subtotal items := by
|
|
73
|
+
unfold total; split <;> omega
|
|
74
|
+
""", models=[LineItem])
|
|
75
|
+
|
|
76
|
+
items = [LineItem(sku="a", qty=2, unitPrice=100)]
|
|
77
|
+
pricing.total(items, pricing.Discount.percent(p=10)) # 180
|
|
78
|
+
pricing.Discount.percent(p=150) # pydantic.ValidationError: p: Input should be less than or equal to 100
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
- `leanfran sync` checks the proofs with Lake and compiles the Lean code from Lean's IR to plain
|
|
82
|
+
Python. It writes the generated modules to `<package>/_lean/`, and they ship with your package.
|
|
83
|
+
To run them you need the `leanfran` wheel and pydantic. You do not need Lean.
|
|
84
|
+
- The generated Python computes what the C backend computes. A diff test runs the same Lean
|
|
85
|
+
programs natively and as Python and compares the output byte for byte. The generated code keeps
|
|
86
|
+
reference counting, so `Array` updates happen in place as in C.
|
|
87
|
+
- Lean structures and inductive types become pydantic models. A proof field (`h : p ≤ 100`) becomes
|
|
88
|
+
a validator that runs a decision procedure compiled from the proposition, so every value that
|
|
89
|
+
reaches Lean satisfies the invariants the proofs rely on. A comparison with a constant also becomes
|
|
90
|
+
an annotated-types constraint (`Le(100)`) that pydantic-core checks and the JSON Schema shows. The
|
|
91
|
+
JSON of the models is the JSON of Lean's `deriving ToJson, FromJson`.
|
|
92
|
+
- Lean code can use your own pydantic models (`models=[...]`). Their field constraints
|
|
93
|
+
(`ge`, `gt`, `le`, `lt`, `min_length`, `max_length`) become proof fields that Lean proofs may assume.
|
|
94
|
+
- The models work wherever pydantic does: `TypeAdapter`, `model_validate_json`, JSON Schema, FastAPI
|
|
95
|
+
request and response types.
|
|
96
|
+
- `@model` binds a plain Python function to Lean specifications. `leanfran check` translates the
|
|
97
|
+
function to Lean and judges your proofs ([Verifying Python functions](#verifying-python-functions)).
|
|
98
|
+
|
|
99
|
+
## Install
|
|
100
|
+
|
|
101
|
+
The Python package and the Lean CLI:
|
|
102
|
+
|
|
103
|
+
```sh
|
|
104
|
+
uv add leanfran # the runtime, lean(), leanfran sync
|
|
105
|
+
nix profile install 'github:conao3/lean-leanfran?dir=Python' # the Lean CLI `leanfran-python`
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
`leanfran sync` also needs `lake` and the Lean toolchain of `lean-toolchain` (v4.35.0) on `PATH`.
|
|
109
|
+
|
|
110
|
+
## Lean blocks
|
|
111
|
+
|
|
112
|
+
`lean(name, source, *, imports=(), uses=(), models=())` defines a Lean block of the calling module,
|
|
113
|
+
which must belong to a package. The block's definitions live in the namespace
|
|
114
|
+
`LeanPythonEmbed.<module>.<name>`. The returned module exposes them under their names relative to it
|
|
115
|
+
(`Discount.percent`, `total`).
|
|
116
|
+
|
|
117
|
+
```sh
|
|
118
|
+
leanfran sync --package src/myapp
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
`leanfran sync` imports every module of the package, writes each block to a Lake workspace in
|
|
122
|
+
`.leanfran/workspace/`, builds it, and generates `src/myapp/_lean/<module>__<name>.py` and
|
|
123
|
+
`src/myapp/_lean/blocks.json`. Lean errors point at the Python file:
|
|
124
|
+
|
|
125
|
+
```
|
|
126
|
+
leanfran: src/myapp/m.py:6: error: (lean block m, Lean 4:28) Tactic `rfl` failed: ...
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Add `.leanfran/` to `.gitignore` and commit `<package>/_lean/`.
|
|
130
|
+
|
|
131
|
+
At run time `lean(...)` compares a hash of the block (its source, imports, uses, the Lean structures
|
|
132
|
+
of its models and the generator version) with `blocks.json`. If the block changed since the last
|
|
133
|
+
sync, it raises `LeanBlockStale`. With `LEANFRAN_PYTHON_AUTO_SYNC=1` it runs `leanfran sync` instead.
|
|
134
|
+
|
|
135
|
+
- `imports=["Std.Data.HashMap"]`: Lean modules to import.
|
|
136
|
+
- `uses=["geometry"]`: other blocks of the module (or `"pkg.mod:name"`) to import and open. The
|
|
137
|
+
block shares their types and does not generate them again.
|
|
138
|
+
- `models=[LineItem]`: pydantic models available as Lean structures (below).
|
|
139
|
+
|
|
140
|
+
## Values
|
|
141
|
+
|
|
142
|
+
| Lean | Python |
|
|
143
|
+
|---|---|
|
|
144
|
+
| `Nat` | `int` (`leanfran.types.Nat` = `Annotated[int, Ge(0)]`) |
|
|
145
|
+
| `Int` | `int` |
|
|
146
|
+
| `UInt8` … `UInt64`, `USize`, `Int8` … `Int64` | `int` with the range as `Ge`/`Le` |
|
|
147
|
+
| `Fin n` | `Annotated[int, Ge(0), Lt(n)]` |
|
|
148
|
+
| `Bool` | `bool` |
|
|
149
|
+
| `Char` | `str` of one character |
|
|
150
|
+
| `String` | `str` |
|
|
151
|
+
| `Float`, `Float32` | `float` |
|
|
152
|
+
| `Unit` | `None` |
|
|
153
|
+
| `Option α` | `α \| None` |
|
|
154
|
+
| `List α`, `Array α` | `list[α]` |
|
|
155
|
+
| `α × β` | `tuple[α, β]` |
|
|
156
|
+
| `{x : α // p x}` | `Annotated[α, AfterValidator(p)]` |
|
|
157
|
+
| structure | a frozen, strict pydantic model |
|
|
158
|
+
| inductive type, constructors without arguments | `enum.StrEnum` |
|
|
159
|
+
| other inductive type | a model per constructor, subclasses of the type's class |
|
|
160
|
+
| `IO α` | `α`; an `IO.Error` is raised as `LeanIOError` (an `OSError`) |
|
|
161
|
+
|
|
162
|
+
The generated functions check arguments while they convert them: `pub.double(-1)` raises
|
|
163
|
+
`ValidationError` with the location of the bad value. Constants are functions without arguments
|
|
164
|
+
(`answer()`).
|
|
165
|
+
|
|
166
|
+
Constructors and structures take keyword arguments (`Shape.rect(width=1, height=2)`); unnamed
|
|
167
|
+
constructor arguments are `a0`, `a1`, …. Inductive values work with `match`:
|
|
168
|
+
|
|
169
|
+
```python
|
|
170
|
+
match shape:
|
|
171
|
+
case geometry.Shape.rect(width=w, height=h):
|
|
172
|
+
...
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### JSON
|
|
176
|
+
|
|
177
|
+
The JSON of a generated model is the JSON of Lean's derived `ToJson`: a structure is an object, a
|
|
178
|
+
constructor without arguments is its name (`"dot"`), a constructor with named arguments is
|
|
179
|
+
`{"rect": {"width": 1, "height": 2}}`, with unnamed arguments `{"num": 7}` or `{"pair": [1, "x"]}`.
|
|
180
|
+
`tests/test_json.py` compares the generated models with a native Lean program that prints `toJson`.
|
|
181
|
+
|
|
182
|
+
### Your pydantic models in Lean
|
|
183
|
+
|
|
184
|
+
`models=[LineItem]` writes a Lean structure for each model (and the models its fields use) to the
|
|
185
|
+
namespace `LeanPythonModels.<python module>`, and the block opens that namespace:
|
|
186
|
+
|
|
187
|
+
```lean
|
|
188
|
+
structure LineItem where
|
|
189
|
+
sku : String
|
|
190
|
+
qty : Nat
|
|
191
|
+
qty_ge : 1 ≤ qty
|
|
192
|
+
unitPrice : Nat
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
`int` with a lower bound of at least 0 becomes `Nat`; the other bounds and `min_length`/`max_length`
|
|
196
|
+
become proof fields. Field types:
|
|
197
|
+
|
|
198
|
+
- `int`, `bool`, `str`, `float`, `list[T]`, `tuple[...]`, `T | None`, other models
|
|
199
|
+
- enums: an inductive type `LeanPythonModels.<module>.<Enum>` with a constructor per member
|
|
200
|
+
- `Literal["a", "b"]`: `LeanPythonLiterals.<module>.<Model>_<field>`
|
|
201
|
+
- unions of models: `LeanPythonUnions.<module>.<Model>_<field>`, a constructor per model holding it
|
|
202
|
+
as `val`
|
|
203
|
+
|
|
204
|
+
Lean proofs cannot assume `multiple_of`, `pattern` or validators; the structure's docstring lists
|
|
205
|
+
them. Generated functions take and return your classes. Values that skipped validation
|
|
206
|
+
(`model_construct`) go through validation again on the way to Lean.
|
|
207
|
+
|
|
208
|
+
## Verifying Python functions
|
|
209
|
+
|
|
210
|
+
`@model` binds a typed, pure Python function to specifications written in a Lean block. The function
|
|
211
|
+
stays ordinary Python. `leanfran check` translates it to Lean and checks your proofs, and
|
|
212
|
+
`check_model` runs the same specifications as a Hypothesis property test.
|
|
213
|
+
|
|
214
|
+
```python
|
|
215
|
+
from leanfran import lean
|
|
216
|
+
from leanfran.verify import model
|
|
217
|
+
|
|
218
|
+
spec = lean("spec", r"""
|
|
219
|
+
def clampSpec (x lo hi : Int) : Int := max lo (min hi x)
|
|
220
|
+
def ordered (_x lo hi : Int) : Bool := lo ≤ hi
|
|
221
|
+
def inRange (_x lo hi : Int) (r : Int) : Bool := lo ≤ r && r ≤ hi
|
|
222
|
+
""")
|
|
223
|
+
|
|
224
|
+
@model(refines=spec.clampSpec, requires=spec.ordered, ensures={"in_range": spec.inRange})
|
|
225
|
+
def clamp(x: int, lo: int, hi: int) -> int:
|
|
226
|
+
if x < lo:
|
|
227
|
+
return lo
|
|
228
|
+
if x > hi:
|
|
229
|
+
return hi
|
|
230
|
+
return x
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
`leanfran check --package calc` writes the translation and one obligation per specification:
|
|
234
|
+
|
|
235
|
+
```lean
|
|
236
|
+
def LeanPythonModel.calc.calc.clamp (x : Int) (lo : Int) (hi : Int) : Int := Id.run do
|
|
237
|
+
if ((decide (x < lo))) then
|
|
238
|
+
return lo
|
|
239
|
+
if ((decide (x > hi))) then
|
|
240
|
+
return hi
|
|
241
|
+
return x
|
|
242
|
+
|
|
243
|
+
abbrev LeanPythonModel.calc.calc.clamp.obligation.refines : Prop :=
|
|
244
|
+
∀ (x : Int) (lo : Int) (hi : Int), ordered x lo hi = true → clamp x lo hi = clampSpec x lo hi
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
Then it judges the theorems `<function>.proof.<label>` of `lean/Proofs/*.lean` next to
|
|
248
|
+
`pyproject.toml`:
|
|
249
|
+
|
|
250
|
+
```lean
|
|
251
|
+
import LeanPythonModel.calc.calc
|
|
252
|
+
open LeanPythonEmbed.calc.spec.spec
|
|
253
|
+
namespace LeanPythonModel.«calc».«calc»
|
|
254
|
+
|
|
255
|
+
theorem clamp.proof.refines : clamp.obligation.refines := by
|
|
256
|
+
intro x lo hi h
|
|
257
|
+
simp only [ordered, decide_eq_true_eq] at h
|
|
258
|
+
simp only [clamp, clampSpec]
|
|
259
|
+
split <;> (try split) <;> simp_all <;> omega
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
```
|
|
263
|
+
proved calc.calc:clamp refines
|
|
264
|
+
proved calc.calc:clamp in_range
|
|
265
|
+
sorry calc.calc:sum_to refines
|
|
266
|
+
missing calc.calc:sum_abs nonneg
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
Under `simp`, a `for` loop over a list becomes `List.foldl` (`forIn_pure_yield_eq_foldl`), so you
|
|
270
|
+
prove a loop by induction on the list (`tests/verify/lean/Proofs/Calc.lean` proves `sum_abs`).
|
|
271
|
+
|
|
272
|
+
The states:
|
|
273
|
+
|
|
274
|
+
| state | meaning |
|
|
275
|
+
|---|---|
|
|
276
|
+
| `proved` | the theorem holds |
|
|
277
|
+
| `sorry` | the proof uses `sorry` |
|
|
278
|
+
| `axioms` | the proof uses non-standard axioms |
|
|
279
|
+
| `failed` | the proof file does not build |
|
|
280
|
+
| `missing` | no theorem for the obligation |
|
|
281
|
+
| `mismatch` | the theorem states something else |
|
|
282
|
+
| `unextracted` | the obligation's statement is not defined |
|
|
283
|
+
|
|
284
|
+
With `--require proved`, `leanfran check` exits with 254 unless every obligation is proved. It
|
|
285
|
+
writes the result to `leanfran.lock` with a hash of each function's source. `leanfran status`
|
|
286
|
+
reads the lock file without Lean and marks changed functions `stale`.
|
|
287
|
+
|
|
288
|
+
- `refines=s`: `f x = s x` (`Except.ok (s x)` for a function that may fail); `requires=p`: `p x = true →`
|
|
289
|
+
before each obligation; `ensures={"label": q}`: `q x (f x) = true`. A function annotated `-> Nat`
|
|
290
|
+
also gets `returns_nat` (`0 ≤ f x`).
|
|
291
|
+
- The translation: `int` is `Int` (a `Nat` parameter is a `Nat` converted to `Int` on entry);
|
|
292
|
+
statements become Lean `do` notation (`let mut`, `for`, `while`, `break`, `continue`, early
|
|
293
|
+
`return`); indexing, `//`, `%`, `assert` and `raise` make the function return
|
|
294
|
+
`Py.M α = Except Py.Exc α`, with Python's negative indices and floor division (`LeanPythonLib.Py`).
|
|
295
|
+
Supported: `int`, `bool`, `str`, `float`, `list`, `tuple`, `T | None`, pydantic models (as the
|
|
296
|
+
Lean structures of `models=`), `len`, `abs`, `min`, `max`, `sum`, list comprehensions, `append` on
|
|
297
|
+
local lists, and calls of other `@model` functions of the module.
|
|
298
|
+
- `check_model(f)` / `check_module(m)` generate arguments from the annotations (pydantic constraints
|
|
299
|
+
included), skip those failing `requires`, and compare with `refines` and `ensures`.
|
|
300
|
+
|
|
301
|
+
## Examples
|
|
302
|
+
|
|
303
|
+
[`samples/`](https://github.com/conao3/lean-leanfran/tree/master/Python/samples) holds Python packages with Lean
|
|
304
|
+
blocks. `make samples` syncs each one, runs it, and compares the output with its `expected.txt`.
|
|
305
|
+
|
|
306
|
+
| sample | shows |
|
|
307
|
+
|---|---|
|
|
308
|
+
| [word-count](https://github.com/conao3/lean-leanfran/tree/master/Python/samples/word-count) | strings and lists, a proof by induction |
|
|
309
|
+
| [roman-numerals](https://github.com/conao3/lean-leanfran/tree/master/Python/samples/roman-numerals) | a round-trip theorem checked for every number below 1000 (`decide +kernel`) |
|
|
310
|
+
| [todo-cli](https://github.com/conao3/lean-leanfran/tree/master/Python/samples/todo-cli) | an invariant over a list kept by every operation, JSON storage, tampered JSON rejected |
|
|
311
|
+
| [pricing-api](https://github.com/conao3/lean-leanfran/tree/master/Python/samples/pricing-api) | FastAPI with a pydantic model and a Lean inductive type as request body, 422 for invalid input |
|
|
312
|
+
|
|
313
|
+
[`samples/steps/`](https://github.com/conao3/lean-leanfran/tree/master/Python/samples/steps) introduces one
|
|
314
|
+
feature at a time, from functions on `Nat` (01) to types shared between blocks with `uses=` (09).
|
|
315
|
+
|
|
316
|
+
## The CLI
|
|
317
|
+
|
|
318
|
+
The Python package installs `leanfran`:
|
|
319
|
+
|
|
320
|
+
```
|
|
321
|
+
leanfran sync --package <dir> [--leanfran-python <path>]
|
|
322
|
+
leanfran check --package <dir> [--leanfran-python <path>] [--require proved]
|
|
323
|
+
leanfran status --package <dir>
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
`--leanfran-python` defaults to `$LEANFRAN_PYTHON_CLI`, then `leanfran-python` on `PATH`. The Lean CLI
|
|
327
|
+
`leanfran-python` does the compilation:
|
|
328
|
+
|
|
329
|
+
```
|
|
330
|
+
leanfran-python module generate --module-name <Name> [--roots <Name> ...] [--namespace <Name>]
|
|
331
|
+
[--import <Name> ...] [--search-path <dir> ...] [--output-file <path>] [--internal-only]
|
|
332
|
+
[--output json|text] [--type-module <Name>=<module> ...] [--model-module <Name>=<module> ...]
|
|
333
|
+
[--batch <file>]
|
|
334
|
+
leanfran-python obligations check --modules <Name> ... --obligations <file> [--search-path <dir> ...]
|
|
335
|
+
leanfran-python --version | --generator-version | help
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
`module generate` writes one Python module with the IR of the roots and of everything they call
|
|
339
|
+
(Init and Std included), and public functions and types for the roots. It reports the definitions it
|
|
340
|
+
cannot expose (polymorphic functions, functions over functions) as skipped. Both CLIs use the exit
|
|
341
|
+
codes 0 success, 252 invalid parameters, 254 input that cannot be converted, 255 other errors.
|
|
342
|
+
|
|
343
|
+
## Performance
|
|
344
|
+
|
|
345
|
+
`make bench` (CPython 3.14, x86_64; the native column is the C backend):
|
|
346
|
+
|
|
347
|
+
| workload | n | Python (s) | native C (s) |
|
|
348
|
+
|---|---|---|---|
|
|
349
|
+
| `Array.push`, `set!`, sum | 10⁴ | 0.017 | 0.005 |
|
|
350
|
+
| `Array.push`, `set!`, sum | 10⁵ | 0.179 | 0.006 |
|
|
351
|
+
| `Array.push`, `set!`, sum | 10⁶ | 1.796 | 0.017 |
|
|
352
|
+
| `fib` (loop) | 10⁵ | 0.176 | 0.074 |
|
|
353
|
+
| `naiveFib` | 25 | 0.149 | 0.005 |
|
|
354
|
+
| `String.push` | 10⁴ | 0.012 | 0.005 |
|
|
355
|
+
| `String.push` | 10⁵ | 0.227 | 0.006 |
|
|
356
|
+
| `Array.qsort` | 10⁵ | 1.929 | 0.020 |
|
|
357
|
+
|
|
358
|
+
Passing 10⁴ models to a Lean function takes 0.036 s (pydantic's `TypeAdapter(list[Model])` validates
|
|
359
|
+
10⁴ dicts in 0.009 s).
|
|
360
|
+
|
|
361
|
+
## Development
|
|
362
|
+
|
|
363
|
+
```sh
|
|
364
|
+
nix develop -c make check # treefmt, the diff tests against the C backend, pytest, the samples
|
|
365
|
+
nix develop -c make bench
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
- `LeanPython/EmitPy.lean`: IR → Python. `LeanPython/Marshal.lean`, `LeanPython/Generate.lean`: public
|
|
369
|
+
types and functions. `LeanPython/Check.lean`: `obligations check`. `Main.lean`: the CLI.
|
|
370
|
+
- `src/leanfran/runtime.py`, `io_externs.py`: the runtime (`lean_*` are the C names of Lean's
|
|
371
|
+
externs). `marshal.py`, `types.py`: pydantic types. `embed.py`, `sync.py`, `models.py`, `cli.py`:
|
|
372
|
+
`lean(...)` and `leanfran sync`. `verify.py`, `translate.py`, `check.py`: `@model` and
|
|
373
|
+
`leanfran check`; `lean/LeanPythonLib/Py.lean` holds Python's semantics in Lean.
|
|
374
|
+
- `LeanPythonTest/`: Lean programs of the tests; `test-diff.sh` runs `Vectors` and `Io` natively and
|
|
375
|
+
as Python.
|
|
376
|
+
|
|
377
|
+
## Limitations
|
|
378
|
+
|
|
379
|
+
- leanfran does not expose polymorphic functions, functions taking or returning functions, or
|
|
380
|
+
`Thunk`/`Task`/`IO.Ref`/`ByteArray` in public signatures. They still run inside Lean code.
|
|
381
|
+
- `Task`s run synchronously.
|
|
382
|
+
- Building a `String` with `String.push` copies the string each time (Python `bytes`), so it grows
|
|
383
|
+
quadratically.
|
|
384
|
+
- The translation of Python functions covers the subset above; the guarantee is partial correctness.
|
|
385
|
+
|
|
386
|
+
## License
|
|
387
|
+
|
|
388
|
+
[Apache-2.0](https://github.com/conao3/lean-leanfran/blob/master/Python/LICENSE)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
leanfran/__init__.py,sha256=rbXGltYyOsZ40mfkDJODO3Nfwg_jA_A7AeS6-FiCZJo,173
|
|
2
|
+
leanfran/check.py,sha256=O82AVpmXOYP7wAAFzzyfdMQysGaQkkhHck_r1ULxFhs,11125
|
|
3
|
+
leanfran/cli.py,sha256=UGZ8LdqKPPDCLj9ZQenEJfUDeQAn_UHc0UdgObB-qyg,2615
|
|
4
|
+
leanfran/embed.py,sha256=hyUcRwhw2tTFQUYRW1F85wPi6Lpnb6Gyk9lxsBIzEps,4007
|
|
5
|
+
leanfran/io.py,sha256=Wlkt_h63RdVkQ_0_pdD8cHrQlS03T6YVW0f4DwZgcLQ,353
|
|
6
|
+
leanfran/io_externs.py,sha256=HDhVFIegH6H46utC16Q983A5ymCWWty7p6ulU8PJR6k,29804
|
|
7
|
+
leanfran/marshal.py,sha256=dX512Kwd76Qlk5d9ckL-S8xzqzj6i7EMQ4uOEdPyVqs,20878
|
|
8
|
+
leanfran/models.py,sha256=wunIZ9hOG-8H3shdRClLN7pR6Kmofo9zlPcL3Hr0rq0,10940
|
|
9
|
+
leanfran/runtime.py,sha256=nPC5aUKPX9WLF3VlYZdMRubVJkJ8eKh2vcWD8SwXQHo,28440
|
|
10
|
+
leanfran/sync.py,sha256=8fhXuwb_trxxFFiv2JL42C_pnYooFHGFDGwx9DH_HQA,9328
|
|
11
|
+
leanfran/translate.py,sha256=F0kmQONpg8EkLA4QOMi8pwaXQLnQ_MtvlUjLWvow8yc,20591
|
|
12
|
+
leanfran/types.py,sha256=qOhcwe1lYGD17OHW_A4LzfGi2bcPovTANTggaJwG-FM,843
|
|
13
|
+
leanfran/verify.py,sha256=tspHs8DPDOQLc2FU0wQoye-6wk9y3A9LkPdUKD-k3EQ,5526
|
|
14
|
+
leanfran/lean/LeanPythonLib/Py.lean,sha256=jAcU2Ad7uNZd5AyqTUTHg1GYGp9UGyATS_OgX8RWPRs,1659
|
|
15
|
+
leanfran-0.6.0.dist-info/METADATA,sha256=mCEzlZMZCqTC1bqkBw4EU47BZKtW97BzYjFn29AOVlc,17633
|
|
16
|
+
leanfran-0.6.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
|
|
17
|
+
leanfran-0.6.0.dist-info/entry_points.txt,sha256=COcWaxUSDdywOfyCH1MtwNxaj7XDfVni1GsS3rKL5c4,47
|
|
18
|
+
leanfran-0.6.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
|
|
19
|
+
leanfran-0.6.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|