cf.Field.get_property

Field.get_property(prop, default=ValueError())

Get a CF property.

New in version 3.0.0.

See also

clear_properties, del_property, has_property, properties, set_property

Parameters

prop: str

The name of the CF property.

Parameter example:

prop='long_name'

default: optional

Return the value of the default parameter if the property has not been set.

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

Returns

The value of the named property or the default value, if set.

Examples

>>> f = cf.Field()
>>> f.set_property('project', 'CMIP7')
>>> f.has_property('project')
True
>>> f.get_property('project')
'CMIP7'
>>> f.del_property('project')
'CMIP7'
>>> f.has_property('project')
False
>>> print(f.del_property('project', None))
None
>>> print(f.get_property('project', None))
None