pynenc.serializer.json_serializer

Module Contents

Classes

ReservedKeys	Defines keys reserved for internal use in the serialization process.
DefaultJSONEncoder	A custom JSON encoder that extends the default JSONEncoder to handle special object types.
JsonSerializer	Implements the BaseSerializer for JSON serialization using the custom DefaultJSONEncoder.

API

class pynenc.serializer.json_serializer.ReservedKeys

Bases: enum.StrEnum

Defines keys reserved for internal use in the serialization process.

This enumeration ensures that specific keys are uniquely identifiable and not confused with user-defined data.

Variables:

ERROR – Reserved key for storing error information in serialized data.

Initialization

Initialize self. See help(type(self)) for accurate signature.

ERROR

‘pynenc__std_py_exc’

class pynenc.serializer.json_serializer.DefaultJSONEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: json.JSONEncoder

A custom JSON encoder that extends the default JSONEncoder to handle special object types.

This encoder specifically handles the serialization of Python exceptions, turning them into a JSON-friendly format.

Initialization

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 RecursionError). 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.

default(obj: Any) → Any

Overrides the default method to provide custom serialization logic.

Parameters:

obj (Any) – The object to be serialized.

Returns:

A serialized representation of ‘obj’, particularly for Exception objects. For other types, it falls back to the superclass’s default method.

class pynenc.serializer.json_serializer.JsonSerializer

Bases: pynenc.serializer.base_serializer.BaseSerializer

Implements the BaseSerializer for JSON serialization using the custom DefaultJSONEncoder.

This class provides methods to serialize and deserialize objects to and from JSON strings, with special handling for Python exceptions.

static serialize(obj: Any) → str

Serializes an object into a JSON string.

Parameters:

obj (Any) – The object to serialize.

Returns:

A JSON string representation of ‘obj’.

static deserialize(obj: str) → Any

Deserializes a JSON string back into an object.

If the string represents a serialized Python exception, it reconstructs the exception object.

Parameters:

obj (str) – The JSON string to deserialize.

Returns:

The deserialized object, which could be a Python exception if appropriate.