Merge pull request #8481 from dhalbert/v1.20-merge

Merge from MicroPython v1.20.0

Author: dhalbert

.codespell/ignore-words.txt

@@ -24,3 +24,5 @@ numer
 arithmetics
 ftbfs
 straightaway
+ftbs
+ftb

.git-blame-ignore-revs

@@ -1,4 +1,7 @@
-#all: Reformat remaining C code that doesn't have a space after a comma.
+# top: Update Python formatting to black "2023 stable style".
+8b2748269244304854b3462cb8902952b4dcb892
+
+# all: Reformat remaining C code that doesn't have a space after a comma.
 5b700b0af90591d6b1a2c087bb8de6b7f1bfdd2d
 
 # ports: Reformat more C and Python source code.

.github/actions/mpy_cross/action.yml

@@ -5,6 +5,9 @@ inputs:
     required: false
     default: true
     type: boolean
+  cp-version:
+    required: true
+    type: string
 
 runs:
   using: composite
@@ -16,22 +19,24 @@ runs:
       uses: actions/download-artifact@v3
       with:
         name: mpy-cross
-        path: mpy-cross
+        path: mpy-cross/build
 
     - name: Make mpy-cross executable
       if: inputs.download == 'true' && steps.download-mpy-cross.outcome == 'success'
-      run: sudo chmod +x mpy-cross/mpy-cross
+      run: sudo chmod +x mpy-cross/build/mpy-cross
       shell: bash
 
     - name: Build mpy-cross
       if: inputs.download == 'false' || steps.download-mpy-cross.outcome == 'failure'
       run: make -C mpy-cross -j2
       shell: bash
+      env:
+        CP_VERSION: ${{ inputs.cp-version }}
 
     - name: Upload mpy-cross
       if: inputs.download == 'false' || steps.download-mpy-cross.outcome == 'failure'
       continue-on-error: true
       uses: actions/upload-artifact@v3
       with:
         name: mpy-cross
-        path: mpy-cross/mpy-cross
+        path: mpy-cross/build/mpy-cross

.github/workflows/build-boards.yml

@@ -49,6 +49,8 @@ jobs:
     - name: Set up mpy-cross
       if: steps.set-up-submodules.outputs.frozen == 'True'
       uses: ./.github/actions/mpy_cross
+      with:
+        cp-version: ${{ inputs.cp-version }}
 
     - name: Versions
       run: |

.github/workflows/build-mpy-cross.yml

@@ -64,11 +64,11 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: mpy-cross.${{ env.EX }}
-        path: mpy-cross/mpy-cross.${{ env.EX }}
+        path: mpy-cross/build-${{ env.EX}}/mpy-cross.${{ env.EX }}
     - name: Upload to S3
       uses: ./.github/actions/upload_aws
       with:
-        source: mpy-cross/mpy-cross.${{ env.EX }}
+        source: mpy-cross/build-${{ env.EX}}/mpy-cross.${{ env.EX }}
         destination: mpy-cross/${{ env.OS }}/mpy-cross-${{ env.OS }}-${{ env.CP_VERSION }}.${{ env.EX }}
         AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

.github/workflows/build.yml

@@ -51,6 +51,7 @@ jobs:
     - name: Set up mpy-cross
       uses: ./.github/actions/mpy_cross
       with:
+        cp-version: ${{ steps.set-up-submodules.outputs.version }}
         download: false
     - name: Get last commit with checks
       id: get-last-commit-with-checks
@@ -127,15 +128,15 @@ jobs:
     - uses: actions/upload-artifact@v3
       with:
         name: mpy-cross-macos-11-x64
-        path: mpy-cross/mpy-cross
+        path: mpy-cross/build/mpy-cross
     - name: Build mpy-cross (arm64)
       run: make -C mpy-cross -j2 -f Makefile.m1 V=2
     - uses: actions/upload-artifact@v3
       with:
         name: mpy-cross-macos-11-arm64
-        path: mpy-cross/mpy-cross-arm64
+        path: mpy-cross/build-arm64/mpy-cross-arm64
     - name: Make universal binary
-      run: lipo -create -output mpy-cross-macos-universal mpy-cross/mpy-cross mpy-cross/mpy-cross-arm64
+      run: lipo -create -output mpy-cross-macos-universal mpy-cross/build/mpy-cross mpy-cross/build-arm64/mpy-cross-arm64
     - name: Upload artifact
       uses: actions/upload-artifact@v3
       with:

.github/workflows/custom-board-build.yml

@@ -65,6 +65,7 @@ jobs:
       if: steps.set-up-submodules.outputs.frozen == 'True'
       uses: ./.github/actions/mpy_cross
       with:
+        cp-version: ${{ steps.set-up-submodules.outputs.version }}
         download: false
     - name: Versions
       run: |

.github/workflows/run-tests.yml

@@ -17,7 +17,7 @@ jobs:
     env:
       CP_VERSION: ${{ inputs.cp-version }}
       MICROPY_CPYTHON3: python3.8
-      MICROPY_MICROPYTHON: ../ports/unix/micropython-coverage
+      MICROPY_MICROPYTHON: ../ports/unix/build-coverage/micropython
       TEST_all:
       TEST_mpy: --via-mpy -d basics float micropython
       TEST_native: --emit native
@@ -41,6 +41,8 @@ jobs:
       uses: ./.github/actions/deps/external
     - name: Set up mpy-cross
       uses: ./.github/actions/mpy_cross
+      with:
+        cp-version: ${{ inputs.cp-version }}
     - name: Build unix port
       run: make -C ports/unix VARIANT=coverage -j2
     - name: Run tests

.gitmodules

@@ -345,6 +345,9 @@
 	path = ports/raspberrypi/lib/Pico-PIO-USB
 	url = https://github.com/sekigon-gonnoc/Pico-PIO-USB.git
 	branch = main
+[submodule "lib/micropython-lib"]
+	path = lib/micropython-lib
+	url = https://github.com/micropython/micropython-lib.git
 [submodule "lib/certificates"]
 	path = lib/certificates
 	url = https://github.com/adafruit/certificates

.pre-commit-config.yaml

@@ -19,7 +19,10 @@ repos:
         exclude: |
           (?x)^(
             locale/|
-            lib/
+            lib/|
+            tests/unicode/data/utf-8_invalid.txt|
+            tests/extmod/data/qr.pgm|
+            tests/basics/bytearray_byte_operations.py
           )
 -   repo: local
     hooks:

LICENSE

@@ -1,6 +1,6 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2013-2022 Damien P. George and others
+Copyright (c) 2013-2023 Damien P. George
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,8 +9,8 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

conf.py

@@ -202,7 +202,8 @@ def autoapi_prepare_jinja_env(jinja_env):
                     "ports/cxd56/spresense-exported-sdk",
                     "ports/espressif/certificates",
                     "ports/espressif/esp-idf",
-                    "ports/espressif/esp32-camera",
+                    "ports/espressif/esp-camera",
+                    "ports/espressif/esp-protocols",
                     "ports/espressif/.idf_tools",
                     "ports/espressif/peripherals",
                     "ports/litex/hw",

devices/ble_hci/common-hal/_bleio/att.c

@@ -44,7 +44,6 @@
 #include "shared-bindings/_bleio/Service.h"
 #include "shared-bindings/_bleio/UUID.h"
 #include "supervisor/shared/tick.h"
-#include "supervisor/shared/translate/translate.h"
 
 STATIC uint16_t max_mtu = BT_ATT_DEFAULT_LE_MTU;  // 23
 STATIC unsigned long timeout = 5000;

docs/index.rst

@@ -33,7 +33,6 @@ Full Table of Contents
    design_guide
    porting
    common_hal
-   reference/mpyfiles.rst
    reference/glossary.rst
 
 .. toctree::

docs/library/array.rst

@@ -27,3 +27,55 @@ Classes
 
         Append new elements as contained in `iterable` to the end of
         array, growing it.
+
+    .. method:: __getitem__(index)
+
+        Indexed read of the array, called as ``a[index]`` (where ``a`` is an ``array``).
+        Returns a value if *index* is an ``int`` and an ``array`` if *index* is a slice.
+        Negative indices count from the end and ``IndexError`` is thrown if the index is
+        out of range.
+
+        **Note:** ``__getitem__`` cannot be called directly (``a.__getitem__(index)`` fails) and
+        is not present in ``__dict__``, however ``a[index]`` does work.
+
+    .. method:: __setitem__(index, value)
+
+        Indexed write into the array, called as ``a[index] = value`` (where ``a`` is an ``array``).
+        ``value`` is a single value if *index* is an ``int`` and an ``array`` if *index* is a slice.
+        Negative indices count from the end and ``IndexError`` is thrown if the index is out of range.
+
+        **Note:** ``__setitem__`` cannot be called directly (``a.__setitem__(index, value)`` fails) and
+        is not present in ``__dict__``, however ``a[index] = value`` does work.
+
+    .. method:: __len__()
+
+        Returns the number of items in the array, called as ``len(a)`` (where ``a`` is an ``array``).
+
+        **Note:** ``__len__`` cannot be called directly (``a.__len__()`` fails) and the
+        method is not present in ``__dict__``, however ``len(a)`` does work.
+
+    .. method:: __add__(other)
+
+        Return a new ``array`` that is the concatenation of the array with *other*, called as
+        ``a + other`` (where ``a`` and *other* are both ``arrays``).
+
+        **Note:** ``__add__`` cannot be called directly (``a.__add__(other)`` fails) and
+        is not present in ``__dict__``, however ``a + other`` does work.
+
+    .. method:: __iadd__(other)
+
+        Concatenates the array with *other* in-place, called as ``a += other`` (where ``a`` and *other*
+        are both ``arrays``).  Equivalent to ``extend(other)``.
+
+        **Note:** ``__iadd__`` cannot be called directly (``a.__iadd__(other)`` fails) and
+        is not present in ``__dict__``, however ``a += other`` does work.
+
+    .. method:: __repr__()
+
+        Returns the string representation of the array, called as ``str(a)`` or ``repr(a)```
+        (where ``a`` is an ``array``).  Returns the string ``"array(<type>, [<elements>])"``,
+        where ``<type>`` is the type code letter for the array and ``<elements>`` is a comma
+        separated list of the elements of the array.
+
+        **Note:** ``__repr__`` cannot be called directly (``a.__repr__()`` fails) and
+        is not present in ``__dict__``, however ``str(a)`` and ``repr(a)`` both work.

docs/reference/glossary.rst

@@ -52,7 +52,7 @@ Glossary
     cross-compiler
         Also known as ``mpy-cross``. This tool runs on your PC and converts a
         :term:`.py file` containing MicroPython code into a :term:`.mpy file`
-        containing MicroPython bytecode. This means it loads faster (the board
+        containing MicroPython :term:`bytecode`. This means it loads faster (the board
         doesn't have to compile the code), and uses less space on flash (the
         bytecode is more space efficient).
 
@@ -112,6 +112,24 @@ Glossary
         require much less power. MicroPython is designed to be small and
         optimized enough to run on an average modern microcontroller.
 
+    micropython-lib
+        MicroPython is (usually) distributed as a single executable/binary
+        file with just few builtin modules. There is no extensive standard
+        library comparable with :term:`CPython`'s. Instead, there is a related,
+        but separate project `micropython-lib
+        <https://github.com/micropython/micropython-lib>`_ which provides
+        implementations for many modules from CPython's standard library.
+
+        Some of the modules are are implemented in pure Python, and are able to
+        be used on all ports. However, the majority of these modules use
+        :term:`FFI` to access operating system functionality, and as such can
+        only be used on the :term:`MicroPython Unix port` (with limited support
+        for Windows).
+
+        Unlike the :term:`CPython` stdlib, micropython-lib modules are
+        intended to be installed individually - either using manual copying or
+        using :term:`mip`.
+
     MicroPython port
         MicroPython supports different :term:`boards <board>`, RTOSes, and
         OSes, and can be relatively easily adapted to new systems. MicroPython
@@ -133,16 +151,26 @@ Glossary
         machine-independent features. It can also function in a similar way to
         :term:`CPython`'s ``python`` executable.
 
+    mip
+        A package installer for MicroPython (mip - "mip installs packages"). It
+        installs MicroPython packages either from :term:`micropython-lib`,
+        GitHub, or arbitrary URLs.  mip can be used on-device on
+        network-capable boards, and internally by tools such
+        as :term:`mpremote`.
+
+    mpremote
+        A tool for interacting with a MicroPython device.
+
     .mpy file
         The output of the :term:`cross-compiler`. A compiled form of a
-        :term:`.py file` that contains MicroPython bytecode instead of Python
-        source code.
+        :term:`.py file` that contains MicroPython :term:`bytecode` instead of
+        Python source code.
 
     native
         Usually refers to "native code", i.e. machine code for the target
         microcontroller (such as ARM Thumb, Xtensa, x86/x64). The ``@native``
         decorator can be applied to a MicroPython function to generate native
-        code instead of bytecode for that function, which will likely be
+        code instead of :term:`bytecode` for that function, which will likely be
         faster but use more RAM.
 
     port
@@ -173,3 +201,12 @@ Glossary
         peripheral that sends data over a pair of pins (TX & RX). Many boards
         include a way to make at least one of the UARTs available to a host PC
         as a serial port over USB.
+
+    upip
+        A now-obsolete package manager for MicroPython, inspired
+        by :term:`CPython`'s pip, but much smaller and with reduced
+        functionality. See its replacement, :term:`mip`.
+
+    webrepl
+        A way of connecting to the REPL (and transferring files) on a device
+        over the internet from a browser. See https://micropython.org/webrepl