Merge pull request #157 from pyiron/cleanUp

Move ExecutorBase to shared modules

Author: jan-janssen

pympipool/interfaces/fluxbroker.py

@@ -8,7 +8,7 @@
     get_future_done,
     execute_task_dict,
 )
-from pympipool.interfaces.base import ExecutorBase
+from pympipool.shared.base import ExecutorBase
 from pympipool.shared.thread import RaisingThread
 from pympipool.shared.taskexecutor import (
     cloudpickle_register,
@@ -34,23 +34,23 @@ class SingleTaskExecutor(ExecutorBase):
 
     Simple example:
         ```
-        import numpy as np
-        from pympipool import Executor
-
-        def calc(i, j, k):
-            from mpi4py import MPI
-            size = MPI.COMM_WORLD.Get_size()
-            rank = MPI.COMM_WORLD.Get_rank()
-            return np.array([i, j, k]), size, rank
-
-        def init_k():
-            return {"k": 3}
-
-        with Executor(cores=2, init_function=init_k) as p:
-            fs = p.submit(calc, 2, j=4)
-            print(fs.result())
-
-        >>> [(array([2, 4, 3]), 2, 0), (array([2, 4, 3]), 2, 1)]
+        >>> import numpy as np
+        >>> from pympipool import Executor
+        >>>
+        >>> def calc(i, j, k):
+        >>>     from mpi4py import MPI
+        >>>     size = MPI.COMM_WORLD.Get_size()
+        >>>     rank = MPI.COMM_WORLD.Get_rank()
+        >>>     return np.array([i, j, k]), size, rank
+        >>>
+        >>> def init_k():
+        >>>     return {"k": 3}
+        >>>
+        >>> with Executor(cores=2, init_function=init_k) as p:
+        >>>     fs = p.submit(calc, 2, j=4)
+        >>>     print(fs.result())
+
+        [(array([2, 4, 3]), 2, 0), (array([2, 4, 3]), 2, 1)]
         ```
     """
 

pympipool/interfaces/taskbroker.py

@@ -1,4 +1,4 @@
-from pympipool.interfaces.base import ExecutorBase
+from pympipool.shared.base import ExecutorBase
 from pympipool.shared.thread import RaisingThread
 from pympipool.shared.broker import executor_broker
 

pympipool/interfaces/taskexecutor.py

@@ -1,4 +1,4 @@
-from pympipool.interfaces.base import ExecutorBase
+from pympipool.shared.base import ExecutorBase
 from pympipool.shared.thread import RaisingThread
 from pympipool.shared.taskexecutor import (
     execute_parallel_tasks,

pympipool/legacy/interfaces/executor.py

@@ -1,4 +1,4 @@
-from pympipool.interfaces.base import ExecutorBase
+from pympipool.shared.base import ExecutorBase
 from pympipool.shared.thread import RaisingThread
 from pympipool.legacy.shared.interface import execute_serial_tasks
 from pympipool.shared.taskexecutor import cloudpickle_register