Skip to content

Encoders

blake2signer.encoders

Encoders: classes that implement the EncoderInterface.

B32Encoder (EncoderInterface)

Base32 encoder.

Source code in blake2signer/encoders.py
class B32Encoder(EncoderInterface):
    """Base32 encoder."""

    @property
    def alphabet(self) -> bytes:
        """Return the encoder alphabet characters."""
        return b'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567'

    def encode(self, data: bytes) -> bytes:
        """Encode given data to base32 without padding.

        Args:
            data: Data to encode.

        Returns:
            Encoded data.
        """
        return b32encode(data)

    def decode(self, data: bytes) -> bytes:
        """Decode given encoded data from base32 without padding.

        Args:
            data: Data to decode.

        Returns:
            Original data.
        """
        return b32decode(data)

alphabet: bytes property readonly

Return the encoder alphabet characters.

decode(self, data)

Decode given encoded data from base32 without padding.

Parameters:

Name Type Description Default
data bytes

Data to decode.

required

Returns:

Type Description
bytes

Original data.

Source code in blake2signer/encoders.py
def decode(self, data: bytes) -> bytes:
    """Decode given encoded data from base32 without padding.

    Args:
        data: Data to decode.

    Returns:
        Original data.
    """
    return b32decode(data)

encode(self, data)

Encode given data to base32 without padding.

Parameters:

Name Type Description Default
data bytes

Data to encode.

required

Returns:

Type Description
bytes

Encoded data.

Source code in blake2signer/encoders.py
def encode(self, data: bytes) -> bytes:
    """Encode given data to base32 without padding.

    Args:
        data: Data to encode.

    Returns:
        Encoded data.
    """
    return b32encode(data)

B64URLEncoder (EncoderInterface)

Base64 URL safe encoder.

Source code in blake2signer/encoders.py
class B64URLEncoder(EncoderInterface):
    """Base64 URL safe encoder."""

    @property
    def alphabet(self) -> bytes:
        """Return the encoder alphabet characters."""
        return b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-'

    def encode(self, data: bytes) -> bytes:
        """Encode given data to base64 URL safe without padding.

        Args:
            data: Data to encode.

        Returns:
            Encoded data.
        """
        return b64encode(data)

    def decode(self, data: bytes) -> bytes:
        """Decode given encoded data from base64 URL safe without padding.

        Args:
            data: Data to decode.

        Returns:
            Original data.
        """
        return b64decode(data)

alphabet: bytes property readonly

Return the encoder alphabet characters.

decode(self, data)

Decode given encoded data from base64 URL safe without padding.

Parameters:

Name Type Description Default
data bytes

Data to decode.

required

Returns:

Type Description
bytes

Original data.

Source code in blake2signer/encoders.py
def decode(self, data: bytes) -> bytes:
    """Decode given encoded data from base64 URL safe without padding.

    Args:
        data: Data to decode.

    Returns:
        Original data.
    """
    return b64decode(data)

encode(self, data)

Encode given data to base64 URL safe without padding.

Parameters:

Name Type Description Default
data bytes

Data to encode.

required

Returns:

Type Description
bytes

Encoded data.

Source code in blake2signer/encoders.py
def encode(self, data: bytes) -> bytes:
    """Encode given data to base64 URL safe without padding.

    Args:
        data: Data to encode.

    Returns:
        Encoded data.
    """
    return b64encode(data)

HexEncoder (EncoderInterface)

Hexadecimal encoder.

Source code in blake2signer/encoders.py
class HexEncoder(EncoderInterface):
    """Hexadecimal encoder."""

    @property
    def alphabet(self) -> bytes:
        """Return the encoder alphabet characters."""
        return b'ABCDEF0123456789'

    def encode(self, data: bytes) -> bytes:
        """Encode given data to hexadecimal.

        Args:
            data: Data to encode.

        Returns:
            Encoded data.
        """
        return hexencode(data)

    def decode(self, data: bytes) -> bytes:
        """Decode given encoded data from hexadecimal.

        Args:
            data: Data to decode.

        Returns:
            Original data.
        """
        return hexdecode(data)

alphabet: bytes property readonly

Return the encoder alphabet characters.

decode(self, data)

Decode given encoded data from hexadecimal.

Parameters:

Name Type Description Default
data bytes

Data to decode.

required

Returns:

Type Description
bytes

Original data.

Source code in blake2signer/encoders.py
def decode(self, data: bytes) -> bytes:
    """Decode given encoded data from hexadecimal.

    Args:
        data: Data to decode.

    Returns:
        Original data.
    """
    return hexdecode(data)

encode(self, data)

Encode given data to hexadecimal.

Parameters:

Name Type Description Default
data bytes

Data to encode.

required

Returns:

Type Description
bytes

Encoded data.

Source code in blake2signer/encoders.py
def encode(self, data: bytes) -> bytes:
    """Encode given data to hexadecimal.

    Args:
        data: Data to encode.

    Returns:
        Encoded data.
    """
    return hexencode(data)
Back to top