pydox.get_params

get_params(param: str, config: Any = None) → Any | Dict

Retrieve the value of a configuration parameter or (sub)group of parameters

Parameters:

• param (str) –

  The parameter name or (sub)group of parameters. Use a string-dotted notation if necessary, eg:

  • argo.qcflags.doxy will return this single parameter value,

  • argo.qcflags will return a subgroup of parameters, as a dict,

  • argo will return a group of parameters, as a dict.

• config (None | Config) – The configuration object to get parameters from. By default, use the global configuration object pydox.params.

Returns:

The parameter value or group of parameters

Return type:

Any | Dict

See also

pydox.set_params(), pydox.reset_params()