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¶

• Model: the dx.Model base, plus BaseModel, ModelConfig, RootModel, TypeAdapter.
• Field: dx.field() and FieldSpec.
• Validators: @dx.validates, ValidationError.
• Refs: Ref, Embed, Backref.
• Backref resolution: resolve_backrefs, ModelPool.
• Tagged unions: TaggedUnion.
• Computed, Derived.
• Axioms: Axiom, axiom, check_class_axioms.
• Types: EmailStr, HttpUrl, SecretStr, Json.

Schema evolution¶

• Lens: Lens, Iso, Mapping, DependentLens, lens decorator, Correspondence, find_correspondences, best_correspondence.
• Migrations: register_migration, migrate, save_registry, load_registry.
• Schema diff: diff, classify_change, is_breaking_change.
• Migration synthesis: synthesise_migration, SynthesisResult.
• Model synthesis: model_from_spec, models_from_specs, model_from_theory.

Theory and fingerprints¶

• Theory bridge: build_theory, build_theory_spec.
• Fingerprints: fingerprint, structural_fingerprint, canonical_json_bytes.

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.