stubber.stubs_from_docs

Read the Micropython library documentation files and use them to build stubs that can be used for static typechecking using a custom-built parser to read and process the micropython RST files

Functions

generate_from_rst(→ int)

clean_destination(dst_path)

Remove all .py/.pyi files in desination folder to avoid left-behinds

get_rst_sources(→ List[pathlib.Path])

Get the list of rst files to process

make_docstubs(dst_path, v_tag, release, suffix, files, ...)

Create docstubs from the list of rst files

make_docstub(file, dst_path, v_tag, release, suffix, ...)

Create a docstub from a single rst file

Module Contents

stubber.stubs_from_docs.generate_from_rst(rst_path: pathlib.Path, dst_path: pathlib.Path, v_tag: str, release: str | None = None, pattern: str = '*.rst', suffix: str = '.pyi', format: bool = True, autoflake: bool = True, clean_rst: bool = True) → int
Parameters:
Return type:

int

stubber.stubs_from_docs.clean_destination(dst_path: pathlib.Path)

Remove all .py/.pyi files in desination folder to avoid left-behinds

Parameters:

dst_path (pathlib.Path)

stubber.stubs_from_docs.get_rst_sources(rst_path: pathlib.Path, pattern: str) → List[pathlib.Path]

Get the list of rst files to process

Parameters:
Return type:

List[pathlib.Path]

stubber.stubs_from_docs.make_docstubs(dst_path: pathlib.Path, v_tag: str, release: str, suffix: str, files: List[pathlib.Path], clean_rst: bool)

Create docstubs from the list of rst files

Parameters:
stubber.stubs_from_docs.make_docstub(file: pathlib.Path, dst_path: pathlib.Path, v_tag: str, release: str, suffix: str, clean_rst: bool)

Create a docstub from a single rst file

Parameters: