serialization

Application serialization utilities.

Serialization Helpers.

src.server.lib.serialization.convert_datetime_to_gmt(dt: datetime) → str

Handle datetime serialization for nested timestamps.

Parameters:

dt – The datetime to convert

Returns:

The datetime converted to GMT

Return type:

str

src.server.lib.serialization.convert_string_to_camel_case(string: str) → str

Convert a string to camel case.

Parameters:

string – The string to convert

Returns:

The string converted to camel case

Return type:

str

src.server.lib.serialization.convert_camel_to_snake_case(string: str) → str

Convert a string to snake case.

Parameters:

string – The string to convert

Returns:

The string converted to snake case

Return type:

str

src.server.lib.serialization.from_json(value: bytes | str) → Any

Decode to an object with the optimized msgspec package.

Parameters:

value – The value to decode

Returns:

The decoded value

Return type:

Any

src.server.lib.serialization.from_msgpack(value: bytes) → Any

Decode to an object with the optimized msgspec package.

Parameters:

value – The value to decode

Returns:

The decoded value

Return type:

Any

src.server.lib.serialization.to_json(value: Any) → bytes

Encode json with the optimized msgspec package.

Parameters:

value – The value to encode

Returns:

The encoded value

Return type:

bytes

src.server.lib.serialization.to_msgpack(value: Any) → bytes

Encode json with the optimized msgspec package.

Parameters:

value – The value to encode

Returns:

The encoded value

Return type:

bytes

class src.server.lib.serialization.UUIDEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: JSONEncoder

JSON Encoder for UUIDs.

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(o: Any) → Any

Handle UUIDs.

Parameters:

o – The object to encode

Returns:

The encoded object

Return type:

str