Skip to content

Encoders

blake2signer.encoders

Encoders: classes that implement the EncoderInterface.

B32Encoder

Bases: EncoderInterface

Base32 encoder.

Source code in blake2signer/encoders.py
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
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

Return the encoder alphabet characters.

decode(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
62
63
64
65
66
67
68
69
70
71
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(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
51
52
53
54
55
56
57
58
59
60
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

Bases: EncoderInterface

Base64 URL-safe encoder.

Source code in blake2signer/encoders.py
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
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

Return the encoder alphabet characters.

decode(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
31
32
33
34
35
36
37
38
39
40
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(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
20
21
22
23
24
25
26
27
28
29
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

Bases: EncoderInterface

Hexadecimal encoder.

Source code in blake2signer/encoders.py
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
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

Return the encoder alphabet characters.

decode(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
 93
 94
 95
 96
 97
 98
 99
100
101
102
def decode(self, data: bytes) -> bytes:
    """Decode given encoded data from hexadecimal.

    Args:
        data: Data to decode.

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

encode(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
82
83
84
85
86
87
88
89
90
91
def encode(self, data: bytes) -> bytes:
    """Encode given data to hexadecimal.

    Args:
        data: Data to encode.

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