Merge pull request #4060 from dhalbert/regularize-extmod-modules

CIRCUITPY_* switches for JSON, RE, etc. Doc cleanup

Author: dhalbert

README.rst

@@ -125,7 +125,7 @@ Behavior
    get back into normal mode.
 -  RGB status LED indicating CircuitPython state, and errors through a sequence of colored flashes.
 -  Re-runs ``code.py`` or other main file after file system writes over USB mass storage. (Disable with
-   ``samd.disable_autoreload()``)
+   ``supervisor.disable_autoreload()``)
 -  Entering the REPL after the main code is finished requires a key press which enters the REPL and
    disables autoreload.
 -  Main is one of these: ``code.txt``, ``code.py``, ``main.py``,

docs/library/uerrno.rst renamed to docs/library/errno.rst

@@ -1,9 +1,7 @@
-:mod:`uerrno` -- system error codes
+:mod:`errno` -- system error codes
 ===================================
 
-.. include:: ../templates/unsupported_in_circuitpython.inc
-
-.. module:: uerrno
+.. module:: errno
    :synopsis: system error codes
 
 |see_cpython_module| :mod:`cpython:errno`.
@@ -22,13 +20,13 @@ Constants
         try:
             os.mkdir("my_dir")
         except OSError as exc:
-            if exc.args[0] == uerrno.EEXIST:
+            if exc.args[0] == errno.EEXIST:
                 print("Directory already exists")
 
 .. data:: errorcode
 
     Dictionary mapping numeric error codes to strings with symbolic error
     code (see above)::
 
-        >>> print(uerrno.errorcode[uerrno.EEXIST])
+        >>> print(errno.errorcode[uerrno.EEXIST])
         EEXIST

docs/library/esp.rst

@@ -6,35 +6,21 @@ MicroPython libraries
 Python standard libraries and micro-libraries
 ---------------------------------------------
 
-These libraries are inherited from MicroPython.
-They are similar to the standard Python libraries with the same name
-or with the "u" prefix dropped.
+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.
 
-.. warning::
-
-   Though these MicroPython-based libraries are available in CircuitPython,
-   their functionality may change in the future, perhaps significantly.
-   As CircuitPython continues to develop, new versions of these libraries will
-   be created that are more compliant with the standard Python libraries.
-   You may need to change your code later if you rely
-   on any non-standard functionality they currently provide.
-
 CircuitPython's long-term goal is that code written in CircuitPython
 using Python standard libraries will be runnable on CPython without changes.
 
-Some libraries below are not enabled on CircuitPython builds with
+These libraries are not enabled on CircuitPython builds with
 limited flash memory, usually on non-Express builds:
-``uerrno``, ``ure``.
-
-Some libraries are not currently enabled in any CircuitPython build, but may be in the future:
-``uio``, ``ujson``, ``uzlib``.
+``binascii``, ``errno``, ``json``, ``re``.
 
-Some libraries are only enabled only WiFi-capable ports (ESP8266, nRF)
-because they are typically used for network software:
-``binascii``, ``hashlib``, ``uheapq``, ``uselect``, ``ussl``.
-Not all of these are enabled on all WiFi-capable ports.
+These libraries are not currently enabled in any CircuitPython build, but may be in the future,
+with the ``u`` prefix dropped:
+``uctypes``, ``uhashlib``, ``uzlib``.
 
 .. toctree::
    :maxdepth: 1
@@ -44,13 +30,14 @@ Not all of these are enabled on all WiFi-capable ports.
    array.rst
    binascii.rst
    collections.rst
+   errno.rst
    gc.rst
    hashlib.rst
+   io.rst
+   json.rst
+   re.rst
    sys.rst
-   uerrno.rst
-   uio.rst
-   ujson.rst
-   ure.rst
+   uctypes.rst
    uselect.rst
    usocket.rst
    ussl.rst
@@ -59,8 +46,8 @@ Not all of these are enabled on all WiFi-capable ports.
 Omitted functions in the ``string`` library
 -------------------------------------------
 
-A few string operations are not enabled on CircuitPython
-M0 non-Express builds, due to limited flash memory:
+A few string operations are not enabled on small builds
+(usually non-Express), due to limited flash memory:
 ``string.center()``, ``string.partition()``, ``string.splitlines()``,
 ``string.reversed()``.
 
@@ -78,15 +65,3 @@ versions of CircuitPython.
    btree.rst
    framebuf.rst
    micropython.rst
-   network.rst
-   uctypes.rst
-
-Libraries specific to the ESP8266
----------------------------------
-
-The following libraries are specific to the ESP8266.
-
-.. toctree::
-  :maxdepth: 2
-
-  esp.rst

docs/library/index.rst

@@ -1,9 +1,7 @@
-:mod:`uio` -- input/output streams
+:mod:`io` -- input/output streams
 ==================================
 
-.. include:: ../templates/unsupported_in_circuitpython.inc
-
-.. module:: uio
+.. module:: io
    :synopsis: input/output streams
 
 |see_cpython_module| :mod:`cpython:io`.

docs/library/uio.rst renamed to docs/library/io.rst

@@ -1,9 +1,7 @@
-:mod:`ujson` -- JSON encoding and decoding
+:mod:`json` -- JSON encoding and decoding
 ==========================================
 
-.. include:: ../templates/unsupported_in_circuitpython.inc
-
-.. module:: ujson
+.. module:: json
    :synopsis: JSON encoding and decoding
 
 |see_cpython_module| :mod:`cpython:json`.