pydox.reset_params

Contents

pydox.reset_params#

reset_params(param: str = None, config: Any = None, factory: bool = False, **kwargs) → None[source]#

Reset a configuration parameter to default values

Default values are those obtained at the end of the sequential loading of all available configuration files.

Parameter or (sub)groups of parameters are modified in place.

Parameters:

  • param (str) –

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

    • argo.qcflags.doxy reset a single parameter value,

    • argo.qcflags reset a subgroup of parameters,

    • argo reset a group of parameters.

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

  • factory (bool, default=False) – Set this argument to True in order to reset with factory values instead of default values. Factory values ignore user specific configuration files and is solely based on the Pydox internal configuration.

  • reference (Config) – The configuration object to use as a reference if different from the default or factory objects. This argument is primarily for internal use only.

Return type:

None

See also

pydox.get_params(), pydox.set_params()

Warning

If for some reason the current configuration has lost some parameters compared to the default configuration, this reset method cannot restore them, it only applies to parameters currently in the configuration.

Contents