Skip to content

Serializers

blake2signer.serializers

Serializers: classes that implement the SerializerInterface.

JSONSerializer

JSON serializer.

serialize(self, data, **kwargs)

Serialize given data to JSON.

Parameters:

Name Type Description Default
data Any

Data to serialize.

required
**kwargs Any

Additional arguments for json.dumps.

{}

Returns:

Type Description
bytes

Serialized data

Source code in blake2signer/serializers.py
def serialize(self, data: typing.Any, **kwargs: typing.Any) -> bytes:
    """Serialize given data to JSON.

    Args:
        data: Data to serialize.
        **kwargs: Additional arguments for `json.dumps`.

    Returns:
        Serialized data
    """
    kwargs.setdefault('separators', (',', ':'))  # Use JSON compact encoding
    return json.dumps(data, **kwargs).encode()

unserialize(self, data, **kwargs)

Unserialize given JSON data.

Parameters:

Name Type Description Default
data bytes

Serialized data to unserialize.

required
**kwargs Any

Additional arguments for json.loads.

{}

Returns:

Type Description
Any

Original data.

Source code in blake2signer/serializers.py
def unserialize(self, data: bytes, **kwargs: typing.Any) -> typing.Any:
    """Unserialize given JSON data.

    Args:
        data: Serialized data to unserialize.
        **kwargs: Additional arguments for `json.loads`.

    Returns:
        Original data.
    """
    return json.loads(data, **kwargs)

NullSerializer

Null serializer that doesn't serializes anything.

serialize(self, data, **kwargs)

Null serialize data (it just converts it to bytes).

Parameters:

Name Type Description Default
data Any

Data to serialize.

required
**kwargs Any

Ignored.

{}

Returns:

Type Description
bytes

Serialized data

Source code in blake2signer/serializers.py
def serialize(self, data: typing.Any, **kwargs: typing.Any) -> bytes:
    """Null serialize data (it just converts it to bytes).

    Args:
        data: Data to serialize.
        **kwargs: Ignored.

    Returns:
        Serialized data
    """
    return force_bytes(data)

unserialize(self, data, **kwargs)

Return given data as-is.

Parameters:

Name Type Description Default
data bytes

Serialized data to unserialize.

required
**kwargs Any

Ignored.

{}

Returns:

Type Description
Any

Original data.

Source code in blake2signer/serializers.py
def unserialize(self, data: bytes, **kwargs: typing.Any) -> typing.Any:
    """Return given data as-is.

    Args:
        data: Serialized data to unserialize.
        **kwargs: Ignored.

    Returns:
        Original data.
    """
    return data