Add Executors to the library (#12)

* Add executors to the library

* Update dependencies

Author: shashankrnr32

docs/package/concurrent/executor/.pages

@@ -1,2 +1,4 @@
 nav:
     - pycommons.base.concurrent.executor: executor.md
+
+title: executor

poetry.lock

@@ -1,3 +1,4 @@
 from .direct import DirectExecutor
+from .executors import Executors
 
-__all__ = ["DirectExecutor"]
+__all__ = ["DirectExecutor", "Executors"]

pycommons/base/concurrent/executor/__init__.py

@@ -0,0 +1,55 @@
+from concurrent.futures import ThreadPoolExecutor
+from typing import Any
+
+from .direct import DirectExecutor
+from ...utils import UtilityClass
+
+
+class Executors(UtilityClass):
+    """
+    The Executors Utility class that contains methods to create different executors.
+    """
+
+    @classmethod
+    def get_direct_executor(cls) -> DirectExecutor:
+        """
+        Get the singleton instance of "DirectExecutor" that runs the callable
+        in the same thread as the caller.
+
+        Returns:
+            The singleton instance of `DirectExecutor`
+        """
+        return DirectExecutor.get_instance()
+
+    @classmethod
+    def new_single_thread_executor(cls, *args: Any, **kwargs: Any) -> ThreadPoolExecutor:
+        """
+        A special threadpool executor where the max number of worker
+        threads is 1. If multiple tasks are submitted to this executor, they are queued
+        until the thread becomes idle.
+
+        Args:
+            *args: Arguments for threadpool executor
+            **kwargs: Keyword Arguments for threadpool executor
+
+        Returns:
+            a new instance of `ThreadPoolExecutor` with number of threads set to 1
+        """
+        return cls.new_fixed_thread_pool_executor(1, *args, **kwargs)
+
+    @classmethod
+    def new_fixed_thread_pool_executor(
+        cls, n_threads: int, *args: Any, **kwargs: Any
+    ) -> ThreadPoolExecutor:
+        """
+        A fixed threadpool with number of threads set. Can be used within a context
+
+        Args:
+            n_threads: Number of worker threads
+            *args: Arguments for threadpool executor
+            **kwargs: Keyword Arguments for threadpool executor
+
+        Returns:
+            A new instance of threadpool executor
+        """
+        return ThreadPoolExecutor(n_threads, *args, **kwargs)

pycommons/base/concurrent/executor/executors.py

@@ -9,18 +9,14 @@ def test_direct_executor_executes_runnable_on_the_same_thread(self):
         def runnable():
             return threading.current_thread()
 
-        executor = DirectExecutor.get_instance()
-
-        future = executor.submit(runnable)
-
-        self.assertEqual(threading.current_thread(), future.result())
+        with DirectExecutor.get_instance() as executor:
+            future = executor.submit(runnable)
+            self.assertEqual(threading.current_thread(), future.result())
 
     def test_direct_executor_executes_runnable_and_throws_exception_on_the_same_thread(self):
         def runnable():
-            raise Exception(threading.current_thread())
-
-        executor = DirectExecutor.get_instance()
-
-        future = executor.submit(runnable)
+            raise RuntimeError(threading.current_thread())
 
-        self.assertEqual(threading.current_thread(), future.exception().args[0])
+        with DirectExecutor.get_instance() as executor:
+            future = executor.submit(runnable)
+            self.assertEqual(threading.current_thread(), future.exception().args[0])

tests/pycommons/base/concurrent/__init__.py

@@ -0,0 +1,33 @@
+import threading
+from typing import List
+from unittest import TestCase
+
+from pycommons.base.concurrent.executor import Executors
+
+
+class TestExecutors(TestCase):
+    def test_single_thread_executor(self):
+        def runnable(*args):
+            assert args[0] is ...
+            return threading.current_thread()
+
+        with Executors.new_single_thread_executor() as executor:
+            threads: List[threading.Thread] = list(executor.map(runnable, (..., ...)))
+            self.assertEqual(threads[0].ident, threads[1].ident)
+
+    def test_direct_executor_executes_runnable_on_the_same_thread(self):
+        def runnable():
+            return threading.current_thread()
+
+        with Executors.get_direct_executor() as executor:
+            future = executor.submit(runnable)
+            self.assertEqual(threading.current_thread(), future.result())
+
+    def test_fixed_threadpool_executor(self):
+        def runnable(*args):
+            assert args[0] is ...
+            return threading.current_thread()
+
+        with Executors.new_fixed_thread_pool_executor(1) as executor:
+            threads: List[threading.Thread] = list(executor.map(runnable, (..., ...)))
+            self.assertEqual(threads[0].ident, threads[1].ident)