runtimepy.commands package

runtimepy.commands package#

Submodules#

runtimepy.commands.all module#

A module aggregating package commands.

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

runtimepy.commands.arbiter module#

An entry-point for the ‘arbiter’ command.

runtimepy.commands.arbiter.add_arbiter_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add arbiter-command arguments to its parser.

runtimepy.commands.arbiter.app(args: Namespace) → int[source]#: Start the application with an optional TUI.

runtimepy.commands.arbiter.arbiter_cmd(args: Namespace) → int[source]#: Execute the arbiter command.

async runtimepy.commands.arbiter.entry(stop_sig: Event, args: Namespace, window: Any = None) → int[source]#: The async command entry.

runtimepy.commands.common module#

A module for package command-line argument interfaces.

runtimepy.commands.common.arbiter_args(parser: ArgumentParser, nargs: str = '+') → Iterator[None][source]#: Add common connection-arbiter parameters.

runtimepy.commands.common.arbiter_flags(parser: ArgumentParser) → None[source]#: Add arbiter command-line flag arguments.

runtimepy.commands.common.cmd_with_jit(command: Callable[[Namespace], int], args: Namespace, data: dict[str, Any]) → int[source]#: Run an ‘arbiter’ command with custom data inserted.

runtimepy.commands.common.curses_wrap_if(method: Callable[[Namespace], int], args: Namespace) → int[source]#: Run a method in TUI mode if a condition is met.

runtimepy.commands.mtu module#

An entry-point for the ‘mtu’ command.

runtimepy.commands.mtu.add_mtu_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add mtu-command arguments to its parser.

runtimepy.commands.mtu.mtu_cmd(args: Namespace) → int[source]#: Execute the mtu command.

runtimepy.commands.server module#

An entry-point for the ‘server’ command.

runtimepy.commands.server.add_server_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add server-command arguments to its parser.

runtimepy.commands.server.client_data(args: Namespace) → dict[str, Any][source]#: Get client data based on command-line arguments.

runtimepy.commands.server.config_data(args: Namespace) → dict[str, Any][source]#: Get configuration data for the ‘server’ command.

runtimepy.commands.server.get_kwargs(args: Namespace, **kwargs) → dict[str, Any][source]#: Get boilerplate kwargs.

runtimepy.commands.server.is_ssl(kwargs: dict[str, Any]) → bool[source]#: Determine if server arugments indicate SSL use.

runtimepy.commands.server.is_websocket(args: Namespace) → bool[source]#: Determine if the specified factory uses WebSocket or not.

runtimepy.commands.server.port_name(args: Namespace, port: str = 'port') → str[source]#: Get the name for a connection factory’s port.

runtimepy.commands.server.server_cmd(args: Namespace) → int[source]#: Execute the server command.

runtimepy.commands.server.server_data(args: Namespace) → dict[str, Any][source]#: Get server data based on command-line arguments.

runtimepy.commands.task module#

An entry-point for the ‘task’ command.

runtimepy.commands.task.add_task_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add task-command arguments to its parser.

runtimepy.commands.task.config_data(args: Namespace) → dict[str, Any][source]#: Get configuration data for the ‘task’ command.

runtimepy.commands.task.task_cmd(args: Namespace) → int[source]#: Execute the task command.

runtimepy.commands.tftp module#

An entry-point for the ‘tftp’ command.

runtimepy.commands.tftp.add_tftp_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add tftp-command arguments to its parser.

runtimepy.commands.tftp.tftp_cmd(args: Namespace) → int[source]#: Execute the tftp command.

runtimepy.commands.tui module#

An entry-point for the ‘tui’ command.

runtimepy.commands.tui.add_tui_cmd(parser: ArgumentParser) → Callable[[Namespace], int][source]#: Add tui-command arguments to its parser.

runtimepy.commands.tui.curses_wrap_if(method: Callable[[Namespace], int], args: Namespace) → int[source]#: Run a method in TUI mode if a condition is met.

runtimepy.commands.tui.start(args: Namespace) → int[source]#: Start the user interface.

runtimepy.commands.tui.tui_cmd(args: Namespace) → int[source]#: Execute the tui command.

Module contents#