jobflow_remote.cli.runner module

jobflow_remote.cli.runner.foreground() → None

Connect to the daemon processes in the foreground.

jobflow_remote.cli.runner.info() → None

Fetch the information about the process of the daemon. Contain the supervisord process and the processes running the Runner.

jobflow_remote.cli.runner.kill() → None

Send a kill signal to the Runner processes. Return immediately, does not wait for processes to be killed.

jobflow_remote.cli.runner.run(log_level: ~jobflow_remote.config.base.Annotated[~jobflow_remote.config.base.LogLevel, <typer.models.OptionInfo object at 0x7f5b8a175750>] = LogLevel.INFO, set_pid: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b8cc587d0>] = False, transfer: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b89bb8650>] = False, complete: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b89bb8890>] = False, queue: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b89bb8910>] = False, checkout: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b89bb8990>] = False, connect_interactive: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b89bb8790>] = False) → None

Execute the Runner in the foreground. Do NOT execute this to start as a daemon. Should be used by the daemon or for testing purposes.

jobflow_remote.cli.runner.shutdown() → None

Shuts down the supervisord process. Note that if the daemon is running it will wait for the daemon to stop.

jobflow_remote.cli.runner.start(transfer: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f5b89bb8c50>] = 1, complete: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f5b89bb8d10>] = 1, single: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b89bb8cd0>] = False, log_level: ~jobflow_remote.config.base.Annotated[~jobflow_remote.config.base.LogLevel, <typer.models.OptionInfo object at 0x7f5b8a175750>] = LogLevel.INFO, connect_interactive: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b89bb8d90>] = False) → None

Start the Runner as a daemon.

jobflow_remote.cli.runner.status() → None

Fetch the status of the daemon runner.

jobflow_remote.cli.runner.stop(wait: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f5b89bb8ed0>] = False) → None

Send a stop signal to the Runner processes. Each of the Runner processes will stop when finished the task being executed. By default, return immediately.