cf.Variable.dump

Variable.dump(display=True, prefix=None, omit=(), field=None, key=None, _title=None, _level=0)

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 str, optional

Omit the given CF properties from the description.

prefix: optional

Ignored.

Returns:

out: None or str

A string containing the description.

Examples:

>>> f.dump()
Data(1, 2) = [[2999-12-01 00:00:00, 3000-12-01 00:00:00]] 360_day
axis = 'T'
standard_name = 'time'

>>> f.dump(omit=('axis',))
Data(1, 2) = [[2999-12-01 00:00:00, 3000-12-01 00:00:00]] 360_day
standard_name = 'time'