cfdm.core.Container


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

Bases: object

Abstract base class for storing components.

New in version (cfdm): 1.7.0

Initialisation

Parameters
source: optional

Initialize the components from those of source.

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

copy: bool, optional

If False then do not deep copy input parameters prior to initialization. By default arguments are deep copied.

Miscellaneous

Methods

copy

Return a deep copy.

Private

Methods

_del_component

Remove a component.

_get_component

Return a component

_has_component

Whether a component has been set.

_set_component

Set a component.

Special

Methods

__deepcopy__

Called by the copy.deepcopy function.

Docstring substitutions

Methods

_docstring_special_substitutions

Return the special docstring substitutions.

_docstring_substitutions

Return the docstring substitutions that apply to methods of the given class.

_docstring_package_depth

Return the package depth, N, for {{package}} docstring substitutions for the given class.

_docstring_method_exclusions

Return the names of methods to exclude from docstring substitutions for the given class.