larray.Metadata

class larray.Metadata

An ordered dictionary allowing key-values accessibly using attribute notation (AttributeDict.attribute) instead of key notation (Dict[“key”]).

Examples

>>> from larray import ndtest
>>> from datetime import datetime

Add metadata at array initialization

>>> # Python 2 or <= 3.5
>>> arr = ndtest((3, 3), meta=[('title', 'the title'), ('author', 'John Smith')])
>>> # Python 3.6+
>>> arr = ndtest((3, 3), meta=Metadata(title='the title', author='John Smith'))  # doctest: +SKIP

Add metadata after array initialization

>>> arr.meta.creation_date = datetime(2017, 2, 10)

Access to metadata

>>> arr.meta.creation_date
datetime.datetime(2017, 2, 10, 0, 0)

Modify metadata

>>> arr.meta.creation_date = datetime(2017, 2, 16)

Delete metadata

>>> del arr.meta.creation_date

__init__(self, /, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

clear()
copy()
from_array(array)
from_hdf(hdfstore[, key])
fromkeys(iterable[, value])	Create a new ordered dictionary with keys from iterable and values set to value.
get(self, key[, default])	Return the value for key if key is in the dictionary, else default.
items()
keys()
move_to_end(self, /, key[, last])	Move an existing element to the end (or beginning if last is false).
pop()	value.
popitem(self, /[, last])	Remove and return a (key, value) pair from the dictionary.
setdefault(self, /, key[, default])	Insert key with a value of default if key is not in the dictionary.
to_hdf(self, hdfstore[, key])
update()	If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()