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 0x7f050df62fd0>] = 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 0x7f050df63750>] = False, break_lock: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050df63cd0>] = 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.run(log_level: ~jobflow_remote.config.base.Annotated[~jobflow_remote.config.base.LogLevel, <typer.models.OptionInfo object at 0x7f050df63090>] = LogLevel.INFO, set_pid: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050dfd3a10>] = False, transfer: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050d9a2890>] = False, complete: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050d9eed50>] = False, queue: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050d9ee190>] = False, checkout: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050d9ef290>] = False, connect_interactive: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050d9ef4d0>] = 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 0x7f050d9f0610>] = 1, complete: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f050d9f06d0>] = 1, single: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050d9f2d50>] = False, log_level: ~jobflow_remote.config.base.Annotated[~jobflow_remote.config.base.LogLevel, <typer.models.OptionInfo object at 0x7f050df63090>] = LogLevel.INFO, connect_interactive: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f050d9f2e10>] = 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 0x7f050d9f2fd0>] = 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.