sphinx_polyversion.json

(De-)Serialize python objects to/from json.

Classes

`Decoder`([decoder, parse_float, parse_int, ...])	A json decoder supporting all kinds of python objects.
`Encoder`()	JSON Encoder supporting all kinds of python objects.
`std_hook`(args, *kwargs)	A set of standard hooks implemented by this module.

Exceptions

RecursionWarning

A transformable object returns its own type.

class sphinx_polyversion.json.Decoder(decoder: Decoder | None = None, *, parse_float: Callable[[str], Any] | None = None, parse_int: Callable[[str], Any] | None = None, parse_constant: Callable[[str], Any] | None = None, strict: bool = True)[source]

Bases: JSONDecoder

A json decoder supporting all kinds of python objects.

To decode such an object, three requirements have to be fullfilled: 1. The object has to implement the Tranformable protocol or a JSONHook has to be implemented for the type. 2. The object has to be encoded in the correct format as done by Encoder. 3. THe hook or class has to be registered with this decoder. You can use register() for that. This method can also be used as a class decorator.

Parameters:

decoder (Decoder | None, optional) – A decoder to inherit properties from, by default None
parse_float (Callable[[str], Any] | None, optional) – Float parser, by default None
parse_int (Callable[[str], Any] | None, optional) – Int parser, by default None
parse_constant (Callable[[str], Any] | None, optional) – Constant parser, by default None
strict (bool, optional) – Whether to disallow control characters, by default True

registered_types

The transformable types registered for decoding.

Type:: List[type]

hooks

hooks registered for decoding.

Type:: List[Type[JSONHook]]

register(*t): Register a hook or a tranformable type.

register_from(decoder): Register all types registered by another decoder.

static determine_classname(t: type) → str

Determine a unique identifier for a class/type.

This identifier is used to store hooks and types but also to select the correct one when its identifier is found in the json to decode.

Parameters:: t (type) – The class/type to identify.
Returns:: The identifier.
Return type:: str

property hooks: List[Type[JSONHook]]: List of hooks registered for decoding.

object_hook(o: Dict[str, None | bool | int | float | str | List[None | bool | int | float | str | List[JSON_TYPE] | Tuple[JSON_TYPE, ...] | Dict[str, JSON_TYPE]] | Tuple[None | bool | int | float | str | List[JSON_TYPE] | Tuple[JSON_TYPE, ...] | Dict[str, JSON_TYPE], ...] | Dict[str, None | bool | int | float | str | List[JSON_TYPE] | Tuple[JSON_TYPE, ...] | Dict[str, JSON_TYPE]]]) → Any: Alter objects after deserialization.

register(t: Type[T], /) → Type[T]

register(t1: Type[JSONHook] | Type[T], t2: Type[JSONHook] | Type[T], /, *types: Type[JSONHook] | Type[T]) → None

register(hook: Type[JSONHook], /) → Type[JSONHook]

A decoder can only decode serialized objects if their type or a corresponding hook was registered with the decoder.

This method can be used as decorator for Tranformable classes or hook classes.

Raises:

ValueError – Hook or class already registered
TypeError – Invalid type that doesn’t implement JSONHook or Transformable.

register_from(decoder: Decoder) → None: Register all types registered by another decoder.

property registered_types: List[type]: List of transformable types registered for decoding.

class sphinx_polyversion.json.Encoder(hook: JSONHook, /, **kwargs: Any)[source]

class sphinx_polyversion.json.Encoder(hooks: Iterable[JSONHook] = [], /, **kwargs: Any)

Bases: JSONEncoder

JSON Encoder supporting all kinds of python objects.

This Encoder supports types/instances implementing the Transformable protocol. You can also pass hooks to the Encoder for supporting types not implementing set protocol.

Parameters:

hooks (Iterable[JSONHook] | JSONHook, optional) – The object hooks to use, by default []
**kwargs – Keyword arguments passed to json.JSONEncoder

Replace custom types by an encodable dictionary.

Parameters:: o (JSONable) – The json object to iterate over.
Returns:: The resulting json object.
Return type:: JSON_TYPE_DUMP

Notes

Calls transform() internally.

static determine_classname(o: object | type, instance: bool = True) → str

Determine a unique identifier for a python class or instance.

This method is put in the produced json to encode classes that aren’t natively supported by JSON.

Parameters:

o (object | type) – The object to identify
instance (bool, optional) – Whether the object is a class/type or an instance, by default True

Returns:

The identifier

Return type:

str

iterencode(o: None | bool | int | float | str | List[JSONable] | Tuple[JSONable, ...] | Dict[None | bool | int | float | str, JSONable] | Transformable, _one_shot: bool = False) → Iterator[str]: Encode an object.

register(t1: Type[JSONHook], t2: Type[JSONHook], /, *types: Type[JSONHook]) → None

register(hook: Type[JSONHook], /) → Type[JSONHook]

A decoder can only decode serialized objects if their type or a corresponding hook was registered with the decoder.

This method can be used as decorator for Tranformable classes or hook classes.

Raises:

ValueError – Hook or class already registered
TypeError – Invalid type that doesn’t implement JSONHook or Transformable.

Replace custom types by an encodable dictionary.

Parameters:: o (JSONable) – The json object to iterate over.
Returns:: The resulting json object.
Return type:: JSON_TYPE_DUMP

exception sphinx_polyversion.json.RecursionWarning[source]

Bases: UserWarning

A transformable object returns its own type.

This usually results in an infinite recursion since _json_fields is called over and over.

class sphinx_polyversion.json.std_hook(*args, **kwargs)[source]

Bases: JSONHook

A set of standard hooks implemented by this module.

This currently on supports the datetime class.

static fields(o: Any) → str | None: Make an object encodable.

static from_json(cls: str, o: None | bool | int | float | str | List[JSON_TYPE] | Tuple[JSON_TYPE, ...] | Dict[str, JSON_TYPE]) → Any: Decode an object.