stubber.utils

Submodules

• stubber.utils.config
• stubber.utils.makeversionhdr
• stubber.utils.manifest
• stubber.utils.post
• stubber.utils.repos
• stubber.utils.stubmaker
• stubber.utils.typed_config_toml

Functions

make_manifest(→ bool)	Create a module.json manifest listing all files/stubs in this folder and subfolders.
manifest(→ dict)	create a new empty manifest dict
do_post_processing(stub_paths, stubgen, format, autoflake)	Common post processing
generate_pyi_files(→ bool)	Generate typeshed files for all scripts in a folder using mypy/stubgen
generate_pyi_from_file(→ bool)	Generate a .pyi stubfile from a single .py module using mypy/stubgen

Package Contents

stubber.utils.make_manifest(folder: pathlib.Path, family: str, port: str, version: str, release: str = '', stubtype: str = '', board: str = '') → bool

Create a module.json manifest listing all files/stubs in this folder and subfolders.

Parameters:

• folder (pathlib.Path)

• family (str)

• port (str)

• version (str)

• release (str)

• stubtype (str)

• board (str)

Return type:

bool

stubber.utils.manifest(family: str = 'micropython', stubtype: str = 'frozen', machine: str | None = None, port: str | None = None, platform: str | None = None, sysname: str | None = None, nodename: str | None = None, version: str | None = None, release: str | None = None, firmware: str | None = None, board: str | None = None) → dict

create a new empty manifest dict

Parameters:

• family (str)

• stubtype (str)

• machine (Optional[str])

• port (Optional[str])

• platform (Optional[str])

• sysname (Optional[str])

• nodename (Optional[str])

• version (Optional[str])

• release (Optional[str])

• firmware (Optional[str])

• board (Optional[str])

Return type:

dict

stubber.utils.do_post_processing(stub_paths: List[pathlib.Path], stubgen: bool, format: bool, autoflake: bool)

Common post processing

Parameters:

• stub_paths (List[pathlib.Path])

• stubgen (bool)

• format (bool)

• autoflake (bool)

stubber.utils.generate_pyi_files(modules_folder: pathlib.Path) → bool

Generate typeshed files for all scripts in a folder using mypy/stubgen

Returns: False if one or more files had an issue generating a stub

Parameters:

modules_folder (pathlib.Path)

Return type:

bool

stubber.utils.generate_pyi_from_file(file: pathlib.Path) → bool

Generate a .pyi stubfile from a single .py module using mypy/stubgen

Parameters:

file (pathlib.Path)

Return type:

bool