Add reportportal_client.helpers.markdown_helpers and helpers refactoring

Author: HardNorth

CHANGELOG.md

@@ -1,8 +1,11 @@
 # Changelog
 
 ## [Unreleased]
+### Added
+- `markdown_helpers` module in `reportportal_client.helpers` package, by @HardNorth
 ### Changed
 - `helpers.is_binary` function to improve binary content detection, by @HardNorth
+- `helpers` module moved to `reportportal_client.helpers` package, by @HardNorth
 
 ## [5.6.0]
 ### Added

reportportal_client/aio/client.py

@@ -227,14 +227,14 @@ async def __get_item_url(self, item_id_future: Union[Optional[str], Task[Optiona
         item_id = await await_if_necessary(item_id_future)
         if item_id is NOT_FOUND or item_id is None:
             logger.warning("Attempt to make request for non-existent id.")
-            return
+            return None
         return root_uri_join(self.base_url_v2, "item", item_id)
 
     async def __get_launch_url(self, launch_uuid_future: Union[Optional[str], Task[Optional[str]]]) -> Optional[str]:
         launch_uuid = await await_if_necessary(launch_uuid_future)
         if launch_uuid is NOT_FOUND or launch_uuid is None:
             logger.warning("Attempt to make request for non-existent launch.")
-            return
+            return None
         return root_uri_join(self.base_url_v2, "launch", launch_uuid, "finish")
 
     async def start_launch(
@@ -272,7 +272,7 @@ async def start_launch(
 
         response = await AsyncHttpRequest((await self.session()).post, url=url, json=request_payload).make()
         if not response:
-            return
+            return None
 
         if not self._skip_analytics:
             stat_coro = async_send_event("start_launch", *agent_name_version(attributes))
@@ -347,7 +347,7 @@ async def start_test_item(
 
         response = await AsyncHttpRequest((await self.session()).post, url=url, json=request_payload).make()
         if not response:
-            return
+            return None
         item_id = await response.id
         if item_id is NOT_FOUND or item_id is None:
             logger.warning("start_test_item - invalid response: %s", str(await response.json))
@@ -402,7 +402,7 @@ async def finish_test_item(
         ).payload
         response = await AsyncHttpRequest((await self.session()).put, url=url, json=request_payload).make()
         if not response:
-            return
+            return None
         message = await response.message
         logger.debug("finish_test_item - ID: %s", await await_if_necessary(item_id))
         logger.debug("response message: %s", message)
@@ -437,7 +437,7 @@ async def finish_launch(
             (await self.session()).put, url=url, json=request_payload, name="Finish Launch"
         ).make()
         if not response:
-            return
+            return None
         message = await response.message
         logger.debug("finish_launch - ID: %s", await await_if_necessary(launch_uuid))
         logger.debug("response message: %s", message)
@@ -465,15 +465,15 @@ async def update_test_item(
         url = root_uri_join(self.base_url_v1, "item", item_id, "update")
         response = await AsyncHttpRequest((await self.session()).put, url=url, json=data).make()
         if not response:
-            return
+            return None
         logger.debug("update_test_item - Item: %s", item_id)
         return await response.message
 
     async def __get_launch_uuid_url(self, launch_uuid_future: Union[str, Task[str]]) -> Optional[str]:
         launch_uuid = await await_if_necessary(launch_uuid_future)
         if launch_uuid is NOT_FOUND or launch_uuid is None:
             logger.warning("Attempt to make request for non-existent Launch UUID.")
-            return
+            return None
         logger.debug("get_launch_info - ID: %s", launch_uuid)
         return root_uri_join(self.base_url_v1, "launch", "uuid", launch_uuid)
 
@@ -486,7 +486,7 @@ async def get_launch_info(self, launch_uuid_future: Union[str, Task[str]]) -> Op
         url = self.__get_launch_uuid_url(launch_uuid_future)
         response = await AsyncHttpRequest((await self.session()).get, url=url).make()
         if not response:
-            return
+            return None
         launch_info = None
         if response.is_success:
             launch_info = await response.json
@@ -499,7 +499,7 @@ async def __get_item_uuid_url(self, item_uuid_future: Union[Optional[str], Task[
         item_uuid = await await_if_necessary(item_uuid_future)
         if item_uuid is NOT_FOUND or item_uuid is None:
             logger.warning("Attempt to make request for non-existent UUID.")
-            return
+            return None
         return root_uri_join(self.base_url_v1, "item", "uuid", item_uuid)
 
     async def get_item_id_by_uuid(self, item_uuid_future: Union[str, Task[str]]) -> Optional[str]:
@@ -531,7 +531,7 @@ async def get_launch_ui_url(self, launch_uuid_future: Union[str, Task[str]]) ->
         launch_info = await self.get_launch_info(launch_uuid)
         launch_id = launch_info.get("id") if launch_info else None
         if not launch_id:
-            return
+            return None
         mode = launch_info.get("mode") if launch_info else None
         if not mode:
             mode = self.mode
@@ -564,7 +564,7 @@ async def log_batch(self, log_batch: Optional[List[AsyncRPRequestLog]]) -> Optio
                 (await self.session()).post, url=url, data=AsyncRPLogBatch(log_batch).payload
             ).make()
             if not response:
-                return
+                return None
             return await response.messages
 
     def clone(self) -> "Client":
@@ -931,7 +931,7 @@ async def get_launch_ui_id(self) -> Optional[int]:
         :return: Launch ID of the Launch. None if not found.
         """
         if not self.launch_uuid:
-            return
+            return None
         return await self.__client.get_launch_ui_id(self.launch_uuid)
 
     async def get_launch_ui_url(self) -> Optional[str]:
@@ -940,7 +940,7 @@ async def get_launch_ui_url(self) -> Optional[str]:
         :return: Launch URL string.
         """
         if not self.launch_uuid:
-            return
+            return None
         return await self.__client.get_launch_ui_url(self.launch_uuid)
 
     async def get_project_settings(self) -> Optional[dict]:
@@ -972,7 +972,7 @@ async def log(
         """
         if item_id is NOT_FOUND:
             logger.warning("Attempt to log to non-existent item")
-            return
+            return None
         rp_file = RPFile(**attachment) if attachment else None
         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))
@@ -1555,7 +1555,7 @@ def create_task(self, coro: Coroutine[Any, Any, _T]) -> Optional[Task[_T]]:
         :return:     Task instance.
         """
         if not getattr(self, "_loop", None):
-            return
+            return None
         result = self._loop.create_task(coro)
         with self._task_mutex:
             self._task_list.append(result)
@@ -1742,7 +1742,7 @@ def create_task(self, coro: Coroutine[Any, Any, _T]) -> Optional[Task[_T]]:
         :return:     Task instance.
         """
         if not getattr(self, "_loop", None):
-            return
+            return None
         result = self._loop.create_task(coro)
         with self._task_mutex:
             tasks = self._task_list.append(result)

reportportal_client/helpers/__init__.py

@@ -0,0 +1,65 @@
+"""This package contains helper functions."""
+
+from reportportal_client.helpers import markdown_helpers
+from reportportal_client.helpers.common_helpers import (
+    ATTRIBUTE_LENGTH_LIMIT,
+    TRUNCATE_REPLACEMENT,
+    CONTENT_TYPE_TO_EXTENSIONS,
+    TYPICAL_MULTIPART_FOOTER_LENGTH,
+    LifoQueue,
+    agent_name_version,
+    await_if_necessary,
+    calculate_file_part_size,
+    calculate_json_part_size,
+    caseless_equal,
+    dict_to_payload,
+    gen_attributes,
+    generate_uuid,
+    get_function_params,
+    get_launch_sys_attrs,
+    get_package_parameters,
+    get_package_version,
+    guess_content_type_from_bytes,
+    is_binary,
+    match_pattern,
+    normalize_caseless,
+    root_uri_join,
+    timestamp,
+    to_bool,
+    translate_glob_to_regex,
+    truncate_attribute_string,
+    uri_join,
+    verify_value_length,
+)
+
+__all__ = [
+    "markdown_helpers",
+    "ATTRIBUTE_LENGTH_LIMIT",
+    "TRUNCATE_REPLACEMENT",
+    "CONTENT_TYPE_TO_EXTENSIONS",
+    "TYPICAL_MULTIPART_FOOTER_LENGTH",
+    "LifoQueue",
+    "agent_name_version",
+    "await_if_necessary",
+    "calculate_file_part_size",
+    "calculate_json_part_size",
+    "caseless_equal",
+    "dict_to_payload",
+    "gen_attributes",
+    "generate_uuid",
+    "get_function_params",
+    "get_launch_sys_attrs",
+    "get_package_parameters",
+    "get_package_version",
+    "guess_content_type_from_bytes",
+    "is_binary",
+    "match_pattern",
+    "normalize_caseless",
+    "root_uri_join",
+    "timestamp",
+    "to_bool",
+    "translate_glob_to_regex",
+    "truncate_attribute_string",
+    "uri_join",
+    "verify_value_length",
+]

reportportal_client/helpers.py renamed to reportportal_client/helpers/common_helpers.py

@@ -253,7 +253,7 @@ def verify_value_length(attributes: Optional[Union[List[dict], dict]]) -> Option
     :return:           List of attributes with corrected value length
     """
     if attributes is None:
-        return
+        return attributes
 
     my_attributes = attributes
     if isinstance(my_attributes, dict):