@@ -27,14 +27,48 @@ The following internal methods had signature changes:
27
27
Besides the signature and attribute changes described above, the following internal methods were made ` async ` for ` AsyncKernelManager ` :
28
28
29
29
- ` async def pre_start_kernel(self, **kwargs) -> Tuple[List[str], Dict[str, Any]]: `
30
- - ` async def post_start_kernel(self, **kwargs) `
30
+ - ` async def post_start_kernel(self, **kwargs): `
31
31
- ` async def request_shutdown(self, restart: bool = False): `
32
32
- ` async def cleanup_resources(self, restart: bool = False): `
33
33
34
+ #### ` AsyncKernelClient `
35
+
36
+ We dropped the ` block: bool = True ` keyword argument for the following methods:
37
+
38
+ - ` async def get_shell_msg(self, timeout: Optional[float] = None) -> Dict[str, Any]: `
39
+ - ` async def get_iopub_msg(self, timeout: Optional[float] = None) -> Dict[str, Any]: `
40
+ - ` async def get_stdin_msg(self, timeout: Optional[float] = None) -> Dict[str, Any]: `
41
+ - ` async def get_control_msg(self, timeout: Optional[float] = None) -> Dict[str, Any]: `
42
+
43
+ Calling these methods with ` block=False ` previously translates to calling them with ` timeout=0 ` now.
44
+ Calling these methods with ` block=True ` previously translates to calling them with a non-zero ` timeout ` value now.
45
+
46
+ #### ` BlockingKernelClient `
47
+
48
+ We dropped the ` block: bool = True ` keyword argument for the following methods:
49
+
50
+ - ` def get_shell_msg(self, timeout: Optional[float] = None) -> Dict[str, Any]: `
51
+ - ` def get_iopub_msg(self, timeout: Optional[float] = None) -> Dict[str, Any]: `
52
+ - ` def get_stdin_msg(self, timeout: Optional[float] = None) -> Dict[str, Any]: `
53
+ - ` def get_control_msg(self, timeout: Optional[float] = None) -> Dict[str, Any]: `
54
+
55
+ Calling these methods with ` block=False ` previously translates to calling them with ` timeout=0 ` now.
56
+ Calling these methods with ` block=True ` previously translates to calling them with a non-zero ` timeout ` value now.
57
+
58
+ #### ` BlockingKernelClient `
59
+
34
60
#### ` ZMQSocketChannel `
35
61
36
- - ` async def get_msg(self, timeout: t.Optional[float] = None) -> t.Dict[str, t.Any]: ` :
37
- We dropped the ` block: bool = True ` keyword argument. Calling this method with ` block=False ` previously translates to calling it with ` timeout=0 ` now.
62
+ We dropped the ` block: bool = True ` keyword argument for the following method:
63
+
64
+ - ` async def get_msg(self, timeout: Optional[float] = None) -> Dict[str, Any]: ` :
65
+
66
+ Calling this method with ` block=False ` previously translates to calling it with ` timeout=0 ` now.
67
+ Calling this method with ` block=True ` previously translates to calling it with a non-zero ` timeout ` value now.
68
+
69
+ ``` {admonition} Note
70
+ Prefer calling e.g. `client.get_shell_msg()` over `client.shell_channel.get_msg()`.
71
+ ```
38
72
39
73
### Deprecations removed
40
74
0 commit comments