circuitpython/docs/library/binascii.rst

:mod:`binascii` -- binary/ASCII conversions
============================================

.. module:: binascii
   :synopsis: binary/ASCII conversions

|see_cpython_module| :mod:`cpython: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.
docs: fix references to ubinascii 2018-05-03 10:34:43 -04:00			:mod:`binascii` -- binary/ASCII conversions
docs: Add quick docs for ubinascii. 2014-12-01 18:51:12 -05:00			`============================================`

docs: fix references to ubinascii 2018-05-03 10:34:43 -04:00			`.. module:: binascii`
docs: Add quick docs for ubinascii. 2014-12-01 18:51:12 -05:00			`:synopsis: binary/ASCII conversions`

Delete a bunch of docs, drivers and examples not relevant to CircuitPython. This fixes #345 and fixes #215. 2018-02-20 20:34:59 -05:00			\|see_cpython_module\| :mod:`cpython:binascii`.
docs/library: Add CPython docs xref to each pertinent module. Cross-reference text/link is implemented as RST substitution, so easy to consistently. 2017-07-02 08:37:31 -04:00
docs: Add quick docs for ubinascii. 2014-12-01 18:51:12 -05:00			`This module implements conversions between binary data and various`
			`encodings of it in ASCII form (in both directions).`

			`Functions`
			`---------`

docs/ubinascii: Document non-standard "sep" argument to hexlify(). 2016-04-07 05:39:00 -04:00			`.. function:: hexlify(data, [sep])`
docs: Add quick docs for ubinascii. 2014-12-01 18:51:12 -05:00
extmod/modubinascii: Update code, docs for hexlify now CPython has sep. Since CPython 3.8 the optional "sep" argument to hexlify is officially supported, so update comments in the code and the docs to reflect this. Signed-off-by: Damien George <damien@micropython.org> 2020-12-13 00:41:12 -05:00			`Convert the bytes in the data object to a hexadecimal representation.`
			`Returns a bytes object.`
docs/ubinascii: Document non-standard "sep" argument to hexlify(). 2016-04-07 05:39:00 -04:00
extmod/modubinascii: Update code, docs for hexlify now CPython has sep. Since CPython 3.8 the optional "sep" argument to hexlify is officially supported, so update comments in the code and the docs to reflect this. Signed-off-by: Damien George <damien@micropython.org> 2020-12-13 00:41:12 -05:00			`If the additional argument sep is supplied it is used as a separator`
			`between hexadecimal values.`
docs/ubinascii: Document non-standard "sep" argument to hexlify(). 2016-04-07 05:39:00 -04:00
extmod: Add ubinascii.unhexlify This also pulls out hex_digit from py/lexer.c and makes unichar_hex_digit 2015-05-18 17:41:25 -04:00			`.. function:: unhexlify(data)`

docs/ubinascii: Clean up grammar. 2016-04-27 08:47:33 -04:00			`Convert hexadecimal data to binary representation. Returns bytes string.`
extmod: Add ubinascii.unhexlify This also pulls out hex_digit from py/lexer.c and makes unichar_hex_digit 2015-05-18 17:41:25 -04:00			`(i.e. inverse of hexlify)`
docs/ubinascii: Document a2b_base64(), b2a_base64(). 2016-04-05 07:00:12 -04:00
			`.. function:: a2b_base64(data)`

docs/library/ubinascii: Update base64 docs. This clarifies return values and the handling of invalid (e.g. newline) characters. Encoding conforms to RFC 3548, but decoding does not, as it ignores invalid characters in base64 input. Instead, it conforms to MIME handling of base64 (RFC 2045). Note that CPython doesn't document handling of invalid characters in a2b_base64() docs: https://docs.python.org/3/library/binascii.html#binascii.a2b_base64 , so we specify it more explicitly than it, based on CPython's actual behavior (with which MicroPython now compliant). 2017-08-04 19:01:35 -04:00			`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.`
docs/ubinascii: Document a2b_base64(), b2a_base64(). 2016-04-05 07:00:12 -04:00
			`.. function:: b2a_base64(data)`

docs/library/ubinascii: Update base64 docs. This clarifies return values and the handling of invalid (e.g. newline) characters. Encoding conforms to RFC 3548, but decoding does not, as it ignores invalid characters in base64 input. Instead, it conforms to MIME handling of base64 (RFC 2045). Note that CPython doesn't document handling of invalid characters in a2b_base64() docs: https://docs.python.org/3/library/binascii.html#binascii.a2b_base64 , so we specify it more explicitly than it, based on CPython's actual behavior (with which MicroPython now compliant). 2017-08-04 19:01:35 -04:00			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.`