cfdm.core.Properties¶

class cfdm.core.Properties(properties=None, source=None, copy=True)[source]

Bases: cfdm.core.abstract.container.Container

Mixin class for an object with descriptive properties.

New in version (cfdm): 1.7.0

Initialisation

Parameters
properties: dict, optional

Set descriptive properties. The dictionary keys are property names, with corresponding values.

Properties may also be set after initialisation with the set_properties and set_property methods.

Parameter example:

properties={'standard_name': 'altitude'}

source: optional

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

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the Properties 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 Properties instance then cfdm.core.Properties(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.

Properties¶

Methods

 del_property Remove a property. get_property Return a property. has_property Whether a property has been set. set_property Set a property. properties Return all properties. clear_properties Remove all properties. del_properties Remove properties. set_properties Set properties.

Miscellaneous¶

Methods

 copy Return a deep copy. has_bounds Whether or not there are cell bounds. has_data Whether or not the construct has data.

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.