algebraixlib.import_export.mojson module¶
Extend json
so that it can convert constructs that contain MathObject
s and a few
other normally not supported types to and from JSON. A lossless round-trip is supported.
Supported types:
- The
MathObject
typesAtom
,Couplet
,Set
andMultiset
. - The Python types
bytes
,complex
,frozenset
,range
. - The Python types
list
andtuple
are already supported by the base implementation, but it can’t distinguish between them. Our implementation can.
-
algebraixlib.import_export.mojson.
encode
(obj)[source]¶ Encode
obj
as construct of objects known to the JSON encoder or return it as-is. Ifobj
is not known to the JSON encoder, it will fail on it.
-
algebraixlib.import_export.mojson.
decode
(obj)[source]¶ obj
is a representation of a straightforward translation of JSON into Python. For a known special construct, convert it into its correct object representation and return it. Otherwise returnobj
as-is.
-
algebraixlib.import_export.mojson.
object_hook_f
(obj)[source]¶ obj
is a representation of a straightforward translation of JSON into Python. For a known special construct (must be adict
), convert it into its correct object representation and return it. Otherwise returnobj
as-is. (May be used asobject_hook
function for the various JSON decoder APIs.)
-
class
algebraixlib.import_export.mojson.
ExportJson
(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)[source]¶ Bases:
json.encoder.JSONEncoder
Export a construct that may contain
MathObject
s and other normally not supported types as a custom JSON format that allows a round-trip.Constructor for JSONEncoder, with sensible defaults.
If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.
If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.
If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an OverflowError). Otherwise, no such check takes place.
If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.
If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.
If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.
If specified, separators should be an (item_separator, key_separator) tuple. The default is (‘, ‘, ‘: ‘) if indent is
None
and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a
TypeError
.
-
class
algebraixlib.import_export.mojson.
ImportJson
(object_hook=None, parse_float=None, parse_int=None, parse_constant=None, strict=True, object_pairs_hook=None)[source]¶ Bases:
json.decoder.JSONDecoder
Import the JSON format created by
ExportJson
and create an object from it.The arguments are the same as for
_json.JSONDecoder
, except for the ones listed here:Parameters: object_hook – If this argument is not set, the function object_hook_f
is used.