cfdm.core.Container¶
-
class
cfdm.core.
Container
(source=None, copy=True)[source]¶ Bases:
object
Abstract base class for storing components.
Warning
The
custom
component dictionary is only shallow copied when initialised from the source parameter, regardless of the value of the copy parameter. This is to avoid potentially expensive deep copies of the dictionary values.A subclass of
Container
that requires custom dictionary values to be deep copied should ensure that this occurs its__init__
method.New in version (cfdm): 1.7.0
Initialiation
- Parameters
- source: optional
Initialise the components from those of source.
Note that if source is a
Container
instance thencfdm.core.Container(source=source)
is equivalent tosource.copy()
.- copy:
bool
, optional If False then do not deep copy input parameters prior to initialisation. By default arguments are deep copied.
Miscellaneous¶
Methods
Return a deep copy. |
Private¶
Methods
Remove a component. |
|
Return a component. |
|
Whether a component has been set. |
|
Set a component. |
Special¶
Methods
Called by the |
Docstring substitutions¶
Methods
Return the special docstring substitutions. |
|
Returns the substitutions that apply to methods of the class. |
|
Returns the class {{package}} substitutions package depth. |
|
Returns method names excluded in the class substitutions. |