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

mpflash/mpflash/cli_group.py

@@ -1,111 +1,111 @@
-"""
-Main entry point for the CLI group.
-Additional comands are added in the submodules.
-"""
-
-import rich_click as click
-
-from mpflash.vendor.click_aliases import ClickAliasedGroup
-
-from .config import __version__, config
-from .logger import log, make_quiet, set_loglevel
-
-
-def cb_verbose(ctx, param, value):
-    """Callback to set the log level to DEBUG if verbose is set"""
-    if value and not config.quiet:
-        # log.debug(f"Setting verbose mode to {value}")
-        config.verbose = True
-        if value > 1:
-            set_loglevel("TRACE")
-        else:
-            set_loglevel("DEBUG")
-        log.debug(f"version: {__version__}")
-    else:
-        set_loglevel("INFO")
-        config.verbose = False
-    return value
-
-
-def cb_interactive(ctx, param, value: bool):
-    log.trace(f"Setting interactive mode to {value}")
-    config.interactive = value
-    return value
-
-
-def cb_test(ctx, param, value):
-    if value:
-        log.trace(f"Setting tests to {value}")
-        config.tests = value
-    return value
-
-def cb_usb(ctx, param, value: bool):
-    config.usb = bool(value)
-    return value
-
-
-def cb_quiet(ctx, param, value):
-    log.trace(f"Setting quiet mode to {value}")
-    if value:
-        make_quiet()
-    return value
-
-
-@click.group(cls=ClickAliasedGroup)
-# @click.group()
-@click.version_option(package_name="mpflash")
-@click.option(
-    "--quiet",
-    "-q",
-    is_eager=True,
-    is_flag=True,
-    help="Suppresses all output.",
-    callback=cb_quiet,
-    envvar="MPFLASH_QUIET",
-    show_default=True,
-)
-@click.option(
-    "--interactive/--no-interactive",
-    "-i/-x",
-    is_eager=True,
-    help="Suppresses all request for Input.",
-    callback=cb_interactive,
-    # envvar="MPFLASH_QUIET",
-    default=True,
-    show_default=True,
-)
-@click.option(
-    "-V",
-    "--verbose",
-    is_eager=True,
-    count=True,
-    help="Enables verbose mode.",
-    callback=cb_verbose,
-)
-@click.option(
-    "--usb",
-    "-u",
-    is_eager=True,
-    is_flag=True,
-    default=False,
-    help="Shows USB location of the connected boards.",
-    callback=cb_usb,
-    show_default=True,
-)
-@click.option(
-    "--test",
-    is_eager=True,
-    help="Test a specific feature.",
-    callback=cb_test,
-    multiple=True,
-    default=[],
-    envvar="MPFLASH_TEST",
-    metavar="FLAG",
-)
-def cli(**kwargs):
-    """mpflash - MicroPython flashing tool.
-
-    A CLI to download and flash MicroPython firmware to different ports and boards.
-    """
-    # all functionality is added in the submodules
-    pass
+"""
+Main entry point for the CLI group.
+Additional comands are added in the submodules.
+"""
+
+import rich_click as click
+
+from mpflash.vendor.click_aliases import ClickAliasedGroup
+
+from .config import __version__, config
+from .logger import log, make_quiet, set_loglevel
+
+
+def cb_verbose(ctx, param, value):
+    """Callback to set the log level to DEBUG if verbose is set"""
+    if value and not config.quiet:
+        # log.debug(f"Setting verbose mode to {value}")
+        config.verbose = True
+        if value > 1:
+            set_loglevel("TRACE")
+        else:
+            set_loglevel("DEBUG")
+        log.debug(f"version: {__version__}")
+    else:
+        set_loglevel("INFO")
+        config.verbose = False
+    return value
+
+
+def cb_interactive(ctx, param, value: bool):
+    log.trace(f"Setting interactive mode to {value}")
+    config.interactive = value
+    return value
+
+
+def cb_test(ctx, param, value):
+    if value:
+        log.trace(f"Setting tests to {value}")
+        config.tests = value
+    return value
+
+def cb_usb(ctx, param, value: bool):
+    config.usb = bool(value)
+    return value
+
+
+def cb_quiet(ctx, param, value):
+    log.trace(f"Setting quiet mode to {value}")
+    if value:
+        make_quiet()
+    return value
+
+
+@click.group(cls=ClickAliasedGroup)
+# @click.group()
+@click.version_option(package_name="mpflash")
+@click.option(
+    "--quiet",
+    "-q",
+    is_eager=True,
+    is_flag=True,
+    help="Suppresses all output.",
+    callback=cb_quiet,
+    envvar="MPFLASH_QUIET",
+    show_default=True,
+)
+@click.option(
+    "--interactive/--no-interactive",
+    "-i/-x",
+    is_eager=True,
+    help="Suppresses all request for Input.",
+    callback=cb_interactive,
+    # envvar="MPFLASH_QUIET",
+    default=True,
+    show_default=True,
+)
+@click.option(
+    "-V",
+    "--verbose",
+    is_eager=True,
+    count=True,
+    help="Enables verbose mode.",
+    callback=cb_verbose,
+)
+@click.option(
+    "--usb",
+    "-u",
+    is_eager=True,
+    is_flag=True,
+    default=False,
+    help="Shows USB location of the connected boards.",
+    callback=cb_usb,
+    show_default=True,
+)
+@click.option(
+    "--test",
+    is_eager=True,
+    help="Test a specific feature.",
+    callback=cb_test,
+    multiple=True,
+    default=[],
+    envvar="MPFLASH_TEST",
+    metavar="FLAG",
+)
+def cli(**kwargs):
+    """mpflash - MicroPython flashing tool.
+
+    A CLI to download and flash MicroPython firmware to different ports and boards.
+    """
+    # all functionality is added in the submodules
+    pass

mpflash/mpflash/cli_list.py

@@ -1,81 +1,87 @@
-import json
-from typing import List
-
-import rich_click as click
-from rich import print
-
-from .cli_group import cli
-from .connected import list_mcus
-from .list import show_mcus
-from .logger import make_quiet
-
-
-@cli.command(
-    "list",
-    help="List the connected MCU boards. alias: devs",
-    aliases=["devs"],
-)
-@click.option(
-    "--json",
-    "-j",
-    "as_json",
-    is_flag=True,
-    default=False,
-    show_default=True,
-    help="""Output in json format""",
-)
-@click.option(
-    "--serial",
-    "--serial-port",
-    "-s",
-    "serial",
-    default=["*"],
-    multiple=True,
-    show_default=True,
-    help="Which serial port(s) to list. ",
-    metavar="SERIALPORT",
-)
-@click.option(
-    "--ignore",
-    "-i",
-    is_eager=True,
-    help="Serial port(s) to ignore. Defaults to MPFLASH_IGNORE.",
-    multiple=True,
-    default=[],
-    envvar="MPFLASH_IGNORE",
-    show_default=True,
-    metavar="SERIALPORT",
-)
-@click.option(
-    "--bluetooth/--no-bluetooth",
-    "-b/-nb",
-    is_flag=True,
-    default=False,
-    show_default=True,
-    help="""Include bluetooth ports in the list""",
-)
-@click.option(
-    "--progress/--no-progress",
-    # "-p/-np", -p is already used for --port
-    "progress",
-    is_flag=True,
-    default=True,
-    show_default=True,
-    help="""Show progress""",
-)
-def cli_list_mcus(serial: List[str], ignore: List[str], bluetooth: bool, as_json: bool, progress: bool = True) -> int:
-    """List the connected MCU boards, and output in a nice table or json."""
-    serial = list(serial)
-    ignore = list(ignore)
-    if as_json:
-        # avoid noise in json output
-        make_quiet()
-    # TODO? Ask user to select a serialport if [?] is given ?
-
-    conn_mcus = list_mcus(ignore=ignore, include=serial, bluetooth=bluetooth)
-    if as_json:
-        print(json.dumps([mcu.__dict__ for mcu in conn_mcus], indent=4))
-        progress = False
-    if progress:
-        show_mcus(conn_mcus, refresh=False)
-    return 0 if conn_mcus else 1
+import json
+from typing import List
+
+import rich_click as click
+from rich import print
+
+from .cli_group import cli
+from .connected import list_mcus
+from .list import show_mcus
+from .logger import make_quiet
+
+
+@cli.command(
+    "list",
+    help="List the connected MCU boards. alias: devs",
+    aliases=["devs"],
+)
+@click.option(
+    "--json",
+    "-j",
+    "as_json",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="""Output in json format""",
+)
+@click.option(
+    "--serial",
+    "--serial-port",
+    "-s",
+    "serial",
+    default=["*"],
+    multiple=True,
+    show_default=True,
+    help="Serial port(s) (or globs) to list. ",
+    metavar="SERIALPORT",
+)
+@click.option(
+    "--ignore",
+    "-i",
+    is_eager=True,
+    help="Serial port(s) (or globs) to ignore. Defaults to MPFLASH_IGNORE.",
+    multiple=True,
+    default=[],
+    envvar="MPFLASH_IGNORE",
+    show_default=True,
+    metavar="SERIALPORT",
+)
+@click.option(
+    "--bluetooth/--no-bluetooth",
+    "-b/-nb",
+    is_flag=True,
+    default=False,
+    show_default=True,
+    help="""Include bluetooth ports in the list""",
+)
+@click.option(
+    "--progress/--no-progress",
+    # "-p/-np", -p is already used for --port
+    "progress",
+    is_flag=True,
+    default=True,
+    show_default=True,
+    help="""Show progress""",
+)
+def cli_list_mcus(serial: List[str], ignore: List[str], bluetooth: bool, as_json: bool, progress: bool = True) -> int:
+    """List the connected MCU boards, and output in a nice table or json."""
+    serial = list(serial)
+    ignore = list(ignore)
+    if as_json:
+        # avoid noise in json output
+        make_quiet()
+    # TODO? Ask user to select a serialport if [?] is given ?
+
+    conn_mcus = list_mcus(ignore=ignore, include=serial, bluetooth=bluetooth)
+    # ignore boards that have the [micropython-stubber] ignore flag set
+    conn_mcus = [item for item in conn_mcus if not (item.toml.get("mpflash", {}).get("ignore", False))]    
+    if as_json:
+        # remove the path and firmware attibutes from the json output as they are always empty
+        for mcu in conn_mcus:
+            del mcu.path
+            del mcu.firmware
+        print(json.dumps([mcu.__dict__ for mcu in conn_mcus], indent=4))
+        progress = False
+    if progress:
+        show_mcus(conn_mcus, refresh=False)
+    return 0 if conn_mcus else 1

mpflash/mpflash/cli_main.py

@@ -1,39 +1,39 @@
-"""mpflash is a CLI to download and flash MicroPython firmware to various boards."""
-
-import os
-
-import click.exceptions as click_exceptions
-from loguru import logger as log
-
-from .cli_download import cli_download
-from .cli_flash import cli_flash_board
-from .cli_group import cli
-from .cli_list import cli_list_mcus
-
-
-def mpflash():
-    cli.add_command(cli_list_mcus)
-    cli.add_command(cli_download)
-    cli.add_command(cli_flash_board)
-
-    # cli(auto_envvar_prefix="MPFLASH")
-    if False and os.environ.get("COMPUTERNAME").startswith("JOSVERL"):
-        # intentional less error suppression on dev machine
-        result = cli(standalone_mode=False)
-    else:
-        try:
-            result = cli(standalone_mode=True)
-            exit(result)
-        except AttributeError as e:
-            log.error(f"Error: {e}")
-            exit(-1)
-        except click_exceptions.ClickException as e:
-            log.error(f"Error: {e}")
-            exit(-2)
-        except click_exceptions.Abort as e:
-            # Aborted - Ctrl-C
-            exit(-3)
-
-
-if __name__ == "__main__":
-    mpflash()
+"""mpflash is a CLI to download and flash MicroPython firmware to various boards."""
+
+import os
+
+import click.exceptions as click_exceptions
+from loguru import logger as log
+
+from .cli_download import cli_download
+from .cli_flash import cli_flash_board
+from .cli_group import cli
+from .cli_list import cli_list_mcus
+
+
+def mpflash():
+    cli.add_command(cli_list_mcus)
+    cli.add_command(cli_download)
+    cli.add_command(cli_flash_board)
+
+    # cli(auto_envvar_prefix="MPFLASH")
+    if False and os.environ.get("COMPUTERNAME").startswith("JOSVERL"):
+        # intentional less error suppression on dev machine
+        result = cli(standalone_mode=False)
+    else:
+        try:
+            result = cli(standalone_mode=True)
+            exit(result)
+        except AttributeError as e:
+            log.error(f"Error: {e}")
+            exit(-1)
+        except click_exceptions.ClickException as e:
+            log.error(f"Error: {e}")
+            exit(-2)
+        except click_exceptions.Abort as e:
+            # Aborted - Ctrl-C
+            exit(-3)
+
+
+if __name__ == "__main__":
+    mpflash()