Object reference

class presets.Preset(module, dispatch=None, defaults=None)

The Preset class overrides the default parameters of functions within a module.

If the given module contains submodules, these are also encapsulated by Preset objects that share the same default parameter dictionary.

Submodules are detected by examining common prefixes of the module source paths.

Attributes:

module : Python module

The module to encapsulate

dispatch : None or dictionary

A dictionary mapping modules to existing Preset objects. This should be left as None for most situations.

defaults : None or dictionary

An existing dictionary object used to collect default parameters. Note: this will be passed by reference.

Methods

keys()	Returns a list of currently set parameter defaults
update(D)	Updates the default parameter set by a dictionary D

keys()

Returns a list of currently set parameter defaults

update(D)

Updates the default parameter set by a dictionary D