Skip to content

Commit e43d01c

Browse files
committed
Some pydoc add
1 parent 9011872 commit e43d01c

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

reportportal_client/client.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
"""This module contains Report Portal Client class.
22
3-
Copyright (c) 2018 http://reportportal.io .
3+
Copyright (c) 2022 https://reportportal.io .
44
55
Licensed under the Apache License, Version 2.0 (the "License");
66
you may not use this file except in compliance with the License.
77
You may obtain a copy of the License at
88
9-
http://www.apache.org/licenses/LICENSE-2.0
9+
https://www.apache.org/licenses/LICENSE-2.0
1010
1111
Unless required by applicable law or agreed to in writing, software
1212
distributed under the License is distributed on an "AS IS" BASIS,
@@ -47,7 +47,15 @@ def _set_current(client):
4747

4848

4949
class RPClient(object):
50-
"""Report portal client."""
50+
"""Report portal client.
51+
52+
The class is supposed to use by Report Portal agents: both custom and
53+
official to make calls to Report Portal. It handles HTTP request and
54+
response bodies generation and serialization, connection retries and log
55+
batching.
56+
NOTICE: the class is not thread-safe, use new class instance for every new
57+
thread to avoid request/response messing and other issues.
58+
"""
5159

5260
def __init__(self,
5361
endpoint,

0 commit comments

Comments
 (0)