micropython-stubber 1.23.1.post1__py3-none-any.whl → 1.23.3__py3-none-any.whl

stubber/commands/config_cmd.py

@@ -1,29 +1,29 @@
-"""Show the current configuration"""
-
-# pragma: no cover
-
-from mpflash.logger import log
-
-from stubber.utils.config import CONFIG
-
-from .cli import stubber_cli
-
-
-@stubber_cli.command(name="show-config")
-def cli_config():
-    """
-    Show the current configuration
-    """
-    try:
-        # todo: sources[1] is depedent on the order the providers are added in
-        log.info(f"config file                {CONFIG._provider._config_sources[1].filename}")  # type: ignore
-    except Exception:
-        pass
-    log.info(f"CONFIG.repo_path           {CONFIG.repo_path}")
-    log.info(f"CONFIG.mpy_path            {CONFIG.mpy_path}")
-    log.info(f"CONFIG.mpy_lib_path        {CONFIG.mpy_lib_path}")
-    log.info(f"CONFIG.mpy_stubs_path      {CONFIG.mpy_stubs_path}")
-
-    log.info(f"CONFIG.stub_path           {CONFIG.stub_path}")
-    log.info(f"CONFIG.publish_path        {CONFIG.publish_path}")
-    log.info(f"CONFIG.template_path       {CONFIG.template_path}")
+"""Show the current configuration"""
+
+# pragma: no cover
+
+from mpflash.logger import log
+
+from stubber.utils.config import CONFIG
+
+from .cli import stubber_cli
+
+
+@stubber_cli.command(name="show-config")
+def cli_config():
+    """
+    Show the current configuration
+    """
+    try:
+        # todo: sources[1] is depedent on the order the providers are added in
+        log.info(f"config file                {CONFIG._provider._config_sources[1].filename}")  # type: ignore
+    except Exception:
+        pass
+    log.info(f"CONFIG.repo_path           {CONFIG.repo_path}")
+    log.info(f"CONFIG.mpy_path            {CONFIG.mpy_path}")
+    log.info(f"CONFIG.mpy_lib_path        {CONFIG.mpy_lib_path}")
+    log.info(f"CONFIG.mpy_stubs_path      {CONFIG.mpy_stubs_path}")
+
+    log.info(f"CONFIG.stub_path           {CONFIG.stub_path}")
+    log.info(f"CONFIG.publish_path        {CONFIG.publish_path}")
+    log.info(f"CONFIG.template_path       {CONFIG.template_path}")

stubber/commands/enrich_folder_cmd.py

@@ -1,71 +1,71 @@
-"""
-enrich machinestubs with docstubs
-"""
-
-from pathlib import Path
-from typing import Union
-
-import rich_click as click
-from mpflash.logger import log
-
-from stubber.codemod.enrich import enrich_folder
-from stubber.utils.config import CONFIG
-
-from .cli import stubber_cli
-
-
-@stubber_cli.command(name="enrich")
-@click.option(
-    "--stubs",
-    "-s",
-    "stubs_folder",
-    default=CONFIG.stub_path.as_posix(),
-    type=click.Path(exists=True, file_okay=True, dir_okay=True),
-    help="File or folder containing the MCU stubs to be updated",
-    show_default=True,
-)
-@click.option(
-    "--docstubs",
-    "-ds",
-    "docstubs_folder",
-    default=CONFIG.stub_path.as_posix(),
-    type=click.Path(exists=True, file_okay=True, dir_okay=True),
-    help="File or folder containing the docstubs to be applied",
-    show_default=True,
-)
-@click.option("--diff", default=False, help="Show diff", show_default=True, is_flag=True)
-@click.option(
-    "--dry-run",
-    default=False,
-    help="Dry run does not write the files back",
-    show_default=True,
-    is_flag=True,
-)
-@click.option(
-    "--package-name",
-    "-p",
-    "package_name",
-    default="",
-    help="Package name to be enriched (Optional)",
-    show_default=True,
-)
-def cli_enrich_folder(
-    stubs_folder: Union[str, Path],
-    docstubs_folder: Union[str, Path],
-    diff: bool = False,
-    dry_run: bool = False,
-    package_name: str = "",
-):
-    """
-    Enrich the stubs in stub_folder with the docstubs in docstubs_folder.
-    """
-    write_back = not dry_run
-    log.info(f"Enriching {stubs_folder} with {docstubs_folder}")
-    _ = enrich_folder(
-        Path(stubs_folder),
-        Path(docstubs_folder),
-        show_diff=diff,
-        write_back=write_back,
-        require_docstub=False,
-        package_name=package_name,
-    )
+"""
+enrich machinestubs with docstubs
+"""
+
+from pathlib import Path
+from typing import Union
+
+import rich_click as click
+from mpflash.logger import log
+
+from stubber.codemod.enrich import enrich_folder
+from stubber.utils.config import CONFIG
+
+from .cli import stubber_cli
+
+
+@stubber_cli.command(name="enrich")
+@click.option(
+    "--stubs",
+    "-s",
+    "stubs_folder",
+    default=CONFIG.stub_path.as_posix(),
+    type=click.Path(exists=True, file_okay=True, dir_okay=True),
+    help="File or folder containing the MCU stubs to be updated",
+    show_default=True,
+)
+@click.option(
+    "--docstubs",
+    "-ds",
+    "docstubs_folder",
+    default=CONFIG.stub_path.as_posix(),
+    type=click.Path(exists=True, file_okay=True, dir_okay=True),
+    help="File or folder containing the docstubs to be applied",
+    show_default=True,
+)
+@click.option("--diff", default=False, help="Show diff", show_default=True, is_flag=True)
+@click.option(
+    "--dry-run",
+    default=False,
+    help="Dry run does not write the files back",
+    show_default=True,
+    is_flag=True,
+)
+@click.option(
+    "--package-name",
+    "-p",
+    "package_name",
+    default="",
+    help="Package name to be enriched (Optional)",
+    show_default=True,
+)
+def cli_enrich_folder(
+    stubs_folder: Union[str, Path],
+    docstubs_folder: Union[str, Path],
+    diff: bool = False,
+    dry_run: bool = False,
+    package_name: str = "",
+):
+    """
+    Enrich the stubs in stub_folder with the docstubs in docstubs_folder.
+    """
+    write_back = not dry_run
+    log.info(f"Enriching {stubs_folder} with {docstubs_folder}")
+    _ = enrich_folder(
+        Path(stubs_folder),
+        Path(docstubs_folder),
+        show_diff=diff,
+        write_back=write_back,
+        require_docstub=False,
+        package_name=package_name,
+    )

stubber/commands/get_core_cmd.py

@@ -1,71 +1,71 @@
-"""Get core CPython stubs from PyPi."""
-
-##########################################################################################
-# core
-##########################################################################################
-
-from pathlib import Path
-from typing import List
-
-import rich_click as click
-from mpflash.logger import log
-
-import stubber.get_cpython as get_cpython
-import stubber.utils as utils
-from stubber.utils.config import CONFIG
-
-from .cli import stubber_cli
-
-##########################################################################################
-# log = logging.getLogger("stubber")
-#########################################################################################
-
-
-@stubber_cli.command(name="get-core")
-@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(
-    "--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_core(
-    stub_folder: str = "",
-    # core_type: str = "pycopy",  # pycopy or Micropython CPython stubs
-    stubgen: bool = True,
-    black: bool = True,
-):
-    """
-    Download core CPython stubs from PyPi.
-
-    Get the core (CPython compat) modules for both MicroPython and Pycopy.
-    """
-    # default parameter values
-    stub_folder = stub_folder or CONFIG.stub_path.as_posix()
-
-    stub_paths: List[Path] = []
-    for core_type in ["pycopy", "micropython"]:
-        log.info(f"::group:: Get Cpython core :{core_type}")
-        req_filename = f"requirements-core-{core_type}.txt"
-        stub_path = Path(stub_folder) / f"cpython_core-{core_type}"
-
-        get_cpython.get_core(
-            stub_path=stub_path.as_posix(), requirements=req_filename, family=core_type
-        )
-        stub_paths.append(stub_path)
-
-    log.info("::group:: start post processing of retrieved stubs")
-    utils.do_post_processing(stub_paths, stubgen=stubgen, black=black, autoflake=True)
-    log.info("::group:: Done")
+"""Get core CPython stubs from PyPi."""
+
+##########################################################################################
+# core
+##########################################################################################
+
+from pathlib import Path
+from typing import List
+
+import rich_click as click
+from mpflash.logger import log
+
+import stubber.get_cpython as get_cpython
+import stubber.utils as utils
+from stubber.utils.config import CONFIG
+
+from .cli import stubber_cli
+
+##########################################################################################
+# log = logging.getLogger("stubber")
+#########################################################################################
+
+
+@stubber_cli.command(name="get-core")
+@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(
+    "--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_core(
+    stub_folder: str = "",
+    # core_type: str = "pycopy",  # pycopy or Micropython CPython stubs
+    stubgen: bool = True,
+    black: bool = True,
+):
+    """
+    Download core CPython stubs from PyPi.
+
+    Get the core (CPython compat) modules for both MicroPython and Pycopy.
+    """
+    # default parameter values
+    stub_folder = stub_folder or CONFIG.stub_path.as_posix()
+
+    stub_paths: List[Path] = []
+    for core_type in ["pycopy", "micropython"]:
+        log.info(f"::group:: Get Cpython core :{core_type}")
+        req_filename = f"requirements-core-{core_type}.txt"
+        stub_path = Path(stub_folder) / f"cpython_core-{core_type}"
+
+        get_cpython.get_core(
+            stub_path=stub_path.as_posix(), requirements=req_filename, family=core_type
+        )
+        stub_paths.append(stub_path)
+
+    log.info("::group:: start post processing of retrieved stubs")
+    utils.do_post_processing(stub_paths, stubgen=stubgen, black=black, autoflake=True)
+    log.info("::group:: Done")

stubber/commands/get_docstubs_cmd.py

@@ -1,92 +1,92 @@
-"""
-get-docstubs
-
-"""
-
-from pathlib import Path
-from typing import Optional
-
-import rich_click as click
-from mpflash.logger import log
-
-import mpflash.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",
-    aliases=["get-doc-stubs", "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 mpflash.logger import log
+
+import mpflash.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",
+    aliases=["get-doc-stubs", "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")