lanky
Python for math you can check.
A lanky file is ordinary Python. The claims live in the annotations, the bodies run, and one command tells you which claims are proved, which are decided, which are only tested, and which nobody could establish.
from lanky import theorem
from lanky.prelude import Fin, Fn, Nat
@theorem
def scan_monotone(
n: Nat,
cnt: Fn[Fin[n], Nat],
off: Fn[Fin[n + 1], Nat],
h0: off(0) == 0,
hs: all(off(r + 1) == off(r) + cnt(r) for r in Fin[n]),
) -> all(off(a) <= off(b) for a in Fin[n + 1] for b in Fin[n + 1] if a <= b):
"""The offsets of an exclusive scan over counts are monotone."""
Parameters annotated with sorts are the variables, parameters annotated with
propositions are the hypotheses, and the return annotation is the goal. There is
no new syntax and no parser: lanky evaluates the annotations, and == inside one
builds a proposition instead of answering a bool.
Three commands, all of them working today:
$ python examples/gauss.py # theorems run as property tests
$ pytest examples/gauss.py # the same theorems, collected as test items
$ lanky check examples/gauss.py # the ledger: every claim and who decided it
STATUS EFFECTIVE BY WHERE OWNER STATEMENT
------ --------- ------------- ----------- ------------- ---------------------------------
tested tested property-test gauss.py:31 gauss n : Nat |- 2*sum(i for i in Fi...
tested tested python gauss.py:31 gauss the term computes what the ann...
proved tested lean gauss.py:39 scan_monotone n : Nat, cnt : Fn[Fin(n), Nat]...
tested tested python gauss.py:39 scan_monotone the term computes what the ann...
4 facts: 1 proved, 3 tested
(Abridged: the statement column is trimmed here to fit the page, and this run
is on a machine with the lean extra installed. CI runs it on one too, and
checks this table against what it prints.
docs/quickstart.md
has the untrimmed table.)
The third row is what the project is for: scan_monotone is proved by Lean.
Under each claim is its reading. lanky reads an annotation by running it on
symbolic terms, and every oracle is handed the term that run builds, so a proof
is a proof of the term. To check that the term is what was written, the
annotations are run again as plain Python at drawn values and the term is
evaluated at the same values: tested python says they agreed at every draw.
The proof rests on that check, so the EFFECTIVE column says what it is worth,
tested. The same file, on a machine without Lean, reads tested property-test and exits 0 just the same: the status column says how strongly
each fact is established, and the EFFECTIVE column, there only when some fact
is worth less than its status, what it is worth.
What nothing else does
-
One ledger for evidence of every strength. A random-draw pass, an isl decision and a Lean proof are all facts in one table, each with a status, a decider, a provenance and a source location. Property-testing tools give you the first, SMT wrappers the second, proof assistants the third, and none of them will tell you, for one file, which is which. A fact can rest on others, and is worth no more than they are: a proof from a cited axiom reads
proved underthat axiom, and is worth what the axiom is. -
Statements are the signature. A theorem is a typed Python function. It imports, it is callable, it is collected by pytest, and it is readable by someone who has never seen a proof assistant.
-
A refutation is a witness, not a verdict.
REFUTEDcarries the counterexample, the offending point, or the pair of statement instances that makes an ordering wrong. So does the exception a caller sees. -
A thin host with real plugins. lanky knows nothing about arrays or loops. Its sister project loopty plugs in a theory of loop kernels, an isl oracle, a loopy executor and a
runverb, and thenlanky checkdecides in-bounds and disjointness obligations for a sparse matrix-vector product, and an illegal loop tiling is refused withtile(t,i,8,8) illegal: instance S0[t=0, i=8] writes u[1, 8] read by S0[t=1, i=7] scheduled earlier
(one line in the terminal, wrapped here)
lanky never imports loopty. It finds it through entry points and asks it what it can do.
examples/pytential_skie.pyis a second consumer in miniature: a rule engine decides, under eight cited axioms, which of five integral representations give a boundary equation of the second kind. Andexamples/sumpy_recurrence.pyis a third: sumpy's compressed Taylor wrangler for the 2-D Laplace kernel claims that its recurrence reconstructs every derivative, and the ledger has the claimtestedby mpmath anddecided (heuristic)by sympy through order 6, and, with Mathlib,proved under harmonicby Lean for every order, the kernel's harmonicityassumedon its citation.
Status
This is 0.2.0. The core works; the edges are sharp. New in 0.2.0, each claim's
reading is checked: the annotations are run again as Python at drawn points and
the term the oracles prove has to agree there, so a misreading is refuted
rather than proved, and a proof is worth tested, the strength of that check.
Below is what works, what works in part and what does not work yet, and after
it, under Known limits, what the check cannot see and the open issues you are
most likely to meet, each with what to do about it: read that before you rely
on a proof. CI runs the suite on every change, without Lean on Python 3.12 and
3.13 and with Lean v4.29.1, and holds the tables on this page and in the
quickstart to what lanky check prints. Until 1.0 an interface a plugin uses
can change in a minor release; the CHANGELOG says when one does, and loopty
raises its floor to match.
Works.
lanky check FILE... [--json OUT] [--verbose], exit code 1 on any refutation or vacuous claim. Each refuted fact is repeated under the table with its counterexample, its witness and its reason, the three standard provenance keys, read the same way whichever oracle or plugin refuted it; or withno witness recordedwhen it carries none of them. Each axiom is named under the table in aCITEDline with its citation, and a fact leftassumedthat an oracle looked at and declined, saying why, in aDECLINEDline with the reason it gave asdeclined, a standard provenance key too; neither changes the exit code. A statement that mentions a name nothing in it binds, a misspelt parameter or sort, gets one from the property tester, which names the name and draws nothing. Two claims with one fact id, which a factory gives the claims it makes since an id names a definition, fail the check: the first is checked and the others are named in aDUPLICATEblock, unchecked, rather than one silently replacing another. Files from different source roots are checked in a process per root, so two directories that each hold ahelpers.pyare each checked against their own.@theorem: statement from the signature,.statement,.term,.fact(),.test(),.report(),.lean(); callable on concrete values.@axiom(cite=...): a statement written like a theorem and taken on a citation. Its fact isassumed (axiom), with the citation in its provenance; no oracle is asked to establish it, and the property tester still looks for a counterexample, so an axiom copied down wrong is refuted (and one whose hypotheses nothing satisfies is caught as vacuous).- The reading of every claim is checked (#91). lanky reads an annotation by
running its Python on symbolic terms, and the oracles are handed the term
that run builds. Each theorem and axiom gets a second fact, of kind
faithfuland statementthe term computes what the annotations compute: the annotations are run again as plain Python at drawn values, six draws of small values and domain ends, one at each integer written in the claim or in a helper it calls and next to it, and then 32 of the property tester's, the term is evaluated at the same values, and the two have to agree. The annotations run again in a copy of the module taken just before the claim was read, its tables and arrays included, so a table the module changes after the claim is read as it was, and each draw starts from that copy. Both readings read the connectives and the quantifiers three-valued, as lanky does, so a point where both have no answer does not keep the points after it from being compared. A disagreement refutes the reading, with the draw, the annotation as written and both answers, and the claim is offered to no oracle and fails the check: a hash, a text,is, an attribute or a comparison of types that answered from the term object, in the annotation or in a helper or a library it calls, is refuted at a point instead of proved. Every pass, decision and proof of a claim rests on its reading, so a proof is worthtestedin theEFFECTIVEcolumn, andproved under faithful:namewhere the reading could not be run at a point, with the reason in aDECLINEDline. The pytest plugin fails a theorem whose reading is refuted. - Facts rest on facts.
@theorem(uses=[...])names the theorems, axioms or fact ids a theorem rests on, and a plugin setsFact.rests_onon the facts it builds. The ledger reads the graph: a row says what it is established under (tested under nicomachus), and anEFFECTIVEcolumn gives the weakest status over everything a fact rests on whenever that is weaker than its own.--jsoncarriesrests_on,effective,effective_heuristicandunder. An id no fact in the ledger has counts as an assumption, andlanky checknames it under the table. An id names a definition by the module its file's path gives it under its source root,theorem:helpers.lemma@12, and not by the name the module was imported under, so a theorem has the same id in its own file's ledger and in therests_onof a file that imports it. A plugin keys its facts the same way, withlanky.ledger.fact_idandlanky.check.module_name.examples/nicomachus.pyis the worked case. @rewrite: a transformation as a claim. A function of no arguments returns(source, target),obligation=names what has to hold between them, and the fact readssource ~> target (obligation), with aRewriteTermfor an oracle that knows the obligation to decide. A plugin builds the same shape withlanky.rewrites.rewrite_fact, and a subclass ofRewritecan claim more about its target.examples/pytential_skie.pyis the worked case.- Trust classes, strongest first:
kernel,decision-procedure,heuristic,test. A decider complete for the fragment it accepts is a decision procedure; one that can fail to answer inside it, or whose answers are not guaranteed, such as a simplifier, is aheuristic. The table marks a fact one decideddecided (heuristic), and a counterexample the property tester finds overrules it. What rests on such a fact is worthdecided (heuristic)at most, in theEFFECTIVEcolumn and aseffective_heuristicin the JSON. The oracle that settles a fact leaves its trust class in the provenance. - The CAS oracle,
cas, aheuristic, where sympy is installed (thecasextra). It decides a statement that asserts equations, alone, in a conjunction or under universals over numbers, with sides built from arithmetic,abs,exp,logandsqrt, whensympy.simplifytakes the difference of the sides of every equation to0, and it declines everything else, a difference left over included, with the reason: what sympy cannot simplify away is no counterexample, and the property tester is asked next. A variable is a symbol with what its sort grants, sosqrt(x**2) == abs(x)is decided for a realxand declined for a complex one, and the hypotheses are not read.lanky.casis the bridge, both ways, and refuses what it cannot translate faithfully: a family, a reduction, a floor division, a variable whose sort is not a set of numbers, a reallogorsqrtof what sympy cannot show is not negative, where sympy's value is complex and Python'smathraises. sympy is imported on the first fact, never with lanky; before its deadline the oracle reads only a statement's shape, and it translates the statement within it. - The ledger: six statuses, provenance, JSON, a rendered table.
- The prelude:
Nat,Int,Real,Complex,Bool,Prop,Fin[n],Fn[A, B], refinement byT & prop, the sumFin[n] + Fin[m]of index types (carried for plugins, not yet a binder domain), exactness classes; andlanky.exp,lanky.logandlanky.sqrt, which build a term from a term, and from a number in an annotation, so thatexp(1)there iseto every oracle and not the float nearest it, and aremath's (orcmath's) functions at a number anywhere else: in the file run as a program, and in a function an annotation calls. Python'sabsof a term is lanky'sAbs, so a comparison of it is a proposition. - Property testing, including satisfying a definitional hypothesis by
construction rather than rejection sampling, so a theorem about a scan is
genuinely tested and not vacuously passed. A synthesized value has to land
inside the family's codomain, so an unsatisfiable definition drops the draw
rather than putting a point outside its sort into it. A pass over zero valid
draws is never reported as
TESTED: the fact staysASSUMEDand its provenance saysuntestedand why. The reals are read exactly, as Lean reads them:RealandComplexare drawn as fractions whatever their exactness class, andexp,logandsqrtare enclosed in intervals where their values are not rational (src/lanky/intervals.py), so a claim is refuted only where the enclosures exclude it. - Refusing the ways a statement can silently mean something other than what was
written: a guard joined with Python's
or, anandororused as a value, anotin a guard, anifstatement inside a function an annotation calls, and a symbolic guard over a concrete domain (if n > 100in a sum overFin[3]), which a walk of the domain would drop; a body that is a term there is kept,allandanyof it being the conjunction and the disjunction of its values at the points. The connectives are&,|and~. Only a generator'sifclause records a guard: a conditional expression (a if i < 3 else b), anotin a body and a comparison of two tuples or lists, which compares their items, are refused inside a quantifier, where each used to be read as its guard. A builtin of Python's in an annotation is Python's at concrete arguments (round(0.5)is0, andcomplex(-1, -0.0)keeps its negative zero) and refused at a variable, naming it (min(x, y)), where it used to be a free name; so is a truth value a builtin asks for inside a quantifier (min(i, j),i in range(3)), which used to be recorded as the quantifier's guard, and a symbolic domainziporenumeratewalks. A theorem refuses a parameter annotated with a builtin type,x: int, or naming one anywhere in its annotation,f: Fn[Fin[n], float], and names the sort meant. A term is no key of a dict and no member of a set in an annotation:{0: 1}.get(i, 0)andi in {0, 1}are refused, where the lookup answered from the term's hash as if the key were absent and Lean proved what that left. Nor is a term text,f"{i}", or a truth value,1 if i else 0, which answered the same at every value; compare it instead,i != 0. - One reading of arithmetic for every oracle.
Natmeans an integer that is not negative, and the Lean printer says so: a natural is anIntwith0 ≤ nas a hypothesis, and//and%areInt.fdivandInt.fmod, which round the way Python's do. What Lean proves is what the property tester tests, so a claim is refuted, or not, whether or not Lean is installed:n - 1 >= 0overNatis refuted everywhere, andn - 1 <= nis still proved where Lean is. A comparison with no variable in it, which only a plugin builds, is ascribedIntas well. AFractionis a number like anint:x ** Fraction(1, 3)is a cube root, and not a power to the float nearest a third. Every declaration Lean is sent is elaborated withautoImplicitoff, so a name its signature does not bind is an unknown identifier to Lean and never a variable Lean picks a type for. - Vacuous claims are caught. When no draw satisfies a fact's hypotheses, the
stronger oracles are asked whether the hypotheses alone prove
False. If one does, the row readsproved (vacuous)andlanky checkexits 1: the claim is true and says nothing, which is usually a mistake in the hypotheses. If none can, a warning says the hypotheses were never satisfied. A goal whose own guard never holds, a flipped or off-by-one generator guard, is caught the same way: when no draw gets through the goal quantifier's guard, the stronger oracles are asked whether it is empty wherever the hypotheses hold, and a guard empty only for some values, asFin[n]is atn = 0, is never flagged. - A statement the annotation already answered is a claim like any other:
-> 1 == 2isrefuted,lanky checkprints why under the table, and it exits 1 on it. - The Lean oracle over core Lean 4, with a tactic ladder and an induction
strategy read off the term. No Mathlib is fetched or needed. CI runs the
suite against Lean v4.29.1 as well as without Lean. A name Python accepts
and Lean reserves, a variable
funor a theoremscoped, is printed quoted («fun»). A theorem is declared asLanky.<name>, so a claim named like a core declaration (and_comm,id,trivial) is not refused as already declared; a variable named like a root name the printer writes (Int,Nat,Bool,Finset) has those printed_root_.Intin its statement; and a variable namedrflor_, whichintroandrcasesread as patterns, is introduced under a fresh name. A statement that mentions a name nothing in it binds is declined, naming it: Lean would read the name as its own declaration of it, Mathlib'sroundfor Python's, or bind it implicitly at a type of its own choosing, and prove another statement. An existential's conditions are conjuncts, so a disjunction among them is bracketed, as Python groups it. An attempt that runs pastLANKY_LEAN_TIMEOUTcosts that attempt alone: the REPL the driver killed is started again for the next. The ladder as a whole has a budget per fact,LANKY_LEAN_BUDGET(120 s), and a smaller one for the questions whether a fact is vacuous,LANKY_LEAN_VACUITY_BUDGET(30 s), which also leave out the attempts that cannot showFalse; the search for an induction's certificates counts against it, and a fact whose budget runs out says after how many attempts. And a REPL ends with the process that started it, however that process ends, aSIGKILLincluded: a small reaper process per lanky process kills it when the pipe from lanky closes, and Ctrl-C during an attempt stops it at once. - Mathlib mode, opt-in:
LANKY_LEAN_MATHLIBnames a Lake project with Mathlib fetched, andpython -m lanky.mathlib DIRsets one up from the project lanky ships, pinned to Mathlib v4.29.1 and every dependency at a commit. The oracle imports Mathlib once and prints statements overRealandComplex(ℝandℂ), sums (∑overFinset.Ico), absolute values, true division, floats as the rationals Python holds, andexp,logandsqrt(Real.expand the rest, andComplex.exp,Complex.logandComplex.sqrt). A complexlogorsqrtis Python's principal branch off its branch cut and not on it, so Lean proves a statement that takes one only after it proves that every argument stays off the cut (#59). The ladder goes on tonorm_num,positivity,ring,field_simp,linarithandnlinarith, and to an induction for a sum whose bound a natural parameter sets, so Gauss's sum inexamples/gauss.pyreadsproved lean. With the variable unset, the oracle is the core one, exactly. docs/quickstart.md walks through it. - Induction over families, in Mathlib mode: a claim about every order, a
universal over naturals whose body is an equation between applications of
the statement's families, is proved by strong induction on the order, and
each case is closed by
linear_combinationover the hypotheses and the induction hypothesis, normalized byring, or byfield_simpandring. Python finds the combination (lanky.induction, with sympy, thecasextra): which hypothesis to use at which point, and the multipliers, which may be expressions in the statement's other variables; Lean checks it.lanky.oracles.lean.use_certificateis the hook through which a plugin hands over multipliers of its own, andlanky.oracles.lean.declineleaves a claim to the oracles after Lean, saying why. The sumpy demonstration's claim for every order is proved this way. - Plugin discovery by entry point, and
lanky <verb>from the registry. - The pytest plugin.
Partial.
- The property tester satisfies hypotheses of the shape
f(i) == eby assignment and rejection-samples everything else, so an awkward hypothesis can end with no valid draws. The fact is thenASSUMED, never falselyTESTED. - Division by zero is the one place the readings part. Lean's division is
total, so
n // 0 == 0is a theorem there and aZeroDivisionErrorin Python; the fact carries a note, the ledger says what the sampled reading could not do, and the exit code stays 0. Seesrc/lanky/semantics.py. - Vacuity is found by sampling first, and sampling cannot tell hypotheses that
hold nowhere from hypotheses that hold only where it does not look
(
n == 1000, with naturals drawn up to five). Both get the warning until an oracle proves the hypotheses inconsistent; without one, a vacuous claim warns and does not fail the check. A statement over a sort the tester cannot draw, such as a family overNat, gets no warning, because no draw reached its hypotheses. A goal's guard is read the same way, and only the goal's outermost quantifier is: a guard nested deeper in the goal is not examined. That holds for a theorem with no parameters as well, whose goal is a goal and has no hypotheses to be mistaken for. - Python's
andbetween two propositions in a generator'sifclause happens to produce the conjunction that was written, because of how CPython compiles a comprehension filter, so it is not refused. It cannot be told apart from twoifclauses in the bytecode. Write&. - The Lean induction strategy is a shape matcher, not proof search. A statement
needing a different induction or a lemma falls through to the tester;
lanky.oracles.lean.use_tacticpins a script by hand. The induction over families searches, but only for a linear combination: a step that needs a hypothesis used other than as an equation to combine, an inequality, or an instance whose guards are not linear arithmetic over the integers is not found, nor is a base case that holds only because the goal's own guard excludes it (all(f(n) == n for n in Nat if n >= 1), whose order 0 is no equation to combine). A function Mathlib does not have, a Bessel or Hankel function, has no form yet in which its recurrence is declared and a proof rests on it (#82). - The Lean printer covers core Lean:
Sum,Abs,Real, true division and an exponent that could be negative raise rather than emit source Lean would reject. In Mathlib mode all but the last are printed, and what is still declined is a sum overNat, aFinwith a real bound, a floor division or a remainder of a real, an order between complex numbers, and a complex logarithm or square root that Lean cannot show stays off its branch cut: each would be printed with a meaning Python does not give it. Showing that takes the hypotheses and guards around the argument and two cheap attempts, soexp(log(z)) == zfor a nonzeroz, true on both sides of the cut, is declined all the same. - Over
RealandComplexthe tester's enclosures decide less than Lean does. Two enclosures can never show two transcendental numbers equal, so an equality counts as holding where the statement asserts it and its two sides agree to 64 bits:exp(x + y) == exp(x) * exp(y)istested, as a sampled universal is, on evidence. Under a negation, in a hypothesis, or as a value, the same agreement decides nothing, and neither does an order whose enclosures overlap, such asexp(x) * exp(-x) <= 1at anyxbut0. Its pass rests on the draws atx = 0alone, and says so: the row readstested, and aWARNINGunder the table says that the pass rests on thin evidence. A complexlogandsqrtare Python's principal branches, enclosed off their branch cut, the non-positive real axis, where Python picks a side by the sign of a zero, which an exact number does not have. On the cut, and at anexpof an argument past2**14, the draw is left undecided. A negative number to a power that is not an integer is Python's complex principal value, enclosed part by part, so(x ** 3) ** Fraction(1, 3) == xis refuted atx = -1. Where Lean is total and Python raises (a division by zero, the logarithm of zero, the square root of a negative number), the fact carries a note in Mathlib mode, as an integer division by zero does in either mode. - A family prints as a total function, so every application of one has to be shown in bounds before the statement can go to Lean. The check is affine arithmetic over the enclosing binders, not a solver, so an argument it cannot settle is declined rather than assumed: the statement falls through to the tester, which is a proof fewer and never a proof too many.
- Sampling quantifiers over
Natdraws a handful of points. That is evidence of the weakest kind and the ledger says so. A sampled quantifier can be refuted but never confirmed: aforallthat a draw breaks is really false, and ananythat a draw witnesses really true, but ananythat no draw witnesses is undecided, not false, and aforallthat holds at every draw counts as evidence only where the statement asserts it. Under~, in a hypothesis or the guard of anall, and inside a sum or a comparison it is undecided, and so is aforallwhose guard or refinement no draw passes, and a sum over draws ofNat. The tester declines such a draw and, when no draw decides the statement, the fact staysASSUMEDwith the reason. A declined draw is replaced by another, so a pass counts only the draws it could decide; when those are outnumbered by the declined ones, or take fewer than three distinct assignments when the draws, decided or not, took more, the pass staystestedand gets areason, printed under the table as aWARNING. OverFinthe domain is enumerated and both answers hold. The connectives are three-valued: an operand the draws leave open does not decide&or|, and a false conjunct or a true disjunct settles it however the operands are ordered. So are the quantifiers, anallbeing the conjunction of its points and ananytheir disjunction: a point the draws leave open, or whose guard has no answer, does not end the walk, andall(p(i) for i in Fin[2])reads asp(0) & p(1)does. A refinement is read as the hypothesis it is, so one that quantifies overNatrejects a draw that breaks it and leaves one it held at undecided. A quantifier over a refined domainT & p, which a plugin building terms by hand can write, ranges over the points ofTwherepholds, as the Lean printer reads it: enumerated whenTis, filtered draws when it is sampled.
Not yet.
CERTIFIED. The Lean source and the tactic script are in provenance; nothing replays them under a checker yet.- Real analysis beyond what the ladder finds: Mathlib mode states it, and the
ladder is a fixed set of tactics, not proof search, so a statement that needs
a lemma by name falls through to the tester (
use_tacticpins a script). - A proof scripting surface: today a proof is a tactic ladder lanky drives, not a Python program over a live goal.
Known limits
An annotation is traced Python: lanky runs it on symbolic terms, and the claim
the oracles are handed is the term that run builds. Python that answers from
the term object instead of through its overloads, is, an attribute, or a
hash or a truth value asked for inside a helper, gives the same answer at every
value, and the term then says something other than what was written. lanky
refuses the cases it can see while it reads, and checks the rest by their
results: each claim's faithful fact runs the annotations again as plain
Python at about forty drawn points, in a copy of the module taken just before
the claim was read, and the term has to compute the same at each. A
disagreement refutes the reading, and no oracle is asked about the claim.
The check is sampled, as the property tester is: small values and a domain's
ends, each integer the claim or a helper it calls writes and its neighbours,
and 32 of the tester's draws. A misreading only at a point none of them
reaches is not seen, which is why a proof is worth tested in the EFFECTIVE
column. It runs your helpers at every draw: a change they make to the
module's data is made to the copy, but a side effect outside the module, a
file written or a line printed, happens at every draw. And a claim it cannot
run at a point keeps an assumed reading, so a proof of it reads proved under faithful:name, with the reason in a DECLINED line: a variable of a
sort no value can be drawn of, an annotation Python evaluated when the
function was defined (add from __future__ import annotations), or what the
copy cannot hold as it was, such as an instance of a class of yours.
The open issues you are most likely to meet:
- Calling a theorem does not check its reading
(#96).
gauss(n=4),gauss.report()andgauss.test(), and sopython examples/gauss.py, evaluate the term, even where the reading is refuted. Uselanky checkorpytest, which make the check, or callgauss.faithful_fact(). math.floorof a variable fails while the file is read (#112).math.floor(x) >= x - 1raises pymbolic'sUnknownVariableError: x, andlanky checkreports a file that does not import; so does anymathfunction of a variable, since it asks the term for a float. Write the floor as a term,x // 1, and uselanky.exp,lanky.logandlanky.sqrtfor those three.minandmaxof a variable are refused (#66), with aTypeErrorthat names the call. State the claim once per case: under a hypothesisx <= y, withxwritten formin(x, y), and undery < x, withy.- A claim about a family over
Natis not tested (#98). The property tester cannot tabulateFn[Nat, Nat], so without Lean such a claim readsassumed, andpytestskips it. Give the family a bounded domain with a size parameter,n: Nat, a: Fn[Fin[n + 1], Nat], and it is drawn. - A long step in C, or in a library, holds the check up
(#108). Each draw has five
seconds, and a function of yours is stopped at its next call or turn of a
loop once they are spent. One step Python takes in C,
sum(range(10 ** n))or2 ** 2 ** ninside a helper, and a library's own code are not: they run to their end. Keep such work out of the helpers a claim calls, or cheap at the values drawn, which include each integer the claim writes. - An installed package's state is read as it is at the check
(#104). The copy holds your
modules, the claim's and those under its source root. A helper from an
installed package, one installed editable from elsewhere included, reads
its package's tables as they are when the check runs, and so does code that
reaches a module through
sys.modulesorimportlib, so a table changed after the claim can hide a misreading. Keep the data a claim's helpers read in a module beside the claim. - After a helper's operation with no value, the rest of that annotation is
not compared at that draw
(#107). Where both readings
have no value, the draw is read again with Lean's values for Python's
errors,
x // 0as0and so on, but only for the operators the annotation itself writes: a helper's own1 // 0, or an overflow anywhere, still ends the comparison there. Write such an operation in the annotation rather than in a helper. - On Windows, which CI does not run, a check of several source roots can
leave processes behind.
lanky checkruns one child process per source root. On Windows a child is not stopped when the command is killed, an interrupted child leaves its Lean REPL running (#48), and a background process a checked file starts holds the command up until it ends (#47). Check the files of one source root per command, which runs no child process.
Install
pip install lanky
lanky needs Python 3.12 or later. In a uv project, uv add lanky, and the
same for the extras below. The examples and the quickstart are in the
repository and not in the package; clone it to follow them.
The CAS oracle is an extra, which installs sympy:
pip install "lanky[cas]"
Where sympy imports, the oracle is on: an identity sympy simplifies reads
decided (heuristic) cas rather than tested property-test.
LANKY_CAS_DISABLE=1 turns it off, and LANKY_CAS_TIMEOUT caps the seconds
sympy may take over one fact (60), translating the statement and simplifying
it.
The Lean oracle is an extra, because it pulls a sizable dependency tree and needs
a Lean toolchain on PATH:
pip install "lanky[lean]"
Lean comes from elan, its toolchain manager
(installation).
The toolchain the oracle runs on has to be one the Lean REPL has a build for.
With lean-interact 0.11.5 that is a Lean release up to v4.32.0 (or
v4.33.0-rc1), which elan's current stable is not. Given a newer lean, the
oracle tries each other toolchain elan has installed, newest first, and then
the newest version the REPL has, which elan downloads when the REPL is first
built. CI uses v4.29.1:
elan toolchain install leanprover/lean4:v4.29.1
elan default leanprover/lean4:v4.29.1
Mathlib mode needs the same extra and toolchain, and a Lake project with Mathlib fetched, about 7 GB on disk. lanky ships the project, pinned, and one command writes it and fetches Mathlib:
python -m lanky.mathlib ~/mathlib # writes the pinned project, runs `lake exe cache get`
export LANKY_LEAN_MATHLIB=~/mathlib
The command never builds Mathlib from source; it fetches the compiled files
Mathlib publishes, keeping the packed downloads in MATHLIB_CACHE_DIR
(default ~/.cache/mathlib). The first session of a process imports Mathlib, which takes
seconds and about 1.5 GB of memory. The induction over families finds its
combinations with sympy, so a claim for every order wants both extras,
pip install "lanky[lean,cas]".
Without the extra, every Lean test skips with a one-line reason and the weaker
oracles do the work. lanky check --verbose prints each oracle and whether it
is available. The first use builds a Lean REPL, which takes about a minute and
the network, and caches it in $XDG_CACHE_HOME/lanky/lean-repl
(~/.cache/lanky by default), outside the virtual environment so that a
reinstall does not throw it away. Useful environment variables:
LANKY_LEAN_DISABLE=1 makes the oracle a declared no-op (the main CI job sets
it), LANKY_LEAN_VERSION pins a toolchain and skips the probe,
LANKY_LEAN_CACHE_DIR moves the cache, LANKY_LEAN_TIMEOUT caps each
tactic attempt (60 s), LANKY_LEAN_BUDGET the whole ladder of one fact
(120 s) and LANKY_LEAN_VACUITY_BUDGET that of a question whether a fact
is vacuous (30 s), 0 for no budget, LANKY_LEAN_MATHLIB turns Mathlib
mode on, and LANKY_LEAN_MATHLIB_IMPORT_TIMEOUT caps the Mathlib import
(600 s).
For work on lanky itself:
uv sync --group dev --extra lean --extra cas
uv run pytest -q
uv run ruff check .
The suite runs with the CAS oracle off, as it runs without Mathlib, and turns
it on in the tests that are about it, which skip without sympy.
tests/test_sumpy_recurrence.py skips without sumpy, which no extra
installs: uv pip install sumpy puts it in the environment.
CI runs the suite twice. The main job, on Python 3.12 and 3.13, installs no
Lean and sets LANKY_LEAN_DISABLE=1, so it sees what a user without the
extras sees. The job named test with Lean installs elan, Lean v4.29.1, the
lean and cas extras and sumpy, caches the toolchain and the built REPL
between runs, and runs the same suite with the Lean oracle on and
LANKY_LEAN_TEST_REQUIRED=1, under which a Lean test that cannot get a Lean
session fails instead of skipping. It then runs
lanky check examples/gauss.py and checks that the proved lean row at the top
of this page is a row the check printed. The suite compares the rest of that
table, and the quickstart's, with the real output in both jobs, reading the
row as tested property-test in the main one.
A third job, test with Lean and Mathlib, is optional: it may fail without
failing the run, since it depends on fetching Mathlib from outside GitHub. It
sets up the pinned project with python -m lanky.mathlib, caching Mathlib's
compiled files between runs, installs sumpy, runs tests/test_mathlib.py
and tests/test_sumpy_recurrence.py with the project required, and checks
that lanky check examples/gauss.py proves both rows and that the sumpy
demonstration's claim for every order is proved under harmonic.
The suite otherwise runs in core-Lean mode wherever it runs: it takes
LANKY_LEAN_MATHLIB out of its environment and hands it to the Mathlib tests
alone.
A file that carries statements needs from __future__ import annotations and a
ruff F821 per-file ignore, because a size such as n is a symbolic variable
lanky invents while evaluating the annotation and has no binding a static checker
can see.
Architecture
Four ideas, and everything else is one of them.
Terms. pymbolic is the expression language, the same one loopy uses, so a
statement and a generated kernel cannot drift apart in translation. lanky adds
Forall, Exists, Sum, Abs and Elementary (exp, log, sqrt) as
pymbolic subclasses, and comparison operators on them build propositions. The
property tester evaluates them in an exact reading of the reals, rationals and
interval enclosures (lanky.intervals), and the file run as a program
evaluates them as Python does.
Facts and the ledger. A Fact is a statement, a term, a status, a decider,
a provenance, a source location, and the ids of the facts it rests on. Status
is tested, decided, proved, certified, assumed, refuted. The ledger is the
output of a check and the thing a reviewer reads; it reads the facts' graph as
well, so a fact's status is shown with the assumptions it rests on and what it
is worth given them.
Four plugin interfaces. Theories turn decorated objects into facts.
Oracles establish facts and report a trust class. Executors run a decorated
object. Verbs are CLI subcommands. Each is an entry-point group:
lanky.theories, lanky.oracles, lanky.executors, lanky.verbs.
Oracles strongest first. Each plugin is installed once per name, so a
theory that arrives both in process and through an entry point does its work
once. Trust classes are ordered kernel (Lean) >
decision-procedure (isl) > heuristic (a simplifier: sympy, the cas
oracle) > test (property test). Each oracle answers
can_establish(fact); check_path offers each fact to the strongest one that
says yes and stops at the first answer. A fact nobody establishes is ASSUMED,
which is not a failure. An oracle that cannot answer declines, so a timeout is
never read as a counterexample. One that took a fact and found it outside what
it decides returns it unchanged with the reason as declined, and lanky check prints that under the table for a fact that stays ASSUMED.
Decorators are inert and registering: @theorem returns a callable object that
runs natively and puts itself in the registry. lanky check FILE imports the
file and reads the registry, keeping the claims defined in that file and none
from the modules it imports; lanky check a.py b.py checks both, each for its
own. A process imports a module of one name once, so files whose source roots
differ (the directories a check puts on sys.path: the file's own, and the one
its package is found from) are checked in child processes, one per root, while
files that share their roots share a process as they always did. A child runs
with the command's interpreter options (-O, -W, -X). On Linux and macOS
it is also sent SIGTERM when the command ends, however it ends, and kills
the Lean REPLs it started before it goes; and once it has exited, what it
wrote is copied and nothing a checked file left running holds the command up.
check_path, the function
underneath, imports into the process that calls it. No environment variable
changes what the code means.
Name
- "Lean Annotations Natively Kernel-check Your math".
- LANK + y, where LANK = Lean Annotations, Native Kernel, and lank means long and thin, next to lean.
Documentation
- docs/quickstart.md: the worked file, end to end, with the output the commands actually print, a second one with an axiom, the pytential demonstration, where a rule engine checks a derivation under the axioms it rests on, and the sumpy demonstration, where a recurrence is tested by mpmath and decided by sympy through an order, and proved by Lean with Mathlib for every order.
- CHANGELOG.md.
- loopty: the sister project and lanky's first plugin: a typed polyhedral layer over loopy, where the facts are about loop kernels and isl decides them.
AI disclosure
This project is developed with substantial assistance from AI coding agents (Anthropic's Claude, via Claude Code). Design, direction, and review are by Xiaoyu Wei. Generated text and code are reviewed before release, but readers should assume AI involvement throughout.
License
MIT. See LICENSE.
Metadata
Release files for lanky 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| lanky-0.2.0.tar.gz | 619.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| lanky-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 919.1 kB
Release files / lanky-0.2.0.tar.gz
| Download URL | lanky-0.2.0.tar.gz |
|---|---|
| Size | 619.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e5808681480755d11f04cadc53102df087c1c1eb6cd51e4ddfb5c60876b67b6b
|
|
BLAKE2b-256 checksum How to use checksums |
c853bb361fc04c25c7a46a73c4388b06cf45426090cc29552b6ed52958af605c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.
Transparency logRelease files / lanky-0.2.0-py3-none-any.whl
| Download URL | lanky-0.2.0-py3-none-any.whl |
|---|---|
| Size | 300.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
86ece599e4495935c4e63cffa8df3aa4957742a26592b6c4273cf1a0c2a23e3b
|
|
BLAKE2b-256 checksum How to use checksums |
176886df23a9116062a1dddb6df863bb07ae326182bcf7d0549f4bef5c75c772
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.
Transparency log