add client 7 support

Author: blink1073

.github/workflows/python-package.yml

@@ -37,9 +37,11 @@ jobs:
     - name: Test with pytest
       run: |
         pytest --cov jupyter_console || pytest jupyter_console --lf
-    - name: Check Manifest
+    - name: Linting
       run: |
         check-manifest
+        pip install mypy
+        mypy .
 
   check_release:
     runs-on: ubuntu-latest

docs/conf.py

@@ -17,6 +17,7 @@
 import os
 import shlex
 import shutil
+from typing import Dict
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -74,7 +75,7 @@
 # built documents.
 #
 
-version_ns = {}
+version_ns: Dict = {}
 version_py = os.path.join('..', 'jupyter_console', '_version.py')
 with open(version_py) as f:
     exec(compile(f.read(), version_py, 'exec'), version_ns)
@@ -229,7 +230,7 @@
 
 # -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
+#latex_elements = {
 # The paper size ('letterpaper' or 'a4paper').
 #'papersize': 'letterpaper',
 
@@ -241,7 +242,7 @@
 
 # Latex figure (float) alignment
 #'figure_align': 'htbp',
-}
+#}
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,

jupyter_console/app.py

@@ -63,7 +63,7 @@
 #-----------------------------------------------------------------------------
 
 
-class ZMQTerminalIPythonApp(JupyterApp, JupyterConsoleApp):
+class ZMQTerminalIPythonApp(JupyterApp, JupyterConsoleApp):  # type:ignore[misc]
     name = "jupyter-console"
     version = __version__
     """Start a terminal frontend to the IPython zmq kernel."""
@@ -85,9 +85,9 @@ class ZMQTerminalIPythonApp(JupyterApp, JupyterConsoleApp):
     """
     examples = _examples
 
-    classes = [ZMQTerminalInteractiveShell] + JupyterConsoleApp.classes
-    flags = Dict(flags)
-    aliases = Dict(aliases)
+    classes = [ZMQTerminalInteractiveShell] + JupyterConsoleApp.classes  # type:ignore[operator]
+    flags = Dict(flags)  # type:ignore[assignment]
+    aliases = Dict(aliases)  # type:ignore[assignment]
     frontend_aliases = Any(frontend_aliases)
     frontend_flags = Any(frontend_flags)
 

jupyter_console/ptshell.py

@@ -13,6 +13,7 @@
 import sys
 from tempfile import TemporaryDirectory
 import time
+import typing as t
 from warnings import warn
 
 from typing import Dict as DictType, Any as AnyType
@@ -30,6 +31,7 @@
     Instance,
     Any,
 )
+import inspect
 from traitlets.config import SingletonConfigurable
 
 from .completer import ZMQCompleter
@@ -76,6 +78,30 @@
 from pygments.util import ClassNotFound
 from pygments.token import Token
 
+from jupyter_core.utils import run_sync as _run_sync
+
+
+T = t.TypeVar("T")
+
+
+def run_sync(coro: t.Callable[..., t.Union[T, t.Awaitable[T]]]) -> t.Callable[..., T]:
+    """Wraps coroutine in a function that blocks until it has executed.
+
+    Parameters
+    ----------
+    coro : coroutine-function
+        The coroutine-function to be executed.
+
+    Returns
+    -------
+    result :
+        Whatever the coroutine-function returns.
+    """
+    if not inspect.iscoroutinefunction(coro):
+        return t.cast(t.Callable[..., T], coro)
+    return _run_sync(coro)
+
+
 
 def ask_yes_no(prompt, default=None, interrupt=None):
     """Asks a question and returns a boolean (y/n) answer.
@@ -314,7 +340,7 @@ class ZMQTerminalInteractiveShell(SingletonConfigurable):
         ),
         default_value="multicolumn",
     ).tag(config=True)
-    
+
     prompt_includes_vi_mode = Bool(True,
         help="Display the current vi mode (when using vi editing mode)."
     ).tag(config=True)
@@ -372,7 +398,7 @@ def vi_mode(self):
                 and self.prompt_includes_vi_mode):
             return '['+str(self.pt_cli.app.vi_state.input_mode)[3:6]+'] '
         return ''
-    
+
     def get_prompt_tokens(self, ec=None):
         if ec is None:
             ec = self.execution_count
@@ -705,8 +731,8 @@ def run_cell(self, cell, store_history=True):
             return
 
         # flush stale replies, which could have been ignored, due to missed heartbeats
-        while self.client.shell_channel.msg_ready():
-            self.client.shell_channel.get_msg()
+        while run_sync(self.client.shell_channel.msg_ready)():
+            run_sync(self.client.shell_channel.get_msg)()
         # execute takes 'hidden', which is the inverse of store_hist
         msg_id = self.client.execute(cell, not store_history)
 
@@ -740,7 +766,7 @@ def run_cell(self, cell, store_history=True):
 
     def handle_execute_reply(self, msg_id, timeout=None):
         kwargs = {"timeout": timeout}
-        msg = self.client.shell_channel.get_msg(**kwargs)
+        msg = run_sync(self.client.shell_channel.get_msg)(**kwargs)
         if msg["parent_header"].get("msg_id", None) == msg_id:
 
             self.handle_iopub(msg_id)
@@ -780,7 +806,7 @@ def handle_is_complete_reply(self, msg_id, timeout=None):
         msg = None
         try:
             kwargs = {"timeout": timeout}
-            msg = self.client.shell_channel.get_msg(**kwargs)
+            msg = run_sync(self.client.shell_channel.get_msg)(**kwargs)
         except Empty:
             warn('The kernel did not respond to an is_complete_request. '
                  'Setting `use_kernel_is_complete` to False.')
@@ -849,8 +875,8 @@ def handle_iopub(self, msg_id=''):
 
            It only displays output that is caused by this session.
         """
-        while self.client.iopub_channel.msg_ready():
-            sub_msg = self.client.iopub_channel.get_msg()
+        while run_sync(self.client.iopub_channel.msg_ready)():
+            sub_msg = run_sync(self.client.iopub_channel.get_msg)()
             msg_type = sub_msg['header']['msg_type']
 
             # Update execution_count in case it changed in another session
@@ -1003,7 +1029,7 @@ def handle_image_callable(self, data, mime):
     def handle_input_request(self, msg_id, timeout=0.1):
         """ Method to capture raw_input
         """
-        req = self.client.stdin_channel.get_msg(timeout=timeout)
+        req = run_sync(self.client.stdin_channel.get_msg)(timeout=timeout)
         # in case any iopub came while we were waiting:
         self.handle_iopub(msg_id)
         if msg_id == req["parent_header"].get("msg_id"):
@@ -1032,6 +1058,6 @@ def double_int(sig, frame):
 
             # only send stdin reply if there *was not* another request
             # or execution finished while we were reading.
-            if not (self.client.stdin_channel.msg_ready() or
-                    self.client.shell_channel.msg_ready()):
+            if not (run_sync(self.client.stdin_channel.msg_ready)() or
+                    run_sync(self.client.shell_channel.msg_ready)()):
                 self.client.input(raw_data)

jupyter_console/tests/test_console.py

@@ -21,6 +21,7 @@
 def test_console_starts():
     """test that `jupyter console` starts a terminal"""
     p, pexpect, t = start_console()
+    import pdb; pdb.set_trace()
     p.sendline("5")
     p.expect([r"Out\[\d+\]: 5", pexpect.EOF], timeout=t)
     p.expect([r"In \[\d+\]", pexpect.EOF], timeout=t)

mypy.ini

@@ -1,4 +1,4 @@
 [mypy]
-python_version = 3.7
+python_version = 3.8
 ignore_missing_imports = True
 follow_imports = silent