stubber.update_module_list
==========================

.. py:module:: stubber.update_module_list

.. autoapi-nested-parse::

   generate the list of modules that should be attempted to stub
   for this :
   - combine the modules from the different texts files
   - split the lines into individual module names
   - combine them in one set
   - remove the ones than cannot be stubbed
   - remove test modules, ending in `_test`
   - write updates to:
       - board/modulelist.txt
       - board/createstubs.py



Functions
---------

.. autoapisummary::

   stubber.update_module_list.read_modules
   stubber.update_module_list.update_module_list


Module Contents
---------------

.. py:function:: read_modules(path: Optional[pathlib.Path] = None) -> Set[str]

   read text files with modules per firmware.
   each contains the output of help("modules")
   - lines starting with # are comments.
   - split the other lines at whitespace separator,
   - and add each module to a set


.. py:function:: update_module_list()

   helper script
   generate a few lines of code with all modules to be stubbed by createstubs