File: msgpack.py

package info (click to toggle)
python-persist-queue 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 328 kB
  • sloc: python: 2,754; sh: 13; makefile: 3
file content (71 lines) | stat: -rw-r--r-- 2,117 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
"""
A serializer that extends msgpack to specify recommended parameters and adds a
4 byte length prefix to store multiple objects per file.
"""
import msgpack
import struct
from typing import Any, BinaryIO, Dict


def dump(value: Any, fp: BinaryIO, sort_keys: bool = False) -> None:
    """
    Serialize value as msgpack to a byte-mode file object with a length prefix.

    Args:
        value: The Python object to serialize.
        fp: A file-like object supporting binary write operations.
        sort_keys: If True, the output of dictionaries will be sorted by key.

    Returns:
        None
    """
    if sort_keys and isinstance(value, Dict):
        value = {key: value[key] for key in sorted(value)}
    packed = msgpack.packb(value, use_bin_type=True)
    length = struct.pack("<L", len(packed))
    fp.write(length)
    fp.write(packed)


def dumps(value: Any, sort_keys: bool = False) -> bytes:
    """
    Serialize value as msgpack to bytes.

    Args:
        value: The Python object to serialize.
        sort_keys: If True, the output of dictionaries will be sorted by key.

    Returns:
        A bytes object containing the serialized representation of value.
    """
    if sort_keys and isinstance(value, Dict):
        value = {key: value[key] for key in sorted(value)}
    return msgpack.packb(value, use_bin_type=True)


def load(fp: BinaryIO) -> Any:
    """
    Deserialize one msgpack value from a byte-mode file object using length
    prefix.

    Args:
        fp: A file-like object supporting binary read operations.

    Returns:
        The deserialized Python object.
    """
    length = struct.unpack("<L", fp.read(4))[0]
    return msgpack.unpackb(fp.read(length), use_list=False, raw=False)


def loads(bytes_value: bytes) -> Any:
    """
    Deserialize one msgpack value from bytes.

    Args:
        bytes_value: A bytes object containing the serialized msgpack data.

    Returns:
        The deserialized Python object.
    """
    return msgpack.unpackb(bytes_value, use_list=False, raw=False)