cf.Variable.dump

Variable.dump(prefix=None, omit=())

Return a string containing a full description of the instance.

Parameters :

id : str, optional

Set the common prefix of component names. By default the instance’s class name is used.

omit : sequence of strs

Omit the given CF properties from the description.

Returns :

out : str

A string containing the description.

Examples

>>> x = v.dump()
>>> print v.dump()
>>> print v.dump(id='variable1')
>>> print v.dump(omit=('long_name',))