Merge branch 'develop' into rp-client-async

CHANGELOG.md

@@ -1,7 +1,10 @@
 # Changelog
 
 ## [Unreleased]
+
+## [5.4.1]
 ### Changed
+- Unified ReportPortal product naming, by @HardNorth
 - `RPClient` internal item stack implementation changed to `LifoQueue` to maintain concurrency better, by @HardNorth
 ### Removed
 - Unused `delayed_assert` dependency, by @HardNorth

reportportal_client/__init__.py

@@ -1,18 +1,17 @@
-"""
-Copyright (c) 2022 https://reportportal.io .
+#  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
 
-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.
-"""
+"""This package is the base package for ReportPortal client."""
 
 # noinspection PyProtectedMember
 from reportportal_client._local import current

reportportal_client/_local/__init__.py

@@ -1,5 +1,3 @@
-"""ReportPortal client context storing and retrieving module."""
-
 #  Copyright (c) 2022 EPAM Systems
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""ReportPortal client context storing and retrieving module."""
+
 from threading import local
 
 __INSTANCES = local()

reportportal_client/aio/client.py

@@ -1,5 +1,3 @@
-"""This module contains asynchronous implementation of ReportPortal Client."""
-
 #  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.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module contains asynchronous implementation of ReportPortal Client."""
+
 import asyncio
 import logging
 import ssl

reportportal_client/client.py

@@ -1,5 +1,3 @@
-"""This module contains ReportPortal Client interface and synchronous implementation class."""
-
 #  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.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module contains ReportPortal Client interface and synchronous implementation class."""
+
 import logging
 import queue
 import sys

reportportal_client/core/rp_file.py

@@ -1,5 +1,3 @@
-"""This module contains classes representing RP file object."""
-
 #  Copyright (c) 2022 EPAM Systems
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module contains classes representing RP file object."""
+
 import uuid
 
 

reportportal_client/core/rp_issues.py

@@ -1,3 +1,16 @@
+#  Copyright (c) 2022 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
+
 """This module includes classes representing RP issues.
 
 Issues are reported within the test item result PUT call. One issue can be
@@ -26,20 +39,6 @@
 }
 """
 
-#  Copyright (c) 2022 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
-
-
 class Issue:
     """This class represents an issue that can be attached to test result."""
 

reportportal_client/core/rp_requests.py

@@ -1,10 +1,3 @@
-"""This module includes classes representing RP API requests.
-
-Detailed information about requests wrapped up in that module
-can be found by the following link:
-https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/reporting.md
-"""
-
 #  Copyright (c) 2022 EPAM Systems
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -18,6 +11,13 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module includes classes representing RP API requests.
+
+Detailed information about requests wrapped up in that module
+can be found by the following link:
+https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/reporting.md
+"""
+
 import asyncio
 import json as json_converter
 import logging

reportportal_client/core/rp_responses.py

@@ -1,10 +1,3 @@
-"""This module contains models for the RP response objects.
-
-Detailed information about responses wrapped up in that module
-can be found by the following link:
-https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/reporting.md
-"""
-
 #  Copyright (c) 2022 EPAM Systems
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -18,6 +11,13 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module contains models for the RP response objects.
+
+Detailed information about responses wrapped up in that module
+can be found by the following link:
+https://github.com/reportportal/documentation/blob/master/src/md/src/DevGuides/reporting.md
+"""
+
 import logging
 from json import JSONDecodeError
 from typing import Any, Optional, Generator, Mapping, Tuple

reportportal_client/core/worker.py

@@ -1,5 +1,3 @@
-"""This module contains worker that makes non-blocking HTTP requests."""
-
 #  Copyright (c) 2022 EPAM Systems
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module contains worker that makes non-blocking HTTP requests."""
+
 import logging
 import queue
 import threading

reportportal_client/helpers.py

@@ -1,16 +1,18 @@
-"""This module contains common functions-helpers of the client and agents.
-
-Copyright (c) 2022 https://reportportal.io .
-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.
-"""
+#  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
+
+"""This module contains common functions-helpers of the client and agents."""
+
 import asyncio
 import inspect
 import json

reportportal_client/logs/__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
+
 """ReportPortal logging handling module."""
 
 import logging
@@ -101,12 +102,11 @@ def __init__(self, level=logging.NOTSET, filter_client_logs=False,
 
         :param level:                level of logging
         :param filter_client_logs:   if True throw away logs emitted by a
-        ReportPortal client
-        :param endpoint:             ReportPortal endpoint URL, used to filter
-        out urllib3 logs, mutes ReportPortal HTTP logs if set, optional
-        parameter
-        :param ignored_record_names: a tuple of record names which will be
-        filtered out by the handler (with startswith method)
+                                     ReportPortal client
+        :param endpoint:             ReportPortal endpoint URL, used to filter out urllib3 logs, mutes
+                                     ReportPortal HTTP logs if set, optional parameter
+        :param ignored_record_names: a tuple of record names which will be filtered out by the handler
+                                     (with startswith method)
         """
         super(RPLogHandler, self).__init__(level)
         self.filter_client_logs = filter_client_logs

reportportal_client/logs/batcher.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
+
 import logging
 import threading
 from typing import List, Optional, TypeVar, Generic

reportportal_client/logs/log_manager.py

@@ -1,5 +1,3 @@
-"""This module contains management functionality for processing logs."""
-
 #  Copyright (c) 2022 EPAM Systems
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module contains management functionality for processing logs."""
+
 import logging
 import queue
 from threading import Lock

reportportal_client/services/__init__.py

@@ -1,5 +1,3 @@
-"""This package contains different service interfaces."""
-
 #  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.
@@ -12,3 +10,5 @@
 #  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
+
+"""This package contains different service interfaces."""

reportportal_client/services/client_id.py

@@ -1,5 +1,3 @@
-"""This module generates and store unique client ID of an instance."""
-
 #  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.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module generates and store unique client ID of an instance."""
+
 import configparser
 import io
 import logging

reportportal_client/services/constants.py

@@ -1,5 +1,3 @@
-"""This module contains constants for the external services."""
-
 #  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.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module contains constants for the external services."""
+
 import base64
 import os
 

reportportal_client/services/statistics.py

@@ -1,5 +1,3 @@
-"""This module sends statistics events to a statistics service."""
-
 #  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.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module sends statistics events to a statistics service."""
+
 import ssl
 import certifi
 import logging

reportportal_client/static/__init__.py

@@ -1,5 +1,3 @@
-"""This package provides common static objects and variables."""
-
 #  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.
@@ -12,3 +10,5 @@
 #  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
+
+"""This package provides common static objects and variables."""

reportportal_client/static/abstract.py

@@ -1,5 +1,3 @@
-"""This module provides base abstract class for RP request objects."""
-
 #  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.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module provides base abstract class for RP request objects."""
+
 from abc import ABCMeta as _ABCMeta, abstractmethod
 
 __all__ = ["AbstractBaseClass", "abstractmethod"]

reportportal_client/static/defines.py

@@ -1,5 +1,3 @@
-"""This module provides RP client static objects and variables."""
-
 #  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.
@@ -13,6 +11,8 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module provides RP client static objects and variables."""
+
 import aenum as enum
 
 

reportportal_client/static/errors.py

@@ -1,5 +1,3 @@
-"""This module includes exceptions used by the client."""
-
 #  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.
@@ -13,6 +11,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License
 
+"""This module includes exceptions used by the client."""
 
 class RPExceptionBase(Exception):
     """General exception for the package."""