quantify_scheduler.structure.model

Root models for data structures used within the package.

Module Contents

Classes

DataStructure

A parent for all data structures.

Functions

orjson_dumps(→ str)

Dump an object to a JSON string using orjson library.

orjson_dumps(obj: Any, *, default: Callable[[Any], Any]) str[source]

Dump an object to a JSON string using orjson library.

Parameters
  • obj – Object to dump

  • default – A function that is called if an object can’t be serialized otherwise. It should return a JSON-encodable version of an object or raise a TypeError.

Returns

JSON-encoded string representation of an object

Return type

str

Raises

TypeError – If value can’t be serialized.

class DataStructure[source]

Bases: pydantic.BaseModel

A parent for all data structures.

Data attributes are generated from the class’ type annotations, similarly to dataclasses. If data attributes are JSON-serializable, data structure can be serialized using json() method. This string can be deserialized using parse_raw() classmethod of a correspondent child class.

If required, data fields can be validated, see examples for more information. It is also possible to define custom field types with advanced validation.

This class is a pre-configured pydantic model. See its documentation for details of usage information.

class Config[source]
json_loads[source]
json_dumps[source]
extra[source]