jetblack_serialization¶

module jetblack_serialization.json ¶

Summary¶

JSON Serialization

function jetblack_serialization.json.deserialize ¶

Summary¶

Convert JSON to an object

jetblack_serialization.json.deserialize(

text: str | bytes | bytearray,

annotation: Annotation,

config: SerializerConfig,

decode: JSONDecoder | None

) -> Any

Parameters¶

text: str | bytes | bytearray

The JSON string

annotation: Annotation

The type annotation

config: SerializerConfig

The serializer configuration

decode: JSONDecoder | None (optional)

Returns¶

Any: The deserialized object.

function jetblack_serialization.json.deserialize_typed ¶

Summary¶

Convert JSON to an object

jetblack_serialization.json.deserialize_typed(

text: Union[str, bytes, bytearray],

annotation: str,

config: jetblack_serialization.config.SerializerConfig | None,

decode: JSONDecoder | None

) -> Any

Parameters¶

text: Union[str, bytes, bytearray]

The JSON string

annotation: str

The type annotation

config: jetblack_serialization.config.SerializerConfig | None (optional)

decode: JSONDecoder | None (optional)

Returns¶

Any: The deserialized object.

function jetblack_serialization.json.deserialize_untyped ¶

Summary¶

Deserialize JSON without type information

jetblack_serialization.json.deserialize_untyped(

text: str | bytes | bytearray,

config: jetblack_serialization.config.SerializerConfig | None,

decode: JSONDecoder | None

) -> Any

Parameters¶

text: str | bytes | bytearray

The JSON string

config: jetblack_serialization.config.SerializerConfig | None (optional)

decode: JSONDecoder | None (optional)

Returns¶

Any: The deserialized JSON object

function jetblack_serialization.json.from_json_value ¶

Summary¶

Convert from a json value

jetblack_serialization.json.from_json_value(

json_value: Any,

annotation: Annotation,

config: SerializerConfig

) -> Any

Parameters¶

json_value: Any

The JSON value

annotation: Annotation

The type annotation

config: SerializerConfig

The serializer configuration

Returns¶

Any: The deserialized value

function jetblack_serialization.json.serialize ¶

Summary¶

Convert the object to JSON

jetblack_serialization.json.serialize(

obj: Any,

annotation: Annotation,

config: SerializerConfig,

encode: JSONEncoder | None

) -> str

Parameters¶

obj: Any

The object to convert

annotation: Annotation

The type annotation

config: SerializerConfig

The serializer configuration

encode: JSONEncoder | None (optional)

Returns¶

str: The serialized object

function jetblack_serialization.json.serialize_typed ¶

Summary¶

Serialize an object to JSON

jetblack_serialization.json.serialize_typed(

python_obj: Any,

annotation: Annotation,

config: jetblack_serialization.config.SerializerConfig | None,

encode: JSONEncoder | None

) -> str

Parameters¶

python_obj: Any

The object to serialize

annotation: Annotation

The objects type annotation

config: jetblack_serialization.config.SerializerConfig | None (optional)

encode: JSONEncoder | None (optional)

Returns¶

str: The JSON string

function jetblack_serialization.json.serialize_untyped ¶

jetblack_serialization.json.serialize_untyped(

obj: Any,

config: jetblack_serialization.config.SerializerConfig | None,

encode: JSONEncoder | None

) -> str

Parameters¶

obj: Any

config: jetblack_serialization.config.SerializerConfig | None (optional)

encode: JSONEncoder | None (optional)

Returns¶

str:

class JSONObject(JSONAnnotation) ¶

Summary¶

A JSON property

jetblack_serialization.json.annotations.JSONObject(

is_serializable_keys: bool,

type_selector: TypeSelector | None

) -> None

Parameters¶

is_serializable_keys: bool (optional)

type_selector: TypeSelector | None (optional)

class JSONProperty(JSONAnnotation) ¶

Summary¶

A JSON property

jetblack_serialization.json.annotations.JSONProperty(

tag: str,

*,

is_serializable_keys: bool,

type_selector: TypeSelector | None

) -> None

Parameters¶

tag: str

is_serializable_keys: bool (optional)

type_selector: TypeSelector | None (optional)

class JSONValue(JSONAnnotation) ¶

Summary¶

A JSON property

jetblack_serialization.json.annotations.JSONValue(

type_selector: TypeSelector | None

) -> None

Parameters¶

type_selector: TypeSelector | None (optional)