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. Ignored if the source parameter is set.

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

Parameter example:

properties={'standard_name': 'altitude'}

source: optional

Initialise the properties from those of source.

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

copy: bool, optional

If True (the default) deep copy input parameters prior to initialisation. If False arguments 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.

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.