fixup! Split workflows into executable and ert_script

Author: oyvindeide

src/ert/config/__init__.py

@@ -38,7 +38,7 @@
 from .summary_observation import SummaryObservation
 from .surface_config import SurfaceConfig
 from .workflow import Workflow
-from .workflow_job import WorkflowJob
+from .workflow_job import _WorkflowJob
 
 __all__ = [
     "AnalysisConfig",
@@ -83,7 +83,7 @@
     "UpdateSettings",
     "WarningInfo",
     "Workflow",
-    "WorkflowJob",
+    "_WorkflowJob",
     "capture_validation",
     "field_transform",
     "lint_file",

src/ert/config/ert_config.py

@@ -74,7 +74,7 @@
     ErtScriptLoadFailure,
     ErtScriptWorkflow,
     ExecutableWorkflow,
-    WorkflowJob,
+    _WorkflowJob,
     workflow_job_from_file,
 )
 
@@ -561,7 +561,7 @@ class ErtConfig:
     random_seed: int | None = None
     analysis_config: AnalysisConfig = field(default_factory=AnalysisConfig)
     queue_config: QueueConfig = field(default_factory=QueueConfig)
-    workflow_jobs: dict[str, WorkflowJob] = field(default_factory=dict)
+    workflow_jobs: dict[str, _WorkflowJob] = field(default_factory=dict)
     workflows: dict[str, Workflow] = field(default_factory=dict)
     hooked_workflows: defaultdict[HookRuntime, list[Workflow]] = field(
         default_factory=lambda: defaultdict(list)

src/ert/config/workflow.py

@@ -10,30 +10,30 @@
 if TYPE_CHECKING:
     from ert.substitutions import Substitutions
 
-    from .workflow_job import WorkflowJob
+    from .workflow_job import _WorkflowJob
 
 
 @dataclass
 class Workflow:
     src_file: str
-    cmd_list: list[tuple[WorkflowJob, Any]]
+    cmd_list: list[tuple[_WorkflowJob, Any]]
 
     def __len__(self) -> int:
         return len(self.cmd_list)
 
-    def __getitem__(self, index: int) -> tuple[WorkflowJob, Any]:
+    def __getitem__(self, index: int) -> tuple[_WorkflowJob, Any]:
         return self.cmd_list[index]
 
-    def __iter__(self) -> Iterator[tuple[WorkflowJob, Any]]:
+    def __iter__(self) -> Iterator[tuple[_WorkflowJob, Any]]:
         return iter(self.cmd_list)
 
     @classmethod
     def _parse_command_list(
         cls,
         src_file: str,
         context: list[tuple[str, str]],
-        job_dict: dict[str, WorkflowJob],
-    ) -> list[tuple[WorkflowJob, Any]]:
+        job_dict: dict[str, _WorkflowJob],
+    ) -> list[tuple[_WorkflowJob, Any]]:
         schema = init_workflow_schema()
         config_dict = parse(src_file, schema, pre_defines=context)
 
@@ -88,7 +88,7 @@ def from_file(
         cls,
         src_file: str,
         context: Substitutions | None,
-        job_dict: dict[str, WorkflowJob],
+        job_dict: dict[str, _WorkflowJob],
     ) -> Workflow:
         cmd_list = cls._parse_command_list(
             src_file=src_file,

src/ert/config/workflow_job.py

@@ -33,12 +33,12 @@ def workflow_job_parser(file: str) -> ConfigDict:
     return parse(file, schema=schema)
 
 
-def workflow_job_from_file(config_file: str, name: str | None = None) -> WorkflowJob:
+def workflow_job_from_file(config_file: str, name: str | None = None) -> _WorkflowJob:
     if not name:
         name = os.path.basename(config_file)
 
     content_dict = workflow_job_parser(config_file)
-    arg_types_list = WorkflowJob._make_arg_types_list(content_dict)
+    arg_types_list = _WorkflowJob._make_arg_types_list(content_dict)
     min_args = content_dict.get("MIN_ARG")  # type: ignore
     max_args = content_dict.get("MAX_ARG")  # type: ignore
     script = str(content_dict.get("SCRIPT")) if "SCRIPT" in content_dict else None  # type: ignore
@@ -85,7 +85,7 @@ def workflow_job_from_file(config_file: str, name: str | None = None) -> Workflo
 
 
 @dataclass
-class WorkflowJob:
+class _WorkflowJob:
     name: str
     min_args: int | None = None
     max_args: int | None = None
@@ -125,12 +125,12 @@ def is_plugin(self) -> bool:
 
 
 @dataclass
-class ExecutableWorkflow(WorkflowJob):
+class ExecutableWorkflow(_WorkflowJob):
     executable: str | None = None
 
 
 @dataclass
-class ErtScriptWorkflow(WorkflowJob):
+class ErtScriptWorkflow(_WorkflowJob):
     """
     Single workflow configuration object
     """

src/ert/gui/tools/export/exporter.py

@@ -4,7 +4,7 @@
 from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
-    from ert.config import ErtConfig, WorkflowJob
+    from ert.config import ErtConfig, _WorkflowJob
 
 from ert.gui.ertnotifier import ErtNotifier
 from ert.workflow_runner import WorkflowJobRunner
@@ -15,7 +15,7 @@
 class Exporter:
     def __init__(
         self,
-        export_job: WorkflowJob | None,
+        export_job: _WorkflowJob | None,
         notifier: ErtNotifier,
         config: ErtConfig,
     ):

src/ert/gui/tools/plugins/plugin.py

@@ -10,7 +10,7 @@
 if TYPE_CHECKING:
     from PyQt6.QtWidgets import QWidget
 
-    from ert.config import WorkflowJob
+    from ert.config import _WorkflowJob
     from ert.gui.ertnotifier import ErtNotifier
     from ert.storage import Ensemble, LocalStorage
 
@@ -66,5 +66,5 @@ def storage(self) -> LocalStorage:
     def ensemble(self) -> Ensemble | None:
         return self.__notifier.current_ensemble
 
-    def getWorkflowJob(self) -> WorkflowJob:
+    def getWorkflowJob(self) -> _WorkflowJob:
         return self.__workflow_job

src/ert/workflow_runner.py

@@ -5,13 +5,13 @@
 from concurrent.futures import Future
 from typing import Any, Self
 
-from ert.config import ErtScript, ExternalErtScript, Workflow, WorkflowJob
+from ert.config import ErtScript, ExternalErtScript, Workflow, _WorkflowJob
 from ert.config.workflow_fixtures import WorkflowFixtures
 from ert.config.workflow_job import ErtScriptWorkflow
 
 
 class WorkflowJobRunner:
-    def __init__(self, workflow_job: WorkflowJob):
+    def __init__(self, workflow_job: _WorkflowJob):
         self.job = workflow_job
         self.__running = False
         self.__script: ErtScript | None = None

tests/ert/unit_tests/config/test_workflow.py

@@ -4,7 +4,7 @@
 import pytest
 from hypothesis import given, strategies
 
-from ert.config import ConfigValidationError, Workflow, WorkflowJob
+from ert.config import ConfigValidationError, Workflow, _WorkflowJob
 from ert.substitutions import Substitutions
 
 
@@ -35,7 +35,7 @@ def test_that_substitution_happens_in_workflow():
     substlist = Substitutions()
     substlist["<A>"] = "a"
     substlist["<B>"] = "b"
-    job = WorkflowJob(
+    job = _WorkflowJob(
         name="JOB",
         min_args=None,
         max_args=None,
@@ -50,7 +50,7 @@ def test_that_substitution_happens_in_workflow():
 
 
 def get_workflow_job(name):
-    return WorkflowJob(
+    return _WorkflowJob(
         name=name,
         min_args=None,
         max_args=None,
@@ -183,7 +183,7 @@ def test_args_validation(config, expectation, min_args, max_args):
             src_file="workflow",
             context=None,
             job_dict={
-                "WORKFLOW": WorkflowJob(
+                "WORKFLOW": _WorkflowJob(
                     name="WORKFLOW",
                     min_args=min_args,
                     max_args=max_args,