Skip to main content

tlaw

tlaw lets ordinary Python code state behavior that an implementation must continue to satisfy. The law file is executable and is the source of truth; Hypothesis generates and shrinks inputs underneath it, or an explicit exhaustive check enumerates a small finite domain.

For the exact implemented surface and its limits, see current tlaw behavior. Design documents are kept separate because they may describe syntax that does not exist yet.

Start here

Requirements: Python 3.12 or newer, and pytest 8.4.2 or newer — tlaw runs the laws through pytest in the project's own environment. The runtime dependencies are Hypothesis and pytest; their exact floors are the ones declared in pyproject.toml.

uv add --dev tlaw        # inside a project (recommended)
uv tool install tlaw     # or: the CLI on its own

The project install is recommended because laws are ordinary Python: when a law imports your project's own dependencies, tlaw must run in the same environment (uv run tlaw check laws.py). The standalone tool works for self-contained law folders whose implementation needs only the standard library.

Pin the version (tlaw>=0.0.11) if your project also pins pytest<9: older tlaw releases predate the current dependency floor, so an unconstrained dependency may resolve to an old release instead of the newest one.

Given an ordinary function:

# implementation.py
def reverse(values: list[int]) -> list[int]:
    return list(reversed(values))

Its law can be one function:

# laws.py
import tlaw

from implementation import reverse


@tlaw.law
def reversing_twice_returns_the_original(values: list[int]) -> bool:
    return reverse(reverse(values)) == values

Run it, then look at what tlaw inferred rather than taking generation on trust:

tlaw check laws.py
tlaw check laws.py --explain

The function name explains the behavior, its annotation supplies generated inputs, and the returned boolean is what must always hold. Writing this first law requires no Hypothesis syntax.

Bare laws run up to 100 deterministic examples without a local example database. tlaw includes the minimized failing input in its output. It also copies generated inputs and rejects a passing bare law when it detects that the law mutated one; stateful behavior should use the explicit path interface below.

For a longer first exercise, open the name cleaner tutorial. For a complete command sequence — check, retain, replay, repair, and mutation, including a deliberate bug and the exit codes — follow the workflow example.

What works today

tlaw currently has a small beginner interface plus explicit tools for narrower domains, structural comparison, stateful paths, and mutation evidence:

  • @tlaw.law turns an ordinary annotated Python function into an executable law;
  • simple annotations such as str, int, and list[int] supply generated inputs;
  • number(...), integer(...), one_of(...), list_of(...), and recursive(...) define visible finite-float, bounded-integer, finite-choice, list, and finite recursive domains without Hypothesis syntax;
  • record(...) composes named fields into a dictionary or a constructed value, and nests, so a whole structured request is one visible domain;
  • depends(...) derives one parameter's domain from another's generated value, so relational inputs are generated correctly by construction;
  • same(..., within=..., relative=...) compares nested values and array-like values with explicit absolute and relative tolerances and reports the first difference, and .and_then(...) adds another claim without losing that report;
  • raises(Expected, function, ...) states an exception contract whose failure names what actually happened instead of returning False, and awaits an async target;
  • returns(Branch, function, ...) states the same kind of contract for code that returns its failure instead of raising it, and .and_then(...) adds a second claim without losing the first one's explanation;
  • excludes(value, *fragments) states that no internal detail leaks, searching nested structures and reporting where a fragment was found;
  • tlaw check laws.py --explain runs the laws and reports what it generated;
  • tlaw check laws.py --exhaustive checks every combination of supported finite inputs, with separate counts and completion evidence;
  • tlaw check feature/ discovers and checks every law file under a folder;
  • tlaw check laws.py --search --json failure.json uses a fresh visible seed to look for new counterexamples and retains exact replay evidence;
  • tlaw check --replay failure.json reruns only those retained failures;
  • tlaw diff origin/main..HEAD statically separates law changes from the surrounding implementation diff without executing either revision;
  • inferred laws use deterministic runs and show Hypothesis's minimized failing input;
  • checks account for every selected law case, so skipped, expected-failure, and unrun laws cannot silently pass, and replay requires actual execution;
  • a passing inferred law is rejected when tlaw detects that it mutated its generated input;
  • system, call, then, and same_as cover explicit stateful paths; and
  • tlaw mutate laws.py implementation.py challenges the laws with generated mutations of one module and shows every survivor, for a flat feature folder or a module inside an installed package; add --exhaustive --max-cases 1000 to enumerate declared finite inputs and report each law's bounds and case counts while preserving exact replay and calibrated timeout confirmation.

Use tlaw mutate laws.py implementation.py --plan to execute one isolated baseline and inspect the campaign's planned work. Add --max-runs 20 to cap all isolated pytest invocations, including the canary and confirmations; reports explicitly identify budget stops, unconfirmed candidates and mutations left unrun.

To rerun specific challenges, copy their IDs from a report and pass --mutant ID (repeat for more IDs), or mutant_ids=[...] in Python. Each invocation gathers fresh baseline, canary and confirmation evidence. Reports separate selected, excluded and unrun mutants; completing a selection does not claim completion of the full generated campaign.

The list above is the implemented surface, not a promise about what comes next. What is intentionally absent is maintained once, in not implemented: domain predicates, relations across scopes, multi-module and non-Python mutation, observation of calls that did not happen, third-party pytest plugins, project-wide impact graphs, and the rest. Read that list before inferring a capability from the vocabulary here; in particular, tlaw sequences the calls a law makes and does not spy on absence.

The vocabulary is a ladder

You now know the whole first rung: @tlaw.law and a returned ==. Everything else is an escalation you reach for only when the rung below cannot say what you mean — most laws never leave the first rung. The same module docstrings (import tlaw; help(tlaw)) carry this map.

What the law returns:

Reach for When the claim is
return a == b exact equality of ordinary values — start here
same(a, b, within=, relative=) equal within tolerance, or nested/array/float values
raises(Exc, f, ...) a call must raise
returns(Type, f, ...) a call must return an error-value branch (Err), not raise
excludes(text, *forbidden) something must not appear (a leaked secret, hostname, traceback)
raises(...).and_then(observe) one call carries two claims (it refused, and its message is redacted)
same(...).and_then(next_claim) equivalence is only the first claim (the results agree, and both runs did the expected work)

What the annotation generates:

Reach for When
values: list[int] a plain type covers the real inputs — start here
number(lo, hi) · integer(lo, hi) · one_of(...) the plain type is broader than the real domain
list_of(...) a list of a domain, with visible size bounds
recursive(base, extend, ...) values recursively contain the same visible domain, within a finite leaf budget
depends(...) · record(...) inputs are related: one bounds another, or a record's fields must agree

When behavior mutates state, describe two paths from fresh starts instead of a returned value.

Getting evidence is a separate axis. Each question is different, and none is implied by the others:

  • tlaw check — do the laws hold against the code now?
  • tlaw mutate and tlaw audit — do the laws actually constrain the implementation? This is a question about the strength of the laws, not about today's correctness.
  • tlaw diff — did a commit change what a law means? This is review visibility only: it reads source, never executes either revision, and is never itself executed evidence.

Make law changes loud

Git remains the acceptance ledger: a committed law is accepted behavior. tlaw diff makes changes in that behavior visible on their own:

tlaw diff origin/main..HEAD
tlaw law-space diff 62ea585dd296..a482e8d8c430
Law changes:
- feature/laws.py::result_stays_bounded: domain narrowed
- feature/laws.py::packing_is_stable: body changed
Changed laws: 2

The command reads source blobs directly from Git and parses them; it never checks out, imports, or executes historical code. A law is identified by its module path and function name. Added and removed laws, descriptions, domains, generation posture, other decorators, and function bodies are compared as parsed Python, so formatting alone is ignored. Adding @pytest.mark.skip or moving from inferred to explicit generation is therefore visible.

Literal number, integer, one_of, and list_of changes are called domain narrowed or domain widened only when subset/superset is provable. A dynamic or otherwise incomparable edit is simply domain changed. Exit code 0 means no law change, 1 means law changes need review, and 2 means the Git range or source could not be read honestly. A rename is intentionally reported as one removal and one addition.

Check every input in a small domain

Declare a bounded domain and opt into enumeration:

import tlaw

Count = tlaw.integer(0, 3)


@tlaw.law
def boolean_addition_stays_bounded(count: Count, enabled: bool) -> bool:
    return 0 <= count + enabled <= 4
tlaw check laws.py --exhaustive --max-cases 1000 --json report.json

This checks all eight combinations. The default limit is 1,000 combinations per law case. Supported inputs are bool, None, Literal, integer, one_of, bounded list_of over finite elements, and dictionary-form record over finite independent fields, including aliases and supported Annotated forms. Larger or unsupported domains are refused before the laws run; tlaw never silently switches to sampling.

For example, tlaw.list_of(tlaw.one_of(["left", "right"]), max_size=4) enumerates all 31 histories of lengths 0..4, including the empty list. Nested finite lists work too. Normal output reports the length bounds beside the checked/total case counts; JSON records them in each obligation's list_bounds. The case cap is checked before lists are generated.

Records compose with lists: a command with two kinds and three amounts has six values; histories of those commands with max_size=2 have 43 cases. Nested records retain field names in list-bound paths such as request.options.flags and history[].options.flags. Constructor-based records and dependent fields remain sampled-only.

Output and JSON distinguish exhaustive, sampled, and replay evidence. Only an exhaustive check that passes every declared combination reports exhausted. A failure stops that law at its first counterexample, which can be retained and replayed with the same commands below. Ordinary checks continue to use Hypothesis; mutation remains a separate challenge to the laws. See finite checking for limits.

Search and replay a counterexample

Normal checks are deterministic. Randomized discovery is an explicit command:

tlaw check laws.py --search --json failure.json

tlaw prints the chosen seed and stores a tlaw.check/v1 report containing the law identity, Hypothesis version, shrunk generated inputs, exception fingerprint, and both values when the law returned tlaw.same(...).

Reproduce only those retained failures with:

tlaw check --replay failure.json

Replay exits 0 only when every recorded input still produces the same exception type and message. It exits 1 when the counterexample no longer fails in the recorded way, and 2 when the report or its law identity is invalid. An unrelated pytest test in the law file is not run during replay.

To rerun the whole randomized search rather than only its shrunk result, reuse the displayed seed:

tlaw check laws.py --search --seed 424242

Check and mutation JSON also retain execution diagnostics: the pytest phase, exception type, message and formatted detail, including nested causes. These explain failures such as Hypothesis deadlines or fixture errors even when no law counterexample could be retained. Diagnostics stay separate from the obligations and exact counterexamples that determine the verdict.

Typed replay encoding currently supports None, booleans, integers, floats, strings, bytes, lists, tuples, dictionaries, sets, and frozensets, recursively. If a failing input cannot be encoded without guessing, tlaw reports invalid evidence and does not write the requested report. Inputs are frozen before the law call, so a mutation-guard failure replays from the value that was actually generated, not the value after the law changed it.

State a narrower domain and comparison

When a plain type is broader than the application's real inputs, name the accepted values beside the laws:

import tlaw

from rewards import center


Reward = tlaw.number(0, 1)
Rewards = tlaw.list_of(Reward, min_size=1, max_size=20)


@tlaw.law
def centered_rewards_sum_to_zero(rewards: Rewards) -> tlaw.Comparison:
    return tlaw.same(sum(center(rewards)), 0.0, within=1e-12)

number(0, 1) means finite floats from 0 through 1, including both bounds. list_of makes the element and size domain visible in --explain. within=1e-12 means absolute tolerance at every numeric leaf; omitting it means exact comparison. For values whose magnitude is large or unknown, add relative=1e-9 — the two combine like math.isclose, and the rescale example shows why a numerical refactor needs it. same also compares nested lists, tuples, dictionaries, and array-like objects exposing shape, dtype, and tolist(). Recursive list and dictionary graphs terminate: revisiting the same left/right container pair means that relation is already established, while a difference on any finite path is still reported.

A recursive input domain uses the same visible vocabulary:

Tree = tlaw.recursive(
    tlaw.integer(0, 9),
    lambda child: tlaw.list_of(child, max_size=3),
    max_leaves=20,
)

The builder must accept exactly one child domain, compose it through a tlaw domain builder, expose that child in the description, and keep the same visible shape on every call. min_leaves and max_leaves count base values, not depth; invalid, description-only, or vacuous declarations are rejected when the domain is defined.

same states only a relationship. Two implementations that both return an empty result satisfy an equivalence law even when the domain says each should produce one item per input. Keep that second claim explanatory with Comparison.and_then(...):

refactored = normalize(values)
baseline = normalize_reference(values)

return tlaw.same(refactored, baseline).and_then(
    lambda: tlaw.same(
        (len(refactored), len(baseline)),
        (len(values), len(values)),
    )
)

If equivalence fails, the report retains that comparison. Only after it matches does tlaw evaluate and return the length comparison. A plain and would convert the first failure to False and discard its left, right, and first difference.

Domain aliases are runtime values, so strict type checkers may flag rewards: Rewards. The checker-clean spelling wraps the domain in Annotated — type Reward = Annotated[float, tlaw.number(0, 1)] used as rewards: list[Reward] — where the base type is for the checker and tlaw enforces the domain; see current tlaw behavior. Annotated metadata other than exactly one tlaw domain, and domains in positions tlaw cannot generate from yet, are rejected rather than silently ignored. A base type that contradicts its domain — Annotated[str, tlaw.number(0, 1)] — is refused too, so the visible contract cannot claim a type the domain never produces.

The complete runnable version is in the rewards example.

For a larger first exercise, open the self-contained name cleaner tutorial. It explains every definition, includes implementation and laws together, and gives a deliberate break-and-fix exercise. The tiny list example and the interface direction document remain available as references. The latter is a July 2026 product-direction document whose implemented parts are marked on the page; its future sections are not implemented syntax, and current behavior is the authoritative account of what runs today.

Keep laws beside the code whose behavior they define. A feature folder should remain understandable on its own; tlaw does not require a distant contract registry or hidden configuration for a local law.

Git and CI are the acceptance mechanism

A law committed to the repository is accepted behavior. tlaw does not maintain a second approval database. Law changes are ordinary reviewable code changes, and the repository's CI should enforce the resulting source of truth:

tlaw check path/to/feature/laws.py --explain

This repository enforces itself with one visible gate, scripts/gate: the committed dependency lock, ruff, the full property suite, independently confirmed CrossHair contracts, tlaw's self-laws, tlaw check on the whole examples/ folder, and tlaw mutate on the flat examples. A separate scheduled and path-triggered workflow runs the slower full mutation grade for the core value boundaries. The exact claim and its limits are in core evidence.

scripts/gate is shared by exactly two callers: .githooks/pre-push runs it on this machine before each push, and .github/workflows/ci.yml runs the same script on every push and pull request. The command list exists once; there is no workflow-only copy, so a check that passes locally is the check CI runs. (The workflow pins the uv version it installs; the hook uses the local one.) Install the hook once:

git config core.hooksPath .githooks

The gate refuses a stale dependency lock.

The gate also builds the source distribution and wheel, installs the wheel with locked runtime dependencies in a fresh environment, and runs the worked example outside the checkout. It verifies sampled and exhaustive checks, retained counterexample JSON, replay before and after a repair, and sampled and exhaustive mutation kills confirmed by exact replay. Run just this check with uv run python scripts/check_installed.py. The release workflow uses the same check on the exact wheel it uploads.

Tlaw also checks itself through two similarly named, deliberately different dogfooding suites:

  • self_laws/ is the fast boundary suite. Four law files state the domain, comparison, exclusion, and typed-replay boundaries through tlaw's public interface; the push gate runs them with tlaw check self_laws/ on every commit, independently of the ordinary pytest suite. scripts/core-evidence mutates the matching core modules while leaving these laws unchanged.
  • selflaws/ is the challenge suite. Four law files run against the real core and ten declared known-wrong implementations, driven by tlaw check selflaws/ and tlaw audit selflaws/audit.py. Independent pytest checks require each intended rejection, detect an always-accepting law checker, and exercise exact counterexample replay. See Laws for tlaw itself.

The gate runs both suites alongside the mutation challenges; this is bounded test evidence, not formal proof. The full composition and its limits are in core evidence. git push --no-verify skips the local run in an emergency; CI remains the enforcement of record. Publishing stays separate: the release workflow is gatekept by a version change in pyproject.toml.

If a commit intentionally changes behavior, its executable law and implementation may change together. The law diff states what changed; CI checks that the implementation now obeys it on every push and pull request.

Probe a codebase without modifying it

Laws can be written against any installed project before that project adopts tlaw. Put a laws file in a scratch directory, import the project's real functions, and run tlaw inside the project's own environment:

uv run --project path/to/project --with tlaw tlaw check laws.py

--project supplies the target's dependencies; --with injects tlaw for the run only. Nothing in the target repository changes — no pyproject edit, no committed files — which makes this the cheapest honest way to answer "would laws hold on this code?" before adopting anything. The target's own pytest addopts are deliberately not applied, so a project configured for a plugin tlaw does not autoload still runs. The documented kvfit probe and anef probe ran this way and paid for features with their findings.

Release to PyPI

Changing [project].version in pyproject.toml on main is the release signal. The workflow compares that value with the version before the push. An unchanged version never publishes; a changed version must pass the lockfile, compiled-changelog, lint, test, build, and distribution checks before it reaches PyPI.

During development, add one small file under changes/ for each user-visible change instead of editing CHANGELOG.md. The complete rules are in CONTRIBUTING.md. At release, use uv to keep the version and lockfile together, then compile and review those fragments:

uv version 0.0.11
uv run towncrier build --yes --version 0.0.11
git diff -- CHANGELOG.md changes pyproject.toml uv.lock
git add pyproject.toml uv.lock CHANGELOG.md changes/
git commit -m "chore(release): publish tlaw 0.0.11"
git push origin main

The upload uses PyPI trusted publishing, not a long-lived API token. Its one-time configuration must name GitHub owner teilomillet, repository tlaw, workflow release.yml, and environment pypi. The workflow is kept in .github/workflows/release.yml.

A release is traceable after the fact. Once the upload succeeds, the same workflow creates the tag v<version> on the release commit and a GitHub Release titled tlaw <version>, with release notes taken from that version's CHANGELOG.md section and the verified distribution files attached. The PyPI publish step generates PEP 740 provenance attestations for the exact files it uploads, so PyPI can verify which workflow and commit produced the distribution.

A release can be preflighted without publishing, and a failed release can be recovered without burning a new version. Run the workflow manually with the publish input left at its default false to execute the full gate, build, and installed-wheel checks only:

gh workflow run release.yml

Add -f publish=true to publish the current pyproject.toml version. Publishing and release creation are idempotent: an already-published version is skipped, the upload uses --check-url, and an existing GitHub Release is updated with --clobber instead of failing. Rerun the failed workflow instead of bumping the version to recover.

Describe stateful paths

When behavior mutates an object, a law can instead compare two paths from fresh starts:

from hypothesis import strategies as st

import tlaw
from wallet import Wallet


money = st.integers(min_value=0)
wallet = tlaw.system(
    Wallet,
    observe=lambda value: value.balance,
)


@tlaw.law(
    "deposit then withdraw changes nothing",
    balance=money,
    amount=money,
)
def deposit_round_trip(balance, amount):
    start = wallet(balance)
    return (
        start
        .call("deposit", amount)
        .call("withdraw", amount)
        .same_as(start)
    )

Run it in the same way:

tlaw check laws.py

The stateful path interface adds four ideas:

  • system(...) defines how to construct fresh values and what to observe;
  • @law(...) supplies ordinary Hypothesis strategies;
  • .call(...) or .then(...) extends a path; and
  • .same_as(...) says two paths must agree.

Law functions do not need pytest's test_ prefix. They are still executable Hypothesis tests and can also be run directly with pytest.

See the complete mutable wallet laws and the smaller pure UTF-8 round-trip law.

Why paths

tlaw models each program as an immutable sequence of steps. Composition is sequence concatenation, and the identity is the empty sequence. This gives the categorical rules—associativity and left/right identity—structurally, before application-specific testing begins.

A domain law is then an equation between two executable paths:

                 deposit(amount)     withdraw(amount)
wallet(balance) ──────────────────────────────────────► result
       │
       └──────────────── do nothing ──────────────────► expected

                         result == expected

For mutable application code, each path constructs its own fresh objects. For pure code, .then(function) uses the function's return value as the next value.

Check versus audit

Human-authored laws and audit evidence are deliberately separate:

tlaw check laws.py
tlaw audit audit.py
  • check runs the laws against the current implementation.
  • audit runs those same laws against a passing baseline and declared known-wrong implementations.

The wallet's audit declaration is separate from its laws, so someone writing a law does not need to think about mutation testing or audit plumbing.

Run the intentionally weak audit:

uv run tlaw audit examples/wallet/tlaw-weak.toml

It excludes the zero-transfer law and exposes the gap:

Strength: 3/4 (75.0%)
Verdict: INSUFFICIENT

Run the complete declared audit:

uv run tlaw audit examples/wallet/audit.py
Strength: 4/4 (100.0%)
Verdict: SUFFICIENT FOR DECLARED KNOWN-WRONG SET

That verdict is deliberately narrow. It does not prove that the wallet is universally correct. It establishes that the baseline passes and every declared known-wrong implementation is rejected by a law.

Challenge laws with generated mutations

The audit's known-wrong set is chosen by its author. tlaw mutate generates challenges nobody selected — small single-site changes to one implementation module — and runs the unchanged laws against every one. Here is the committed rescale example run in this repository on 2026-10-23 with tlaw 0.0.10. The output is unmodified except that the absolute checkout prefix on the two path lines is elided as ... and that timings vary between runs:

$ uv run tlaw mutate examples/rescale/laws.py examples/rescale/implementation.py
tlaw generated-mutation evidence
Laws: .../examples/rescale/laws.py
Implementation: .../examples/rescale/implementation.py
Boundary: directory (implementation)
Checking: sampled; total input space not enumerated
Baseline: PASS (0.26s); per-mutant budget 5.0s (10x baseline, floor 5s)
Baseline law obligations: 1 of 1 completed
  sampled: laws.py::kahan_matches_naive_to_relative_precision; total input space not enumerated
Mutation scope: generated 4; selected 4; excluded 0
Campaign plan: generated mutations 4; selected 4; excluded 0; compiling mutations 4; law cases 1
Planned isolated runs: 6..14 for the full campaign, including baseline, canary and confirmations
Planned law input counts: unknown (sampled checks)
Isolated runs started: 9; run budget: unlimited
Canary: KILLED (laws observe the mutated module)
  sampled: laws.py::kahan_matches_naive_to_relative_precision; total input space not enumerated
Mutations:
- e77faa4243e4 SURVIVED total_kahan: replace value - compensation with value + compensation (all laws passed)
  sampled: laws.py::kahan_matches_naive_to_relative_precision; total input space not enumerated
- 5b18a28a84d5 KILLED total_kahan: replace total + adjusted with total - adjusted (law failure or implementation exception; exact replay confirmed; law: laws.py::kahan_matches_naive_to_relative_precision)
  sampled: laws.py::kahan_matches_naive_to_relative_precision; total input space not enumerated
- 77e15088d04d KILLED total_kahan: replace stepped - total - adjusted with stepped - total + adjusted (law failure or implementation exception; exact replay confirmed; law: laws.py::kahan_matches_naive_to_relative_precision)
  sampled: laws.py::kahan_matches_naive_to_relative_precision; total input space not enumerated
- 86ec9ad9200f KILLED total_kahan: replace stepped - total with stepped + total (law failure or implementation exception; exact replay confirmed; law: laws.py::kahan_matches_naive_to_relative_precision)
  sampled: laws.py::kahan_matches_naive_to_relative_precision; total input space not enumerated
Killed 3 of 4 runnable generated mutations.
Survivors: 1
Mutations not run: 0
Mutations excluded from selection: 0
Unresolved equivalent candidates: 0
Invalid or infrastructure errors: 0

That run exited 1: an unexplained survivor is a prompt for investigation, not proof that the laws are wrong. Exit 2 would mean the evidence itself was invalid or incomplete. The single survivor is the interesting result: the kahan_matches_naive_to_relative_precision law only states relative agreement to 1e-9, and flipping the sign of the compensation term changes the result below that floor. The committed equivalence ledger records it as an equivalent within the declared contract rather than a missed defect, with the reason a human can review.

The rules are recorded in generated mutation evidence and encoded in tlaw/mutation.py (campaign and evidence rules) and tlaw/mutation_ast.py (generation): the baseline must pass with complete law obligations first. Ordinary mutant runs must execute the same law cases, and kills must reproduce retained typed inputs and exception fingerprints against the same mutant in a fresh copy. Calibrated timeout kills must time out again after a fresh passing baseline recalibrates the budget. Missing or incomplete evidence is an error; load failures are invalid; every survivor stays visible.

The JSON report retains law obligations, counterexamples, and replay evidence. replay_method distinguishes exact input replay from timeout confirmation, with the confirmation process's exit code, timeout flag, and duration recorded.

The canary runs by default before anything is scored: a poisoned copy of the implementation, in which every function raises, must be rejected by the laws. If it survives, the laws never observed the boundary module — typically because they import an installed package instead of the sibling file — and the report says INVALID EVIDENCE instead of listing meaningless survivors. There is no opt-out; the canary protects exactly the user who has never heard of it.

A survivor a human has investigated can be recorded in a committed TOML ledger and passed with --equivalents equivalents.toml; entries contradicted by evidence are reported as stale instead of being silently honored. Mutation IDs are content-based, so they survive edits elsewhere in the module.

Start a new feature law-first

For new code, the recommended shape makes mutation evidence free from day one:

feature/
├── implementation.py
└── laws.py            # imports: from implementation import ...

Write the laws first and watch them fail; implement until tlaw check passes; then run tlaw mutate to measure whether the laws actually constrain the implementation. Because the folder is flat and the laws import the module by name, the mutation boundary is wired by construction — the canary confirms it on every run.

Two worked examples record real runs end to end: examples/score_weights includes a genuine surviving mutant explained in a committed equivalence ledger, and examples/batch_packer is a full law-first development session — seven laws red before any implementation existed, then 13 of 13 mutants killed — with its findings in the law-first experiment record.

Use it from Python

import tlaw

check = tlaw.check("laws.py")
if not check.passed:
    print(check.output)

report = tlaw.audit("audit.py")
print(report)
report.enforce()

mutations = tlaw.mutate("laws.py", "implementation.py")
print(mutations)

report.enforce() raises tlaw.EnforcementError when evidence is invalid or insufficient. Its error.result retains the structured audit evidence.

Existing TOML audit manifests remain supported but are deprecated: loading one emits a DeprecationWarning and the CLI prints a notice. Prefer a Python Lawbook for new audit declarations. Python law and audit files are executable code, so run only files you trust.

Develop tlaw

tlaw is itself developed property-first:

uv run pytest -q
uv run ruff check .
uv run ruff format --check .
./scripts/crosshair
uv run tlaw check self_laws/
uv run tlaw check selflaws/
uv run tlaw audit selflaws/audit.py
./scripts/core-evidence

Two similarly named suites cover different things, and neither replaces the other. self_laws/ is the fast boundary suite the push gate runs on every commit; it states the domain, comparison, exclusion, and typed-replay boundaries through tlaw's public interface. selflaws/ is the challenge suite: the same public surface run against ten declared known-wrong implementations, with independent pytest checks that require each intended rejection. The distinction is explained in the Git and CI section and in core evidence.

The precise implemented surface is recorded in current tlaw behavior, and the independent challenge rules are recorded in generated mutation evidence. The repository-specific composition of symbolic, property, and mutation evidence is recorded in core evidence. The documentation index, including which page states implemented behavior versus design or direction, is docs/README.md.

Metadata

Release files for tlaw 0.0.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tlaw 0.0.11
File Size Uploaded Provenance
tlaw-0.0.11.tar.gz 111.3 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for tlaw 0.0.11
File Interpreter ABI Platform
tlaw-0.0.11-py3-none-any.whl Python 3 none any Details

Total release size: 224.0 kB

Release files / tlaw-0.0.11.tar.gz

Download URL tlaw-0.0.11.tar.gz
Size 111.3 kB
Tags Source
SHA-256 checksum
How to use checksums
813027b6f5a66d743316fa59e39ffb6608b1b4186fb7b8c395558f721d4dd690
BLAKE2b-256 checksum
How to use checksums
c8ae0f2a0f57b4db4a1f43ae6926d83d088ee938b5872c50f2002e3b636ceaa4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 23, 2026.

Transparency log

Release files / tlaw-0.0.11-py3-none-any.whl

Download URL tlaw-0.0.11-py3-none-any.whl
Size 112.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
69b4debc99baa9339fe6e12a60eba559b45da4d49a95288063c1195e6a6c18fd
BLAKE2b-256 checksum
How to use checksums
9afd5bb400c993b7863967f8ba8f8741d2322bb531ae15a692b00a092b845a60
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 23, 2026.

Transparency log

Security for tlaw 0.0.11

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.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for tlaw-0.0.11.tar.gz

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 23, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page