Serialisers

JSONSerialiser

class refract.json.JSONSerialiser

JSON Refract Serialiser

serialise(element: refract.elements.base.Element, **kwargs) → str

Serialises the given element into JSON.

>>> JSONSerialiser().serialise(String(content='Hello'))
'{"element": "string", "content": "Hello"}'

ComapctJSONSerialiser

class refract.json.CompactJSONSerialiser

serialise(element: refract.elements.base.Element) → str

Serialises the given element into Compact JSON.

>>> CompactJSONSerialiser().serialise(String(content='Hello'))
'["string", null, null, "Hello"]'

JSONDeserialiser

class refract.json.JSONDeserialiser(registry: refract.registry.Registry = None) → None

JSON Refract Deserialiser

deserialise(element_json: str) → refract.elements.base.Element

Deserialises the given JSON into an element.

>>> json = '{"element": "string", "content": "Hello"'
>>> JSONDeserialiser().deserialise(json)
String(content='Hello')

ComapctJSONDeserialiser

class refract.json.CompactJSONDeserialiser(registry: refract.registry.Registry = None) → None

JSON Refract Deserialiser

deserialise(content) → refract.elements.base.Element

Deserialises the given compact JSON into an element.

>>> deserialiser = CompactJSONDeserialiser()
>>> deserialiser.deserialise('["string", null, null, "Hi"]')
String(content='Hi')

LegacyJSONDeserialiser

Warning

Legacy deserialiser is deprecated.

class refract.json.LegacyJSONDeserialiser(registry: refract.registry.Registry = None) → None

Deserialiser for Refract 0.6.0 and below.

deserialise(element_json: str) → refract.elements.base.Element

Deserialises the given JSON into an element.

>>> json = '{"element": "string", "content": "Hello"'
>>> JSONDeserialiser().deserialise(json)
String(content='Hello')