micropython/docs/library/ubinascii.rst

: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 binary data to hexadecimal representation. Returns bytes string.

   .. admonition:: Difference to CPython
      :class: attention

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

   Convert Base64-encoded data to binary representation. Returns bytes string.

.. function:: b2a_base64(data)

   Encode binary data in Base64 format. Returns string.
docs: Add quick docs for ubinascii. 2014-12-02 07:51:12 +08:00			:mod:`ubinascii` -- binary/ASCII conversions
			`============================================`

			`.. module:: ubinascii`
			`:synopsis: binary/ASCII conversions`

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 20:37:31 +08:00			\|see_cpython_module\| :mod:`python:binascii`.

docs: Add quick docs for ubinascii. 2014-12-02 07:51:12 +08: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 17:39:00 +08:00			`.. function:: hexlify(data, [sep])`
docs: Add quick docs for ubinascii. 2014-12-02 07:51:12 +08:00
docs/ubinascii: Clean up grammar. 2016-04-27 20:47:33 +08:00			`Convert binary data to hexadecimal 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-19 05:41:25 +08:00
docs/ubinascii: Document non-standard "sep" argument to hexlify(). 2016-04-07 17:39:00 +08:00			`.. admonition:: Difference to CPython`
			`:class: attention`

docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions. 2017-06-27 05:38:05 +08:00			`If additional argument, sep is supplied, it is used as a separator`
docs/ubinascii: Document non-standard "sep" argument to hexlify(). 2016-04-07 17:39:00 +08:00			`between hexadecimal values.`

extmod: Add ubinascii.unhexlify This also pulls out hex_digit from py/lexer.c and makes unichar_hex_digit 2015-05-19 05:41:25 +08:00			`.. function:: unhexlify(data)`

docs/ubinascii: Clean up grammar. 2016-04-27 20:47:33 +08: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-19 05:41:25 +08:00			`(i.e. inverse of hexlify)`
docs/ubinascii: Document a2b_base64(), b2a_base64(). 2016-04-05 19:00:12 +08:00
			`.. function:: a2b_base64(data)`

docs/ubinascii: Clean up grammar. 2016-04-27 20:47:33 +08:00			`Convert Base64-encoded data to binary representation. Returns bytes string.`
docs/ubinascii: Document a2b_base64(), b2a_base64(). 2016-04-05 19:00:12 +08:00
			`.. function:: b2a_base64(data)`

docs/ubinascii: Clean up grammar. 2016-04-27 20:47:33 +08:00			`Encode binary data in Base64 format. Returns string.`