dataframely.deserialize_schema#

dataframely.deserialize_schema(
data: str,
strict: bool = True,
) → type[Schema] | None[source]#

Deserialize a schema from a JSON string.

This method allows to dynamically load a schema from its serialization, without having to know the schema to load in advance.

Parameters:

  • data – The JSON string created via Schema.serialize().

  • strict – Whether to raise an exception if the schema cannot be deserialized.

Returns:

The schema loaded from the JSON data.

Raises:

ValueError – If the schema format version is not supported and strict=True.

Attention

This functionality is considered unstable. It may be changed at any time without it being considered a breaking change.

See also

Schema.serialize() for additional information on serialization.

On this page