# `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, /, *, padded=True, alphabet=BASE64_ALPHABET, strict_mode=False, canonical=False)
binascii.a2b_base64(string, /, *, ignorechars, padded=True, alphabet=BASE64_ALPHABET, strict_mode=True, canonical=False)

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

  Optional alphabet must be a `bytes` object of length 64 which specifies an alternative alphabet.

  If padded is true, the last group of 4 base 64 alphabet characters must be padded with the „=“ character. If padded is false, padding is neither required nor recognized: the „=“ character is not treated as padding but as a non-alphabet character, which means it is silently discarded when strict_mode is false, or causes an `Error` when strict_mode is true unless b“=“ is included in ignorechars.

  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.

  If canonical is true, non-zero padding bits in the last group are rejected with `binascii.Error`, enforcing canonical encoding as defined in RFC 4648 section 3.5. This check is independent of strict_mode.

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

  Змінено в версії 3.15: Added the alphabet, canonical, ignorechars, and padded parameters.

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

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

  If padded is true (default), pad the encoded data with the „=“ character to a size multiple of 4. If padded is false, do not add the pad characters.

  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 alphabet, padded and wrapcol parameters.

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

  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. A single-character final group is always rejected as an encoding violation.

  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 encoded byte sequence is framed with `<~` and `~>`, as in a PostScript base-85 string literal. If adobe is true, a leading `<~` is optionally accepted, while a trailing `~>` is required, and `binascii.Error` is raised if it is not found.

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

  If canonical is true, non-canonical encodings are rejected with `binascii.Error`. Here «canonical» means the encoding that `b2a_ascii85()` would produce: the `z` abbreviation must be used for all-zero groups (rather than `!!!!!`), and partial final groups must use the same padding digits as the encoder.

  Invalid Ascii85 data will raise `binascii.Error`.

  Added in version 3.15.

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 zero-padding applied to the end of the input is fully retained in the output encoding, as done by `btoa`, producing an exact multiple of 5 bytes of output. This is not part of the standard encoding used in PDF, as it does not preserve the length of the data.

  adobe controls whether the encoded byte sequence is framed with `<~` and `~>`, as in a PostScript base-85 string literal. Note that while ASCII85Decode streams in PDF documents must be terminated with `~>`, they must not use a leading `<~`.

  Added in version 3.15.

binascii.a2b_base85(string, /, *, alphabet=BASE85_ALPHABET, ignorechars=b'', canonical=False)

  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. A single-character final group is always rejected as an encoding violation.

  Optional alphabet must be a `bytes` object of length 85 which specifies an alternative alphabet.

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

  If canonical is true, non-canonical encodings are rejected with `binascii.Error`. Here «canonical» means the encoding that `b2a_base85()` would produce: partial final groups must use the same padding digits as the encoder.

  Invalid Base85 data will raise `binascii.Error`.

  Added in version 3.15.

binascii.b2a_base85(data, /, *, alphabet=BASE85_ALPHABET, wrapcol=0, pad=False)

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

  Optional alphabet must be a bytes-like object of length 85 which specifies an alternative alphabet.

  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 zero-padding applied to the end of the input is retained in the output, which will always be a multiple of 5 bytes, and thus the length of the data may not be preserved on decoding.

  Added in version 3.15.

binascii.a2b_base32(string, /, *, padded=True, alphabet=BASE32_ALPHABET, ignorechars=b'', canonical=False)

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

  Valid base32 data contains characters from the base32 alphabet specified in RFC 4648 in groups of eight (if necessary, the final group is padded to eight characters with `=`). Each group encodes 40 bits of binary data in the range from `0` to `2 ** 40 - 1`, inclusive.

  Примітка

  This function does not map lowercase characters (which are invalid in standard base32) to their uppercase counterparts, nor does it contextually map `0` to `O` and `1` to `I`/`L` as RFC 4648 allows.

  Optional alphabet must be a `bytes` object of length 32 which specifies an alternative alphabet.

  If padded is true, the last group of 8 base 32 alphabet characters must be padded with the „=“ character. If padded is false, the „=“ character is treated as other non-alphabet characters (depending on the value of ignorechars).

  ignorechars should be a bytes-like object containing characters to ignore from the input. 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.

  If canonical is true, non-zero padding bits in the last group are rejected with `binascii.Error`, enforcing canonical encoding as defined in RFC 4648 section 3.5.

  Invalid base32 data will raise `binascii.Error`.

  Added in version 3.15.

binascii.b2a_base32(data, /, *, padded=True, alphabet=BASE32_ALPHABET, wrapcol=0)

  Convert binary data to a line of ASCII characters in base32 coding, as specified in RFC 4648. The return value is the converted line.

  Optional alphabet must be a bytes-like object of length 32 which specifies an alternative alphabet.

  If padded is true (default), pad the encoded data with the „=“ character to a size multiple of 8. If padded is false, do not add the pad characters.

  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.

  Added in version 3.15.

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 x16 + x12 + x5 + 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, *, ignorechars=b'')
binascii.unhexlify(hexstr, *, ignorechars=b'')

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

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

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

  Змінено в версії 3.15: Added the ignorechars parameter.

exception binascii.Error

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

exception binascii.Incomplete

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

binascii.BASE64_ALPHABET

  The Base 64 alphabet according to RFC 4648.

  Added in version 3.15.

binascii.URLSAFE_BASE64_ALPHABET

  The «URL and filename safe» Base 64 alphabet according to RFC 4648.

  Added in version 3.15.

binascii.UU_ALPHABET

  The uuencoding alphabet.

  Added in version 3.15.

binascii.CRYPT_ALPHABET

  The Base 64 alphabet used in the crypt(3) routine and in the GEDCOM format.

  Added in version 3.15.

binascii.BINHEX_ALPHABET

  The Base 64 alphabet used in BinHex 4 (HQX) within the classic Mac OS.

  Added in version 3.15.

binascii.BASE85_ALPHABET

  The Base85 alphabet.

  Added in version 3.15.

binascii.ASCII85_ALPHABET

  The Ascii85 alphabet.

  Added in version 3.15.

binascii.Z85_ALPHABET

  The Z85 alphabet.

  Added in version 3.15.

binascii.BASE32_ALPHABET

  The Base 32 alphabet according to RFC 4648.

  Added in version 3.15.

binascii.BASE32HEX_ALPHABET

  The «Extended Hex» Base 32 alphabet according to RFC 4648. Data encoded with this alphabet maintains its sort order during bitwise comparisons.

  Added in version 3.15.

Дивись також

Модуль `base64`

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

Модуль `quopri`

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