ConfigsRecord

class ConfigsRecord(config_dict: dict[str, ConfigRecordValues] | None = None, keep_input: bool = True)

Bases: ConfigRecord

Deprecated class ConfigsRecord, use ConfigRecord instead.

This class exists solely for backward compatibility with legacy code that previously used ConfigsRecord. It has been renamed to ConfigRecord.

Warning

ConfigsRecord is deprecated and will be removed in a future release. Use ConfigRecord instead.

Examples

Legacy (deprecated) usage:

from flwr.common import ConfigsRecord

record = ConfigsRecord()

Updated usage:

from flwr.common import ConfigRecord

record = ConfigRecord()

Methods

clear()
copy()	Return a shallow copy of the dictionary.
count_bytes()	Return number of Bytes stored in this object.
deflate()	Deflate object.
get(k[,d])
inflate(object_content[, children])	Inflate a ConfigRecord 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

children	Get all child objects as a dictionary or None if there are no children.
is_dirty	Check if the object is dirty after the last deflation.
object_id	Get object_id.

property children: dict[str, InflatableObject] | None

Get all child objects as a dictionary or None if there are no children.

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

copy() → Self

Return a shallow copy of the dictionary.

count_bytes() → int

Return number of Bytes stored in this object.

This function counts booleans as occupying 1 Byte.

deflate() → bytes

Deflate object.

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) → ConfigRecord

Inflate a ConfigRecord from bytes.

Parameters:

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

• children (Optional[dict[str, InflatableObject]] (default: None)) – Must be None. ConfigRecord does not support child objects. Providing any children will raise a ValueError.

Returns:

The inflated ConfigRecord.

Return type:

ConfigRecord

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 object_id: str

Get object_id.

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.