micropython-stubber 1.23.1__py3-none-any.whl → 1.23.2__py3-none-any.whl

stubber/commands/merge_cmd.py

@@ -1,66 +1,66 @@
-"""
-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",
-    "-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 mpflash.logger import 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",
+    "-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
+    )

stubber/commands/publish_cmd.py

@@ -1,118 +1,118 @@
-"""
-Commandline interface to publish stubs.
-"""
-
-from typing import List, Union
-
-import rich_click as click
-from loguru import logger as log
-from tabulate import tabulate
-
-from stubber.commands.cli import stubber_cli
-from stubber.publish.defaults import GENERIC_U
-from stubber.publish.publish import publish_multiple
-from stubber.utils.config import CONFIG
-
-
-@stubber_cli.command(name="publish")
-@click.option("--family", default="micropython", type=str, show_default=True)
-@click.option(
-    "--version",
-    "-v",
-    "versions",
-    multiple=True,
-    default=[CONFIG.stable_version],
-    show_default=True,
-    help="multiple: ",
-)
-@click.option(
-    "--port",
-    "-p",
-    "ports",
-    multiple=True,
-    default=["all"],
-    show_default=True,
-    help="multiple: ",
-)
-@click.option(
-    "--board",
-    "-b",
-    "boards",
-    multiple=True,
-    default=[GENERIC_U],  # or "all" ?
-    show_default=True,
-    help="multiple: ",
-)
-@click.option(
-    "--pypi/--test-pypi",
-    "production",
-    is_flag=True,
-    default=False,
-    show_default=True,
-    prompt="Publish to PYPI (y) or Test-PYPI (n)",
-    help="publish to PYPI or Test-PYPI",
-)
-@click.option(
-    "--build",
-    is_flag=True,
-    default=False,
-    help="build before publish",
-)
-@click.option(
-    "--force",
-    is_flag=True,
-    default=False,
-    help="create new post release even if no changes detected",
-)
-@click.option(
-    "--dry-run",
-    is_flag=True,
-    default=False,
-    help="Do not actually publish, just show what would be done",
-)
-@click.option(
-    "--clean",
-    is_flag=True,
-    default=False,
-    help="clean folders after processing and publishing",
-)
-def cli_publish(
-    family: str,
-    versions: Union[str, List[str]],
-    ports: Union[str, List[str]],
-    boards: Union[str, List[str]],
-    production: bool = True,
-    build: bool = False,
-    force: bool = False,
-    dry_run: bool = False,
-    clean: bool = False,
-):
-    """
-    Commandline interface to publish stubs.
-    """
-    # lists please
-    versions = list(versions)
-    ports = list(ports)
-    boards = list(boards)
-
-    if len(versions) > 1:
-        raise NotImplementedError(
-            "Multiple versions are not supported yet\n See https://github.com/Josverl/micropython-stubber/issues/487"
-        )
-
-    # db = get_database(publish_path=CONFIG.publish_path, production=production)
-    destination = "pypi" if production else "test-pypi"
-    log.info(f"Publish {family} {versions} {ports} {boards} to {destination}")
-
-    results = publish_multiple(
-        family=family,
-        versions=versions,
-        ports=ports,
-        boards=boards,
-        production=production,
-        build=build,
-        force=force,
-        dry_run=dry_run,
-        clean=clean,
-    )
-    log.info(tabulate(results, headers="keys"))
+"""
+Commandline interface to publish stubs.
+"""
+
+from typing import List, Union
+
+import rich_click as click
+from mpflash.logger import log
+from tabulate import tabulate
+
+from stubber.commands.cli import stubber_cli
+from stubber.publish.defaults import GENERIC_U
+from stubber.publish.publish import publish_multiple
+from stubber.utils.config import CONFIG
+
+
+@stubber_cli.command(name="publish")
+@click.option("--family", default="micropython", type=str, show_default=True)
+@click.option(
+    "--version",
+    "-v",
+    "versions",
+    multiple=True,
+    default=[CONFIG.stable_version],
+    show_default=True,
+    help="multiple: ",
+)
+@click.option(
+    "--port",
+    "-p",
+    "ports",
+    multiple=True,
+    default=["all"],
+    show_default=True,
+    help="multiple: ",
+)
+@click.option(
+    "--board",
+    "-b",
+    "boards",
+    multiple=True,
+    default=[GENERIC_U],  # or "all" ?
+    show_default=True,
+    help="multiple: ",
+)
+@click.option(
+    "--pypi/--test-pypi",
+    "production",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    prompt="Publish to PYPI (y) or Test-PYPI (n)",
+    help="publish to PYPI or Test-PYPI",
+)
+@click.option(
+    "--build",
+    is_flag=True,
+    default=False,
+    help="build before publish",
+)
+@click.option(
+    "--force",
+    is_flag=True,
+    default=False,
+    help="create new post release even if no changes detected",
+)
+@click.option(
+    "--dry-run",
+    is_flag=True,
+    default=False,
+    help="Do not actually publish, just show what would be done",
+)
+@click.option(
+    "--clean",
+    is_flag=True,
+    default=False,
+    help="clean folders after processing and publishing",
+)
+def cli_publish(
+    family: str,
+    versions: Union[str, List[str]],
+    ports: Union[str, List[str]],
+    boards: Union[str, List[str]],
+    production: bool = True,
+    build: bool = False,
+    force: bool = False,
+    dry_run: bool = False,
+    clean: bool = False,
+):
+    """
+    Commandline interface to publish stubs.
+    """
+    # lists please
+    versions = list(versions)
+    ports = list(ports)
+    boards = list(boards)
+
+    if len(versions) > 1:
+        raise NotImplementedError(
+            "Multiple versions are not supported yet\n See https://github.com/Josverl/micropython-stubber/issues/487"
+        )
+
+    # db = get_database(publish_path=CONFIG.publish_path, production=production)
+    destination = "pypi" if production else "test-pypi"
+    log.info(f"Publish {family} {versions} {ports} {boards} to {destination}")
+
+    results = publish_multiple(
+        family=family,
+        versions=versions,
+        ports=ports,
+        boards=boards,
+        production=production,
+        build=build,
+        force=force,
+        dry_run=dry_run,
+        clean=clean,
+    )
+    log.info(tabulate(results, headers="keys"))

stubber/commands/stub_cmd.py

@@ -1,31 +1,31 @@
-"""Create or update .pyi type hint files."""
-
-##########################################################################################
-# stub
-##########################################################################################
-
-from loguru import logger as log
-from pathlib import Path
-from typing import Union
-
-import rich_click as click
-from stubber.utils import generate_pyi_files
-from stubber.utils.post import do_post_processing
-
-from .cli import stubber_cli
-
-##########################################################################################
-# log = logging.getLogger("stubber")
-#########################################################################################
-
-
-@stubber_cli.command(name="stub")
-@click.option("--source", "-s", type=click.Path(exists=True, file_okay=True, dir_okay=True))
-def cli_stub(source: Union[str, Path]):
-    "Create or update .pyi type hint files."
-
-    log.info("Generate type hint files (pyi) in folder: {}".format(source))
-    OK = generate_pyi_files(Path(source))
-    # do not generate pyi files twice
-    do_post_processing([Path(source)], stubgen=False, black=True, autoflake=False)
-    return 0 if OK else 1
+"""Create or update .pyi type hint files."""
+
+##########################################################################################
+# stub
+##########################################################################################
+
+from mpflash.logger import log
+from pathlib import Path
+from typing import Union
+
+import rich_click as click
+from stubber.utils import generate_pyi_files
+from stubber.utils.post import do_post_processing
+
+from .cli import stubber_cli
+
+##########################################################################################
+# log = logging.getLogger("stubber")
+#########################################################################################
+
+
+@stubber_cli.command(name="stub")
+@click.option("--source", "-s", type=click.Path(exists=True, file_okay=True, dir_okay=True))
+def cli_stub(source: Union[str, Path]):
+    "Create or update .pyi type hint files."
+
+    log.info("Generate type hint files (pyi) in folder: {}".format(source))
+    OK = generate_pyi_files(Path(source))
+    # do not generate pyi files twice
+    do_post_processing([Path(source)], stubgen=False, black=True, autoflake=False)
+    return 0 if OK else 1

stubber/commands/switch_cmd.py

@@ -1,62 +1,62 @@
-"""
-switch to a specific version of the micropython repos
-"""
-
-from pathlib import Path
-from typing import Optional, Union
-
-import rich_click as click
-
-import mpflash.basicgit as git
-from stubber.utils.config import CONFIG
-from stubber.utils.repos import fetch_repos, repo_paths
-from mpflash.versions import SET_PREVIEW, V_PREVIEW
-
-from .cli import stubber_cli
-
-##########################################################################################
-# log = logging.getLogger("stubber")
-#########################################################################################
-
-
-# get version list from Git tags in the repo that is provided on the command line
-
-try:
-    VERSION_LIST = git.get_tags("micropython/micropython", minver="v1.9.3") + [
-        V_PREVIEW,
-        "latest",
-        "stable",
-    ]
-except Exception:
-    # offline fallback
-    VERSION_LIST = ["v1.91.1", "v1.20.1", "v1.21.0", "v1.22.1", "preview", "stable"]
-
-
-@stubber_cli.command(name="switch")
-@click.argument("tag", required=False, type=click.Choice(VERSION_LIST, case_sensitive=False))
-@click.option(
-    "--path",
-    "-p",
-    default=CONFIG.repo_path.as_posix(),
-    type=click.Path(file_okay=False, dir_okay=True),
-)
-def cli_switch(path: Union[str, Path], tag: Optional[str] = None):
-    """
-    Switch to a specific version of the micropython repos.
-
-    The Micropython-lib repo will be checked out to a commit that corresponds
-    in time to that version tag, in order to allow non-current versions to be
-    stubbed correctly.
-
-    The repros must be cloned already
-    """
-
-    try:
-        mpy_path, mpy_lib_path = repo_paths(Path(path))
-    except Exception:
-        return -1
-    if not tag or tag in SET_PREVIEW:
-        tag = V_PREVIEW
-
-    result = fetch_repos(tag, mpy_path, mpy_lib_path)
-    return -1 if result else 0
+"""
+switch to a specific version of the micropython repos
+"""
+
+from pathlib import Path
+from typing import Optional, Union
+
+import rich_click as click
+
+import mpflash.basicgit as git
+from stubber.utils.config import CONFIG
+from stubber.utils.repos import fetch_repos, repo_paths
+from mpflash.versions import SET_PREVIEW, V_PREVIEW
+
+from .cli import stubber_cli
+
+##########################################################################################
+# log = logging.getLogger("stubber")
+#########################################################################################
+
+
+# get version list from Git tags in the repo that is provided on the command line
+
+try:
+    VERSION_LIST = git.get_tags("micropython/micropython", minver="v1.9.3") + [
+        V_PREVIEW,
+        "latest",
+        "stable",
+    ]
+except Exception:
+    # offline fallback
+    VERSION_LIST = ["v1.91.1", "v1.20.1", "v1.21.0", "v1.22.1", "preview", "stable"]
+
+
+@stubber_cli.command(name="switch")
+@click.argument("tag", required=False, type=click.Choice(VERSION_LIST, case_sensitive=False))
+@click.option(
+    "--path",
+    "-p",
+    default=CONFIG.repo_path.as_posix(),
+    type=click.Path(file_okay=False, dir_okay=True),
+)
+def cli_switch(path: Union[str, Path], tag: Optional[str] = None):
+    """
+    Switch to a specific version of the micropython repos.
+
+    The Micropython-lib repo will be checked out to a commit that corresponds
+    in time to that version tag, in order to allow non-current versions to be
+    stubbed correctly.
+
+    The repros must be cloned already
+    """
+
+    try:
+        mpy_path, mpy_lib_path = repo_paths(Path(path))
+    except Exception:
+        return -1
+    if not tag or tag in SET_PREVIEW:
+        tag = V_PREVIEW
+
+    result = fetch_repos(tag, mpy_path, mpy_lib_path)
+    return -1 if result else 0

stubber/commands/variants_cmd.py

@@ -1,48 +1,48 @@
-"""Create all variant of createstubs*.py."""
-
-from pathlib import Path
-
-import rich_click as click
-from loguru import logger as log
-from stubber.utils.config import CONFIG
-from stubber.variants import create_variants
-import stubber
-
-from .cli import stubber_cli
-
-
-@click.option(
-    "--version",
-    "-v",
-    "version",
-    default=CONFIG.stable_version,
-    show_default=True,
-    help="The version of mpy-cross to use",
-)
-@click.option(
-    "--target",
-    "-t",
-    "target_folder",
-    default=None,
-    type=click.Path(exists=False, file_okay=False, dir_okay=True),
-    help="Target folder for the createstubs*.py/.mpy files",
-    show_default=True,
-)
-@stubber_cli.command(name="make-variants")
-@click.pass_context
-def cli_variants(
-    ctx: click.Context,
-    target_folder: str = "",
-    version: str = CONFIG.stable_version,
-) -> int:
-    """Update all variants of createstubs*.py."""
-    board_path = Path(stubber.__file__).parent / "board"
-    if target_folder:
-        target_path = Path(target_folder).absolute()
-        target_path.mkdir(parents=True, exist_ok=True)
-    else:
-        target_path = board_path
-    create_variants(board_path, target_path=target_path, version=version)
-
-    log.info("Done!")
-    return 0
+"""Create all variant of createstubs*.py."""
+
+from pathlib import Path
+
+import rich_click as click
+from mpflash.logger import log
+from stubber.utils.config import CONFIG
+from stubber.variants import create_variants
+import stubber
+
+from .cli import stubber_cli
+
+
+@click.option(
+    "--version",
+    "-v",
+    "version",
+    default=CONFIG.stable_version,
+    show_default=True,
+    help="The version of mpy-cross to use",
+)
+@click.option(
+    "--target",
+    "-t",
+    "target_folder",
+    default=None,
+    type=click.Path(exists=False, file_okay=False, dir_okay=True),
+    help="Target folder for the createstubs*.py/.mpy files",
+    show_default=True,
+)
+@stubber_cli.command(name="make-variants")
+@click.pass_context
+def cli_variants(
+    ctx: click.Context,
+    target_folder: str = "",
+    version: str = CONFIG.stable_version,
+) -> int:
+    """Update all variants of createstubs*.py."""
+    board_path = Path(stubber.__file__).parent / "board"
+    if target_folder:
+        target_path = Path(target_folder).absolute()
+        target_path.mkdir(parents=True, exist_ok=True)
+    else:
+        target_path = board_path
+    create_variants(board_path, target_path=target_path, version=version)
+
+    log.info("Done!")
+    return 0