Skip to content

Commit

Permalink
Ensure KernelClient's API is complete
Browse files Browse the repository at this point in the history
  • Loading branch information
davidbrochart committed May 31, 2022
1 parent c817714 commit 5982286
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
10 changes: 6 additions & 4 deletions jupyter_client/channels.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
from threading import Event
from threading import Thread

import zmq.asyncio
import zmq
from zmq.asyncio import Context
from zmq.asyncio import Socket

from .channelsabc import HBChannelABC
from .session import Session
Expand Down Expand Up @@ -49,7 +51,7 @@ class HBChannel(Thread):

def __init__(
self,
context: t.Optional[zmq.asyncio.Context] = None,
context: t.Optional[Context] = None,
session: t.Optional[Session] = None,
address: t.Union[t.Tuple[str, int], str] = "",
):
Expand Down Expand Up @@ -193,7 +195,7 @@ def call_handlers(self, since_last_heartbeat: float) -> None:
class ZMQSocketChannel(object):
"""A ZMQ socket in an async API"""

def __init__(self, socket: zmq.asyncio.Socket, session: Session, loop: t.Any = None) -> None:
def __init__(self, socket: Socket, session: Session, loop: t.Any = None) -> None:
"""Create a channel.
Parameters
Expand All @@ -207,7 +209,7 @@ def __init__(self, socket: zmq.asyncio.Socket, session: Session, loop: t.Any = N
"""
super().__init__()

self.socket: t.Optional[zmq.asyncio.Socket] = socket
self.socket: t.Optional[Socket] = socket
self.session = session

async def _recv(self, **kwargs: t.Any) -> t.Dict[str, t.Any]:
Expand Down
8 changes: 8 additions & 0 deletions jupyter_client/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,14 @@ class KernelClient(ConnectionFileMixin):
:meth:`get_shell_msg` to fetch messages from the shell channel.
"""

get_shell_msg: t.Callable[..., t.Union[t.Coroutine[t.Any, t.Any, t.Dict[str, t.Any]], t.Dict[str, t.Any]]]
get_iopub_msg: t.Callable[..., t.Union[t.Coroutine[t.Any, t.Any, t.Dict[str, t.Any]], t.Dict[str, t.Any]]]
get_stdin_msg: t.Callable[..., t.Union[t.Coroutine[t.Any, t.Any, t.Dict[str, t.Any]], t.Dict[str, t.Any]]]
get_control_msg: t.Callable[..., t.Union[t.Coroutine[t.Any, t.Any, t.Dict[str, t.Any]], t.Dict[str, t.Any]]]
wait_for_ready: t.Callable[["KernelClient", t.Optional[float]], t.Union[t.Coroutine[t.Any, t.Any, None], None]]
is_alive: t.Callable[["KernelClient"], t.Union[t.Coroutine[t.Any, t.Any, bool], bool]]
execute_interactive: t.Callable[..., t.Union[t.Coroutine[t.Any, t.Any, t.Dict[str, t.Any]], t.Dict[str, t.Any]]]

# The PyZMQ Context to use for communication with the kernel.
context = Instance(zmq.asyncio.Context)

Expand Down

0 comments on commit 5982286

Please sign in to comment.