jetblack_serialization¶

module jetblack_serialization.yaml ¶

Summary¶

YAML Serialization

function jetblack_serialization.yaml.deserialize ¶

Summary¶

Convert YAML to an object.

jetblack_serialization.yaml.deserialize(

text: str | bytes | bytearray,

annotation: Annotation,

config: SerializerConfig,

decode: YAMLDecoder | None

) -> Any

Parameters¶

text: str | bytes | bytearray

The JSON string

annotation: Annotation

The type annotation

config: SerializerConfig

The serializer configuration

decode: YAMLDecoder | None (optional)

Returns¶

Any: The deserialized object.

function jetblack_serialization.yaml.deserialize_typed ¶

Summary¶

Convert YAML to an object.

jetblack_serialization.yaml.deserialize_typed(

text: str | bytes | bytearray,

annotation: str,

config: SerializationConfig,

decode: YAMLDecoder | None

) -> Any

Parameters¶

text: str | bytes | bytearray

The YAML string

annotation: str

The type annotation.

config: SerializationConfig

The serializer config.

decode: YAMLDecoder | None (optional)

Returns¶

Any: The deserialized object.

function jetblack_serialization.yaml.deserialize_untyped ¶

jetblack_serialization.yaml.deserialize_untyped(

text: str | bytes | bytearray,

config: jetblack_serialization.config.SerializerConfig | None,

decode: YAMLDecoder | None

) -> Any

Parameters¶

text: str | bytes | bytearray

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

decode: YAMLDecoder | None (optional)

Returns¶

Any:

function jetblack_serialization.yaml.serialize ¶

Summary¶

Convert the object to YAML.

jetblack_serialization.yaml.serialize(

obj: Any,

annotation: Annotation,

config: SerializerConfig,

encode: YAMLEncoder | None

) -> str

Parameters¶

obj: Any

The object to convert

annotation: Annotation

The type annotation

config: SerializerConfig

The serializer configuration

encode: YAMLEncoder | None (optional)

Returns¶

str: The serialized object

function jetblack_serialization.yaml.serialize_typed ¶

Summary¶

Serialize an object to YAML.

jetblack_serialization.yaml.serialize_typed(

obj: Any,

annotation: Annotation,

config: YAMLSerializerConfig,

encode: YAMLEncoder | None

) -> str

Parameters¶

obj: Any

The object to serialize.

annotation: Annotation

The objects type annotation.

config: YAMLSerializerConfig

The serialization config.

encode: YAMLEncoder | None (optional)

Returns¶

str: The YAML string.

function jetblack_serialization.yaml.serialize_untyped ¶

jetblack_serialization.yaml.serialize_untyped(

obj: Any,

config: jetblack_serialization.config.SerializerConfig | None,

encode: YAMLEncoder | None

) -> str

Parameters¶

obj: Any

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

encode: YAMLEncoder | 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)