Add EmptyTask class

Author: HardNorth

reportportal_client/aio/__init__.py

@@ -22,10 +22,11 @@
     BatchedRPClient,
     ThreadedRPClient,
 )
-from reportportal_client.aio.tasks import BlockingOperationError, Task
+from reportportal_client.aio.tasks import BlockingOperationError, EmptyTask, Task
 
 __all__ = [
     "Task",
+    "EmptyTask",
     "BlockingOperationError",
     "DEFAULT_TASK_TIMEOUT",
     "DEFAULT_SHUTDOWN_TIMEOUT",

reportportal_client/aio/client.py

@@ -56,6 +56,7 @@
 # noinspection PyProtectedMember
 from reportportal_client._internal.static.abstract import AbstractBaseClass, abstractmethod
 from reportportal_client._internal.static.defines import DEFAULT_LOG_LEVEL
+from reportportal_client.aio import EmptyTask
 
 # noinspection PyProtectedMember
 from reportportal_client.aio.tasks import Task
@@ -1311,7 +1312,7 @@ def __init__(
         set_current(self)
 
     @abstractmethod
-    def create_task(self, coro: Coroutine[Any, Any, _T]) -> Optional[Task[_T]]:
+    def create_task(self, coro: Coroutine[Any, Any, _T]) -> Task[_T]:
         """Create a Task from given Coroutine.
 
         :param coro: Coroutine which will be used for the Task creation.
@@ -1572,7 +1573,7 @@ def get_launch_ui_url(self) -> Task[Optional[str]]:
         result_task = self.create_task(result_coro)
         return result_task
 
-    def get_project_settings(self) -> Task[Optional[str]]:
+    def get_project_settings(self) -> Task[Optional[dict]]:
         """Get settings of the current Project.
 
         :return: Settings response in Dictionary.
@@ -1685,8 +1686,9 @@ def __init_loop(self, loop: Optional[asyncio.AbstractEventLoop] = None):
             self._loop = asyncio.new_event_loop()
             self._loop.set_task_factory(ThreadedTaskFactory(self.task_timeout))
             self.__heartbeat()
-            self._thread = threading.Thread(target=self._loop.run_forever, name="RP-Async-Client", daemon=True)
-            self._thread.start()
+            thread = threading.Thread(target=self._loop.run_forever, name="RP-Async-Client", daemon=True)
+            thread.start()
+            self._thread = thread
 
     async def __return_value(self, value):
         return value
@@ -1758,14 +1760,14 @@ def __init__(
         else:
             super().__init__(endpoint, project, launch_uuid=launch_uuid, **kwargs)
 
-    def create_task(self, coro: Coroutine[Any, Any, _T]) -> Optional[Task[_T]]:
+    def create_task(self, coro: Coroutine[Any, Any, _T]) -> Task[_T]:
         """Create a Task from given Coroutine.
 
         :param coro: Coroutine which will be used for the Task creation.
         :return:     Task instance.
         """
         if not getattr(self, "_loop", None):
-            return None
+            return EmptyTask()
         result = self._loop.create_task(coro)
         with self._task_mutex:
             self._task_list.append(result)
@@ -1951,14 +1953,14 @@ def __init__(
         else:
             super().__init__(endpoint, project, launch_uuid=launch_uuid, **kwargs)
 
-    def create_task(self, coro: Coroutine[Any, Any, _T]) -> Optional[Task[_T]]:
+    def create_task(self, coro: Coroutine[Any, Any, _T]) -> Task[_T]:
         """Create a Task from given Coroutine.
 
         :param coro: Coroutine which will be used for the Task creation.
         :return:     Task instance.
         """
         if not getattr(self, "_loop", None):
-            return None
+            return EmptyTask()
         result = self._loop.create_task(coro)
         with self._task_mutex:
             tasks = self._task_list.append(result)

reportportal_client/aio/tasks.py

@@ -55,7 +55,7 @@ def __init__(
         self,
         coro: _TaskCompatibleCoro,
         *,
-        loop: asyncio.AbstractEventLoop,
+        loop: Optional[asyncio.AbstractEventLoop],
         name: Optional[str] = None,
     ) -> None:
         """Initialize an instance of the Task.
@@ -92,3 +92,26 @@ def __str__(self):
         if self.done():
             return str(self.result())
         return super().__str__()
+
+
+class EmptyTask(Task[None]):
+    """Task implementation which always returns None."""
+
+    @staticmethod
+    async def __empty_coro() -> None:
+        return None
+
+    def __init__(self) -> None:
+        """Initialize an EmptyTask.
+
+        The class provides a no-op coroutine because ``asyncio.Task`` requires a non-None coroutine object.
+        """
+        super().__init__(self.__empty_coro(), loop=None)
+
+    def blocking_result(self) -> None:
+        """Return None without blocking."""
+        return None
+
+    def result(self) -> None:
+        """Return None regardless of the task state."""
+        return None

reportportal_client/helpers/common_helpers.py

@@ -23,8 +23,9 @@
 from datetime import datetime, timezone
 from platform import machine, processor, system
 from types import MappingProxyType
-from typing import Any, Callable, Generic, Iterable, Optional, Sized, TypeVar, Union
+from typing import Any, Callable, Coroutine, Generic, Iterable, Optional, Sized, TypeVar, Union
 
+from reportportal_client.aio import Task
 from reportportal_client.core.rp_file import RPFile
 
 try:
@@ -401,7 +402,7 @@ def agent_name_version(attributes: Optional[Union[list, dict]] = None) -> tuple[
     return agent_name, agent_version
 
 
-async def await_if_necessary(obj: Optional[Any]) -> Optional[Any]:
+async def await_if_necessary(obj: Union[_T, Task[_T], Coroutine[_T, None, None]]) -> Optional[_T]:
     """Await Coroutine, Feature or coroutine Function if given argument is one of them, or return immediately.
 
     :param obj: value, Coroutine, Feature or coroutine Function