Metadata

class baybe.utils.metadata.Metadata

Bases: SerialMixin

Metadata class providing basic information for BayBE objects.

Public methods

__init__([description, misc])	Method generated by attrs for class Metadata.
from_dict(dictionary)	Create an object from its dictionary representation.
from_json(string)	Create an object from its JSON representation.
to_dict()	Create an object's dictionary representation.
to_json()	Create an object's JSON representation.

Public attributes and properties

description	A description of the object.
misc	Additional user-defined metadata.
is_empty	Check if metadata contains any meaningful information.

__init__(description: str | None = None, *, misc: dict[str, Any] = NOTHING)

Method generated by attrs for class Metadata.

For details on the parameters, see Public attributes and properties.

classmethod from_dict(dictionary: dict)

Create an object from its dictionary representation.

Parameters:

dictionary (dict) – The dictionary representation.

Return type:

TypeVar(_T)

Returns:

The reconstructed object.

classmethod from_json(string: str)

Create an object from its JSON representation.

Parameters:

string (str) – The JSON representation of the object.

Return type:

TypeVar(_T)

Returns:

The reconstructed object.

to_dict()

Create an object’s dictionary representation.

Return type:

dict

to_json()

Create an object’s JSON representation.

Return type:

str

Returns:

The JSON representation as a string.

description: str | None

A description of the object.

property is_empty: bool

Check if metadata contains any meaningful information.

misc: dict[str, Any]

Additional user-defined metadata.