# `binascii` --- バイナリ と 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_*` 関数は ASCII 文字だけを含むユニコード文字列を受け取ります。他の関数は (`bytes` や `bytearray` またはバッファープロトコルをサポートするその他のオブジェクトのような) bytes-like オブジェクト だけを受け取ります。

バージョン 3.3 で変更: `a2b_*` 関数は ASCII のみのユニコード文字列を受け取るようになりました。

The `binascii` module defines the following functions:

binascii.a2b_uu(string)

  uuencode された 1 行のデータをバイナリに変換し、変換後のバイナリデータを返します。最後の行を除いて、通常 1 行には (バイナリデータで) 45 バイトが含まれます。入力データの先頭には空白文字が連続していてもかまいません。

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

  Convert binary data to a line of ASCII characters, the return value is the converted line, including a newline char. The length of data should be at most 45. If backtick is true, zeros are represented by `'`'` instead of spaces.

  バージョン 3.7 で変更: backtick パラメータを追加しました.

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

  base64 でエンコードされたデータのブロックをバイナリに変換し、変換後のバイナリデータを返します。一度に 1 行以上のデータを与えてもかまいません。

  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 で変更: パラメータに newline を追加しました。

  バージョン 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)

  quoted-printable 形式のデータをバイナリに変換し、バイナリデータを返します。一度に 1 行以上のデータを渡すことができます。オプション引数 header が与えられており、かつその値が真であれば、アンダースコアは空白文字にデコードされます。

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

  バイナリデータを quoted-printable 形式でエンコードして 1 行から複数行の ASCII 文字列に変換します。変換後の文字列を返します。オプション引数 quptetabs が存在し、かつその値が真であれば、全てのタブおよび空白文字もエンコードされます。オプション引数 istext が存在し、かつその値が真であれば、改行はエンコードされませんが、行末の空白文字はエンコードされます。オプション引数 header が存在し、かつその値が真である場合、空白文字は RFC 1522 にしたがってアンダースコアにエンコードされます。オプション引数 header が存在し、かつその値が偽である場合、改行文字も同様にエンコードされます。そうでない場合、復帰 (linefeed) 文字の変換によってバイナリデータストリームが破損してしまうかもしれません。

binascii.crc_hqx(data, value)

  value を CRC の初期値として data の 16 ビット CRC 値を計算し、その結果を返します。 この関数は、よく 0x1021 と表現される CRC-CCITT 多項式 x16 + x12 + x5 + 1 を使います。 この CRC は binhex4 形式で使われています。

binascii.crc32(data[, value])

  符号無し 32 ビットチェックサムである CRC-32 を data に対して計算します。 crc の初期値は value です。デフォルトの 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]])

  バイナリ data の16進表現を返します。data の各バイトは、対応する2桁の16進表現に変換されます。したがって、返されるバイトオブジェクトは data の2倍の長さになります。

  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'

  バージョン 3.8 で変更: 引数 sep と bytes_per_sep が追加されました.

binascii.a2b_hex(hexstr)
binascii.unhexlify(hexstr)

  16進数表記の文字列 hexstr の表すバイナリデータを返します。この関数は `b2a_hex()` の逆です。 hexstr は 16進数字 (大文字でも小文字でも構いません) を偶数個含んでいなければなりません。そうでない場合、例外 `Error` が送出されます。

  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 binascii.Incomplete

  変換するデータが不完全な場合に送出される例外です。通常はプログラムのエラーではなく、多少追加読み込みを行って再度変換を試みることで対処できます。

参考

`base64` モジュール

  RFC 準拠の base64 形式の、底が 16、32、64、85 のエンコーディング。

`quopri` モジュール

  MIME 電子メールメッセージで使われる quoted-printable エンコードのサポート。