@@ -62,6 +62,12 @@ class _ClientOptions(TypedDict, total=False):
6262 launch_uuid_print : bool
6363 print_output : OutputType
6464 truncate_attributes : bool
65+ truncate_fields : bool
66+ replace_binary_chars : bool
67+ launch_name_length_limit : int
68+ item_name_length_limit : int
69+ launch_description_length_limit : int
70+ item_description_length_limit : int
6571 log_batch_size : int
6672 log_batch_payload_limit : int
6773 # Async client specific parameters
@@ -80,42 +86,48 @@ def create_client(
8086) -> Optional [RP ]:
8187 """Create and ReportPortal Client based on the type and arguments provided.
8288
83- :param client_type: Type of the Client to create.
84- :param endpoint: Endpoint of the ReportPortal service.
85- :param project: Project name to report to.
86- :param api_key: Authorization API key.
87- :param oauth_uri: OAuth 2.0 token endpoint URI (for OAuth authentication).
88- :param oauth_username: Username for OAuth 2.0 authentication.
89- :param oauth_password: Password for OAuth 2.0 authentication.
90- :param oauth_client_id: OAuth 2.0 client ID.
91- :param oauth_client_secret: OAuth 2.0 client secret (optional).
92- :param oauth_scope: OAuth 2.0 scope (optional).
93- :param launch_uuid: A launch UUID to use instead of starting own one.
94- :param is_skipped_an_issue: Option to mark skipped tests as not 'To Investigate' items on the server
95- side.
96- :param verify_ssl: Option to skip ssl verification.
97- :param retries: Number of retry attempts to make in case of connection / server
98- errors.
99- :param max_pool_size: Option to set the maximum number of connections to save the pool.
100- :param http_timeout : A float in seconds for connect and read timeout. Use a Tuple to
101- specific connect and read separately.
102- :param mode: Launch mode, all Launches started by the client will be in that mode.
103- :param launch_uuid_print: Print Launch UUID into passed TextIO or by default to stdout.
104- :param print_output: Set output stream for Launch UUID printing.
105- :param truncate_attributes: Truncate test item attributes to default maximum length.
106- :param log_batch_size: Option to set the maximum number of logs that can be processed in one
107- batch.
108- :param log_batch_payload_limit: Maximum size in bytes of logs that can be processed in one batch.
109- :param keepalive_timeout: For Async Clients only. Maximum amount of idle time in seconds before
110- force connection closing.
111- :param task_timeout: For Async Threaded and Batched Clients only. Time limit in seconds for a
112- Task processing.
113- :param shutdown_timeout: For Async Threaded and Batched Clients only. Time limit in seconds for
114- shutting down internal Tasks.
115- :param trigger_num: For Async Batched Client only. Number of tasks which triggers Task batch
116- execution.
117- :param trigger_interval: For Async Batched Client only. Time limit which triggers Task batch
118- execution.
89+ :param client_type: Type of the Client to create.
90+ :param endpoint: Endpoint of the ReportPortal service.
91+ :param project: Project name to report to.
92+ :param api_key: Authorization API key.
93+ :param oauth_uri: OAuth 2.0 token endpoint URI (for OAuth authentication).
94+ :param oauth_username: Username for OAuth 2.0 authentication.
95+ :param oauth_password: Password for OAuth 2.0 authentication.
96+ :param oauth_client_id: OAuth 2.0 client ID.
97+ :param oauth_client_secret: OAuth 2.0 client secret (optional).
98+ :param oauth_scope: OAuth 2.0 scope (optional).
99+ :param launch_uuid: A launch UUID to use instead of starting own one.
100+ :param is_skipped_an_issue: Option to mark skipped tests as not 'To Investigate' items on the server
101+ side.
102+ :param verify_ssl: Option to skip ssl verification.
103+ :param retries: Number of retry attempts to make in case of connection / server
104+ errors.
105+ :param max_pool_size: Option to set the maximum number of connections to save the pool.
106+ :param http_timeout: A float in seconds for connect and read timeout. Use a Tuple to
107+ specific connect and read separately.
108+ :param mode: Launch mode, all Launches started by the client will be in that mode.
109+ :param launch_uuid_print: Print Launch UUID into passed TextIO or by default to stdout.
110+ :param print_output: Set output stream for Launch UUID printing.
111+ :param truncate_attributes: Truncate test item attributes to default maximum length.
112+ :param truncate_fields: Truncate request fields to configured limits.
113+ :param replace_binary_chars: Toggle replacement of basic binary characters with \ufffd char.
114+ :param launch_name_length_limit: Maximum allowed launch name length.
115+ :param item_name_length_limit: Maximum allowed test item name length.
116+ :param launch_description_length_limit: Maximum allowed launch description length.
117+ :param item_description_length_limit: Maximum allowed test item description length.
118+ :param log_batch_size: Option to set the maximum number of logs that can be processed in one
119+ batch.
120+ :param log_batch_payload_limit: Maximum size in bytes of logs that can be processed in one batch.
121+ :param keepalive_timeout: For Async Clients only. Maximum amount of idle time in seconds before
122+ force connection closing.
123+ :param task_timeout: For Async Threaded and Batched Clients only. Time limit in seconds for a
124+ Task processing.
125+ :param shutdown_timeout: For Async Threaded and Batched Clients only. Time limit in seconds for
126+ shutting down internal Tasks.
127+ :param trigger_num: For Async Batched Client only. Number of tasks which triggers Task batch
128+ execution.
129+ :param trigger_interval: For Async Batched Client only. Time limit which triggers Task batch
130+ execution.
119131 :return: ReportPortal Client instance.
120132 """
121133 my_kwargs = kwargs .copy ()
0 commit comments