Update documentation

Author: actions-user

docs/_sources/differences/python_37.rst.txt

@@ -105,4 +105,4 @@ Changes to built-in modules:
 
 .. rubric:: Notes
 
-.. [#ftimenanosec] Only :func:`time.time_ns` is implemented. 
+.. [#ftimenanosec] Only :func:`time.time_ns` is implemented.

docs/_sources/genrst/builtin_types.rst.txt

@@ -2,7 +2,7 @@
 
 Builtin types
 =============
-Generated Tue 05 Mar 2024 02:12:06 UTC
+Generated Tue 23 Jul 2024 04:50:56 UTC
 
 Exception
 ---------
@@ -423,6 +423,37 @@ Sample code::
 |     [5, 2, 6, 4] |     /bin/sh: 1: ../ports/unix/build-standard/micropython: not found |
 +------------------+---------------------------------------------------------------------+
 
+memoryview
+----------
+
+.. _cpydiff_types_memoryview_invalid:
+
+memoryview can become invalid if its target is resized
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Cause:** CPython prevents a ``bytearray`` or ``io.bytesIO`` object from changing size while there is a ``memoryview`` object that references it. MicroPython requires the programmer to manually ensure that an object is not resized while any ``memoryview`` references it.
+
+In the worst case scenario, resizing an object which is the target of a memoryview can cause the memoryview(s) to reference invalid freed memory (a use-after-free bug) and corrupt the MicroPython runtime.
+
+**Workaround:** Do not change the size of any ``bytearray`` or ``io.bytesIO`` object that has a ``memoryview`` assigned to it.
+
+Sample code::
+
+    b = bytearray(b"abcdefg")
+    m = memoryview(b)
+    b.extend(b"hijklmnop")
+    print(b, bytes(m))
+
++----------------------------------------------------------------------+---------------------------------------------------------------------+
+| CPy output:                                                          | uPy output:                                                         |
++----------------------------------------------------------------------+---------------------------------------------------------------------+
+| ::                                                                   | ::                                                                  |
+|                                                                      |                                                                     |
+|     Traceback (most recent call last):                               |     /bin/sh: 1: ../ports/unix/build-standard/micropython: not found |
+|       File "<stdin>", line 11, in <module>                           |                                                                     |
+|     BufferError: Existing exports of data: object cannot be re-sized |                                                                     |
++----------------------------------------------------------------------+---------------------------------------------------------------------+
+
 str
 ---
 

docs/_sources/genrst/core_language.rst.txt

@@ -2,7 +2,7 @@
 
 Core language
 =============
-Generated Tue 05 Mar 2024 02:12:06 UTC
+Generated Tue 23 Jul 2024 04:50:56 UTC
 
 .. _cpydiff_core_fstring_concat:
 
@@ -165,6 +165,50 @@ Sample code::
 |     Foo     |     /bin/sh: 1: ../ports/unix/build-standard/micropython: not found |
 +-------------+---------------------------------------------------------------------+
 
+.. _cpydiff_core_class_name_mangling:
+
+Private Class Members name mangling is not implemented
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+**Cause:** The MicroPython compiler does not implement name mangling for private class members.
+
+**Workaround:** Avoid using or having a collision with global names, by adding a unique prefix to the private class member name manually.
+
+Sample code::
+
+    
+    
+    def __print_string(string):
+        print(string)
+    
+    
+    class Foo:
+        def __init__(self, string):
+            self.string = string
+    
+        def do_print(self):
+            __print_string(self.string)
+    
+    
+    example_string = "Example String to print."
+    
+    class_item = Foo(example_string)
+    print(class_item.string)
+    
+    class_item.do_print()
+
++---------------------------------------------------------+---------------------------------------------------------------------+
+| CPy output:                                             | uPy output:                                                         |
++---------------------------------------------------------+---------------------------------------------------------------------+
+| ::                                                      | ::                                                                  |
+|                                                         |                                                                     |
+|     Example String to print.                            |     /bin/sh: 1: ../ports/unix/build-standard/micropython: not found |
+|     Traceback (most recent call last):                  |                                                                     |
+|       File "<stdin>", line 26, in <module>              |                                                                     |
+|       File "<stdin>", line 18, in do_print              |                                                                     |
+|     NameError: name '_Foo__print_string' is not defined |                                                                     |
++---------------------------------------------------------+---------------------------------------------------------------------+
+
 .. _cpydiff_core_class_supermultiple:
 
 When inheriting from multiple classes super() only calls one class

docs/_sources/genrst/modules.rst.txt

@@ -2,7 +2,41 @@
 
 Modules
 =======
-Generated Tue 05 Mar 2024 02:12:06 UTC
+Generated Tue 23 Jul 2024 04:50:56 UTC
+
+.. Preamble section inserted into generated output
+
+Positional-only Parameters
+--------------------------
+
+To save code size, many functions that accept keyword arguments in CPython only accept positional arguments in MicroPython.
+
+MicroPython marks positional-only parameters in the same way as CPython, by inserting a ``/`` to mark the end of the positional parameters. Any function whose signature ends in ``/`` takes *only* positional arguments. For more details, see `PEP 570 <https://peps.python.org/pep-0570/>`_.
+
+Example
+~~~~~~~
+
+For example, in CPython 3.4 this is the signature of the constructor ``socket.socket``::
+
+    socket.socket(family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None)
+
+However, the signature documented in :func:`MicroPython<socket.socket>` is::
+
+    socket(af=AF_INET, type=SOCK_STREAM, proto=IPPROTO_TCP, /)
+
+The ``/`` at the end of the parameters indicates that they are all positional-only in MicroPython. The following code works in CPython but not in most MicroPython ports::
+
+    import socket
+    s = socket.socket(type=socket.SOCK_DGRAM)
+
+MicroPython will raise an exception::
+
+    TypeError: function doesn't take keyword arguments
+
+The following code will work in both CPython and MicroPython::
+
+    import socket
+    s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
 
 array
 -----
@@ -281,7 +315,7 @@ Sample code::
 +-------------------------+---------------------------------------------------------------------+
 | ::                      | ::                                                                  |
 |                         |                                                                     |
-|     4275605868765694853 |     /bin/sh: 1: ../ports/unix/build-standard/micropython: not found |
+|     3720919278385122334 |     /bin/sh: 1: ../ports/unix/build-standard/micropython: not found |
 +-------------------------+---------------------------------------------------------------------+
 
 .. _cpydiff_modules_random_randint:
@@ -307,7 +341,7 @@ Sample code::
 +-----------------------------------------------+---------------------------------------------------------------------+
 | ::                                            | ::                                                                  |
 |                                               |                                                                     |
-|     x=340282366920938463463374607431768211455 |     /bin/sh: 1: ../ports/unix/build-standard/micropython: not found |
+|     x=340282366920938463463374607431768211456 |     /bin/sh: 1: ../ports/unix/build-standard/micropython: not found |
 +-----------------------------------------------+---------------------------------------------------------------------+
 
 struct

docs/_sources/genrst/syntax.rst.txt

@@ -2,7 +2,7 @@
 
 Syntax
 ======
-Generated Tue 05 Mar 2024 02:12:06 UTC
+Generated Tue 23 Jul 2024 04:50:56 UTC
 
 .. _cpydiff_syntax_arg_unpacking:
 

docs/_sources/library/asyncio.rst.txt

@@ -149,8 +149,7 @@ class ThreadSafeFlag
 
     Create a new flag which can be used to synchronise a task with code running
     outside the asyncio loop, such as other threads, IRQs, or scheduler
-    callbacks.  Flags start in the cleared state.  The class does not currently
-    work under the Unix build of MicroPython.
+    callbacks.  Flags start in the cleared state.
 
 .. method:: ThreadSafeFlag.set()
 

docs/_sources/library/bluetooth.rst.txt

@@ -312,7 +312,7 @@ Broadcaster Role (Advertiser)
     in all broadcasts, and *resp_data* is send in reply to an active scan.
 
     **Note:** if *adv_data* (or *resp_data*) is ``None``, then the data passed
-    to the previous call to ``gap_advertise`` will be re-used. This allows a
+    to the previous call to ``gap_advertise`` will be reused. This allows a
     broadcaster to resume advertising with just ``gap_advertise(interval_us)``.
     To clear the advertising payload pass an empty ``bytes``, i.e. ``b''``.
 
@@ -722,7 +722,7 @@ Pairing and bonding
     and ``_IRQ_SET_SECRET`` events.
 
     **Note:** This is currently only supported when using the NimBLE stack on
-    STM32 and Unix (not ESP32).
+    ESP32, STM32 and Unix.
 
 .. method:: BLE.gap_pair(conn_handle, /)
 

docs/_sources/library/collections.rst.txt

@@ -18,26 +18,47 @@ Classes
     appends and pops from either side of the deque.  New deques are created
     using the following arguments:
 
-        - *iterable* must be the empty tuple, and the new deque is created empty.
+        - *iterable* is an iterable used to populate the deque when it is
+          created.  It can be an empty tuple or list to create a deque that
+          is initially empty.
 
         - *maxlen* must be specified and the deque will be bounded to this
           maximum length.  Once the deque is full, any new items added will
           discard items from the opposite end.
 
         - The optional *flags* can be 1 to check for overflow when adding items.
 
-    As well as supporting `bool` and `len`, deque objects have the following
-    methods:
+    Deque objects support `bool`, `len`, iteration and subscript load and store.
+    They also have the following methods:
 
     .. method:: deque.append(x)
 
         Add *x* to the right side of the deque.
-        Raises IndexError if overflow checking is enabled and there is no more room left.
+        Raises ``IndexError`` if overflow checking is enabled and there is
+        no more room in the queue.
+
+    .. method:: deque.appendleft(x)
+
+        Add *x* to the left side of the deque.
+        Raises ``IndexError`` if overflow checking is enabled and there is
+        no more room in the queue.
+
+    .. method:: deque.pop()
+
+        Remove and return an item from the right side of the deque.
+        Raises ``IndexError`` if no items are present.
 
     .. method:: deque.popleft()
 
         Remove and return an item from the left side of the deque.
-        Raises IndexError if no items are present.
+        Raises ``IndexError`` if no items are present.
+
+    .. method:: deque.extend(iterable)
+
+        Extend the deque by appending all the items from *iterable* to
+        the right of the deque.
+        Raises ``IndexError`` if overflow checking is enabled and there is
+        no more room in the deque.
 
 .. function:: namedtuple(name, fields)
 

docs/_sources/library/index.rst.txt

@@ -98,15 +98,15 @@ the following libraries.
    btree.rst
    cryptolib.rst
    deflate.rst
-   framebuf.rst
    machine.rst
    micropython.rst
-   neopixel.rst
    network.rst
+   openamp.rst
    uctypes.rst
    mutex.rst
    uping.rst
    urequests.rst
+   vfs.rst
 
 Libraries specific to the OpenMV Cam
 ------------------------------------
@@ -120,11 +120,10 @@ The following libraries are specific to the OpenMV Cam.
    stm.rst
    omv.sensor.rst
    omv.image.rst
-   omv.tf.rst
+   omv.ml.rst
    omv.gif.rst
    omv.mjpeg.rst
    omv.audio.rst
-   omv.micro_speech.rst
    omv.display.rst
    omv.fir.rst
    omv.tv.rst
@@ -177,12 +176,6 @@ Examples scripts are located in OpenMV IDE under the ``IMU Shield`` examples fol
 
 Examples scripts are located in OpenMV IDE under the ``Motor Shield`` examples folder.
 
-:mod:`lsm6dsox` --- `lsm6dsox Driver <https://github.com/openmv/openmv/blob/master/scripts/libraries/lsm6dsox.py>`_
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. module:: lsm6dsox
-   :synopsis: lsm6dsox Driver
-
 :mod:`modbus` --- `modbus protocol library <https://github.com/openmv/openmv/blob/master/scripts/libraries/modbus.py>`_
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

docs/_sources/library/machine.ADCBlock.rst.txt

@@ -26,7 +26,7 @@ Constructors
 
    Access the ADC peripheral identified by *id*, which may be an integer
    or string.
-   
+
    The *bits* argument, if given, sets the resolution in bits of the
    conversion process.  If not specified then the previous or default
    resolution is used.