Merge pull request #253 from reportportal/develop

Release

Author: HardNorth

.flake8

@@ -1,4 +1,4 @@
 [flake8]
-ignore = E203, W503, E701
+ignore = E203, W503, E701, E704
 exclude = .git,venv,env
 max-line-length = 119

.github/workflows/release.yml

@@ -50,30 +50,30 @@ jobs:
         with:
           python-version: '3.10'
 
-#      - name: Install dependencies
-#        run: python -m pip install --upgrade pip setuptools wheel
+      - name: Install dependencies
+        run: python -m pip install --upgrade pip setuptools wheel
 
-#      - name: Build package
-#        run: python setup.py sdist bdist_wheel
-#
-#      - name: Publish package
-#        uses: pypa/gh-action-pypi-publish@release/v1
-#        with:
-#          user: ${{ secrets.PYPI_USERNAME }}
-#          password: ${{ secrets.PYPI_PASSWORD }}
+      - name: Build package
+        run: python setup.py sdist bdist_wheel
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: ${{ secrets.PYPI_USERNAME }}
+          password: ${{ secrets.PYPI_PASSWORD }}
 
       - name: Setup git credentials
         uses: oleksiyrudenko/gha-git-credentials@v2-latest
         with:
           name: 'reportportal.io'
           email: '[email protected]'
           token: ${{ secrets.GITHUB_TOKEN }}
-#
-#      - name: Tagging new version
-#        id: newVersionTag
-#        run: |
-#          git tag -a ${{ env.RELEASE_VERSION }} -m "Release ${{ env.RELEASE_VERSION }}"
-#          git push --tags
+
+      - name: Tagging new version
+        id: newVersionTag
+        run: |
+          git tag -a ${{ env.RELEASE_VERSION }} -m "Release ${{ env.RELEASE_VERSION }}"
+          git push --tags
 
       - name: Checkout develop branch
         uses: actions/checkout@v4
@@ -108,13 +108,13 @@ jobs:
           version: ${{ env.RELEASE_VERSION }}
           path: ./${{ env.CHANGE_LOG_FILE }}
 
-#      - name: Create Release
-#        id: createRelease
-#        uses: ncipollo/release-action@v1
-#        with:
-#          tag: ${{ env.RELEASE_VERSION }}
-#          name: Release ${{ env.RELEASE_VERSION }}
-#          body: ${{ steps.readChangelogEntry.outputs.changes }}
+      - name: Create Release
+        id: createRelease
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ env.RELEASE_VERSION }}
+          name: Release ${{ env.RELEASE_VERSION }}
+          body: ${{ steps.readChangelogEntry.outputs.changes }}
 
       - name: Update version file
         id: versionFileUpdate

.pre-commit-config.yaml

@@ -1,31 +1,31 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
-    -   id: trailing-whitespace
-    -   id: end-of-file-fixer
-    -   id: check-yaml
-    -   id: check-added-large-files
--   repo: https://github.com/PyCQA/pydocstyle
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/PyCQA/pydocstyle
     rev: 6.3.0
     hooks:
-    -   id: pydocstyle
+      - id: pydocstyle
         exclude: |
-            (?x)^(
-                tests/.*
-            )
--   repo: https://github.com/psf/black
+          (?x)^(
+              tests/.*
+          )
+  - repo: https://github.com/psf/black
     rev: 24.10.0
     hooks:
-    -   id: black
-        args: ['reportportal_client', 'tests']
--   repo: https://github.com/pycqa/isort
+      - id: black
+        args: [ '--check', 'reportportal_client', 'tests' ]
+  - repo: https://github.com/pycqa/isort
     rev: 5.13.2
     hooks:
       - id: isort
--   repo: https://github.com/pycqa/flake8
+  - repo: https://github.com/pycqa/flake8
     rev: 7.1.1
     hooks:
-    -   id: flake8
+      - id: flake8

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## [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
 - `match_pattern` and `translate_glob_to_regex`, `normalize_caseless`, `caseless_equal` functions in `helpers` module, by @HardNorth
 - `client.RP.start_test_item` method and all its children now accept `uuid` argument, by @HardNorth
 ### Removed

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/client.py

@@ -587,7 +587,7 @@ def start_launch(
             http_timeout=self.http_timeout,
         ).make()
         if not response:
-            return
+            return None
 
         if not self._skip_analytics:
             send_event("start_launch", *agent_name_version(attributes))
@@ -638,7 +638,7 @@ def start_test_item(
         """
         if parent_item_id is NOT_FOUND:
             logger.warning("Attempt to start item for non-existent parent item.")
-            return
+            return None
         if parent_item_id:
             url = uri_join(self.base_url_v2, "item", parent_item_id)
         else:
@@ -667,7 +667,7 @@ def start_test_item(
             http_timeout=self.http_timeout,
         ).make()
         if not response:
-            return
+            return None
         item_id = response.id
         if item_id is not NOT_FOUND:
             logger.debug("start_test_item - ID: %s", item_id)
@@ -707,7 +707,7 @@ def finish_test_item(
         """
         if item_id is NOT_FOUND or not item_id:
             logger.warning("Attempt to finish non-existent item")
-            return
+            return None
         url = uri_join(self.base_url_v2, "item", item_id)
         request_payload = ItemFinishRequest(
             end_time,
@@ -725,7 +725,7 @@ def finish_test_item(
             self.session.put, url=url, json=request_payload, verify_ssl=self.verify_ssl, http_timeout=self.http_timeout
         ).make()
         if not response:
-            return
+            return None
         self._remove_current_item()
         logger.debug("finish_test_item - ID: %s", item_id)
         logger.debug("response message: %s", response.message)
@@ -748,7 +748,7 @@ def finish_launch(
         if self.use_own_launch:
             if self.launch_uuid is NOT_FOUND or not self.launch_uuid:
                 logger.warning("Attempt to finish non-existent launch")
-                return
+                return None
             url = uri_join(self.base_url_v2, "launch", self.launch_uuid, "finish")
             request_payload = LaunchFinishRequest(
                 end_time,
@@ -765,7 +765,7 @@ def finish_launch(
                 http_timeout=self.http_timeout,
             ).make()
             if not response:
-                return
+                return None
             logger.debug("finish_launch - ID: %s", self.launch_uuid)
             logger.debug("response message: %s", response.message)
             message = response.message
@@ -794,7 +794,7 @@ def update_test_item(
             self.session.put, url=url, json=data, verify_ssl=self.verify_ssl, http_timeout=self.http_timeout
         ).make()
         if not response:
-            return
+            return None
         logger.debug("update_test_item - Item: %s", item_id)
         return response.message
 
@@ -833,7 +833,7 @@ 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 = RPRequestLog(self.launch_uuid, time, rp_file, item_id, level, message)
         return self._log(self._log_batcher.append(rp_log))
@@ -863,7 +863,7 @@ def get_launch_info(self) -> Optional[dict]:
             self.session.get, url=url, verify_ssl=self.verify_ssl, http_timeout=self.http_timeout
         ).make()
         if not response:
-            return
+            return None
         launch_info = None
         if response.is_success:
             launch_info = response.json
@@ -888,7 +888,7 @@ def get_launch_ui_url(self) -> Optional[str]:
         launch_info = self.get_launch_info()
         ui_id = launch_info.get("id") if launch_info else None
         if not ui_id:
-            return
+            return None
         mode = launch_info.get("mode") if launch_info else None
         if not mode:
             mode = self.mode
@@ -925,7 +925,7 @@ def _remove_current_item(self) -> Optional[str]:
         try:
             return self._item_stack.get()
         except queue.Empty:
-            return
+            return None
 
     def current_item(self) -> Optional[str]:
         """Retrieve the last item reported by the client (based on the internal FILO queue).