Merge pull request #254 from reportportal/develop

Release

Author: HardNorth

CHANGELOG.md

@@ -1,6 +1,12 @@
 # Changelog
 
 ## [Unreleased]
+### Fixed
+- Issue [#246](https://github.com/reportportal/client-Python/issues/246): Invalid return type, by @HardNorth
+### Changed
+- `helpers.common_helpers.gen_attributes` function now accepts refactored, by @HardNorth
+
+## [5.6.1]
 ### Added
 - `markdown_helpers` module in `reportportal_client.helpers` package, by @HardNorth
 ### Changed

reportportal_client/_internal/aio/tasks.py

@@ -19,6 +19,7 @@
 from asyncio import Future
 from typing import Any, Awaitable, Coroutine, Generator, Generic, List, Optional, TypeVar, Union
 
+from reportportal_client._internal.static.defines import NOT_FOUND
 from reportportal_client.aio.tasks import BlockingOperationError, Task
 
 _T = TypeVar("_T")
@@ -54,8 +55,10 @@ def blocking_result(self) -> _T:
         :return: execution result or raise an error, or return immediately if already executed
         """
         if self.done():
-            return self.result()
-        return self.__loop.run_until_complete(self)
+            result = self.result()
+        else:
+            result = self.__loop.run_until_complete(self)
+        return result if result is not NOT_FOUND else None
 
 
 class ThreadedTask(Generic[_T], Task[_T]):
@@ -88,7 +91,8 @@ def blocking_result(self) -> _T:
         :return: execution result or raise an error, or return immediately if already executed
         """
         if self.done():
-            return self.result()
+            result = self.result()
+            return result if result is not NOT_FOUND else None
         if not self.__loop.is_running() or self.__loop.is_closed():
             raise BlockingOperationError("Running loop is not alive")
         start_time = time.time()
@@ -97,7 +101,8 @@ def blocking_result(self) -> _T:
             time.sleep(sleep_time)
         if not self.done():
             raise BlockingOperationError("Timed out waiting for the task execution")
-        return self.result()
+        result = self.result()
+        return result if result is not NOT_FOUND else None
 
 
 class BatchedTaskFactory:

reportportal_client/aio/client.py

@@ -639,6 +639,8 @@ def launch_uuid(self) -> Optional[str]:
 
         :return: UUID string.
         """
+        if self.__launch_uuid is NOT_FOUND:
+            return None
         return self.__launch_uuid
 
     @property
@@ -750,7 +752,7 @@ async def start_launch(
             name, start_time, description=description, attributes=attributes, rerun=rerun, rerun_of=rerun_of, **kwargs
         )
         self.__launch_uuid = launch_uuid
-        return launch_uuid
+        return self.launch_uuid
 
     async def start_test_item(
         self,
@@ -791,7 +793,7 @@ async def start_test_item(
         :return:               Test Item UUID if successfully started or None.
         """
         item_id = await self.__client.start_test_item(
-            self.launch_uuid,
+            self.__launch_uuid,
             name,
             start_time,
             item_type,
@@ -842,7 +844,7 @@ async def finish_test_item(
         :return:             Response message.
         """
         result = await self.__client.finish_test_item(
-            self.launch_uuid,
+            self.__launch_uuid,
             item_id,
             end_time,
             status=status,
@@ -874,7 +876,7 @@ async def finish_launch(
         """
         if self.use_own_launch:
             result = await self.__client.finish_launch(
-                self.launch_uuid, end_time, status=status, attributes=attributes, **kwargs
+                self.__launch_uuid, end_time, status=status, attributes=attributes, **kwargs
             )
         else:
             result = ""
@@ -915,7 +917,7 @@ async def get_launch_info(self) -> Optional[dict]:
         """
         if not self.launch_uuid:
             return {}
-        return await self.__client.get_launch_info(self.launch_uuid)
+        return await self.__client.get_launch_info(self.__launch_uuid)
 
     async def get_item_id_by_uuid(self, item_uuid: str) -> Optional[str]:
         """Get Test Item ID by the given Item UUID.
@@ -932,7 +934,7 @@ async def get_launch_ui_id(self) -> Optional[int]:
         """
         if not self.launch_uuid:
             return None
-        return await self.__client.get_launch_ui_id(self.launch_uuid)
+        return await self.__client.get_launch_ui_id(self.__launch_uuid)
 
     async def get_launch_ui_url(self) -> Optional[str]:
         """Get full quality URL of the current Launch.
@@ -941,7 +943,7 @@ async def get_launch_ui_url(self) -> Optional[str]:
         """
         if not self.launch_uuid:
             return None
-        return await self.__client.get_launch_ui_url(self.launch_uuid)
+        return await self.__client.get_launch_ui_url(self.__launch_uuid)
 
     async def get_project_settings(self) -> Optional[dict]:
         """Get settings of the current Project.
@@ -974,7 +976,7 @@ async def log(
             logger.warning("Attempt to log to non-existent item")
             return None
         rp_file = RPFile(**attachment) if attachment else None
-        rp_log = AsyncRPRequestLog(self.launch_uuid, time, rp_file, item_id, level, message)
+        rp_log = AsyncRPRequestLog(self.__launch_uuid, time, rp_file, item_id, level, message)
         return await self.__client.log_batch(await self._log_batcher.append_async(rp_log))
 
     def clone(self) -> "AsyncRPClient":
@@ -989,7 +991,7 @@ def clone(self) -> "AsyncRPClient":
             endpoint=self.endpoint,
             project=self.project,
             client=cloned_client,
-            launch_uuid=self.launch_uuid,
+            launch_uuid=self.__launch_uuid,
             log_batch_size=self.log_batch_size,
             log_batch_payload_limit=self.log_batch_payload_limit,
             log_batcher=self._log_batcher,
@@ -1017,7 +1019,7 @@ class _RPClient(RP, metaclass=AbstractBaseClass):
     _item_stack: LifoQueue
     _log_batcher: LogBatcher
     __client: Client
-    __launch_uuid: Optional[Task[str]]
+    __launch_uuid: Optional[Task[Optional[str]]]
     __endpoint: str
     __project: str
     __step_reporter: StepReporter
@@ -1031,7 +1033,7 @@ def client(self) -> Client:
         return self.__client
 
     @property
-    def launch_uuid(self) -> Task[Optional[str]]:
+    def launch_uuid(self) -> Optional[Task[Optional[str]]]:
         """Return current Launch UUID.
 
         :return: UUID string.
@@ -1068,7 +1070,7 @@ def __init__(
         project: str,
         *,
         client: Optional[Client] = None,
-        launch_uuid: Optional[Task[str]] = None,
+        launch_uuid: Optional[Task[Optional[str]]] = None,
         log_batch_size: int = 20,
         log_batch_payload_limit: int = MAX_LOG_BATCH_PAYLOAD_SIZE,
         log_batcher: Optional[LogBatcher] = None,

reportportal_client/client.py

@@ -408,6 +408,8 @@ def launch_uuid(self) -> Optional[str]:
 
         :return: UUID string
         """
+        if self.__launch_uuid is NOT_FOUND:
+            return None
         return self.__launch_uuid
 
     @property
@@ -593,9 +595,9 @@ def start_launch(
             send_event("start_launch", *agent_name_version(attributes))
 
         self.__launch_uuid = response.id
-        logger.debug("start_launch - ID: %s", self.launch_uuid)
+        logger.debug("start_launch - ID: %s", self.__launch_uuid)
         if self.launch_uuid_print and self.print_output:
-            print(f"ReportPortal Launch UUID: {self.launch_uuid}", file=self.print_output.get_output())
+            print(f"ReportPortal Launch UUID: {self.__launch_uuid}", file=self.print_output.get_output())
         return self.launch_uuid
 
     def start_test_item(
@@ -647,7 +649,7 @@ def start_test_item(
             name,
             start_time,
             item_type,
-            self.launch_uuid,
+            self.__launch_uuid,
             attributes=verify_value_length(attributes) if self.truncate_attributes else attributes,
             code_ref=code_ref,
             description=description,
@@ -711,7 +713,7 @@ def finish_test_item(
         url = uri_join(self.base_url_v2, "item", item_id)
         request_payload = ItemFinishRequest(
             end_time,
-            self.launch_uuid,
+            self.__launch_uuid,
             status,
             attributes=verify_value_length(attributes) if self.truncate_attributes else attributes,
             description=description,
@@ -746,10 +748,10 @@ def finish_launch(
         :param attributes:  Launch attributes
         """
         if self.use_own_launch:
-            if self.launch_uuid is NOT_FOUND or not self.launch_uuid:
+            if self.__launch_uuid is NOT_FOUND or not self.__launch_uuid:
                 logger.warning("Attempt to finish non-existent launch")
                 return None
-            url = uri_join(self.base_url_v2, "launch", self.launch_uuid, "finish")
+            url = uri_join(self.base_url_v2, "launch", self.__launch_uuid, "finish")
             request_payload = LaunchFinishRequest(
                 end_time,
                 status=status,
@@ -766,7 +768,7 @@ def finish_launch(
             ).make()
             if not response:
                 return None
-            logger.debug("finish_launch - ID: %s", self.launch_uuid)
+            logger.debug("finish_launch - ID: %s", self.__launch_uuid)
             logger.debug("response message: %s", response.message)
             message = response.message
         else:
@@ -835,7 +837,7 @@ def log(
             logger.warning("Attempt to log to non-existent item")
             return None
         rp_file = RPFile(**attachment) if attachment else None
-        rp_log = RPRequestLog(self.launch_uuid, time, rp_file, item_id, level, message)
+        rp_log = RPRequestLog(self.__launch_uuid, time, rp_file, item_id, level, message)
         return self._log(self._log_batcher.append(rp_log))
 
     def get_item_id_by_uuid(self, item_uuid: str) -> Optional[str]:
@@ -857,8 +859,8 @@ def get_launch_info(self) -> Optional[dict]:
         """
         if self.launch_uuid is None:
             return {}
-        url = uri_join(self.base_url_v1, "launch", "uuid", self.launch_uuid)
-        logger.debug("get_launch_info - ID: %s", self.launch_uuid)
+        url = uri_join(self.base_url_v1, "launch", "uuid", self.__launch_uuid)
+        logger.debug("get_launch_info - ID: %s", self.__launch_uuid)
         response = HttpRequest(
             self.session.get, url=url, verify_ssl=self.verify_ssl, http_timeout=self.http_timeout
         ).make()
@@ -899,7 +901,7 @@ def get_launch_ui_url(self) -> Optional[str]:
             project_name=self.__project.lower(), launch_type=launch_type, launch_id=ui_id
         )
         url = uri_join(self.__endpoint, path)
-        logger.debug("get_launch_ui_url - UUID: %s", self.launch_uuid)
+        logger.debug("get_launch_ui_url - UUID: %s", self.__launch_uuid)
         return url
 
     def get_project_settings(self) -> Optional[dict]:
@@ -949,7 +951,7 @@ def clone(self) -> "RPClient":
             verify_ssl=self.verify_ssl,
             retries=self.retries,
             max_pool_size=self.max_pool_size,
-            launch_uuid=self.launch_uuid,
+            launch_uuid=self.__launch_uuid,
             http_timeout=self.http_timeout,
             log_batch_payload_size=self.log_batch_payload_size,
             mode=self.mode,

reportportal_client/core/rp_requests.py

@@ -173,7 +173,7 @@ async def make(self) -> Optional[AsyncRPResponse]:
         """
         url = await await_if_necessary(self.url)
         if not url:
-            return
+            return None
         data = await await_if_necessary(self.data)
         json = await await_if_necessary(self.json)
         try:

reportportal_client/core/rp_responses.py

@@ -70,7 +70,7 @@ def id(self) -> Optional[str]:
         :return: ID as string or NOT_FOUND, or None if the response is not JSON
         """
         if self.json is None:
-            return
+            return None
         return self.json.get("id", NOT_FOUND)
 
     @property
@@ -102,7 +102,7 @@ def message(self) -> Optional[str]:
         :return: message as string or NOT_FOUND, or None if the response is not JSON
         """
         if self.json is None:
-            return
+            return None
         return self.json.get("message")
 
     @property
@@ -112,7 +112,7 @@ def messages(self) -> Optional[Tuple[str, ...]]:
         :return: a variable size tuple of strings or NOT_FOUND, or None if the response is not JSON
         """
         if self.json is None:
-            return
+            return None
         return tuple(_iter_json_messages(self.json))
 
 
@@ -138,7 +138,7 @@ async def id(self) -> Optional[str]:
         """
         json = await self.json
         if json is None:
-            return
+            return None
         return json.get("id", NOT_FOUND)
 
     @property
@@ -171,7 +171,7 @@ async def message(self) -> Optional[str]:
         """
         json = await self.json
         if json is None:
-            return
+            return None
         return json.get("message", NOT_FOUND)
 
     @property
@@ -182,5 +182,5 @@ async def messages(self) -> Optional[Tuple[str, ...]]:
         """
         json = await self.json
         if json is None:
-            return
+            return None
         return tuple(_iter_json_messages(json))

reportportal_client/helpers/common_helpers.py

@@ -39,6 +39,7 @@
 ATTRIBUTE_LENGTH_LIMIT: int = 128
 TRUNCATE_REPLACEMENT: str = "..."
 BYTES_TO_READ_FOR_DETECTION = 128
+ATTRIBUTE_DELIMITER = ":"
 
 CONTENT_TYPE_TO_EXTENSIONS = MappingProxyType(
     {
@@ -167,20 +168,18 @@ def gen_attributes(rp_attributes: Iterable[str]) -> List[Dict[str, str]]:
     :return:              Correctly created list of dictionaries
                           to be passed to RP
     """
-    attrs = []
-    for rp_attr in rp_attributes:
-        try:
-            key, value = rp_attr.split(":")
-            attr_dict = {"key": key, "value": value}
-        except ValueError as exc:
-            logger.debug(str(exc))
-            attr_dict = {"value": rp_attr}
-
-        if all(attr_dict.values()):
-            attrs.append(attr_dict)
+    attributes = []
+    for attr in rp_attributes:
+        if not attr:
             continue
-        logger.debug(f'Failed to process "{rp_attr}" attribute, attribute value should not be empty.')
-    return attrs
+        value = attr
+        if ATTRIBUTE_DELIMITER in attr:
+            key, value = attr.split(ATTRIBUTE_DELIMITER, 1)
+            attribute = {"key": key, "value": value}
+        else:
+            attribute = {"value": value}
+        attributes.append(attribute)
+    return attributes
 
 
 def get_launch_sys_attrs() -> Dict[str, str]:

setup.py

@@ -4,7 +4,7 @@
 
 from setuptools import find_packages, setup
 
-__version__ = "5.6.1"
+__version__ = "5.6.2"
 
 TYPE_STUBS = ["*.pyi"]
 

tests/helpers/test_helpers.py

@@ -36,7 +36,7 @@ def test_gen_attributes():
     """Test functionality of the gen_attributes function."""
     expected_out = [{"value": "Tag"}, {"key": "Key", "value": "Value"}]
     out = gen_attributes(["Tag", "Key:Value", ""])
-    assert expected_out == out
+    assert out == expected_out
 
 
 @mock.patch("reportportal_client.helpers.common_helpers.system", mock.Mock(return_value="linux"))