crow.cluster_modules.parameters module

The parameters module.

This module holds the class that stores and manages parameter to be used in each cluster_module object.

class crow.cluster_modules.parameters.Parameters(default_parameters_dict)

Bases: object

The parameter class that stores and manages parameter to be used in each cluster_module object.

items()

Return an iterable view of (key, value) pairs.

Returns:

A view of the parameter (key, value) pairs in this container.

Return type:

dict_items

keys()

Return an iterable view of parameter names.

Returns:

A view of the parameter keys in this container.

Return type:

dict_keys

update(update_dict)

Update multiple parameters at once.

Parameters:

update_dict (dict or Parameters) -- Mapping of parameter names to new values. Keys must be a subset of the parameters defined for this container.

Raises:

• ValueError -- If update_dict is not a dict or Parameters instance.

• KeyError -- If update_dict contains keys not defined in this container.

values()

Return an iterable view of parameter values.

Returns:

A view of the parameter values in this container.

Return type:

dict_values