RecordSet

class RecordSet(records: dict[str, ArrayRecord | MetricRecord | ConfigRecord] | None = None, *, parameters_records: dict[str, ArrayRecord] | None = None, metrics_records: dict[str, MetricRecord] | None = None, configs_records: dict[str, ConfigRecord] | None = None)

Bases: RecordDict

Deprecated class RecordSet, use RecordDict instead.

Methods

clear()
copy()	Return a shallow copy of the dictionary.
deflate()	Deflate the RecordDict.
get(k[,d])
inflate(object_content[, children])	Inflate an RecordDict from bytes.
items()
keys()
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.
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()

Attributes

array_records	Dictionary holding only ArrayRecord instances.
children	Return a dictionary of records with their Object IDs as keys.
config_records	Dictionary holding only ConfigRecord instances.
configs_records	Deprecated property.
is_dirty	Check if the object is dirty after the last deflation.
metric_records	Dictionary holding only MetricRecord instances.
metrics_records	Deprecated property.
object_id	Get object_id.
parameters_records	Deprecated property.

property array_records: TypedDict[str, ArrayRecord]

Dictionary holding only ArrayRecord instances.

property children: dict[str, InflatableObject]

Return a dictionary of records with their Object IDs as keys.

clear() → None.  Remove all items from D.

property config_records: TypedDict[str, ConfigRecord]

Dictionary holding only ConfigRecord instances.

property configs_records: TypedDict[str, ConfigRecord]

Deprecated property.

Use config_records instead.

copy() → Self

Return a shallow copy of the dictionary.

deflate() → bytes

Deflate the RecordDict.

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

classmethod inflate(object_content: bytes, children: dict[str, InflatableObject] | None = None) → RecordDict

Inflate an RecordDict from bytes.

Parameters:

• object_content (bytes) – The deflated object content of the RecordDict.

• children (Optional[dict[str, InflatableObject]] (default: None)) – Dictionary of children InflatableObjects mapped to their Object IDs. These children enable the full inflation of the RecordDict. Default is None.

Returns:

The inflated RecordDict.

Return type:

RecordDict

property is_dirty: bool

Check if the object is dirty after the last deflation.

An object is considered dirty if its content has changed since the last its object ID was computed.

items() → a set-like object providing a view on D's items.

keys() → a set-like object providing a view on D's keys.

property metric_records: TypedDict[str, MetricRecord]

Dictionary holding only MetricRecord instances.

property metrics_records: TypedDict[str, MetricRecord]

Deprecated property.

Use metric_records instead.

property object_id: str

Get object_id.

property parameters_records: TypedDict[str, ArrayRecord]

Deprecated property.

Use array_records instead.

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.