Skip to content

hololinked.core.interfaces.serializer.BaseSerializer

Bases: object

Base class for serializer implementations.

All serializers must inherit this class and overload dumps() and loads() to be usable. Any serializer that returns bytes when serialized and a python object on deserialization will be accepted. Serialization and deserialization errors will be passed as invalid message type from server side and a exception will be raised on the client.

Source code in repo/hololinked/hololinked/core/interfaces/serializer.py 
 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
class BaseSerializer(object):
    """
    Base class for serializer implementations.

    All serializers must inherit this class
    and overload dumps() and loads() to be usable. Any serializer
    that returns bytes when serialized and a python object on deserialization will be accepted.
    Serialization and deserialization errors will be passed as invalid message type
    from server side and a exception will be raised on the client.
    """

    def __init__(self) -> None:
        super().__init__()
        self.type = None

    def loads(self, data) -> Any:
        """Deserialize data."""
        raise NotImplementedError("implement loads()/deserialization in subclass")

    def dumps(self, data) -> bytes:
        """Serialize data."""
        raise NotImplementedError("implement dumps()/serialization in subclass")

    def convert_to_bytes(self, data) -> bytes:
        """
        Convert data to bytes if it is bytearray or memoryview.

        Returns
        -------
        bytes

        Raises
        ------
        TypeError
            if data is not bytes, bytearray or memoryview
        """
        if isinstance(data, bytes):
            return data
        if isinstance(data, bytearray):
            return bytes(data)
        if isinstance(data, memoryview):
            return data.tobytes()
        raise TypeError(
            "serializer convert_to_bytes accepts only bytes, bytearray or memoryview, not type {}".format(type(data))
        )

    @property
    def content_type(self) -> str:
        """Content type of the serializer."""
        raise NotImplementedError("serializer must implement a content type")

Attributes

type instance-attribute 

type = None

Functions

__init__ 

__init__() -> None
Source code in repo/hololinked/hololinked/core/interfaces/serializer.py 
17
18
19
def __init__(self) -> None:
    super().__init__()
    self.type = None

content_type 

content_type() -> str

Content type of the serializer.

Source code in repo/hololinked/hololinked/core/interfaces/serializer.py 
52
53
54
55
@property
def content_type(self) -> str:
    """Content type of the serializer."""
    raise NotImplementedError("serializer must implement a content type")

dumps 

dumps(data) -> bytes

Serialize data.

Source code in repo/hololinked/hololinked/core/interfaces/serializer.py 
25
26
27
def dumps(self, data) -> bytes:
    """Serialize data."""
    raise NotImplementedError("implement dumps()/serialization in subclass")

loads 

loads(data) -> Any

Deserialize data.

Source code in repo/hololinked/hololinked/core/interfaces/serializer.py 
21
22
23
def loads(self, data) -> Any:
    """Deserialize data."""
    raise NotImplementedError("implement loads()/deserialization in subclass")

convert_to_bytes 

convert_to_bytes(data) -> bytes

Convert data to bytes if it is bytearray or memoryview.

Returns:

Type Description
bytes

Raises:

Type Description
TypeError

if data is not bytes, bytearray or memoryview
Source code in repo/hololinked/hololinked/core/interfaces/serializer.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
def convert_to_bytes(self, data) -> bytes:
    """
    Convert data to bytes if it is bytearray or memoryview.

    Returns
    -------
    bytes

    Raises
    ------
    TypeError
        if data is not bytes, bytearray or memoryview
    """
    if isinstance(data, bytes):
        return data
    if isinstance(data, bytearray):
        return bytes(data)
    if isinstance(data, memoryview):
        return data.tobytes()
    raise TypeError(
        "serializer convert_to_bytes accepts only bytes, bytearray or memoryview, not type {}".format(type(data))
    )