.pre-commit-config.yaml

@@ -35,7 +35,7 @@ repos:
       - id: black
 
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.243
+    rev: v0.0.254
     hooks:
       - id: ruff
         args: ["--fix"]

CHANGELOG.md

@@ -2,6 +2,28 @@
 
 <!-- <START NEW CHANGELOG ENTRY> -->
 
+## 8.1.0
+
+([Full Changelog](https://github.com/jupyter/jupyter_client/compare/v8.0.3...e3ac7a69355dd1af66038eda767e51e92ef034fb))
+
+### Bugs fixed
+
+- ThreadedZMQStream: close stream before socket [#936](https://github.com/jupyter/jupyter_client/pull/936) ([@minrk](https://github.com/minrk))
+
+### Maintenance and upkeep improvements
+
+### Documentation improvements
+
+- Adds spec for the copyToGlobals request [#932](https://github.com/jupyter/jupyter_client/pull/932) ([@brichet](https://github.com/brichet))
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyter/jupyter_client/graphs/contributors?from=2023-02-16&to=2023-03-20&type=c))
+
+[@blink1073](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Ablink1073+updated%3A2023-02-16..2023-03-20&type=Issues) | [@brichet](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Abrichet+updated%3A2023-02-16..2023-03-20&type=Issues) | [@minrk](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Aminrk+updated%3A2023-02-16..2023-03-20&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Apre-commit-ci+updated%3A2023-02-16..2023-03-20&type=Issues)
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
 ## 8.0.3
 
 ([Full Changelog](https://github.com/jupyter/jupyter_client/compare/v8.0.2...dc0eaba1f609079672ec739fcd977dc44431da92))
@@ -22,8 +44,6 @@
 
 [@andrehora](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Aandrehora+updated%3A2023-01-30..2023-02-16&type=Issues) | [@blink1073](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Ablink1073+updated%3A2023-01-30..2023-02-16&type=Issues) | [@dcsaba89](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Adcsaba89+updated%3A2023-01-30..2023-02-16&type=Issues) | [@kevin-bates](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Akevin-bates+updated%3A2023-01-30..2023-02-16&type=Issues) | [@minrk](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Aminrk+updated%3A2023-01-30..2023-02-16&type=Issues) | [@pre-commit-ci](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Apre-commit-ci+updated%3A2023-01-30..2023-02-16&type=Issues) | [@xl0](https://github.com/search?q=repo%3Ajupyter%2Fjupyter_client+involves%3Axl0+updated%3A2023-01-30..2023-02-16&type=Issues)
 
-<!-- <END NEW CHANGELOG ENTRY> -->
-
 ## 8.0.2
 
 ([Full Changelog](https://github.com/jupyter/jupyter_client/compare/v8.0.1...717d36edcd9ce595f727d8b5a27e270c2a6e2c46))

docs/messaging.rst

@@ -1131,9 +1131,14 @@ Additions to the DAP
 
 The Jupyter debugger protocol makes several additions to the DAP:
 
-- the `dumpCell` request and response messages
-- the `debugInfo` request and response messages
-- the `inspectVariables` request and response messages
+- the `dumpCell`_ request and response messages
+- the `debugInfo`_ request and response messages
+- the `inspectVariables`_ request and response messages
+- the `richInspectVariables`_ request and response messages
+- the `copyToGlobals`_ request and response messages
+
+dumpCell
+########
 
 In order to support the debugging of notebook cells and of Jupyter consoles,
 which are not based on source files, we need a message to submit code to the
@@ -1159,6 +1164,9 @@ debugger to which breakpoints can be added.
           }
      }
 
+debugInfo
+#########
+
 In order to support page reloading, or a client connecting at a later stage,
 Jupyter kernels must store the state of the debugger (such as breakpoints,
 whether the debugger is currently stopped). The `debugInfo` request is a DAP
@@ -1196,6 +1204,9 @@ whether the debugger is currently stopped). The `debugInfo` request is a DAP
 
   The `source_breakpoint` schema is specified by the Debug Adapter Protocol.
 
+inspectVariables
+################
+
 The `inspectVariables` is meant to retrieve the values of all the variables
 that have been defined in the kernel. It is a DAP `Request` with no extra
 argument.
@@ -1224,10 +1235,13 @@ argument.
           }
       }
 
-The ``richInspectVariables`` request allows to get the rich representation of a
+richInspectVariables
+####################
+
+The `richInspectVariables` request allows to get the rich representation of a
 variable that has been defined in the kernel.
 
-  Content of the ``richInspectVariables`` request::
+  Content of the `richInspectVariables` request::
 
       {
           'type' : 'request',
@@ -1239,7 +1253,7 @@ variable that has been defined in the kernel.
           }
       }
 
-  Content of the ``richInspectVariables`` response::
+  Content of the `richInspectVariables` response::
 
       {
           'type' : 'response',
@@ -1251,6 +1265,41 @@ variable that has been defined in the kernel.
           }
       }
 
+copyToGlobals
+#############
+
+The `copyToGlobals` request allows to copy a variable from the local variable panel
+of the debugger to the `global`` scope to inspect it after debug session.
+
+  Content of the `copyToGlobals` request::
+
+    {
+        'type': 'request',
+        'command': 'copyToGlobals',
+        'arguments': {
+            # the variable to copy from the frame corresponding to `srcFrameId`
+            'srcVariableName': str,
+            'srcFrameId': int,
+            # the copied variable name in the global scope
+            'dstVariableName': str
+        }
+    }
+
+  Content of the `copyToGlobals` response::
+
+    {
+        'type': 'response',
+        'success': bool,
+        'command': 'setExpression',
+        'body': {
+            # string representation of the copied variable
+            'value': str,
+            # type of the copied variable
+            'type': str,
+            'variablesReference': int
+        }
+    }
+
 .. versionadded:: 5.5
 
 Messages on the IOPub (PUB/SUB) channel

jupyter_client/__init__.py

@@ -6,17 +6,17 @@
 
 try:
     from .asynchronous import AsyncKernelClient  # noqa
-    from .blocking import BlockingKernelClient  # noqa
-    from .client import KernelClient  # noqa
+    from .blocking import BlockingKernelClient
+    from .client import KernelClient
     from .connect import *  # noqa
     from .launcher import *  # noqa
-    from .manager import AsyncKernelManager  # noqa
-    from .manager import KernelManager  # noqa
-    from .manager import run_kernel  # noqa
-    from .multikernelmanager import AsyncMultiKernelManager  # noqa
-    from .multikernelmanager import MultiKernelManager  # noqa
-    from .provisioning import KernelProvisionerBase  # noqa
-    from .provisioning import LocalProvisioner  # noqa
+    from .manager import AsyncKernelManager
+    from .manager import KernelManager
+    from .manager import run_kernel
+    from .multikernelmanager import AsyncMultiKernelManager
+    from .multikernelmanager import MultiKernelManager
+    from .provisioning import KernelProvisionerBase
+    from .provisioning import LocalProvisioner
 except ModuleNotFoundError:
     import warnings
 

jupyter_client/_version.py

@@ -2,7 +2,7 @@
 import re
 from typing import List, Union
 
-__version__ = "8.0.3"
+__version__ = "8.1.0"
 
 # Build up version_info tuple for backwards compatibility
 pattern = r'(?P<major>\d+).(?P<minor>\d+).(?P<patch>\d+)(?P<rest>.*)'

jupyter_client/session.py

@@ -249,7 +249,7 @@ def __init__(self, msg_dict: t.Dict[str, t.Any]) -> None:
         dct = self.__dict__
         for k, v in dict(msg_dict).items():
             if isinstance(v, dict):
-                v = Message(v)
+                v = Message(v)  # noqa
             dct[k] = v
 
     # Having this iterator lets dict(msg_obj) work out of the box.
@@ -861,9 +861,9 @@ def send(
             stream.send_multipart(to_send, copy=copy)
 
         if self.debug:
-            pprint.pprint(msg)  # noqa
-            pprint.pprint(to_send)  # noqa
-            pprint.pprint(buffers)  # noqa
+            pprint.pprint(msg)
+            pprint.pprint(to_send)
+            pprint.pprint(buffers)
 
         msg["tracker"] = tracker
 
@@ -1088,7 +1088,7 @@ def deserialize(
             buffers = [memoryview(bytes(b.bytes)) for b in msg_list[5:]]
         message["buffers"] = buffers
         if self.debug:
-            pprint.pprint(message)  # noqa
+            pprint.pprint(message)
         # adapt to the current version
         return adapt(message)
 

jupyter_client/threaded.py

@@ -4,12 +4,14 @@
 import asyncio
 import atexit
 import time
+from concurrent.futures import Future
 from threading import Event, Thread
 from typing import Any, Dict, List, Optional
 
 import zmq
 from tornado.ioloop import IOLoop
 from traitlets import Instance, Type
+from traitlets.log import get_logger
 from zmq.eventloop import zmqstream
 
 from .channels import HBChannel
@@ -45,7 +47,7 @@ def __init__(
         session : :class:`session.Session`
             The session to use.
         loop
-            A pyzmq ioloop to connect the socket to using a ZMQStream
+            A tornado ioloop to connect the socket to using a ZMQStream
         """
         super().__init__()
 
@@ -79,7 +81,30 @@ def stop(self) -> None:
         self._is_alive = False
 
     def close(self) -> None:
-        """ "Close the channel."""
+        """Close the channel."""
+        if self.stream is not None and self.ioloop is not None:
+            # c.f.Future for threadsafe results
+            f: Future = Future()
+
+            def close_stream():
+                try:
+                    if self.stream is not None:
+                        self.stream.close(linger=0)
+                        self.stream = None
+                except Exception as e:
+                    f.set_exception(e)
+                else:
+                    f.set_result(None)
+
+            self.ioloop.add_callback(close_stream)
+            # wait for result
+            try:
+                f.result(timeout=5)
+            except Exception as e:
+                log = get_logger()
+                msg = f"Error closing stream {self.stream}: {e}"
+                log.warning(msg, RuntimeWarning, stacklevel=2)
+
         if self.socket is not None:
             try:
                 self.socket.close(linger=0)

jupyter_client/utils.py

@@ -54,7 +54,7 @@ def _filefind(filename, path_dirs=None):
 
     for path in path_dirs:
         if path == ".":
-            path = os.getcwd()
+            path = os.getcwd()  # noqa
         testname = _expand_path(os.path.join(path, filename))
         if os.path.isfile(testname):
             return os.path.abspath(testname)

pyproject.toml

@@ -110,7 +110,7 @@ test = "mypy --install-types --non-interactive {args:.}"
 dependencies = [
   "black[jupyter]==23.1.0",
   "mdformat>0.7",
-  "ruff==0.0.243",
+  "ruff==0.0.254",
 ]
 [tool.hatch.envs.lint.scripts]
 style = [
@@ -242,6 +242,8 @@ ignore = [
   "SIM108",
   # S110 `try`-`except`-`pass` detected, consider logging the exception
   "S110",
+  # PLW0603 Using the global statement to update
+  "PLW0603",
 ]
 unfixable = [
   # Don't touch print statements

tests/test_jsonutil.py

@@ -182,7 +182,7 @@ def test_json_default():
 
     for val, jval in pairs:
         if jval is None:
-            jval = val
+            jval = val  # noqa
         out = json.loads(json.dumps(val, default=jsonutil.json_default))
         # validate our cleanup
         assert out == jval