json_utils

Module containing quantify JSON utilities.

Module Contents

Classes

JSONSchemaValMixin	A mixin that adds validation utilities to classes that have
SchedulerJSONDecoder	The Quantify Scheduler JSONDecoder.
SchedulerJSONEncoder	Custom JSONEncoder which encodes a Quantify Scheduler object into a JSON file format

Functions

validate_json(data, schema)	Validate schema using jsonschema-rs.
load_json_schema(relative_to, filename)	Load a JSON schema from file. Expects a 'schemas' directory in the same directory
load_json_validator(→ Callable)	Load a JSON validator from file. Expects a 'schemas' directory in the same directory

Attributes

current_python_version
lru_cache

current_python_version

lru_cache

validate_json(data, schema)

Validate schema using jsonschema-rs.

load_json_schema(relative_to: str | pathlib.Path, filename: str)

Load a JSON schema from file. Expects a ‘schemas’ directory in the same directory as relative_to.

Tip

Typical usage of the form schema = load_json_schema(__file__, 'definition.json')

Parameters:

• relative_to – the file to begin searching from

• filename – the JSON file to load

Returns:

the schema

Return type:

dict

load_json_validator(relative_to: str | pathlib.Path, filename: str) → Callable

Load a JSON validator from file. Expects a ‘schemas’ directory in the same directory as relative_to.

Parameters:

• relative_to – the file to begin searching from

• filename – the JSON file to load

Returns:

The validator

Return type:

Callable

class JSONSchemaValMixin

A mixin that adds validation utilities to classes that have a data attribute like a UserDict based on JSONSchema.

This requires the class to have a class variable “schema_filename”

classmethod is_valid(object_to_be_validated) → bool

Checks if the object is valid according to its schema.

Raises:

fastjsonschema.JsonSchemaException – if the data is invalid

class SchedulerJSONDecoder(*args, **kwargs)

Bases: json.JSONDecoder

The Quantify Scheduler JSONDecoder.

The SchedulerJSONDecoder is used to convert a string with JSON content into instances of classes in quantify-scheduler.

To avoid the execution of malicious code ScheduleJSONDecoder uses ast.literal_eval() instead of eval() to convert the data to an instance of Schedule.

The list of serializable classes can be extended with custom classes by providing the modules keyword argument. These classes have to implement quantify_scheduler.operations.operation.Operation and overload the __str__ and __repr__ methods in order to serialize and deserialize domain objects into a valid JSON-format.

Keyword Arguments:

modules (List[ModuleType], optional) – A list of custom modules containing serializable classes, by default []

classes: Dict[str, Type[Any]]

decode_dict(obj: Dict[str, Any]) → Dict[str, Any] | numpy.ndarray | type

Returns the deserialized JSON dictionary.

Parameters:

obj – The dictionary to deserialize.

Returns:

The deserialized result.

custom_object_hook(obj: object) → object

The object_hook hook will be called with the result of every JSON object decoded and its return value will be used in place of the given dict.

Parameters:

obj – A pair of JSON objects.

Returns:

The deserialized result.

class SchedulerJSONEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: json.JSONEncoder

Custom JSONEncoder which encodes a Quantify Scheduler object into a JSON file format string.

default(o)

Overloads the json.JSONEncoder default method that returns a serializable object. It will try 3 different serialization methods which are, in order, check if the object is to be serialized to a string using repr. If not, try to use __getstate__. Finally, try to serialize the __dict__ property.