spacepy.pycdf.AttrList

class spacepy.pycdf.AttrList(cdf_file, special_entry=None)

Object representing a list of attributes.

Warning

This class should not be used directly, but only via its subclasses, gAttrList and zAttrList. Methods listed here are safe to use from the subclasses.

__init__(cdf_file, special_entry=None)

Initialize the attribute collection

Parameters:

cdf_fileCDF

CDF these attributes are in

special_entrycallable

callable which returns a “special” entry number, used to limit results for zAttrs to those which match the zVar

Methods

clone(master[, name, new_name])	Clones another attribute list, or one attribute from it, into this list.
copy()	Create a copy of this attribute list
new(name[, data, type])	Create a new Attr in this AttrList
rename(old_name, new_name)	Rename an attribute in this list

clone(master, name=None, new_name=None)

Clones another attribute list, or one attribute from it, into this list.

Parameters:

masterAttrList

the attribute list to copy from. This can be any dict-like object.

Other Parameters:

namestr (optional)

name of attribute to clone (default: clone entire list)

new_namestr (optional)

name of the new attribute, default name

copy()

Create a copy of this attribute list

Returns:

outdict

copy of the entries for all attributes in this list

new(name, data=None, type=None)

Create a new Attr in this AttrList

Parameters:

namestr

name of the new Attribute

Other Parameters:

data

data to put into the first entry in the new Attribute

type

CDF type of the first entry from const. Only used if data are specified.

Raises:

KeyErrorif the name already exists in this list

rename(old_name, new_name)

Rename an attribute in this list

Renaming a zAttribute renames it for all zVariables in this CDF!

Parameters:

old_namestr

the current name of the attribute

new_namestr

the new name of the attribute