djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
circuitpython/docs/library/binascii.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

39 lines
1.2 KiB
ReStructuredText
Raw Normal View History

docs: Replace ufoo with foo in all docs. Anywhere a module is mentioned, use its "non-u" name for consistency. The "import module" vs "import umodule" is something of a FAQ, and this commit intends to help clear that up. As a first approximation MicroPython is Python, and so imports should work the same as Python and use the same name, to a first approximation. The u-version of a module is a detail that can be learned later on, when the user wants to understand more and have finer control over importing. Existing Python code should just work, as much as it is possible to do that within the constraints of embedded systems, and the MicroPython documentation should match the idiomatic way to write Python code. With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users can consistently use "import foo" across all ports (with the exception of the minimal ports). And the ability to override/extend via "foo.py" continues to work well. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-08-11 23:59:29 -04:00
:mod:`binascii` -- binary/ASCII conversions
===========================================
docs: Add quick docs for ubinascii.
2014-12-01 18:51:12 -05:00
docs: Replace ufoo with foo in all docs. Anywhere a module is mentioned, use its "non-u" name for consistency. The "import module" vs "import umodule" is something of a FAQ, and this commit intends to help clear that up. As a first approximation MicroPython is Python, and so imports should work the same as Python and use the same name, to a first approximation. The u-version of a module is a detail that can be learned later on, when the user wants to understand more and have finer control over importing. Existing Python code should just work, as much as it is possible to do that within the constraints of embedded systems, and the MicroPython documentation should match the idiomatic way to write Python code. With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users can consistently use "import foo" across all ports (with the exception of the minimal ports). And the ability to override/extend via "foo.py" continues to work well. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-08-11 23:59:29 -04:00
.. module:: binascii
docs: Add quick docs for ubinascii.
2014-12-01 18:51:12 -05:00
: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 08:37:31 -04:00
|see_cpython_module| :mod:`python:binascii`.
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
extmod/modubinascii: Add newline keyword to b2a_base64 function. This allows encoding things (eg a Basic-Auth header for a request) without slicing the \n from the string, which allocates additional memory. Co-authored-by: David Lechner <david@lechnology.com>
2022-01-15 09:19:59 -05:00
.. function:: b2a_base64(data, *, newline=True)
docs/ubinascii: Document a2b_base64(), b2a_base64().
2016-04-05 07:00:12 -04:00
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
extmod/modubinascii: Add newline keyword to b2a_base64 function. This allows encoding things (eg a Basic-Auth header for a request) without slicing the \n from the string, which allocates additional memory. Co-authored-by: David Lechner <david@lechnology.com>
2022-01-15 09:19:59 -05:00
followed by a newline character if newline is true, as a bytes object.