cf.dump

cf.dump(x, **kwargs)[source]

Print a description of an object.

If the object has a dump method then this is used to create the output, so that cf.dump(f) is equivalent to print f.dump(). Otherwise cf.dump(x) is equivalent to print(x).

Parameters
x:

The object to print.

kwargsoptional

As for the input variable’s dump method, if it has one.

Returns

None

Examples:

>>> x = 3.14159
>>> cf.dump(x)
3.14159

>>> f
<CF Field: rainfall_rate(latitude(10), longitude(20)) kg m2 s-1>
>>> cf.dump(f)
>>> cf.dump(f, complete=True)