cf.Field.identity

Field.identity(default=None, relaxed_identity=None)[source]

Return the identity of the field.

The identity is, by default, the first found of the following:

  • The standard_name CF property.
  • The id attribute.
  • If the relaxed parameter is True, the standard_name CF property.
  • The id attribute.
  • The value of the default parameter.

This is altered if the relaxed parameter is True.

See also

name

Examples 1: 
>>> i = f.identity()
Parameters:
default: optional

The identity if one could not otherwise be found. By default, default is None.
Returns:
out:

The identity.
Examples 2: 
>>> f.standard_name = 'Kelvin'
>>> f.id = 'foo'
>>> f.identity()
'Kelvin'
>>> del f.standard_name
>>> f.identity()
'foo'
>>> del f.id
>>> f.identity()
None
>>> f.identity('bar')
'bar'
>>> print f.identity()
None