micropython-stubber 1.20.5__py3-none-any.whl → 1.23.0__py3-none-any.whl

stubber/commands/get_docstubs_cmd.py

@@ -1,87 +1,89 @@
-"""
-get-docstubs
-
-"""
-
-from pathlib import Path
-from typing import Optional
-
-import click
-from loguru import logger as log
-
-import stubber.basicgit as git
-import stubber.utils as utils
-from stubber.stubs_from_docs import generate_from_rst
-from stubber.utils.config import CONFIG
-from stubber.utils.repos import fetch_repos
-
-from .cli import stubber_cli
-
-##########################################################################################
-# log = logging.getLogger("stubber")
-#########################################################################################
-
-
-@stubber_cli.command(name="get-docstubs")
-@click.option(
-    "--path",
-    "-p",
-    default=CONFIG.repo_path.as_posix(),
-    type=click.Path(file_okay=False, dir_okay=True),
-    show_default=True,
-)
-@click.option(
-    "--stub-path",
-    "--stub-folder",
-    "target",
-    default=CONFIG.stub_path.as_posix(),
-    type=click.Path(exists=True, file_okay=False, dir_okay=True),
-    help="Destination of the files to be generated.",
-    show_default=True,
-)
-#  @click.option("--family", "-f", "basename", default="micropython", help="Micropython family.", show_default=True)
-@click.option("--version", "--tag", default="", type=str, help="Version number to use. [default: Git tag]")
-@click.option("--black/--no-black", "-b/-nb", default=True, help="Run black", show_default=True)
-@click.pass_context
-def cli_docstubs(
-    ctx: click.Context,
-    path: Optional[str] = None,
-    target:Optional[str] = None,
-    black: bool = True,
-    basename: Optional[str] = None,
-    version: str = "",
-):
-    """
-    Build stubs from documentation.
-
-    Read the Micropython library documentation files and use them to build stubs that can be used for static typechecking.
-    """
-    # default parameter values
-    path = path or CONFIG.repo_path.as_posix()
-    target = target or CONFIG.stub_path.as_posix()
-    basename = basename or "micropython"
-
-    if path == CONFIG.repo_path.as_posix():
-        # default
-        rst_path = CONFIG.mpy_path / "docs" / "library"
-    elif Path(path).stem == "micropython":
-        # path to a micropython repo
-        rst_path = Path(path) / "docs" / "library"
-    else:
-        rst_path = Path(path)  # or specify full path
-
-    if version:
-        version = utils.clean_version(version, drop_v=False)
-        result = fetch_repos(version, CONFIG.mpy_path, CONFIG.mpy_lib_path)
-        if not result:
-            return -1
-    # get the current checked out version
-    version = utils.checkedout_version(CONFIG.mpy_path)
-
-    release = git.get_local_tag(rst_path.as_posix(), abbreviate=False) or ""
-
-    dst_path = Path(target) / f"{basename}-{utils.clean_version(version, flat=True)}-docstubs"
-
-    log.info(f"Get docstubs for MicroPython {utils.clean_version(version, drop_v=False)}")
-    generate_from_rst(rst_path, dst_path, version, release=release, suffix=".pyi", black=black)
-    log.info("::group:: Done")
+"""
+get-docstubs
+
+"""
+
+from pathlib import Path
+from typing import Optional
+
+import rich_click as click
+from loguru import logger as log
+
+import stubber.basicgit as git
+import stubber.utils as utils
+from stubber.stubs_from_docs import generate_from_rst
+from stubber.utils.config import CONFIG
+from stubber.utils.repos import fetch_repos
+
+from .cli import stubber_cli
+
+##########################################################################################
+# log = logging.getLogger("stubber")
+#########################################################################################
+
+
+@stubber_cli.command(name="get-docstubs")
+@click.option(
+    "--path",
+    "-p",
+    default=CONFIG.repo_path.as_posix(),
+    type=click.Path(file_okay=False, dir_okay=True),
+    show_default=True,
+)
+@click.option(
+    "--stub-path",
+    "--stub-folder",
+    "target",
+    default=CONFIG.stub_path.as_posix(),
+    type=click.Path(exists=True, file_okay=False, dir_okay=True),
+    help="Destination of the files to be generated.",
+    show_default=True,
+)
+#  @click.option("--family", "-f", "basename", default="micropython", help="Micropython family.", show_default=True)
+@click.option(
+    "--version", "--tag", default="", type=str, help="Version number to use. [default: Git tag]"
+)
+@click.option("--black/--no-black", "-b/-nb", default=True, help="Run black", show_default=True)
+@click.pass_context
+def cli_docstubs(
+    ctx: click.Context,
+    path: Optional[str] = None,
+    target: Optional[str] = None,
+    black: bool = True,
+    basename: Optional[str] = None,
+    version: str = "",
+):
+    """
+    Build stubs from documentation.
+
+    Read the Micropython library documentation files and use them to build stubs that can be used for static typechecking.
+    """
+    # default parameter values
+    path = path or CONFIG.repo_path.as_posix()
+    target = target or CONFIG.stub_path.as_posix()
+    basename = basename or "micropython"
+
+    if path == CONFIG.repo_path.as_posix():
+        # default
+        rst_path = CONFIG.mpy_path / "docs" / "library"
+    elif Path(path).stem == "micropython":
+        # path to a micropython repo
+        rst_path = Path(path) / "docs" / "library"
+    else:
+        rst_path = Path(path)  # or specify full path
+
+    if version:
+        version = utils.clean_version(version, drop_v=False)
+        result = fetch_repos(version, CONFIG.mpy_path, CONFIG.mpy_lib_path)
+        if not result:
+            return -1
+    # get the current checked out version
+    version = utils.checkedout_version(CONFIG.mpy_path)
+
+    release = git.get_local_tag(rst_path.as_posix(), abbreviate=False) or ""
+
+    dst_path = Path(target) / f"{basename}-{utils.clean_version(version, flat=True)}-docstubs"
+
+    log.info(f"Get docstubs for MicroPython {utils.clean_version(version, drop_v=False)}")
+    generate_from_rst(rst_path, dst_path, version, release=release, suffix=".pyi", black=black)
+    log.info("::group:: Done")

stubber/commands/get_frozen_cmd.py

@@ -1,112 +1,114 @@
-"""Get the frozen stubs for MicroPython."""
-
-##########################################################################################
-# get-frozen
-##########################################################################################
-from pathlib import Path
-from typing import List, Optional
-
-import click
-from loguru import logger as log
-
-import stubber.utils as utils
-from stubber.codemod.enrich import enrich_folder
-from stubber.freeze.get_frozen import freeze_any
-from stubber.utils.config import CONFIG
-from stubber.utils.repos import fetch_repos
-
-from .cli import stubber_cli
-
-##########################################################################################
-
-
-@stubber_cli.command(name="get-frozen")
-@click.option(
-    "--stub-folder",
-    "-stubs",
-    default=CONFIG.stub_path.as_posix(),
-    type=click.Path(exists=True, file_okay=False, dir_okay=True),
-    show_default=True,
-)
-@click.option(
-    "--version",
-    "--Version",
-    "-V",
-    "version",
-    default="",
-    # default=[CONFIG.stable_version],
-    show_default=True,
-    help="The version of MicroPython to get the frozen modules for. Use 'preview' to get the latest version from the micropython repo",
-)
-@click.option(
-    "--stubgen/--no-stubgen",
-    default=True,
-    help="Run stubgen to create .pyi files for the (new) frozen modules",
-    show_default=True,
-)
-@click.option(
-    "--black/--no-black",
-    default=True,
-    help="Run black on the (new) frozen modules",
-    show_default=True,
-)
-def cli_get_frozen(
-    stub_folder: Optional[str] = None,
-    # path: str = config.repo_path.as_posix(),
-    version: str = "",
-    stubgen: bool = True,
-    black: bool = True,
-    autoflake: bool = True,
-):
-    """
-    Get the frozen stubs for MicroPython.
-
-    Get the frozen modules for the checked out version of MicroPython
-    """
-    # default parameter values
-    stub_folder = stub_folder or CONFIG.stub_path.as_posix()
-    # FIXME: Stub_folder is not used
-
-    stub_paths: List[Path] = []
-
-    if version:
-        version = utils.clean_version(version, drop_v=False)
-        result = fetch_repos(version, CONFIG.mpy_path, CONFIG.mpy_lib_path)
-        if not result:
-            log.error(
-                "Failed to fetch repos for version: {} for micropython folder: {} and micropython-lib folder: {}".format(
-                    version, CONFIG.mpy_path.as_posix(), CONFIG.mpy_lib_path.as_posix()
-                )
-            )
-            return -1
-    # folder/{family}-{version[_preview]}-frozen
-    family = "micropython"
-    # get the current checked out version
-    version = utils.checkedout_version(CONFIG.mpy_path)
-    log.info("MicroPython version : {}".format(version))
-
-    stub_path = freeze_any(version=version, mpy_path=CONFIG.mpy_path, mpy_lib_path=CONFIG.mpy_lib_path)
-    stub_paths.append(stub_path)
-    # Also enrich the frozen modules from the doc stubs if available
-
-    # first create .pyi files so they can be enriched
-    utils.do_post_processing(stub_paths, stubgen=stubgen, black=False, autoflake=False)
-    family = "micropython"
-    _version = utils.clean_version(version, drop_v=False, flat=True)
-    docstubs_path = Path(CONFIG.stub_path) / f"{family}-{_version}-docstubs"
-    if docstubs_path.exists():
-        log.info(f"Enriching {str(stub_path)} with {docstubs_path}")
-        if merged := enrich_folder(
-            stub_path,
-            docstubs_path,
-            show_diff=False,
-            write_back=True,
-            require_docstub=False,
-        ):
-            log.info(f"Enriched {merged} frozen modules from docstubs")
-    else:
-        log.info(f"No docstubs found at {docstubs_path}")
-
-    log.info("::group:: start post processing of retrieved stubs")
-    utils.do_post_processing(stub_paths, stubgen=False, black=black, autoflake=autoflake)
-    log.info("::group:: Done")
+"""Get the frozen stubs for MicroPython."""
+
+##########################################################################################
+# get-frozen
+##########################################################################################
+from pathlib import Path
+from typing import List, Optional
+
+import rich_click as click
+from loguru import logger as log
+
+import stubber.utils as utils
+from stubber.codemod.enrich import enrich_folder
+from stubber.freeze.get_frozen import freeze_any
+from stubber.utils.config import CONFIG
+from stubber.utils.repos import fetch_repos
+
+from .cli import stubber_cli
+
+##########################################################################################
+
+
+@stubber_cli.command(name="get-frozen")
+@click.option(
+    "--stub-folder",
+    "-stubs",
+    default=CONFIG.stub_path.as_posix(),
+    type=click.Path(exists=True, file_okay=False, dir_okay=True),
+    show_default=True,
+)
+@click.option(
+    "--version",
+    "--Version",
+    "-V",
+    "version",
+    default="",
+    # default=[CONFIG.stable_version],
+    show_default=True,
+    help="The version of MicroPython to get the frozen modules for. Use 'preview' to get the latest version from the micropython repo",
+)
+@click.option(
+    "--stubgen/--no-stubgen",
+    default=True,
+    help="Run stubgen to create .pyi files for the (new) frozen modules",
+    show_default=True,
+)
+@click.option(
+    "--black/--no-black",
+    default=True,
+    help="Run black on the (new) frozen modules",
+    show_default=True,
+)
+def cli_get_frozen(
+    stub_folder: Optional[str] = None,
+    # path: str = config.repo_path.as_posix(),
+    version: str = "",
+    stubgen: bool = True,
+    black: bool = True,
+    autoflake: bool = True,
+):
+    """
+    Get the frozen stubs for MicroPython.
+
+    Get the frozen modules for the checked out version of MicroPython
+    """
+    # default parameter values
+    stub_folder = stub_folder or CONFIG.stub_path.as_posix()
+    # FIXME: Stub_folder is not used
+
+    stub_paths: List[Path] = []
+
+    if version:
+        version = utils.clean_version(version, drop_v=False)
+        result = fetch_repos(version, CONFIG.mpy_path, CONFIG.mpy_lib_path)
+        if not result:
+            log.error(
+                "Failed to fetch repos for version: {} for micropython folder: {} and micropython-lib folder: {}".format(
+                    version, CONFIG.mpy_path.as_posix(), CONFIG.mpy_lib_path.as_posix()
+                )
+            )
+            return -1
+    # folder/{family}-{version[_preview]}-frozen
+    family = "micropython"
+    # get the current checked out version
+    version = utils.checkedout_version(CONFIG.mpy_path)
+    log.info("MicroPython version : {}".format(version))
+
+    stub_path = freeze_any(
+        version=version, mpy_path=CONFIG.mpy_path, mpy_lib_path=CONFIG.mpy_lib_path
+    )
+    stub_paths.append(stub_path)
+    # Also enrich the frozen modules from the doc stubs if available
+
+    # first create .pyi files so they can be enriched
+    utils.do_post_processing(stub_paths, stubgen=stubgen, black=False, autoflake=False)
+    family = "micropython"
+    _version = utils.clean_version(version, drop_v=False, flat=True)
+    docstubs_path = Path(CONFIG.stub_path) / f"{family}-{_version}-docstubs"
+    if docstubs_path.exists():
+        log.info(f"Enriching {str(stub_path)} with {docstubs_path}")
+        if merged := enrich_folder(
+            stub_path,
+            docstubs_path,
+            show_diff=False,
+            write_back=True,
+            require_docstub=False,
+        ):
+            log.info(f"Enriched {merged} frozen modules from docstubs")
+    else:
+        log.info(f"No docstubs found at {docstubs_path}")
+
+    log.info("::group:: start post processing of retrieved stubs")
+    utils.do_post_processing(stub_paths, stubgen=False, black=black, autoflake=autoflake)
+    log.info("::group:: Done")

stubber/commands/get_mcu_cmd.py

@@ -1,56 +1,61 @@
-"""Deploy and run createstubs on one or more microcontrollers."""
-
-##########################################################################################
-# stub
-##########################################################################################
-
-
-import click
-from loguru import logger as log
-
-from stubber.bulk.mcu_stubber import stub_connected_mcus
-from stubber.utils.config import CONFIG
-
-from .cli import stubber_cli
-
-##########################################################################################
-# log = logging.getLogger("stubber")
-#########################################################################################
-
-
-@stubber_cli.command(name="get-mcu-stubs")
-@click.option(
-    "--variant",
-    "-v",
-    type=click.Choice(["Full", "Mem", "DB"], case_sensitive=False),
-    default="DB",
-    show_default=True,
-    help="Variant of createstubs to run",
-)
-@click.option(
-    "--format",
-    "-f",
-    type=click.Choice(["py", "mpy"], case_sensitive=False),
-    default="mpy",
-    show_default=True,
-    help="Python source or pre-compiled.",
-)
-@click.option("--debug/--no-debug", default=False, show_default=True, help="Debug mode.")
-@click.option(
-    "--reset/--no-reset", default=False, show_default=True, help="Reset the board before running createstubs."
-)
-@click.option(
-    "--github/--local",
-    default=True,
-    show_default=True,
-    help="where to install the board files from. local is intended for development.",
-)
-def cli_create_mcu_stubs(variant: str, format: str, debug: bool, reset: bool, github: bool) -> int:
-    """Run createstubs on one or more MCUs, and add the stubs to the micropython-stub repo."""
-    # check if all repos have been cloned
-    for repo in CONFIG.repos:
-        if not repo.exists():
-            log.error(f"Repo {repo} not found, use 'stubber clone --add-stubs' to clone the repos.")
-            exit(1)
-
-    exit(stub_connected_mcus(variant=variant, format=format, debug=debug))
+"""Deploy and run createstubs on one or more microcontrollers."""
+
+##########################################################################################
+# stub
+##########################################################################################
+
+
+import rich_click as click
+from loguru import logger as log
+
+from stubber.bulk.mcu_stubber import stub_connected_mcus
+from stubber.utils.config import CONFIG
+
+from .cli import stubber_cli
+
+##########################################################################################
+# log = logging.getLogger("stubber")
+#########################################################################################
+
+
+@stubber_cli.command(name="get-mcu-stubs")
+@click.option(
+    "--variant",
+    "-v",
+    type=click.Choice(["Full", "Mem", "DB"], case_sensitive=False),
+    default="DB",
+    show_default=True,
+    help="Variant of createstubs to run",
+)
+@click.option(
+    "--format",
+    "-f",
+    type=click.Choice(["py", "mpy"], case_sensitive=False),
+    default="mpy",
+    show_default=True,
+    help="Python source or pre-compiled.",
+)
+@click.option("--debug/--no-debug", default=False, show_default=True, help="Debug mode.")
+@click.option(
+    "--reset/--no-reset",
+    default=False,
+    show_default=True,
+    help="Reset the board before running createstubs.",
+)
+@click.option(
+    "--github/--local",
+    default=True,
+    show_default=True,
+    help="where to install the board files from. local is intended for development.",
+)
+def cli_create_mcu_stubs(variant: str, format: str, debug: bool, reset: bool, github: bool) -> int:
+    """Run createstubs on one or more MCUs, and add the stubs to the micropython-stub repo."""
+    # check if all repos have been cloned
+    for repo in CONFIG.repos:
+        if not repo.exists():
+            log.error(
+                f"Repo {repo} not found, use 'stubber clone --add-stubs' to clone the repos."
+            )
+            exit(1)
+
+    exit(stub_connected_mcus(variant=variant, format=format, debug=debug))

stubber/commands/merge_cmd.py

@@ -1,66 +1,67 @@
-"""
-enrich machinestubs with docstubs
-"""
-from typing import List, Union
-
-import click
-from loguru import logger as log
-
-from stubber.publish.merge_docstubs import merge_all_docstubs
-from stubber.publish.package import GENERIC_L
-from stubber.utils.config import CONFIG
-
-from .cli import stubber_cli
-
-
-@stubber_cli.command(name="merge")
-@click.option("--family", default="micropython", type=str, show_default=True)
-@click.option(
-    "--version",
-    "--Version",
-    "-V",
-    "versions",
-    multiple=True,
-    default=["all"],
-    # type=click.Choice(ALL_VERSIONS),
-    show_default=True,
-    help="'latest', 'auto', or one or more versions",
-)
-@click.option(
-    "--port",
-    "-p",
-    "ports",
-    multiple=True,
-    default=["all"],
-    show_default=True,
-    help="multiple: ",
-)
-@click.option(
-    "--board",
-    "-b",
-    "boards",
-    multiple=True,
-    default=[GENERIC_L],  # or "all" ?
-    show_default=True,
-    help="multiple: ",
-)
-def cli_merge_docstubs(
-    versions: Union[str, List[str]],
-    boards: Union[str, List[str]],
-    ports: Union[str, List[str]],
-    family: str,
-):
-    """
-    Enrich the stubs in stub_folder with the docstubs in docstubs_folder.
-    """
-    if isinstance(ports, tuple):
-        ports = list(ports)
-    if isinstance(boards, tuple):
-        boards = list(boards)
-    if isinstance(versions, tuple):
-        versions = list(versions)
-    # single version should be a string
-    log.info(f"Merge docstubs for {family} {versions}")
-    _ = merge_all_docstubs(
-        versions=versions, family=family, boards=boards, ports=ports, mpy_path=CONFIG.mpy_path
-    )
+"""
+enrich machinestubs with docstubs
+"""
+
+from typing import List, Union
+
+import rich_click as click
+from loguru import logger as log
+
+from stubber.publish.merge_docstubs import merge_all_docstubs
+from stubber.publish.package import GENERIC_L
+from stubber.utils.config import CONFIG
+
+from .cli import stubber_cli
+
+
+@stubber_cli.command(name="merge")
+@click.option("--family", default="micropython", type=str, show_default=True)
+@click.option(
+    "--version",
+    "--Version",
+    "-V",
+    "versions",
+    multiple=True,
+    default=["all"],
+    # type=click.Choice(ALL_VERSIONS),
+    show_default=True,
+    help="'latest', 'auto', or one or more versions",
+)
+@click.option(
+    "--port",
+    "-p",
+    "ports",
+    multiple=True,
+    default=["all"],
+    show_default=True,
+    help="multiple: ",
+)
+@click.option(
+    "--board",
+    "-b",
+    "boards",
+    multiple=True,
+    default=[GENERIC_L],  # or "all" ?
+    show_default=True,
+    help="multiple: ",
+)
+def cli_merge_docstubs(
+    versions: Union[str, List[str]],
+    boards: Union[str, List[str]],
+    ports: Union[str, List[str]],
+    family: str,
+):
+    """
+    Enrich the stubs in stub_folder with the docstubs in docstubs_folder.
+    """
+    if isinstance(ports, tuple):
+        ports = list(ports)
+    if isinstance(boards, tuple):
+        boards = list(boards)
+    if isinstance(versions, tuple):
+        versions = list(versions)
+    # single version should be a string
+    log.info(f"Merge docstubs for {family} {versions}")
+    _ = merge_all_docstubs(
+        versions=versions, family=family, boards=boards, ports=ports, mpy_path=CONFIG.mpy_path
+    )