cf.Variable.dump

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

Return a string containing a full description of the instance.

Parameters :

display : bool, optional

If False then return the description as a string. By default the description is printed, i.e. f.dump() is equivalent to print f.dump(display=False).

omit : sequence of strs

Omit the given CF properties from the description.

Returns :

out : None or str

A string containing the description.

Examples