yambs.commands package

yambs.commands package#

Submodules#

yambs.commands.all module#

A module aggregating package commands.

yambs.commands.all.commands() → List[Tuple[str, str, Callable[[ArgumentParser], Callable[[Namespace], int]]]][source]#: Get this package’s commands.

yambs.commands.common module#

Common command-line argument interfaces.

yambs.commands.common.add_common_args(parser: ArgumentParser) → None[source]#: Add common command-line arguments to a parser.

yambs.commands.common.add_config_arg(parser: ArgumentParser) → None[source]#: Add an argument for specifying a configuration file.

yambs.commands.common.handle_build(args: Namespace) → None[source]#: Run ‘ninja’ if some conditions are met.

yambs.commands.common.log_package() → None[source]#: Log some basic package information.

yambs.commands.common.run_watch(args: Namespace, src_root: Path, command: str) → int[source]#: Run the ‘watch’ command from rcmpy.

yambs.commands.compile_config module#

An entry-point for the ‘compile_config’ command.

yambs.commands.compile_config.add_compile_config_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add dist-command arguments to its parser.

yambs.commands.compile_config.compile_config_cmd(args: Namespace) → int[source]#: Execute the compile_config command.

yambs.commands.dist module#

An entry-point for the ‘dist’ command.

yambs.commands.dist.add_dist_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add dist-command arguments to its parser.

yambs.commands.dist.dist_cmd(args: Namespace) → int[source]#: Execute the dist command.

yambs.commands.download module#

An entry-point for the ‘download’ command.

yambs.commands.download.add_download_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add download-command arguments to its parser.

yambs.commands.download.download_cmd(args: Namespace) → int[source]#: Execute the download command.

yambs.commands.gen module#

An entry-point for the ‘gen’ command.

yambs.commands.gen.add_gen_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add gen-command arguments to its parser.

yambs.commands.gen.gen_cmd(args: Namespace) → int[source]#: Execute the gen command.

yambs.commands.native module#

An entry-point for the ‘native’ command.

yambs.commands.native.add_native_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add native-command arguments to its parser.

yambs.commands.native.native_cmd(args: Namespace) → int[source]#: Execute the native command.

yambs.commands.uf2conv module#

Based on: microsoft/uf2

An entry-point for the ‘uf2conv’ command.

yambs.commands.uf2conv.add_uf2conv_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add uf2conv-command arguments to its parser.

yambs.commands.uf2conv.error(msg) → None[source]#: Print an error message and exit the program.

yambs.commands.uf2conv.uf2conv_cmd(args: Namespace) → int[source]#: Execute the uf2conv command.

Module contents#