diff options
Diffstat (limited to 'docs/library/binascii.rst')
| -rw-r--r-- | docs/library/binascii.rst | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/library/binascii.rst b/docs/library/binascii.rst new file mode 100644 index 0000000000..721b80508e --- /dev/null +++ b/docs/library/binascii.rst @@ -0,0 +1,38 @@ +:mod:`ubinascii` -- binary/ASCII conversions +============================================ + +.. module:: ubinascii + :synopsis: binary/ASCII conversions + +|see_cpython_module| :mod:`python:binascii`. + +This module implements conversions between binary data and various +encodings of it in ASCII form (in both directions). + +Functions +--------- + +.. function:: hexlify(data, [sep]) + + Convert the bytes in the *data* object to a hexadecimal representation. + Returns a bytes object. + + If the additional argument *sep* is supplied it is used as a separator + between hexadecimal values. + +.. function:: unhexlify(data) + + Convert hexadecimal data to binary representation. Returns bytes string. + (i.e. inverse of hexlify) + +.. function:: a2b_base64(data) + + Decode base64-encoded data, ignoring invalid characters in the input. + Conforms to `RFC 2045 s.6.8 <https://tools.ietf.org/html/rfc2045#section-6.8>`_. + Returns a bytes object. + +.. function:: b2a_base64(data) + + Encode binary data in base64 format, as in `RFC 3548 + <https://tools.ietf.org/html/rfc3548.html>`_. Returns the encoded data + followed by a newline character, as a bytes object. |