cf.Field.set_property

Field.set_property(prop, value, copy=True)

Set a property.

New in version 3.0.0.

See also

clear_properties, del_property, get_property, has_property, properties

Parameters

prop: str

The name of the property to be set.

value:

The value for the property.

copy: bool, optional

If True then set a deep copy of value.

Returns

None

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