pymmcore_plus.metadata.serialize ¶

Functions

Name	Description
`encode_hook`	Hook to encode objects that are not JSON serializable.
`msgspec_json_dumps`	Serialize object to bytes.
`msgspec_json_loads`	Deserialize bytes to object.
`msgspec_to_builtins`	Convert object to built-in types.
`msgspec_to_schema`	Generate JSON schema for a given type.
`schema_hook`	Hook to convert objects to schema.
`std_json_dumps`	Serialize object to bytes.
`std_json_loads`	Deserialize bytes to object.
`std_to_builtins`	Convert object to built-in types.

Attributes

Name	Description
`json_loads`	Deserialize JSON bytes (or a string) to Python objects.

Functions¶

encode_hook(obj: Any, raises: bool = True) -> Any

Hook to encode objects that are not JSON serializable.

schema_hook(obj: type) -> dict[str, Any]

Hook to convert objects to schema.

msgspec_json_dumps(obj: Any, *, indent: int | None = None) -> bytes

Serialize object to bytes.

msgspec_json_loads(s: bytes | str) -> Any

Deserialize bytes to object.

msgspec_to_builtins(obj: Any) -> Any

Convert object to built-in types.

msgspec_to_schema(type: Any) -> Any

Generate JSON schema for a given type.

std_json_dumps(obj: Any, *, indent: int | None = None) -> bytes

Serialize object to bytes.

Used by:

std_json_loads(s: bytes | str) -> Any

Deserialize bytes to object.

Used by:

std_to_builtins(obj: Any) -> Any

Convert object to built-in types.

Used by:

json_loads = std_json_loads

Deserialize JSON bytes (or a string) to Python objects.

These can also be imported from this module, but each is documented under its shortest import path (linked below).

Name	Description
`json_dumps`	Serialize `obj` (e.g. a metadata dict) to JSON bytes.
`to_builtins`	Convert `obj` (e.g. a metadata dict) to builtin Python types.