Merge remote-tracking branch 'origin/main' into docstring

Author: jan-janssen

executorlib/__init__.py

@@ -1,3 +1,4 @@
+from executorlib.executor.base import BaseExecutor
 from executorlib.executor.flux import (
     FluxClusterExecutor,
     FluxJobExecutor,
@@ -13,6 +14,7 @@
 
 __all__: list[str] = [
     "get_cache_data",
+    "BaseExecutor",
     "FluxJobExecutor",
     "FluxClusterExecutor",
     "SingleNodeExecutor",

executorlib/executor/base.py

@@ -1,4 +1,5 @@
 import queue
+from abc import ABC
 from concurrent.futures import (
     Executor as FutureExecutor,
 )
@@ -10,7 +11,7 @@
 from executorlib.task_scheduler.base import TaskSchedulerBase
 
 
-class ExecutorBase(FutureExecutor):
+class BaseExecutor(FutureExecutor, ABC):
     """
     Interface class for the executor.
 

executorlib/executor/flux.py

@@ -1,6 +1,6 @@
 from typing import Callable, Optional, Union
 
-from executorlib.executor.base import ExecutorBase
+from executorlib.executor.base import BaseExecutor
 from executorlib.standalone.inputcheck import (
     check_command_line_argument_lst,
     check_init_function,
@@ -17,7 +17,7 @@
 from executorlib.task_scheduler.interactive.onetoone import OneProcessTaskScheduler
 
 
-class FluxJobExecutor(ExecutorBase):
+class FluxJobExecutor(BaseExecutor):
     """
     The executorlib.FluxJobExecutor leverages either the message passing interface (MPI), the SLURM workload manager or
     preferable the flux framework for distributing python functions within a given resource allocation. In contrast to
@@ -201,7 +201,7 @@ def __init__(
             )
 
 
-class FluxClusterExecutor(ExecutorBase):
+class FluxClusterExecutor(BaseExecutor):
     """
     The executorlib.FluxClusterExecutor leverages either the message passing interface (MPI), the SLURM workload manager
     or preferable the flux framework for distributing python functions within a given resource allocation. In contrast

executorlib/executor/single.py

@@ -1,6 +1,6 @@
 from typing import Callable, Optional, Union
 
-from executorlib.executor.base import ExecutorBase
+from executorlib.executor.base import BaseExecutor
 from executorlib.standalone.inputcheck import (
     check_command_line_argument_lst,
     check_gpus_per_worker,
@@ -17,7 +17,7 @@
 from executorlib.task_scheduler.interactive.onetoone import OneProcessTaskScheduler
 
 
-class SingleNodeExecutor(ExecutorBase):
+class SingleNodeExecutor(BaseExecutor):
     """
     The executorlib.SingleNodeExecutor leverages either the message passing interface (MPI), the SLURM workload manager
     or preferable the flux framework for distributing python functions within a given resource allocation. In contrast

executorlib/executor/slurm.py

@@ -1,6 +1,6 @@
 from typing import Callable, Optional, Union
 
-from executorlib.executor.base import ExecutorBase
+from executorlib.executor.base import BaseExecutor
 from executorlib.standalone.inputcheck import (
     check_init_function,
     check_plot_dependency_graph,
@@ -18,7 +18,7 @@
 )
 
 
-class SlurmClusterExecutor(ExecutorBase):
+class SlurmClusterExecutor(BaseExecutor):
     """
     The executorlib.SlurmClusterExecutor leverages either the message passing interface (MPI), the SLURM workload
     manager or preferable the flux framework for distributing python functions within a given resource allocation. In
@@ -193,7 +193,7 @@ def __init__(
             )
 
 
-class SlurmJobExecutor(ExecutorBase):
+class SlurmJobExecutor(BaseExecutor):
     """
     The executorlib.SlurmJobExecutor leverages either the message passing interface (MPI), the SLURM workload manager or
     preferable the flux framework for distributing python functions within a given resource allocation. In contrast to