stubber.freeze.get_frozen
=========================

.. py:module:: stubber.freeze.get_frozen

.. autoapi-nested-parse::

   Collect modules and python stubs from MicroPython source projects (v1.12 +) and stores them in the all_stubs folder
   The all_stubs folder should be mapped/symlinked to the micropython_stubs/stubs repo/folder



Attributes
----------

.. autoapisummary::

   stubber.freeze.get_frozen.FAMILY


Functions
---------

.. autoapisummary::

   stubber.freeze.get_frozen.get_manifests
   stubber.freeze.get_frozen.add_comment_to_path
   stubber.freeze.get_frozen.freeze_any
   stubber.freeze.get_frozen.get_fsp


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

.. py:data:: FAMILY
   :value: 'micropython'


.. py:function:: get_manifests(mpy_path: pathlib.Path) -> List[pathlib.Path]

   Returns a list of all manifests.py files found in the ports folder of the MicroPython repo


.. py:function:: add_comment_to_path(path: pathlib.Path, comment: str) -> None

   Add a comment to the top of each .py and .pyi file in the path.
   Uses simple string prepending for speed and reliability.


.. py:function:: freeze_any(stub_folder: Optional[pathlib.Path] = None, version: str = V_PREVIEW, mpy_path: Optional[pathlib.Path] = None, mpy_lib_path: Optional[pathlib.Path] = None) -> pathlib.Path

   Get and parse the to-be-frozen .py modules for micropython to extract the static type information
    - requires that the MicroPython and Micropython-lib repos are checked out and available on a local path
    - repos should be cloned side-by-side as some of the manifests refer to micropython-lib scripts using a relative path

   The micropython-* repos must be checked out to the required version/tag.



.. py:function:: get_fsp(version: str, stub_folder: Optional[pathlib.Path] = None) -> pathlib.Path

   get frozen stub path