argdigest package

Subpackages

• argdigest.contrib package
  • Submodules
  • argdigest.contrib.beartype_support module
    • beartype_digest()
  • argdigest.contrib.pydantic_support module
    • model_from_dict()
    • pydantic_pipeline()
  • argdigest.contrib.pyunitwizard_support module
    • check()
    • context()
    • convert()
    • is_quantity()
    • standardize()
  • Module contents
• argdigest.core package
  • Submodules
  • argdigest.core.agent_docs module
    • generate_agent_docs()
  • argdigest.core.argument_loader module
    • load_argument_digesters()
    • resolve_standardizer()
  • argdigest.core.argument_registry module
    • ArgumentRegistry
      • ArgumentRegistry.clear()
      • ArgumentRegistry.get_all()
      • ArgumentRegistry.register()
    • argument_digest()
  • argdigest.core.config module
    • DigestConfig
      • DigestConfig.digestion_source
      • DigestConfig.digestion_style
      • DigestConfig.profiling
      • DigestConfig.puw_context
      • DigestConfig.skip_param
      • DigestConfig.standardizer
      • DigestConfig.strictness
    • get_defaults()
    • get_env_config_module()
    • load_from_file()
    • resolve_config()
    • set_defaults()
  • argdigest.core.context module
    • Context
      • Context.all_args
      • Context.argname
      • Context.audit_log
      • Context.function_name
      • Context.value
  • argdigest.core.decorator module
    • DigestionPlan
      • DigestionPlan.digesters
      • DigestionPlan.enable_argument_digestion
      • DigestionPlan.pipeline_targets
      • DigestionPlan.profiling
      • DigestionPlan.skip_param
      • DigestionPlan.standardizer
      • DigestionPlan.strictness
      • DigestionPlan.var_keyword_name
    • arg_digest()
    • get_digester_metadata()
  • argdigest.core.errors module
    • DigestError
    • DigestInvariantError
      • DigestInvariantError.catalog_key
    • DigestNotDigestedError
      • DigestNotDigestedError.catalog_key
    • DigestNotDigestedWarning
      • DigestNotDigestedWarning.catalog_key
    • DigestTypeError
      • DigestTypeError.catalog_key
    • DigestValueError
      • DigestValueError.catalog_key
  • argdigest.core.errors_base module
    • ArgDigestCatalogException
    • ArgDigestCatalogWarning
  • argdigest.core.health module
    • run_health_check()
  • argdigest.core.logger module
    • configure_logging()
    • get_logger()
  • argdigest.core.registry module
    • Registry
      • Registry.get_pipelines()
      • Registry.register_pipeline()
      • Registry.run()
    • get_pipelines()
    • register_pipeline()
  • argdigest.core.utils module
    • bind_arguments()
  • Module contents
    • DigestConfig
      • DigestConfig.digestion_source
      • DigestConfig.digestion_style
      • DigestConfig.profiling
      • DigestConfig.puw_context
      • DigestConfig.skip_param
      • DigestConfig.standardizer
      • DigestConfig.strictness
    • DigestError
    • DigestInvariantError
      • DigestInvariantError.catalog_key
    • DigestNotDigestedError
      • DigestNotDigestedError.catalog_key
    • DigestNotDigestedWarning
      • DigestNotDigestedWarning.catalog_key
    • DigestTypeError
      • DigestTypeError.catalog_key
    • DigestValueError
      • DigestValueError.catalog_key
    • arg_digest()
    • argument_digest()
    • get_defaults()
    • get_pipelines()
    • register_pipeline()
    • set_defaults()
• argdigest.pipelines package
  • Submodules
  • argdigest.pipelines.base module
    • feature_base()
    • feature_shape()
  • argdigest.pipelines.coercers module
    • lower()
    • strip()
    • to_bool()
    • to_list()
    • to_tuple()
    • upper()
  • argdigest.pipelines.data module
    • has_columns()
    • has_ndim()
    • is_dtype()
    • is_shape()
    • min_rows()
    • to_dataframe()
    • to_numpy()
  • argdigest.pipelines.validators module
    • is_dir()
    • is_file()
    • is_int()
    • is_non_negative()
    • is_positive()
    • is_str()
  • Module contents

Submodules

argdigest.cli module

argdigest.cli.audit_module(module_name)

Imports a module and prints the digestion plan for all decorated functions.

Parameters:

module_name (str)

argdigest.cli.main()

argdigest.config module

Central configuration module for ArgDigest. Use this module to set global defaults and configure logging.

argdigest.config.get_defaults()

Return type:

DigestConfig

argdigest.config.load_from_file(path)

Load configuration from a Python, YAML, or JSON file path.

Parameters:

path (str | Path)

Return type:

DigestConfig

argdigest.config.set_defaults(config=None, **kwargs)

Parameters:

• config (DigestConfig | None)

• kwargs (Any)

Return type:

None

argdigest.config.setup_logging(level=20, stream=None)

Simple helper to configure the argdigest logger.

Parameters:

• level (int | str)

• stream (Any | None)

Return type:

None

Module contents

ArgDigest — flexible argument auditing and normalization for scientific libraries.

class argdigest.DigestConfig(digestion_source: 'str | list[str] | None' = None, digestion_style: 'str' = 'auto', standardizer: 'Any' = None, strictness: 'str' = 'warn', skip_param: 'str' = 'skip_digestion', puw_context: 'dict[str, Any] | None' = None, profiling: 'bool' = False)

Bases: object

Parameters:

• digestion_source (str | list[str] | None)

• digestion_style (str)

• standardizer (Any)

• strictness (str)

• skip_param (str)

• puw_context (dict[str, Any] | None)

• profiling (bool)

digestion_source: str | list[str] | None = None

digestion_style: str = 'auto'

profiling: bool = False

puw_context: dict[str, Any] | None = None

skip_param: str = 'skip_digestion'

standardizer: Any = None

strictness: str = 'warn'

exception argdigest.DigestError(message, context=None, hint=None, code=None)

Bases: ArgDigestCatalogException

Base class for all ArgDigest exceptions.

Parameters:

• message (str)

• context (Context | None)

• hint (str | None)

• code (str | None)

exception argdigest.DigestInvariantError(message, context=None, hint=None, code=None)

Bases: DigestError

Semantic rule violation (e.g. invalid parent-child link).

Parameters:

• message (str)

• context (Context | None)

• hint (str | None)

• code (str | None)

catalog_key: str | None = 'DigestInvariantError'

exception argdigest.DigestNotDigestedError(message, context=None, hint=None, code=None)

Bases: DigestError

Missing digester or cyclic dependency.

Parameters:

• message (str)

• context (Context | None)

• hint (str | None)

• code (str | None)

catalog_key: str | None = 'DigestNotDigestedError'

exception argdigest.DigestNotDigestedWarning(message, context=None, hint=None, code=None)

Bases: ArgDigestCatalogWarning, RuntimeWarning

Warning for missing digesters when strictness is ‘warn’.

Parameters:

• message (str)

• context (Context | None)

• hint (str | None)

• code (str | None)

catalog_key: str | None = 'DigestNotDigestedWarning'

exception argdigest.DigestTypeError(message, context=None, hint=None, code=None)

Bases: DigestError, TypeError

Unexpected or inconsistent data type.

Parameters:

• message (str)

• context (Context | None)

• hint (str | None)

• code (str | None)

catalog_key: str | None = 'DigestTypeError'

exception argdigest.DigestValueError(message, context=None, hint=None, code=None)

Bases: DigestError, ValueError

Invalid or out-of-domain value.

Parameters:

• message (str)

• context (Context | None)

• hint (str | None)

• code (str | None)

catalog_key: str | None = 'DigestValueError'

argdigest.arg_digest(*, kind=None, rules=None, map=None, digestion_source=<object object>, digestion_style=<object object>, standardizer=<object object>, strictness=<object object>, skip_param=<object object>, config=<object object>, type_check=False, puw_context=None, profiling=<object object>, **digestion_params)

Parameters:

• kind (str | None)

• rules (list[str] | None)

• map (dict[str, dict] | None)

• digestion_source (str | list[str] | None | object)

• digestion_style (str | object)

• standardizer (Any | object)

• strictness (str | object)

• skip_param (str | object)

• config (DigestConfig | str | None | object)

• type_check (bool)

• puw_context (dict[str, Any] | None)

• profiling (bool | object)

• digestion_params (Any)

argdigest.argument_digest(name)

Decorator to register an argument digester by argument name.

Parameters:

name (str)

argdigest.get_pipelines(kind)

Parameters:

kind (str)

Return type:

dict[str, Callable[[…], Any]]

argdigest.register_pipeline(kind, name)

Decorator to register a pipeline function for a given kind and name.

Parameters:

• kind (str)

• name (str)