binascii — Converte entre binário e ASCII

---

The binascii module contains a number of methods to convert between binary and various ASCII-encoded binary representations. Normally, you will not use these functions directly but use wrapper modules like base64 instead. The binascii module contains low-level functions written in C for greater speed that are used by the higher-level modules.

Nota

Funções a2b_* aceitam strings Unicode contendo apenas caracteres ASCII. Outras funções aceitam apenas objetos bytes ou similares (como bytes, bytearray e outros objetos que suportam o protocolo buffer).

Alterado na versão 3.3: Strings unicode exclusivamente ASCII agora são aceitas pelas funções a2b_*.

The binascii module defines the following functions:

binascii.a2b_uu(string)

Converte uma única linha de dados uuencoded de volta para binário e retorna os dados binários. As linhas normalmente contêm 45 bytes (binários), exceto a última linha. Os dados da linha podem ser seguidos por espaços em branco.

binascii.b2a_uu(data, *, backtick=False)

Converte dados binários para uma linha de caracteres ASCII, o valor de retorno é a linha convertida, incluindo um caractere de nova linha. O comprimento de data deve ser no máximo 45. Se backtick for true, zeros são representados por '`' em vez de espaços.

Alterado na versão 3.7: Adicionado o parâmetro backtick.

binascii.a2b_base64(string, /, *, strict_mode=False)

binascii.a2b_base64(string, /, *, strict_mode=True, ignorechars)

Converte um bloco de dados base64 de volta para binário e retorna os dados binários. Mais de uma linha pode ser passada por vez.

If ignorechars is specified, it should be a bytes-like object containing characters to ignore from the input when strict_mode is true. If ignorechars contains the pad character '=', the pad characters presented before the end of the encoded data and the excess pad characters will be ignored. The default value of strict_mode is True if ignorechars is specified, False otherwise.

Se strict_mode for true, somente dados base64 válidos serão convertidos. Dados base64 inválidos levantarão binascii.Error.

base64 válido:

• Conforms to RFC 4648.

• Contém apenas caracteres do alfabeto base64.

• Não contém dados excedentes após o preenchimento (incluindo excesso de preenchimento, novas linhas, etc.).

• Não começa com um preenchimento.

Alterado na versão 3.11: Adicionado o parâmetro strict_mode.

Alterado na versão 3.15.0a5 (unreleased): Added the ignorechars parameter.

binascii.b2a_base64(data, *, wrapcol=0, newline=True)

Convert binary data to a line(s) of ASCII characters in base64 coding, as specified in RFC 4648.

If wrapcol is non-zero, insert a newline (b'\n') character after at most every wrapcol characters. If wrapcol is zero (default), do not insert any newlines.

If newline is true (default), a newline character will be added at the end of the output.

Alterado na versão 3.6: Adicionado o parâmetro newline.

Alterado na versão 3.15: Added the wrapcol parameter.

binascii.a2b_ascii85(string, /, *, foldspaces=False, adobe=False, ignorechars=b'')

Convert Ascii85 data back to binary and return the binary data.

Valid Ascii85 data contains characters from the Ascii85 alphabet in groups of five (except for the final group, which may have from two to five characters). Each group encodes 32 bits of binary data in the range from 0 to 2 ** 32 - 1, inclusive. The special character z is accepted as a short form of the group !!!!!, which encodes four consecutive null bytes.

foldspaces is a flag that specifies whether the ‘y’ short sequence should be accepted as shorthand for 4 consecutive spaces (ASCII 0x20). This feature is not supported by the “standard” Ascii85 encoding.

adobe controls whether the input sequence is in Adobe Ascii85 format (i.e. is framed with <~ and ~>).

ignorechars should be a bytes-like object containing characters to ignore from the input. This should only contain whitespace characters.

Invalid Ascii85 data will raise binascii.Error.

Adicionado na versão 3.15.0a5 (unreleased).

binascii.b2a_ascii85(data, /, *, foldspaces=False, wrapcol=0, pad=False, adobe=False)

Convert binary data to a formatted sequence of ASCII characters in Ascii85 coding. The return value is the converted data.

foldspaces is an optional flag that uses the special short sequence ‘y’ instead of 4 consecutive spaces (ASCII 0x20) as supported by ‘btoa’. This feature is not supported by the “standard” Ascii85 encoding.

If wrapcol is non-zero, insert a newline (b'\n') character after at most every wrapcol characters. If wrapcol is zero (default), do not insert any newlines.

If pad is true, the input is padded with b'\0' so its length is a multiple of 4 bytes before encoding. Note that the btoa implementation always pads.

adobe controls whether the encoded byte sequence is framed with <~ and ~>, which is used by the Adobe implementation.

Adicionado na versão 3.15.0a5 (unreleased).

binascii.a2b_base85(string, /)

Convert Base85 data back to binary and return the binary data. More than one line may be passed at a time.

Valid Base85 data contains characters from the Base85 alphabet in groups of five (except for the final group, which may have from two to five characters). Each group encodes 32 bits of binary data in the range from 0 to 2 ** 32 - 1, inclusive.

Invalid Base85 data will raise binascii.Error.

Adicionado na versão 3.15.0a5 (unreleased).

binascii.b2a_base85(data, /, *, pad=False)

Convert binary data to a line of ASCII characters in Base85 coding. The return value is the converted line.

If pad is true, the input is padded with b'\0' so its length is a multiple of 4 bytes before encoding.

Adicionado na versão 3.15.0a5 (unreleased).

binascii.a2b_z85(string, /)

Convert Z85 data back to binary and return the binary data. More than one line may be passed at a time.

Valid Z85 data contains characters from the Z85 alphabet in groups of five (except for the final group, which may have from two to five characters). Each group encodes 32 bits of binary data in the range from 0 to 2 ** 32 - 1, inclusive.

See Z85 specification for more information.

Invalid Z85 data will raise binascii.Error.

Adicionado na versão 3.15.0a5 (unreleased).

binascii.b2a_z85(data, /, *, pad=False)

Convert binary data to a line of ASCII characters in Z85 coding. The return value is the converted line.

If pad is true, the input is padded with b'\0' so its length is a multiple of 4 bytes before encoding.

See Z85 specification for more information.

Adicionado na versão 3.15.0a5 (unreleased).

binascii.a2b_qp(data, header=False)

Convert a block of quoted-printable data back to binary and return the binary data. More than one line may be passed at a time. If the optional argument header is present and true, underscores will be decoded as spaces.

binascii.b2a_qp(data, quotetabs=False, istext=True, header=False)

Convert binary data to a line(s) of ASCII characters in quoted-printable encoding. The return value is the converted line(s). If the optional argument quotetabs is present and true, all tabs and spaces will be encoded. If the optional argument istext is present and true, newlines are not encoded but trailing whitespace will be encoded. If the optional argument header is present and true, spaces will be encoded as underscores per RFC 1522. If the optional argument header is present and false, newline characters will be encoded as well; otherwise linefeed conversion might corrupt the binary data stream.

binascii.crc_hqx(data, value)

Compute a 16-bit CRC value of data, starting with value as the initial CRC, and return the result. This uses the CRC-CCITT polynomial x¹⁶ + x¹² + x⁵ + 1, often represented as 0x1021. This CRC is used in the binhex4 format.

binascii.crc32(data[, value])

Compute CRC-32, the unsigned 32-bit checksum of data, starting with an initial CRC of value. The default initial CRC is zero. The algorithm is consistent with the ZIP file checksum. Since the algorithm is designed for use as a checksum algorithm, it is not suitable for use as a general hash algorithm. Use as follows:

print(binascii.crc32(b"hello world"))
# Or, in two pieces:
crc = binascii.crc32(b"hello")
crc = binascii.crc32(b" world", crc)
print('crc32 = {:#010x}'.format(crc))

Alterado na versão 3.0: O resultado é sempre sem sinal.

binascii.b2a_hex(data[, sep[, bytes_per_sep=1]])

binascii.hexlify(data[, sep[, bytes_per_sep=1]])

Return the hexadecimal representation of the binary data. Every byte of data is converted into the corresponding 2-digit hex representation. The returned bytes object is therefore twice as long as the length of data.

Similar functionality (but returning a text string) is also conveniently accessible using the bytes.hex() method.

If sep is specified, it must be a single character str or bytes object. It will be inserted in the output after every bytes_per_sep input bytes. Separator placement is counted from the right end of the output by default, if you wish to count from the left, supply a negative bytes_per_sep value.

>>> import binascii
>>> binascii.b2a_hex(b'\xb9\x01\xef')
b'b901ef'
>>> binascii.hexlify(b'\xb9\x01\xef', '-')
b'b9-01-ef'
>>> binascii.b2a_hex(b'\xb9\x01\xef', b'_', 2)
b'b9_01ef'
>>> binascii.b2a_hex(b'\xb9\x01\xef', b' ', -2)
b'b901 ef'

Alterado na versão 3.8: The sep and bytes_per_sep parameters were added.

binascii.a2b_hex(hexstr)

binascii.unhexlify(hexstr)

Return the binary data represented by the hexadecimal string hexstr. This function is the inverse of b2a_hex(). hexstr must contain an even number of hexadecimal digits (which can be upper or lower case), otherwise an Error exception is raised.

Similar functionality (accepting only text string arguments, but more liberal towards whitespace) is also accessible using the bytes.fromhex() class method.

exception binascii.Error

Exception raised on errors. These are usually programming errors.

exception binascii.Incomplete

Exception raised on incomplete data. These are usually not programming errors, but may be handled by reading a little more data and trying again.

Ver também

Módulo base64

Support for RFC compliant base64-style encoding in base 16, 32, 64, and 85.

Módulo quopri

Support for quoted-printable encoding used in MIME email messages.