qml.data.AttributeInfo¶
-
class
AttributeInfo
(attrs_bind=None, **kwargs)[source]¶ Bases:
collections.abc.MutableMapping
Contains metadata that may be assigned to a dataset attribute. Is stored in the HDF5 object’s
attrs
dict.-
attrs_bind
¶ The HDF5 attrs dict that this instance is bound to, or any mutable mapping
- Type
MutableMapping[str, Any]
-
\*\*kwargs
Extra metadata to include. Must be a string, number or numpy array
Attributes
Documentation for this attribute.
String representation of this attribute’s python type.
-
attrs_namespace
: ClassVar[str] = 'qml.data'¶
-
doc
¶ Documentation for this attribute.
-
py_type
¶ String representation of this attribute’s python type.
Methods
bind_key
(_AttributeInfo__name)Returns
__name
dot-prefixed withattrs_namespace
.clear
()get
(key[, default])Retrieve the corresponding layout by the string key.
items
()keys
()load
(info)Inserts the values set in
info
into this instance.pop
(k[,d])If key is not found, d is returned if given, otherwise KeyError is raised.
popitem
()as a 2-tuple; but raise KeyError if D is empty.
save
(info)Inserts the values set in this instance into
info
.setdefault
(k[,d])update
([E, ]**F)If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values
()-
classmethod
bind_key
(_AttributeInfo__name)[source]¶ Returns
__name
dot-prefixed withattrs_namespace
.
-
clear
() → None. Remove all items from D.¶
-
get
(key, default=None)¶ Retrieve the corresponding layout by the string key.
When there isn’t an exact match, all the existing keys in the layout map will be treated as a regex and map against the input key again. The first match will be returned, based on the key insertion order. Return None if there isn’t any match found.
- Parameters
key – the string key as the query for the layout.
- Returns
Corresponding layout based on the query.
-
items
() → a set-like object providing a view on D’s items¶
-
keys
() → a set-like object providing a view on D’s keys¶
-
pop
(k[, d]) → v, remove specified key and return the corresponding value.¶ If key is not found, d is returned if given, otherwise KeyError is raised.
-
popitem
() → (k, v), remove and return some (key, value) pair¶ as a 2-tuple; but raise KeyError if D is empty.
-
setdefault
(k[, d]) → D.get(k,d), also set D[k]=d if k not in D¶
-
update
([E, ]**F) → None. Update D from mapping/iterable E and F.¶ If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
-
values
() → an object providing a view on D’s values¶
-