Spec¶

The structure of the 835 and the columns of each table. See The spec for the guide.

Spec ¶

The loop structure, element definitions and tables of a file format.

builtin(version: str = '5010') -> Spec

The built-in 835 spec of version, "5010" (the default) or "4010"; raises ValueError for any other version.

from_json(json: str) -> Spec

The spec described by json; raises SpecError with the core message when it is not valid.

patch(patch: str | dict[str, Any]) -> Spec

A new spec with patch (a dict or JSON text) merged over this one; raises SpecError when the result is not valid.

to_json() -> builtins.str

The spec as JSON text.

loops() -> builtins.list[builtins.str]

The loop names, in spec order.

Bases: ValueError

A spec that cannot be loaded or patched; the message names the rule, the loop and key, and the datum.