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'.