cfdm.FieldAncillary.creation_commands

FieldAncillary.creation_commands(representative_data=False, namespace=None, indent=0, string=True, name='c', data_name='data', header=True)[source]

Return the commands that would create the construct.

New in version (cfdm): 1.8.7.0

See also

cfdm.Data.creation_commands, cfdm.Field.creation_commands

Parameters
representative_data: bool, optional

Return one-line representations of Data instances, which are not executable code but prevent the data being converted in its entirety to a string representation.

namespace: str, optional

The name space containing classes of the cfdm package. This is prefixed to the class name in commands that instantiate instances of cfdm objects. By default, or if None, the name space is assumed to be consistent with cfdm being imported as import cfdm.

Parameter example:

If cfdm was imported as import cfdm as xyz then set namespace='xyz'

Parameter example:

If cfdm was imported as from cfdm import * then set namespace=''

indent: int, optional

Indent each line by this many spaces. By default no indentation is applied. Ignored if string is False.

string: bool, optional

If False then return each command as an element of a list. By default the commands are concatenated into a string, with a new line inserted between each command.

name: str, optional

The name of the FieldAncillary instance created by the returned commands.

Parameter example:

name='var1'

data_name: str, optional

The name of the construct’s Data instance created by the returned commands.

Parameter example:

name='data1'

header: bool, optional

If True (the default) output a comment describing the components. If False no such comment is returned.

Returns
str or list

The commands in a string, with a new line inserted between each command. If string is False then the separate commands are returned as each element of a list.

Examples

>>> x = cfdm.FieldAncillary(
...     properties={'units': 'Kelvin',
...                 'standard_name': 'air_temperature'}
... )
>>> x.set_data([271.15, 274.15, 280])
>>> print(x.creation_commands(header=False))
c = cfdm.FieldAncillary()
c.set_properties({'units': 'Kelvin', 'standard_name': 'air_temperature'})
data = cfdm.Data([271.15, 274.15, 280.0], units='Kelvin', dtype='f8')
c.set_data(data)