circuitpython/docs/library/index.rst

68 lines
1.7 KiB
ReStructuredText
Raw Normal View History

.. _micropython_lib:
MicroPython libraries
=====================
2018-05-22 19:52:01 -04:00
Python standard libraries and micro-libraries
---------------------------------------------
2021-01-25 23:06:47 -05:00
The libraries below are inherited from MicroPython.
They are similar to the standard Python libraries with the same name.
They implement a subset of or a variant of the corresponding
standard Python library.
2020-12-09 10:52:18 -05:00
CircuitPython's long-term goal is that code written in CircuitPython
using Python standard libraries will be runnable on CPython without changes.
These libraries are not enabled on CircuitPython builds with
2018-05-22 19:52:01 -04:00
limited flash memory, usually on non-Express builds:
``binascii``, ``errno``, ``json``, ``re``.
2018-05-22 19:52:01 -04:00
These libraries are not currently enabled in any CircuitPython build, but may be in the future,
with the ``u`` prefix dropped:
2021-01-25 23:06:47 -05:00
``uctypes``, ``uhashlib``, ``uzlib``.
.. toctree::
:maxdepth: 1
builtins.rst
2018-05-22 19:52:01 -04:00
uheapq.rst
array.rst
2018-05-03 10:34:43 -04:00
binascii.rst
collections.rst
errno.rst
2018-05-22 19:52:01 -04:00
gc.rst
2018-05-06 13:23:21 -04:00
hashlib.rst
io.rst
json.rst
re.rst
2018-05-22 19:52:01 -04:00
sys.rst
uctypes.rst
uselect.rst
usocket.rst
ussl.rst
uzlib.rst
2018-05-22 19:52:01 -04:00
Omitted functions in the ``string`` library
-------------------------------------------
A few string operations are not enabled on small builds
(usually non-Express), due to limited flash memory:
2018-05-22 19:52:01 -04:00
``string.center()``, ``string.partition()``, ``string.splitlines()``,
``string.reversed()``.
2018-05-22 19:52:01 -04:00
CircuitPython/MicroPython-specific libraries
2018-05-22 21:21:19 -04:00
--------------------------------------------
Functionality specific to the CircuitPython/MicroPython implementation is available in
2020-12-09 10:52:18 -05:00
the following libraries. These libraries may change significantly or be removed in future
versions of CircuitPython.
.. toctree::
:maxdepth: 1
btree.rst
framebuf.rst
micropython.rst