openfloor.json_serializable

class openfloor.json_serializable.JsonSerializable

Bases: ABC

Abstract base class for JSON serializable objects

classmethod from_dict(data)

Create an instance from a dictionary or instance

Return type:

JsonSerializableDict

classmethod from_file(filepath, **kwargs)

Create an instance from a JSON file

Return type:

JsonSerializable

classmethod from_json(json_str)

Create an instance from a JSON string

Return type:

JsonSerializable

to_file(filepath, **kwargs)

Save instance to a JSON file

Return type:

None

to_json(**kwargs)

Convert instance to JSON string

Return type:

str

class openfloor.json_serializable.JsonSerializableDataclass

Bases: JsonSerializable

Base class for JSON serializable objects that are dataclasses

copy()

Create a copy of the dataclass

Return type:

JsonSerializableDataclass

classmethod from_dict(data)

Create an instance from a dictionary

Return type:

JsonSerializableDataclass

class openfloor.json_serializable.JsonSerializableDict(*args, **kwargs)

Bases: JsonSerializable

Base class for JSON serializable objects that serialize to dictionaries

clear()

Clear all items

Return type:

None

copy()

Create a copy of the dictionary

Return type:

JsonSerializableDict

get(key, default=None)

Get a value by key with a default value

Return type:

Any

update(other)

Update with values from another dictionary

Return type:

None

class openfloor.json_serializable.JsonSerializableList(*args, **kwargs)

Bases: JsonSerializable

Base class for JSON serializable objects that serialize to lists

append(item)

Add an item to the list

Return type:

None

clear()

Clear all items from the list

Return type:

None

extend(items)

Add multiple items to the list

Return type:

None

to_file(filepath, **kwargs)

Save instance to a JSON file

Return type:

None

to_json(**kwargs)

Convert instance to JSON string

Return type:

str

openfloor.json_serializable.split_kwargs(cls, kwargs)

Split kwargs into defined and undefined fields for a dataclass class.

Parameters:

• cls (Type) – The class to check fields against

• kwargs (Dict[str, Any]) – Dictionary of keyword arguments to split

Return type:

Tuple[Dict[str, Any], Dict[str, Any]]

Returns:

Tuple of (defined_fields, undefined_fields) where each is a dictionary of the respective fields from kwargs. Defined fields that are not in kwargs will be included in defined_fields with a value of None.