Skip to content

Encoders

blake2signer.encoders

Encoders: classes that implement the EncoderInterface.

B32Encoder

Bases: EncoderInterface

Base32 encoder.

Source code in blake2signer/encoders.py 
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
72
73
74
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 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 
65
66
67
68
69
70
71
72
73
74
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 
54
55
56
57
58
59
60
61
62
63
def encode(self, data: bytes) -> bytes:
    """Encode given data to base32 without padding.

    Args:
        data: Data to encode.

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

B58Encoder

Bases: EncoderInterface

Base58 encoder.

It contains characters from a-z (except l), A-Z (except I and O), and numbers 1-9, to improve readability and reduce transcription errors.

Source code in blake2signer/encoders.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
class B58Encoder(EncoderInterface):
    """Base58 encoder.

    It contains characters from a-z (except `l`), A-Z (except `I` and `O`), and numbers 1-9,
    to improve readability and reduce transcription errors.
    """

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

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

        Args:
            data: Data to encode.

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

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

        Args:
            data: Data to decode.

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

alphabet property

Return the encoder alphabet characters.

decode(data)

Decode given encoded data from base58.

Parameters:

Name Type Description Default
data bytes

Data to decode.

 required

Returns:

Type Description
bytes

Original data.
Source code in blake2signer/encoders.py 
131
132
133
134
135
136
137
138
139
140
def decode(self, data: bytes) -> bytes:
    """Decode given encoded data from base58.

    Args:
        data: Data to decode.

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

encode(data)

Encode given data to base58.

Parameters:

Name Type Description Default
data bytes

Data to encode.

 required

Returns:

Type Description
bytes

Encoded data.
Source code in blake2signer/encoders.py 
120
121
122
123
124
125
126
127
128
129
def encode(self, data: bytes) -> bytes:
    """Encode given data to base58.

    Args:
        data: Data to encode.

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

B64URLEncoder

Bases: EncoderInterface

Base64 URL-safe encoder.

Source code in blake2signer/encoders.py 
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
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 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 
34
35
36
37
38
39
40
41
42
43
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 
23
24
25
26
27
28
29
30
31
32
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 
 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
103
104
105
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 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 
 96
 97
 98
 99
100
101
102
103
104
105
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 
85
86
87
88
89
90
91
92
93
94
def encode(self, data: bytes) -> bytes:
    """Encode given data to hexadecimal.

    Args:
        data: Data to encode.

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