binascii — Convert between binary and 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.

Примітка

Функції a2b_* приймають рядки Unicode, що містять лише символи ASCII. Інші функції приймають лише байтоподібні об’єкти (такі як bytes, bytearray та інші об’єкти, які підтримують протокол буфера).

Змінено в версії 3.3: Функції a2b_* тепер приймають рядки Unicode тільки ASCII.

The binascii module defines the following functions:

binascii.a2b_uu(string)

Перетворити один рядок uuencoded даних назад у двійкові та повернути двійкові дані. Рядки зазвичай містять 45 (двійкових) байт, за винятком останнього рядка. Після рядкових даних може стояти пробіл.

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

Перетворює двійкові дані на рядок із символами ASCII, повертається значенням є перетворений рядок, включаючи символ нового рядка. Довжина data має становити щонайбільше 45. Якщо backtick має значення true, нулі позначаються символом ''`' замість пробілів.

Змінено в версії 3.7: Додано параметр backtick.

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

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

Перетворіть блок даних base64 назад у двійковий і поверніть двійкові дані. Одночасно можна передати більше одного рядка.

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.

If strict_mode is true, only valid base64 data will be converted. Invalid base64 data will raise binascii.Error.

Valid base64:

• Conforms to RFC 4648.

• Contains only characters from the base64 alphabet.

• Contains no excess data after padding (including excess padding, newlines, etc.).

• Does not start with a padding.

Змінено в версії 3.11: Added the strict_mode parameter.

Змінено в версії 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.

Змінено в версії 3.6: Додано параметр новий рядок.

Змінено в версії 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.

Added in version 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.

Added in version 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.

Added in version 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.

Added in version 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.

Added in version 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.

Added in version 3.15.0a5 (unreleased).

binascii.a2b_qp(data, header=False)

Перетворити блок даних, які можна роздрукувати в лапках, назад у двійкові та повернути двійкові дані. Одночасно можна передати більше одного рядка. Якщо необов’язковий аргумент header присутній і має значення true, підкреслення розшифровуватимуться як пробіли.

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

Перетворюйте двійкові дані на рядки символів ASCII у кодуванні, що друкується в лапках. Поверненим значенням є перетворені рядки. Якщо необов’язковий аргумент quotetabs присутній і вірний, усі символи табуляції та пробіли будуть закодовані. Якщо необов’язковий аргумент istext присутній і має значення true, нові рядки не кодуються, але кінцеві пробіли кодуються. Якщо необов’язковий аргумент header присутній і відповідає дійсності, пробіли будуть закодовані як підкреслення відповідно до RFC 1522. Якщо необов’язковий аргумент header присутній і false, символи нового рядка також будуть закодовані; інакше перетворення переводу рядка може пошкодити двійковий потік даних.

binascii.crc_hqx(data, value)

Обчисліть 16-бітне значення CRC data, починаючи з value як початкового CRC, і поверніть результат. Тут використовується поліном CRC-CCITT x¹⁶ + x¹² + x⁵ + 1, який часто представляється як 0x1021. Цей CRC використовується у форматі binhex4.

binascii.crc32(data[, value])

Обчисліть CRC-32, беззнакову 32-бітну контрольну суму даних, починаючи з початкового CRC значення. Початковий CRC за умовчанням дорівнює нулю. Алгоритм узгоджується з контрольною сумою файлу ZIP. Оскільки алгоритм розроблено для використання як алгоритм контрольної суми, він не підходить для використання як загальний алгоритм хешування. Використовуйте наступним чином:

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))

Змінено в версії 3.0: The result is always unsigned.

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

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

Повертає шістнадцяткове представлення двійкових даних. Кожен байт даних перетворюється у відповідне 2-значне шістнадцяткове представлення. Тому повернутий об’єкт bytes вдвічі довший за довжину data.

Подібні функції (але повернення текстового рядка) також зручно доступні за допомогою методу bytes.hex().

Якщо вказано sep, це має бути односимвольний об’єкт str або bytes. Його буде вставлено у вивід після кожного вхідного байта bytes_per_sep. Розташування роздільника за замовчуванням відраховується від правого кінця виводу. Якщо ви бажаєте відраховувати зліва, укажіть від’ємне значення bytes_per_sep.

>>> 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'

Змінено в версії 3.8: Додано параметри sep і bytes_per_sep.

binascii.a2b_hex(hexstr)

binascii.unhexlify(hexstr)

Повертає двійкові дані, представлені шістнадцятковим рядком hexstr. Ця функція є зворотною до b2a_hex(). hexstr має містити парну кількість шістнадцяткових цифр (які можуть бути великими чи нижніми регістрами), інакше виникає виняткова ситуація Error.

Подібна функціональність (приймає лише текстові рядкові аргументи, але більш вільна щодо пробілів) також доступна за допомогою методу класу bytes.fromhex().

exception binascii.Error

Виняток, викликаний помилками. Зазвичай це помилки програмування.

exception binascii.Incomplete

Винятком є неповні дані. Зазвичай це не помилки програмування, але їх можна вирішити, прочитавши трохи більше даних і повторивши спробу.

Дивись також

Модуль base64

Підтримка RFC-сумісного кодування в стилі base64 у базових 16, 32, 64 та 85.

Модуль quopri

Підтримка кодування для друку в лапках, що використовується в електронних повідомленнях MIME.