Skip to content

Commit 333a010

Browse files
willingcminrk
authored andcommitted
Adds docstring
1 parent e195cb7 commit 333a010

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

jupyter_client/blocking/client.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,19 @@
1616
from jupyter_client.client import KernelClient
1717
from .channels import ZMQSocketChannel
1818

19+
1920
class BlockingKernelClient(KernelClient):
21+
"""A BlockingKernelClient """
22+
2023
def wait_for_ready(self, timeout=None):
24+
"""Waits for a response when a client is blocked
25+
26+
- Sets future time for timeout
27+
- Blocks on shell channel until a message is received
28+
- Exit if the kernel has died
29+
- If client times out before receiving a message from the kernel, send RuntimeError
30+
- Flush the IOPub channel
31+
"""
2132
if timeout is None:
2233
abs_timeout = float('inf')
2334
else:

0 commit comments

Comments
 (0)