Skip to content

Pickle

cachetory.serializers.PickleSerializer

Uses the standard built-in pickle serialization.

Source code in cachetory/serializers/pickle.py 
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
class PickleSerializer(Serializer[ValueT, bytes], Generic[ValueT]):
    """
    Uses the standard built-in [`pickle`][1] serialization.

    [1]: https://docs.python.org/3/library/pickle.html
    """

    __slots__ = ("protocol",)

    @classmethod
    def from_url(cls, url: str) -> PickleSerializer[ValueT]:
        """
        Construct serializer from the URL.

        # Supported schema's

        - `pickle://`

        # URL parameters

        | Parameter         |                           |
        |-------------------|---------------------------|
        | `pickle-protocol` | `pickle` protocol version |
        """
        params = _UrlParams.model_validate(dict(parse_qsl(urlparse(url).query)))
        return cls(pickle_protocol=params.pickle_protocol)

    def __init__(self, pickle_protocol: int = pickle.HIGHEST_PROTOCOL) -> None:
        """
        Initialize the serializer.

        Args:
            pickle_protocol: `pickle` protocol version
        """
        self.protocol = pickle_protocol

    def serialize(self, value: ValueT) -> bytes:
        return pickle.dumps(value, self.protocol)

    def deserialize(self, data: bytes) -> ValueT:
        return pickle.loads(data)  # type: ignore[no-any-return]

from_url classmethod 

from_url(url: str) -> PickleSerializer[ValueT]

Construct serializer from the URL.

Supported schema's

  • pickle://

URL parameters

Parameter
pickle-protocol pickle protocol version
Source code in cachetory/serializers/pickle.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
@classmethod
def from_url(cls, url: str) -> PickleSerializer[ValueT]:
    """
    Construct serializer from the URL.

    # Supported schema's

    - `pickle://`

    # URL parameters

    | Parameter         |                           |
    |-------------------|---------------------------|
    | `pickle-protocol` | `pickle` protocol version |
    """
    params = _UrlParams.model_validate(dict(parse_qsl(urlparse(url).query)))
    return cls(pickle_protocol=params.pickle_protocol)

__init__ 

__init__(pickle_protocol: int = pickle.HIGHEST_PROTOCOL) -> None

Initialize the serializer.

Parameters:

Name Type Description Default
pickle_protocol int

pickle protocol version

 HIGHEST_PROTOCOL
Source code in cachetory/serializers/pickle.py 
40
41
42
43
44
45
46
47
def __init__(self, pickle_protocol: int = pickle.HIGHEST_PROTOCOL) -> None:
    """
    Initialize the serializer.

    Args:
        pickle_protocol: `pickle` protocol version
    """
    self.protocol = pickle_protocol