API Reference#

This section documents the public API exported by argdigest. Pages under autosummary/ are generated automatically from docstrings and signatures.

Public API#

`arg_digest`
`register_pipeline`	Decorator to register a pipeline function for a given kind and name.
`get_pipelines`
`argument_digest`	Decorator to register an argument digester by argument name.
`DigestConfig`
`pipelines`
`DigestError`	Base class for all ArgDigest exceptions.
`DigestTypeError`	Unexpected or inconsistent data type.
`DigestValueError`	Invalid or out-of-domain value.
`DigestInvariantError`	Semantic rule violation (e.g. invalid parent-child link).
`DigestNotDigestedError`	Missing digester or cyclic dependency.
`DigestNotDigestedWarning`	Warning for missing digesters when strictness is 'warn'.
`Domain`	A named, introspectable set of admissible keyword names.
`FunctionContract`	What a function accepts and requires, declared as data.
`FunctionContractError`	Base class for breaches of a function's argument contract (axis 1).
`FunctionContractWarning`	A contract breach reported instead of raised, under the 'warn' policy.
`UnknownArgumentError`	An argument the function does not accept.
`MissingArgumentError`	A call that satisfies no required argument group.
`ArgumentConsistencyError`	Mutually exclusive or co-required arguments used inconsistently.
`describe_contract`	Render a contract as plain data, for documentation and introspection.
`AliasTable`	A set of argument-name aliases, optionally scoped to callers and to a context.
`describe_normalization`	Render the declared aliases as plain data, optionally for one caller.
`StandardizerContractError`	A standardizer that did not honour (caller, kwargs) -> mapping.