Skip to content

API reference

Per-symbol documentation generated from the source. Use this when you know what you want to call and need the exact signature and parameter list.

Models and fields

Schema evolution

  • Lens: Lens, Iso, Mapping, DependentLens, lens decorator.
  • Migrations: register_migration, migrate, save_registry, load_registry.
  • Schema diff: diff, classify_change, is_breaking_change.
  • Synthesis: synthesise_migration, SynthesisResult.

Theory and fingerprints

Output and integration

  • Code generation: emit_as, Emitter, IndentWriter, register_emitter, json_schema_of, write.
  • Self-describing: schema_uri, embed_schema_uri, FingerprintRegistry, validate_with_uri_lookup.
  • Repository: Repository.
  • Testing: the lens-law fixtures.
  • CLI: didactic.cli.main.

Sibling packages

  • Pydantic adapter: from_pydantic, to_pydantic.
  • Settings: Settings, EnvSource, DotEnvSource, FileSource, CliSource.
  • FastAPI: as_request, as_response, register_validation_handler.