djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/speed_python: Clarify/generalize "Buffers" subsection.

This commit is contained in:
Paul Sokolovsky 2016-04-15 17:24:56 +03:00
parent f474e956d7
commit 6c84f1e03a
1 changed files with 4 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/speed_python.rst
View File

@ -59,12 +59,10 @@ An example of the above is the common case where a buffer is required, such as o
used for communication with a device. A typical driver will create the buffer in the
constructor and use it in its I/O methods which will be called repeatedly.
The MicroPython libraries typically provide optional support for pre-allocated buffers.
For example the ``uart.readinto()`` method allows two options for its argument, an integer
or a buffer. If an integer is supplied it will read up to that number of bytes and
return the outcome: this implies that a buffer is created with a corresponding
memory allocation. Providing a pre-allocated buffer as the argument avoids this. See
the code fragment in :ref:`Caching object references <Caching>` below.
The MicroPython libraries typically provide support for pre-allocated buffers. For
example, objects which support stream interface (e.g., file or UART) provide ``read()``
method which allocate new buffer for read data, but also a ``readinto()`` method
to read data into an existing buffer.
Floating Point
~~~~~~~~~~~~~~