cfdm.core.FieldAncillary.clear_properties

FieldAncillary.clear_properties()

Remove all properties.

New in version (cfdm): 1.7.0

See also

del_properties, del_property, properties, set_properties

Returns

dict

The properties that have been removed.

Examples

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