jobflow_remote.cli.runner module#

jobflow_remote.cli.runner.foreground() None[source]#

Connect to the daemon processes in the foreground.

jobflow_remote.cli.runner.info(verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fc04d796f90>] = 0) None[source]#

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[source]#

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

jobflow_remote.cli.runner.reset(force: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d797710>] = False, break_lock: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc04d797c90>] = False) None[source]#

Reset the value of the machine executing the runner from the database. Should be executed only if it is certain that the runner is not active on that machine anymore.

jobflow_remote.cli.runner.restart() None[source]#

Restart the runner. Send a stop signal, wait for the runner to stop and restart it. The options to start the runner (e.g. –single) remain the same.

jobflow_remote.cli.runner.run(log_level: ~jobflow_remote.config.base.Annotated[~jobflow_remote.config.base.LogLevel, <typer.models.OptionInfo object at 0x7fc04d797050>] = LogLevel.INFO, set_pid: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047a56d10>] = False, transfer: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047aa6b10>] = False, complete: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047aa7490>] = False, queue: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047aa7550>] = False, checkout: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047aa7fd0>] = False, connect_interactive: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047aa7f90>] = False) None[source]#

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[source]#

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 0x7fc047a4c590>] = 1, complete: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7fc047a4f950>] = 1, single: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047a4f910>] = False, log_level: ~jobflow_remote.config.base.Annotated[~jobflow_remote.config.base.LogLevel, <typer.models.OptionInfo object at 0x7fc04d797050>] = LogLevel.INFO, connect_interactive: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7fc047a4f890>] = False) None[source]#

Start the Runner as a daemon.

jobflow_remote.cli.runner.status() None[source]#

Fetch the status of the daemon runner.

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

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.