Skip to content

Serialization API

JSON serialization and file operations.

Serialization API

JSON serialization and file operations.

Generic Serialization

to_dict

to_dict

to_dict(obj: Any) -> Dict[str, Any]

Serialize object to a dictionary.

from_dict

from_dict

from_dict(data: Dict[str, Any], cls: Type[T]) -> T

Deserialize object from dictionary.

JSON Operations

to_json

to_json

to_json(obj: Any, indent: int | None = None) -> str

Serialize a supported qlcore object (position/portfolio) to a JSON string.

from_json

from_json

from_json(raw: str, cls: Type[T]) -> T

Deserialize a JSON string produced by to_json back into the requested type.

File Operations

save_to_file

save_to_file

save_to_file(
    obj: Any, path: str | Path, indent: int | None = 2
) -> None

Serialize object to JSON and write it to disk.

load_from_file

load_from_file

load_from_file(path: str | Path, cls: Type[T]) -> T

Load JSON from disk and deserialize into the requested type.

Domain Objects

encode_domain_object

encode_domain_object

encode_domain_object(obj: Any) -> Dict[str, Any]

Encode domain object to JSON-serializable dict.

decode_domain_object

decode_domain_object

decode_domain_object(data: Dict[str, Any]) -> Any

Decode domain object from JSON-serializable dict.