mloq.cli#

Command line interface for mloq.

Module Contents#

Classes#

MloqCLI

Load the commands available at runtime from the files present in the command module.

Functions#

mloq_click_command(func)

Wrap a command function to interface with click.

cli()

welcome_message([extra, string])

Welcome message to be displayed during interactive setup.

Attributes#

overwrite_opt

config_file_opt

only_config_opt

output_directory_arg

interactive_opt

hydra_args

mloq.cli.overwrite_opt#
mloq.cli.config_file_opt#
mloq.cli.only_config_opt#
mloq.cli.output_directory_arg#
mloq.cli.interactive_opt#
mloq.cli.hydra_args#
mloq.cli.mloq_click_command(func)[source]#

Wrap a command function to interface with click.

class mloq.cli.MloqCLI(name=None, invoke_without_command=False, no_args_is_help=None, subcommand_metavar=None, chain=False, result_callback=None, **attrs)[source]#

Bases: click.MultiCommand

Load the commands available at runtime from the files present in the command module.

Parameters

  • name (Optional[str]) –

  • invoke_without_command (bool) –

  • no_args_is_help (Optional[bool]) –

  • subcommand_metavar (Optional[str]) –

  • chain (bool) –

  • result_callback (Optional[Callable[Ellipsis, Any]]) –

  • attrs (Any) –

command_folder#
list_commands(ctx)[source]#

List the names of the mloq commands available.

get_command(ctx, name)[source]#

Create the command callable corresponding to the provided command name.

Return type

Callable

mloq.cli.cli()[source]#
mloq.cli.welcome_message(extra=False, string=None)[source]#

Welcome message to be displayed during interactive setup.

Parameters

  • extra (bool) –

  • string (Optional[str]) –