cfdm.core.Parameters

---

class cfdm.core.Parameters(parameters=None, source=None, copy=True)

Bases: cfdm.core.abstract.container.Container

Mixin class for a collection of named parameters.

New in version (cfdm): 1.7.0

Initialisation

Parameters

parameters: dict, optional

Set parameters. The dictionary keys are parameter names, with corresponding values.

Parameters may also be set after initialisation with the set_parameters and set_parameter methods.

Parameter example:

parameters={'earth_radius': 6371007.}

source: optional

Convert source, which can be any type of object, to a Parameters instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the Parameters API. Any parameters that can not be retrieved from source in this way are assumed to have their default value.

Note that if x is also a Parameters instance then cfdm.core.Parameters(source=x) is equivalent to x.copy().

copy: bool, optional

If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.

Parameter terms

Methods

del_parameter	Delete a parameter.
get_parameter	Get a parameter value.
has_parameter	Whether a parameter has been set.
set_parameter	Set a parameter-valued term.
parameters	Return all parameters.
clear_parameters	Remove all parameters.
set_parameters	Set parameters.

Miscellaneous

Methods

copy	Return a deep copy.

Special

Methods

__deepcopy__

Called by the copy.deepcopy function.

Docstring substitutions

Methods

_docstring_special_substitutions	Return the special docstring substitutions.
_docstring_substitutions	Returns the substitutions that apply to methods of the class.
_docstring_package_depth	Returns the class {{package}} substitutions package depth.
_docstring_method_exclusions	Returns method names excluded in the class substitutions.