Required
stdout| Type: | dict | None |
| Description: | The stdout. |
class StdOutErr(builtins.object):
def __init__(
self, stdout: dict | None, stderr: dict | None, timings: dict | None
) -> None: ...| Type: | dict | None |
| Description: | The stdout. |
| Type: | dict | None |
| Description: | The stderr. |
| Type: | dict | None |
| Description: | The timings for the given task chain. |
def get_diagnosis_string(self) -> str: ...class TaskChainController(builtins.object):
def __init__(
self,
task_chain_tasks: dict[str, list],
sites: dict[str, TaskChainSiteConfig],
task_chain_runner_context: typing.Callable | None = None,
): ...| Type: | dict[str, list] |
| Description: | A dictionary mapping an arbitrary job key (name) to a list of tasks, e.g. tasks that happen within one task chain. |
| Type: | dict[str, TaskChainSiteConfig] |
| Description: | A dictionary of identifier + site config for sites to run the tasks on. The identifier does not have to be the site name. |
| Type: | typing.Callable | None |
| Default value: | None |
| Description: | A optional function returning a context manager that will be used in each TaskChainRunner prior to running the actual task chains. |
def check_status_of_task_chain_runners(
self, raise_on_error: bool = True
) -> None: ...| Type: | bool |
| Default value: | True |
| Description: | If True, an exception will be raised if one of the child local task chain runner fail (not the individual task chains). If False, a warning will be logged. |
def delete_remote_files(self, verbosity: int = 1) -> None: ...| Type: | int |
| Default value: | 1 |
| Description: | The verbosity. |
def get_site_and_remote_path_for_task_chain(
self, identifier: str
) -> tuple[BaseExecutor, _RemotePathType]: ...| Type: | str |
| Description: | Identifier of the task chain to get. |
def get_status_for_all_task_chains(self) -> dict[str, JobStatus | None]: ...def get_stdouterr_for_task_chain(self, identifier: str) -> StdOutErr: ...| Type: | str |
| Description: | Identifier of the task chain to get. |
def launch(self) -> None: ...def run(self, assert_no_failed_runners: bool = True) -> None: ...| Type: | bool |
| Default value: | True |
| Description: | If True, an exception will be raised if one of the child local task chain runner fails (not the individual task chains). If False, a warning will be logged. This is useful for error resilient workflows but will require error handling elsewhere. |
def update_status(self) -> dict[str, JobStatus]: ...def wait(self) -> None: ...