Add typing on kwargs argument in create_client function

Author: HardNorth

reportportal_client/__init__.py

@@ -12,7 +12,15 @@
 #  limitations under the License
 
 """This package is the base package for ReportPortal client."""
-import typing
+
+import sys
+from typing import Optional, Tuple, TypedDict, Union
+
+# noinspection PyUnreachableCode
+if sys.version_info >= (3, 11):
+    from typing import Unpack
+else:
+    from typing_extensions import Unpack
 
 import aenum
 
@@ -33,73 +41,93 @@ class ClientType(aenum.Enum):
     ASYNC_BATCHED = aenum.auto()
 
 
+class _ClientOptions(TypedDict, total=False):
+    client_type: ClientType
+    endpoint: str
+    project: str
+    api_key: Optional[str]
+    # OAuth 2.0 parameters
+    oauth_oauth_uri: Optional[str]
+    oauth_username: Optional[str]
+    oauth_password: Optional[str]
+    oauth_client_id: Optional[str]
+    oauth_client_secret: Optional[str]
+    oauth_scope: Optional[str]
+    # Common client parameters
+    launch_uuid: Optional[str]
+    is_skipped_an_issue: bool
+    verify_ssl: Union[bool, str]
+    retries: int
+    max_pool_size: int
+    http_timeout: Union[float, Tuple[float, float]]
+    mode: str
+    launch_uuid_print: bool
+    print_output: OutputType
+    truncate_attributes: bool
+    log_batch_size: int
+    log_batch_payload_limit: int
+    # Async client specific parameters
+    keepalive_timeout: float
+    # Async threaded/batched client specific parameters
+    task_timeout: float
+    shutdown_timeout: float
+    # Async batched client specific parameters
+    trigger_num: int
+    trigger_interval: float
+
+
 # noinspection PyIncorrectDocstring
 def create_client(
-    client_type: ClientType, endpoint: str, project: str, *, api_key: str = None, **kwargs: typing.Any
-) -> typing.Optional[RP]:
+    client_type: ClientType, endpoint: str, project: str, **kwargs: Unpack[_ClientOptions]
+) -> Optional[RP]:
     """Create and ReportPortal Client based on the type and arguments provided.
 
     :param client_type:             Type of the Client to create.
-    :type client_type:              ClientType
     :param endpoint:                Endpoint of the ReportPortal service.
-    :type endpoint:                 str
     :param project:                 Project name to report to.
-    :type project:                  str
     :param api_key:                 Authorization API key.
-    :type api_key:                  str
+    :param oauth_oauth_uri:         OAuth 2.0 token endpoint URI (for OAuth authentication).
+    :param oauth_username:          Username for OAuth 2.0 authentication.
+    :param oauth_password:          Password for OAuth 2.0 authentication.
+    :param oauth_client_id:         OAuth 2.0 client ID.
+    :param oauth_client_secret:     OAuth 2.0 client secret (optional).
+    :param oauth_scope:             OAuth 2.0 scope (optional).
     :param launch_uuid:             A launch UUID to use instead of starting own one.
-    :type launch_uuid:              str
     :param is_skipped_an_issue:     Option to mark skipped tests as not 'To Investigate' items on the server
                                     side.
-    :type is_skipped_an_issue:      bool
     :param verify_ssl:              Option to skip ssl verification.
-    :type verify_ssl:               typing.Union[bool, str]
     :param retries:                 Number of retry attempts to make in case of connection / server
                                     errors.
-    :type retries:                  int
     :param max_pool_size:           Option to set the maximum number of connections to save the pool.
-    :type max_pool_size:            int
     :param http_timeout :           A float in seconds for connect and read timeout. Use a Tuple to
                                     specific connect and read separately.
-    :type http_timeout:             Tuple[float, float]
     :param mode:                    Launch mode, all Launches started by the client will be in that mode.
-    :type mode:                     str
     :param launch_uuid_print:       Print Launch UUID into passed TextIO or by default to stdout.
-    :type launch_uuid_print:        bool
     :param print_output:            Set output stream for Launch UUID printing.
-    :type print_output:             OutputType
     :param truncate_attributes:     Truncate test item attributes to default maximum length.
-    :type truncate_attributes:      bool
     :param log_batch_size:          Option to set the maximum number of logs that can be processed in one
                                     batch.
-    :type log_batch_size:           int
     :param log_batch_payload_limit: Maximum size in bytes of logs that can be processed in one batch.
-    :type log_batch_payload_limit:  int
     :param keepalive_timeout:       For Async Clients only. Maximum amount of idle time in seconds before
                                     force connection closing.
-    :type keepalive_timeout:        int
     :param task_timeout:            For Async Threaded and Batched Clients only. Time limit in seconds for a
                                     Task processing.
-    :type task_timeout:             float
     :param shutdown_timeout:        For Async Threaded and Batched Clients only. Time limit in seconds for
                                     shutting down internal Tasks.
-    :type shutdown_timeout:         float
     :param trigger_num:             For Async Batched Client only. Number of tasks which triggers Task batch
                                     execution.
-    :type trigger_num:              int
     :param trigger_interval:        For Async Batched Client only. Time limit which triggers Task batch
                                     execution.
-    :type trigger_interval:         float
     :return: ReportPortal Client instance.
     """
     if client_type is ClientType.SYNC:
-        return RPClient(endpoint, project, api_key=api_key, **kwargs)
+        return RPClient(endpoint, project, **kwargs)
     if client_type is ClientType.ASYNC:
-        return AsyncRPClient(endpoint, project, api_key=api_key, **kwargs)
+        return AsyncRPClient(endpoint, project, **kwargs)
     if client_type is ClientType.ASYNC_THREAD:
-        return ThreadedRPClient(endpoint, project, api_key=api_key, **kwargs)
+        return ThreadedRPClient(endpoint, project, **kwargs)
     if client_type is ClientType.ASYNC_BATCHED:
-        return BatchedRPClient(endpoint, project, api_key=api_key, **kwargs)
+        return BatchedRPClient(endpoint, project, **kwargs)
     raise ValueError(f"Unknown ReportPortal Client type requested: {client_type}")
 
 

requirements.txt

@@ -1,4 +1,5 @@
 aenum
+typing-extensions>=4.13.2
 requests>=2.32.3
 aiohttp>=3.10.11
 certifi>=2024.8.30

tests/test_client_factory.py

@@ -27,5 +27,5 @@
     ],
 )
 def test_client_factory_types(requested_type: ClientType, expected_type):
-    result = create_client(requested_type, "http://endpoint", "default_personal")
+    result = create_client(requested_type, "http://endpoint", "default_personal", api_key="test_api_key")
     assert isinstance(result, expected_type)