stubber.freeze.common

common functions for frozen stub generation

Functions

get_portboard(manifest_path)	returns a 2-tuple of the port and board in the provided manifest path
get_freeze_path(→ Tuple[pathlib.Path, str])	get path to a folder to store the frozen stubs for the given port/board
apply_frozen_module_fixes(freeze_path, mpy_path)	apply common fixes to the fozen modules to improve stub generation

Module Contents

stubber.freeze.common.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

Parameters:

manifest_path (pathlib.Path)

stubber.freeze.common.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

Parameters:

• stub_path (pathlib.Path)

• port (str)

• board (str)

Return type:

Tuple[pathlib.Path, str]

stubber.freeze.common.apply_frozen_module_fixes(freeze_path: pathlib.Path, mpy_path: pathlib.Path)

apply common fixes to the fozen modules to improve stub generation

Parameters:

• freeze_path (pathlib.Path)

• mpy_path (pathlib.Path)