stubber.freeze.common
=====================

.. py:module:: stubber.freeze.common

.. autoapi-nested-parse::

   common functions for frozen stub generation



Functions
---------

.. autoapisummary::

   stubber.freeze.common.get_portboard
   stubber.freeze.common.get_freeze_path
   stubber.freeze.common.apply_frozen_module_fixes


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

.. py:function:: get_portboard(manifest_path: pathlib.Path)

   returns a 2-tuple of the port and board in the provided manifest path

   raises an ValueError if neither a port or board can be found


.. py:function:: get_freeze_path(stub_path: pathlib.Path, port: str, board: str) -> Tuple[pathlib.Path, str]

   get path to a folder to store the frozen stubs for the given port/board


.. py:function:: apply_frozen_module_fixes(freeze_path: pathlib.Path, mpy_path: pathlib.Path)

   apply common fixes to the fozen modules to improve stub generation