From 95bf5b0264837da22f072b7ec72faa35241e75c1 Mon Sep 17 00:00:00 2001 From: David Lougheed Date: Tue, 12 Mar 2024 14:54:38 -0400 Subject: [PATCH] chore: fix outdated base backend docstrings --- bento_wes/backends/_wes_backend.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/bento_wes/backends/_wes_backend.py b/bento_wes/backends/_wes_backend.py index 9eeb229..33019ac 100644 --- a/bento_wes/backends/_wes_backend.py +++ b/bento_wes/backends/_wes_backend.py @@ -157,9 +157,9 @@ def _params_path(self, run: Run) -> Path: @abstractmethod def _check_workflow(self, run: Run) -> None: """ - Checks that a workflow can be executed by the backend via the workflow's URI. + Checks that a workflow can be executed by the backend via the workflow's URI. A RunExceptionWithFailState is + raised if the workflow is not valid. :param run: The run, including a request with the workflow URI - :return: None if the workflow is valid; a tuple of an error message and an error state otherwise """ pass @@ -191,9 +191,8 @@ def execute_womtool_command(cls, command: tuple[str, ...]) -> subprocess.Popen: def _check_workflow_wdl(self, run: RunWithDetails) -> None: """ - Checks that a particular WDL workflow is valid. + Checks that a particular WDL workflow is valid. A RunExceptionWithFailState is raised if the WDL is not valid. :param run: The run whose workflow is being checked - :return: None if the workflow is valid; a tuple of an error message and an error state otherwise """ # Validate WDL, listing dependencies: @@ -219,9 +218,9 @@ def _check_workflow_wdl(self, run: RunWithDetails) -> None: def _check_workflow_and_type(self, run: RunWithDetails) -> None: """ - Checks a workflow file's validity. + Checks a workflow file's validity. A RunExceptionWithFailState is raised if the workflow file is not valid. + A NotImplementedError is raised if the workflow type is not supported by the backend. :param run: The run specifying the workflow in question - :return: None if the workflow is valid; a tuple of an error message and an error state otherwise """ workflow_type: WorkflowType = WorkflowType(run.request.workflow_type)