machinechecked 0.1.0__py3-none-any.whl

prooflens/data/prooflens.sty

@@ -0,0 +1,75 @@
+% prooflens.sty -- records where every numbered claim of a paper is typeset.
+%
+% Loaded before \documentclass by `prooflens tex` (latexmk -usepretex), so the paper's source is
+% not modified. For every tracked environment it writes to \jobname.plx, one record per line:
+%
+%   paper <width> <height>                          page size in sp
+%   begin <id> <env> <line> <file>                  where the environment opens in the source
+%   prev <id> <label>                               \@currentlabel when it opens (a head number
+%                                                   equal to it was not stepped by the environment)
+%                                                   (the file with its path as \input gave it)
+%   number <id> <currentlabel>                      the number the environment received
+%   label <id> <name> <currentlabel>                every \label inside the environment
+%   pos <id> <begin|head|end> <page> <x> <y>        position at shipout, in sp from bottom left;
+%                                                   head is the baseline of the first line
+%
+% The environments tracked are \prooflensEnvs (a comma list), set by the caller before loading,
+% or the default list below. Requires pdfTeX or LuaTeX (\pdfsavepos) and LaTeX 2020-10 or later
+% (hooks, \CurrentFile, \ReadonlyShipoutCounter).
+\NeedsTeXFormat{LaTeX2e}[2020/10/01]
+\ProvidesPackage{prooflens}[2026/10/15 ProofLens claim anchors]
+
+\ifdefined\pdfsavepos\else
+  \ifdefined\savepos
+    \let\pdfsavepos\savepos \let\pdflastxpos\lastxpos \let\pdflastypos\lastypos
+  \fi
+\fi
+
+\ifdefined\prooflensEnvs\else
+  \def\prooflensEnvs{theorem,lemma,proposition,corollary,definition,assumption,remark,%
+    example,conjecture,claim,hypothesis,convention}
+\fi
+
+\newwrite\plx@out
+\newcount\plx@id
+\def\plx@cur{0}
+
+\AddToHook{begindocument/end}{%
+  \immediate\openout\plx@out=\jobname.plx\relax
+  \immediate\write\plx@out{paper \the\paperwidth\space\the\paperheight}}
+\AddToHook{enddocument/end}{\immediate\closeout\plx@out}
+
+% A position record, written at shipout so that the page and coordinates are final.
+\def\plx@pos#1{%
+  \edef\plx@tmp{\noexpand\write\plx@out{pos \plx@cur\space #1
+    \noexpand\the\noexpand\ReadonlyShipoutCounter\space
+    \noexpand\the\noexpand\pdflastxpos\space\noexpand\the\noexpand\pdflastypos}}%
+  \pdfsavepos\plx@tmp}
+
+\def\plx@begin#1{%
+  \global\advance\plx@id\@ne
+  \edef\plx@cur{\the\plx@id}%
+  \immediate\write\plx@out{begin \plx@cur\space #1 \the\inputlineno\space\CurrentFilePath\ifx\CurrentFilePath\@empty\else/\fi\CurrentFile}%
+  \protected@edef\plx@tmp{\@currentlabel}%
+  \immediate\write\plx@out{prev \plx@cur\space\detokenize\expandafter{\plx@tmp}}%
+  \plx@pos{begin}%
+  % The number is \@currentlabel when the first paragraph of the environment (its head) starts.
+  \AddToHookNext{para/begin}{%
+    \plx@pos{head}%
+    \protected@edef\plx@tmp{\@currentlabel}%
+    \immediate\write\plx@out{number \plx@cur\space\detokenize\expandafter{\plx@tmp}}}%
+  \let\plx@savedlabel\label
+  \def\label##1{%
+    \protected@edef\plx@tmp{\@currentlabel}%
+    \immediate\write\plx@out{label \plx@cur\space\detokenize{##1} \detokenize\expandafter{\plx@tmp}}%
+    \plx@savedlabel{##1}}}
+
+\def\plx@end{\plx@pos{end}}
+
+\@for\plx@env:=\prooflensEnvs\do{%
+  \edef\plx@tmp{%
+    \noexpand\AddToHook{env/\plx@env/begin}{\noexpand\plx@begin{\plx@env}}%
+    \noexpand\AddToHook{env/\plx@env/end}{\noexpand\plx@end}}%
+  \plx@tmp}
+
+\endinput

prooflens/data/schema/evidence.schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/cgarryZA/ProofLens/schema/evidence.schema.json",
+  "title": "ProofLens evidence record",
+  "type": "object",
+  "required": ["id", "created", "body"],
+  "properties": {
+    "id": {"type": "string", "pattern": "^[0-9a-f]{64}$"},
+    "created": {"type": "string"},
+    "body": {
+      "type": "object",
+      "required": ["schema", "provenance", "inventory", "reviews", "lean", "tex", "assessment"],
+      "properties": {
+        "schema": {"const": "prooflens/evidence@0"},
+        "provenance": {"type": "object", "required": ["tool", "project", "papers"]},
+        "inventory": {"type": "object", "required": ["claims"]},
+        "reviews": {"type": "object", "required": ["files", "records"]},
+        "lean": {"type": ["object", "null"]},
+        "tex": {"type": "object"},
+        "assessment": {"type": "object", "required": ["claims", "findings"]}
+      }
+    }
+  }
+}

prooflens/data/schema/inventory.schema.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/cgarryZA/ProofLens/schema/inventory.schema.json",
+  "title": "ProofLens claim inventory",
+  "description": "Every claim of the papers, with its scope and, for a formal claim, the clauses mapped to Lean declarations.",
+  "type": "object",
+  "required": ["claims"],
+  "properties": {
+    "note": {"type": "string"},
+    "papers": {"type": "object"},
+    "claims": {"type": "array", "items": {"$ref": "#/$defs/claim"}}
+  },
+  "$defs": {
+    "scope": {"enum": ["formal", "definition", "expository", "literature", "empirical",
+                       "proof-step", "part-of", "duplicate"]},
+    "claim": {
+      "type": "object",
+      "required": ["id", "paper", "scope", "clauses"],
+      "properties": {
+        "id": {"type": "string", "pattern": "^[A-Za-z0-9]+:.+$"},
+        "paper": {"type": "string"},
+        "commit": {"type": ["string", "null"]},
+        "kind": {"type": "string"},
+        "number": {"type": "string"},
+        "title": {"type": "string"},
+        "label": {"type": ["string", "null"]},
+        "location": {"type": ["string", "null"]},
+        "source_sha256": {"type": ["string", "null"], "pattern": "^[0-9a-f]{64}$"},
+        "scope": {"$ref": "#/$defs/scope"},
+        "scope_note": {"type": "string"},
+        "scope_reviewed": {"type": "boolean"},
+        "clauses": {"type": "array", "items": {"$ref": "#/$defs/clause"}}
+      }
+    },
+    "clause": {
+      "type": "object",
+      "required": ["name"],
+      "properties": {
+        "name": {"type": "string"},
+        "spec": {"type": ["string", "null"]},
+        "accept": {"type": ["string", "null"]},
+        "refute": {"type": ["string", "null"]},
+        "corrects": {"type": ["string", "null"]},
+        "witness": {"type": ["string", "null"]},
+        "defs": {"type": "array", "items": {"type": "string"}},
+        "regimes": {"type": "array", "items": {
+          "type": "object", "required": ["name"],
+          "properties": {"name": {"type": "string"}, "description": {"type": "string"},
+                         "witness": {"type": ["string", "null"]}}}}
+      },
+      "not": {"required": ["accept", "refute"],
+              "properties": {"accept": {"type": "string"}, "refute": {"type": "string"}}}
+    }
+  }
+}

prooflens/data/schema/manifest-claim.schema.json

@@ -0,0 +1,126 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/cgarryZA/ProofLens/schema/manifest-claim.schema.json",
+  "title": "ProofLens claim passport",
+  "type": "object",
+  "required": [
+    "schema",
+    "release",
+    "id",
+    "paper",
+    "status",
+    "clauses",
+    "findings",
+    "decls"
+  ],
+  "properties": {
+    "schema": {
+      "const": "prooflens/manifest@0"
+    },
+    "release": {
+      "type": "string"
+    },
+    "id": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string"
+    },
+    "statement_tex": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "clauses": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "name",
+          "state",
+          "ladder"
+        ],
+        "properties": {
+          "state": {
+            "enum": [
+              "unspecified",
+              "unchecked",
+              "open",
+              "proved",
+              "refuted",
+              "malformed",
+              "stated"
+            ]
+          },
+          "ladder": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "rung",
+                "state"
+              ],
+              "properties": {
+                "state": {
+                  "enum": [
+                    "pass",
+                    "fail",
+                    "open",
+                    "author",
+                    "none",
+                    "n/a",
+                    "pdf-only",
+                    "not-run",
+                    "unverified"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "findings": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/finding"
+      }
+    },
+    "decls": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string",
+        "pattern": "^[0-9a-f]{24}$"
+      },
+      "description": "Each declaration of the claim's closures, by name, with the key of its record data/decls/<key>.json (the first 24 hex digits of the SHA-256 of the record)"
+    },
+    "blockers": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "$defs": {
+    "finding": {
+      "type": "object",
+      "required": [
+        "id",
+        "tier",
+        "code",
+        "subject",
+        "message"
+      ],
+      "properties": {
+        "tier": {
+          "enum": [
+            "violation",
+            "warning",
+            "obligation"
+          ]
+        }
+      }
+    }
+  }
+}

prooflens/data/schema/manifest-index.schema.json

@@ -0,0 +1,128 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/cgarryZA/ProofLens/schema/manifest-index.schema.json",
+  "title": "ProofLens manifest index",
+  "type": "object",
+  "required": [
+    "schema",
+    "release",
+    "evidence",
+    "papers",
+    "claims",
+    "summary",
+    "classes",
+    "findings"
+  ],
+  "properties": {
+    "schema": {
+      "const": "prooflens/manifest@0"
+    },
+    "release": {
+      "type": "string"
+    },
+    "evidence": {
+      "type": "string",
+      "pattern": "^[0-9a-f]{64}$"
+    },
+    "created": {
+      "type": "string"
+    },
+    "project": {
+      "type": "object"
+    },
+    "lean": {
+      "type": [
+        "object",
+        "null"
+      ]
+    },
+    "tool": {
+      "type": "object"
+    },
+    "papers": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "id",
+          "mode",
+          "pdf"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "mode": {
+            "enum": [
+              "latex",
+              "pdf"
+            ]
+          },
+          "pdf": {
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        }
+      }
+    },
+    "summary": {
+      "type": "object"
+    },
+    "findings": {
+      "type": "object"
+    },
+    "claims": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "id",
+          "paper",
+          "status",
+          "class",
+          "file",
+          "counts"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "paper": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string"
+          },
+          "class": {
+            "enum": [
+              "accepted",
+              "proved",
+              "refuted",
+              "open",
+              "malformed",
+              "out-of-scope",
+              "unspecified"
+            ]
+          },
+          "anchor": {
+            "type": [
+              "object",
+              "null"
+            ]
+          },
+          "file": {
+            "type": "string"
+          },
+          "counts": {
+            "type": "object"
+          }
+        }
+      }
+    },
+    "search": {
+      "type": "string"
+    }
+  }
+}

prooflens/evidence.py

@@ -0,0 +1,60 @@
+"""The evidence store: content-addressed, append-only records of what the pipeline established.
+
+A record is `{"id", "created", "body"}` with `id` the SHA-256 of the canonical JSON of `body`. A
+new run with any difference produces a new record; an existing record is never rewritten.
+"""
+
+from __future__ import annotations
+
+import datetime as _dt
+import json
+from pathlib import Path
+
+from .util import canonical_json, content_id, read_json
+
+SCHEMA = "prooflens/evidence@0"
+
+
+class EvidenceError(RuntimeError):
+    pass
+
+
+def store(out_dir: Path, body: dict) -> str:
+    body = dict(body, schema=SCHEMA)
+    eid = content_id(body)
+    path = out_dir / "evidence" / f"{eid}.json"
+    if path.exists():
+        old = read_json(path)
+        if content_id(old["body"]) != eid:
+            raise EvidenceError(f"evidence record {path} does not match its id")
+        return eid
+    path.parent.mkdir(parents=True, exist_ok=True)
+    rec = {"id": eid, "created": _dt.datetime.now(_dt.timezone.utc).isoformat(timespec="seconds"),
+           "body": json.loads(canonical_json(body))}
+    tmp = path.with_suffix(".tmp")
+    tmp.write_text(json.dumps(rec, ensure_ascii=False, sort_keys=True), encoding="utf-8")
+    tmp.replace(path)
+    return eid
+
+
+def load(out_dir: Path, eid: str) -> dict:
+    path = out_dir / "evidence" / f"{eid}.json"
+    rec = read_json(path)
+    if content_id(rec["body"]) != eid:
+        raise EvidenceError(f"evidence record {path} does not match its id")
+    return rec
+
+
+def record_release(out_dir: Path, name: str, eid: str) -> Path:
+    """Name a release; a release name, once given, keeps its evidence."""
+    path = out_dir / "releases" / f"{name}.json"
+    if path.exists():
+        old = read_json(path)
+        if old["evidence"] != eid:
+            raise EvidenceError(f"release {name} already names evidence {old['evidence']}")
+        return path
+    path.parent.mkdir(parents=True, exist_ok=True)
+    path.write_text(json.dumps({"release": name, "evidence": eid,
+                                "created": _dt.datetime.now(_dt.timezone.utc)
+                                .isoformat(timespec="seconds")}, indent=1) + "\n")
+    return path