Skip to content

Commit ad0ce8f

Browse files
committed
Pydocs add
1 parent 2579665 commit ad0ce8f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

reportportal_client/_local/__init__.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,26 @@
1010
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1111
# See the License for the specific language governing permissions and
1212
# limitations under the License
13+
"""Report Portal client context storing and retrieving module"""
1314
from threading import local
1415

1516

1617
__INSTANCES = local()
1718

1819

1920
def current():
21+
"""Return current Report Portal client which is used by the current thread.
22+
"""
2023
if hasattr(__INSTANCES, 'current'):
2124
return __INSTANCES.current
2225

2326

2427
def set_current(client):
28+
"""Save Report Portal client as current.
29+
30+
The method is not intended to use used by users. Report Portal client calls
31+
it itself when new client is created.
32+
33+
:param client: Report Portal client
34+
"""
2535
__INSTANCES.current = client

0 commit comments

Comments
 (0)