mirrors
/
micropython
mirror of https://github.com/micropython/micropython.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
micropython/docs/library/ubinascii.rst

41 lines
1.2 KiB
ReStructuredText
Raw Normal View History

docs: Add quick docs for ubinascii.
2014-12-01 23:51:12 +00: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 13:37:31 +01:00
|see_cpython_module| :mod:`python:binascii`.
docs: Add quick docs for ubinascii.
2014-12-01 23:51:12 +00: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 10:39:00 +01:00
.. function:: hexlify(data, [sep])
docs: Add quick docs for ubinascii.
2014-12-01 23:51:12 +00:00
docs/ubinascii: Clean up grammar.
2016-04-27 13:47:33 +01: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-18 22:41:25 +01:00
docs/ubinascii: Document non-standard "sep" argument to hexlify().
2016-04-07 10:39:00 +01:00
.. admonition:: Difference to CPython
:class: attention
docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.
2017-06-26 22:38:05 +01: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 10:39:00 +01: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-18 22:41:25 +01:00
.. function:: unhexlify(data)
docs/ubinascii: Clean up grammar.
2016-04-27 13:47:33 +01: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 22:41:25 +01:00
(i.e. inverse of hexlify)
docs/ubinascii: Document a2b_base64(), b2a_base64().
2016-04-05 12:00:12 +01: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-05 00:01:35 +01: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 12:00:12 +01: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-05 00:01:35 +01: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.