cfdm.core.Constructs.value

Constructs.value(default=ValueError())[source]

Return the sole metadata construct.

New in version (cfdm): 1.7.0

See also

get, key, values

Parameters
default: optional

Return the value of the default parameter if there is not exactly one construct.

If set to an Exception instance then it will be raised instead.

Returns

The metadata construct.

Examples

>>> f = cfdm.core.Field()
>>> c = f.constructs
>>> d = cfdm.core.DimensionCoordinate(
...     properties={
...         'standard_name': 'latitude', 'units': 'degrees_north'},
...     data=cfdm.core.Data(range(5))
... )
>>> c._set_construct(d)
'dimensioncoordinate0'
>>> print(c)
Constructs:
{'dimensioncoordinate0': <DimensionCoordinate: latitude(5) degrees_north>}
>>> c.key()
'dimensioncoordinate0'
>>> c.value()
<DimensionCoordinate: latitude(5) degrees_north>