cf.Field.set_properties

Field.set_properties(properties, copy=True)

Set properties.

Added in version 3.0.0.

See also

clear_properties, properties, set_property

Parameters:

properties: dict

Store the properties from the dictionary supplied.

Parameter example:

properties={'standard_name': 'altitude', 'foo': 'bar'}

copy: bool, optional

If False then any property values provided by the properties parameter are not copied before insertion. By default they are deep copied.

Returns:

None

Examples

>>> f.properties()
{}
>>> f.set_properties(
...     {'standard_name': 'air_pressure', 'long_name': 'Air Pressure'})
>>> f.properties()
{'standard_name': 'air_pressure',
 'foo': 'bar',
 'long_name': 'Air Pressure'}
>>> f.set_properties({'standard_name': 'air_pressure', 'foo': 'bar'})
>>> f.properties()
{'standard_name': 'air_pressure',
 'foo': 'bar',
 'long_name': 'Air Pressure'}
>>> f.clear_properties()
{'standard_name': 'air_pressure',
 'foo': 'bar',
 'long_name': 'Air Pressure'}
>>> f.properties()
{}