stubber.codemod.board
=====================
.. py:module:: stubber.codemod.board
.. autoapi-nested-parse::
"
Codemods to create the different variants of createstubs.py
Attributes
----------
.. autoapisummary::
stubber.codemod.board._STUBBER_MATCHER
stubber.codemod.board._MODULES_MATCHER
stubber.codemod.board._DEF_MAIN_MATCHER
stubber.codemod.board._PROBLEMATIC_MATCHER
stubber.codemod.board._EXCLUDED_MATCHER
stubber.codemod.board._LOW_MEM_MODULE_DOC
stubber.codemod.board._DB_MODULE_DOC
stubber.codemod.board._LVGL_MODULE_DOC
Classes
-------
.. autoapisummary::
stubber.codemod.board.CreateStubsVariant
stubber.codemod.board.ReadModulesCodemod
stubber.codemod.board.ModuleDocCodemod
stubber.codemod.board.ModulesUpdateCodemod
stubber.codemod.board.LVGLCodemod
stubber.codemod.board.LowMemoryCodemod
stubber.codemod.board.DBCodemod
stubber.codemod.board.CreateStubsCodemod
Module Contents
---------------
.. py:data:: _STUBBER_MATCHER
.. py:data:: _MODULES_MATCHER
.. py:data:: _DEF_MAIN_MATCHER
.. py:data:: _PROBLEMATIC_MATCHER
.. py:data:: _EXCLUDED_MATCHER
.. py:data:: _LOW_MEM_MODULE_DOC
:value: Multiline-String
.. raw:: html
Show Value
.. code-block:: python
"""
"""Create stubs for (all) modules on a MicroPython board.
This variant of the createstubs.py script is optimised for use on low-memory devices, and reads the list of modules from a text file
`modulelist.txt` in the root or `libs` folder that should be uploaded to the device.
If that cannot be found then only a single module (micropython) is stubbed.
In order to run this on low-memory devices two additional steps are recommended:
- minifification, using python-minifier
to reduce overall size, and remove logging overhead.
- cross compilation, using mpy-cross,
to avoid the compilation step on the micropython device
"""
"""
.. raw:: html
Show Value
.. code-block:: python
"""
"""
Create stubs for (all) modules on a MicroPython board.
This variant of the createstubs.py script is optimized for use on very-low-memory devices.
Note: this version has undergone limited testing.
1) reads the list of modules from a text file `modulelist.txt` that should be uploaded to the device.
2) stored the already processed modules in a text file `modulelist.done`
3) process the modules in the database:
- stub the module
- update the modulelist.done file
- reboots the device if it runs out of memory
4) creates the modules.json
If that cannot be found then only a single module (micropython) is stubbed.
In order to run this on low-memory devices two additional steps are recommended:
- minification, using python-minifierto reduce overall size, and remove logging overhead.
- cross compilation, using mpy-cross, to avoid the compilation step on the micropython device
"""
"""
.. raw:: html
Show Value
.. code-block:: python
"""
"""
Create stubs for the lvgl modules on a MicroPython board.
Note that the stubs can be very large, and it may be best to directly store them on an SD card if your device supports this.
"""
"""
.. raw:: html