Async RPClient: WIP

reportportal_client/__init__.py

@@ -14,10 +14,11 @@
 limitations under the License.
 """
 
-from ._local import current
-from .logs import RPLogger, RPLogHandler
-from .client import RPClient
-from .steps import step
+# noinspection PyProtectedMember
+from reportportal_client._local import current
+from reportportal_client.logs import RPLogger, RPLogHandler
+from reportportal_client.client import RPClient
+from reportportal_client.steps import step
 
 __all__ = [
     'current',

reportportal_client/async/__init__.py

@@ -0,0 +1,12 @@
+#  Copyright (c) 2023 EPAM Systems
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License

reportportal_client/client_async.py → reportportal_client/async/client.py

@@ -21,10 +21,10 @@
 
 import aiohttp
 
-from .core.rp_issues import Issue
-from .logs.log_manager import LogManager, MAX_LOG_BATCH_PAYLOAD_SIZE
-from .static.defines import NOT_FOUND
-from .steps import StepReporter
+from reportportal_client.core.rp_issues import Issue
+from reportportal_client.logs.log_manager import LogManager, MAX_LOG_BATCH_PAYLOAD_SIZE
+from reportportal_client.static.defines import NOT_FOUND
+from reportportal_client.steps import StepReporter
 
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
@@ -37,7 +37,7 @@ def last(self):
                 return self.queue[-1]
 
 
-class _RPClient:
+class _RPClientAsync:
     _log_manager: LogManager = ...
     api_v1: str = ...
     api_v2: str = ...
@@ -129,7 +129,7 @@ async def start_launch(self,
                            attributes: Optional[Union[List, Dict]] = None,
                            rerun: bool = False,
                            rerun_of: Optional[str] = None,
-                           **kwargs) -> Optional[Union[asyncio.Future, str]]:
+                           **kwargs) -> Optional[str]:
         pass
 
     async def start_test_item(self,
@@ -145,7 +145,7 @@ async def start_test_item(self,
                               code_ref: Optional[str] = None,
                               retry: bool = False,
                               test_case_id: Optional[str] = None,
-                              **_: Any) -> Optional[Union[asyncio.Future, str]]:
+                              **_: Any) -> Optional[str]:
         parent = parent_item_id
         if parent_item_id and asyncio.isfuture(parent_item_id):
             parent = await parent_item_id
@@ -167,13 +167,13 @@ def current_item(self) -> Union[asyncio.Future, str]:
         """Retrieve the last item reported by the client."""
         return self._item_stack.last()
 
-    def clone(self) -> '_RPClient':
+    def clone(self) -> '_RPClientAsync':
         """Clone the client object, set current Item ID as cloned item ID.
 
         :returns: Cloned client object
-        :rtype: _RPClient
+        :rtype: _RPClientAsync
         """
-        cloned = _RPClient(
+        cloned = _RPClientAsync(
             endpoint=self.endpoint,
             project=self.project,
             api_key=self.api_key,
@@ -193,7 +193,7 @@ def clone(self) -> '_RPClient':
         return cloned
 
 
-class RPClientAsync(_RPClient):
+class RPClientAsync(_RPClientAsync):
 
     async def start_test_item(self,
                               name: str,
@@ -208,7 +208,7 @@ async def start_test_item(self,
                               code_ref: Optional[str] = None,
                               retry: bool = False,
                               test_case_id: Optional[str] = None,
-                              **kwargs: Any) -> Optional[Union[asyncio.Future, str]]:
+                              **kwargs: Any) -> Optional[str]:
         item_id = await super().start_test_item(name, start_time, item_type, description=description,
                                                 attributes=attributes, parameters=parameters,
                                                 parent_item_id=parent_item_id, has_stats=has_stats,
@@ -235,7 +235,7 @@ async def finish_test_item(self,
         return result
 
 
-class RPClientSync(_RPClient):
+class RPClientSync(_RPClientAsync):
     loop: asyncio.AbstractEventLoop
     thread: threading.Thread
 
@@ -280,7 +280,7 @@ def start_test_item(self,
                         code_ref: Optional[str] = None,
                         retry: bool = False,
                         test_case_id: Optional[str] = None,
-                        **kwargs: Any) -> Optional[Union[asyncio.Future, str]]:
+                        **kwargs: Any) -> Optional[asyncio.Future]:
         item_id_coro = super().start_test_item(name, start_time, item_type, description=description,
                                                attributes=attributes, parameters=parameters,
                                                parent_item_id=parent_item_id, has_stats=has_stats,

reportportal_client/steps/__init__.py

@@ -10,6 +10,7 @@
 #  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #  See the License for the specific language governing permissions and
 #  limitations under the License
+
 """Report portal Nested Step handling module.
 
 The module for handling and reporting Report Portal Nested Steps inside python