orionis.cache.serializer.Serializer

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

class Serializer: (source)

Undocumented

Static Method	`dumps`	Serialize an object to a JSON-formatted string.
Static Method	`dumpToFile`	Write serialized data to a file atomically.
Static Method	`loadFromFile`	Load and deserialize data from a file.
Static Method	`loads`	Deserialize a JSON-formatted string to a Python object.

def dumps(data: Any, indent: int | None = None) -> str: (source) ¶

Serialize an object to a JSON-formatted string.

Parameters
data:`Any`	The object to serialize.
indent:`int or None, optional`	Number of spaces for indentation in the output JSON string.

Returns
`str`	The JSON-formatted string representing the serialized object.

def dumpToFile(data: Any, file_path: Path): (source) ¶

Write serialized data to a file atomically.

Parameters
data:`Any`	The object to serialize and write.
file_path:`Path`	The file path where the serialized data will be written.

Returns
`None`	This method does not return a value.

Raises
`OSError`	If the payload cannot be staged or renamed into place.

def loadFromFile(file_path: Path) -> Any: (source) ¶

Load and deserialize data from a file.

Parameters
file_path:`Path`	Path to the file from which to load and deserialize data.

Returns
`Any`	The deserialized Python object, or None if the file does not exist or is empty.

def loads(raw: str | bytes) -> Any: (source) ¶

Deserialize a JSON-formatted string to a Python object.

Parameters
raw:`str`	JSON-formatted string to deserialize.

Returns
`Any`	The deserialized Python object.