Make json_clean a no-op for jupyter-client >= 7

Author: martinRenou

ipykernel/datapub.py

@@ -66,6 +66,6 @@ def publish_data(data):
         DeprecationWarning,
         stacklevel=2
     )
-    
+
     from ipykernel.zmqshell import ZMQInteractiveShell
     ZMQInteractiveShell.instance().data_pub.publish_data(data)

ipykernel/debugger.py

@@ -7,15 +7,21 @@
 from tornado.queues import Queue
 from tornado.locks import Event
 
+from IPython.core.getipython import get_ipython
+
+try:
+    from jupyter_client.jsonutil import json_default
+except ImportError:
+    from jupyter_client.jsonutil import date_default as json_default
+
 from .compiler import (get_file_name, get_tmp_directory, get_tmp_hash_seed)
 
-from IPython.core.getipython import get_ipython
 
-from .jsonutil import json_clean
 
 # Required for backwards compatiblity
 ROUTING_ID = getattr(zmq, 'ROUTING_ID', None) or zmq.IDENTITY
 
+
 class DebugpyMessageQueue:
 
     HEADER = 'Content-Length: '
@@ -58,7 +64,7 @@ def put_tcp_frame(self, frame):
                 self.header_pos = self.tcp_buffer.find(DebugpyMessageQueue.HEADER)
             if self.header_pos == -1:
                 return
-        
+
             self.log.debug('QUEUE - found header at pos %i', self.header_pos)
 
             #Finds separator
@@ -94,7 +100,7 @@ def put_tcp_frame(self, frame):
 
     async def get_message(self):
         return await self.message_queue.get()
-            
+
 
 class DebugpyClient:
 
@@ -123,15 +129,20 @@ def _forward_event(self, msg):
     def _send_request(self, msg):
         if self.routing_id is None:
             self.routing_id = self.debugpy_stream.socket.getsockopt(ROUTING_ID)
-        content = jsonapi.dumps(msg)
+        content = jsonapi.dumps(
+            msg,
+            default=json_default,
+            ensure_ascii=False,
+            allow_nan=False,
+        )
         content_length = str(len(content))
         buf = (DebugpyMessageQueue.HEADER + content_length + DebugpyMessageQueue.SEPARATOR).encode('ascii')
         buf += content
         self.log.debug("DEBUGPYCLIENT:")
         self.log.debug(self.routing_id)
         self.log.debug(buf)
         self.debugpy_stream.send_multipart((self.routing_id, buf))
-    
+
     async def _wait_for_response(self):
         # Since events are never pushed to the message_queue
         # we can safely assume the next message in queue
@@ -141,7 +152,7 @@ async def _wait_for_response(self):
     async def _handle_init_sequence(self):
         # 1] Waits for initialized event
         await self.init_event.wait()
-        
+
         # 2] Sends configurationDone request
         configurationDone = {
             'type': 'request',
@@ -193,6 +204,7 @@ async def send_dap_request(self, msg):
             self.log.debug(rep)
             return rep
 
+
 class Debugger:
 
     # Requests that requires that the debugger has started
@@ -202,7 +214,7 @@ class Debugger:
         'variables', 'attach',
         'configurationDone'
     ]
-    
+
     # Requests that can be handled even if the debugger is not running
     static_debug_msg_types = [
         'debugInfo', 'inspectVariables', 'richInspectVariables'
@@ -215,7 +227,7 @@ def __init__(self, log, debugpy_stream, event_callback, shell_socket, session):
         self.session = session
         self.is_started = False
         self.event_callback = event_callback
-        
+
         self.started_debug_handlers = {}
         for msg_type in Debugger.started_debug_msg_types:
             self.started_debug_handlers[msg_type] = getattr(self, msg_type)
@@ -264,7 +276,7 @@ def start(self):
             }
             self.session.send(self.shell_socket, 'execute_request', content,
                               None, (self.shell_socket.getsockopt(ROUTING_ID)))
-                          
+
             ident, msg = self.session.recv(self.shell_socket, mode=0)
             self.debugpy_initialized = msg['content']['status'] == 'ok'
         self.debugpy_client.connect_tcp_socket()
@@ -424,8 +436,12 @@ async def inspectVariables(self, message):
         for k, v in get_ipython().user_ns.items():
             if self.accept_variable(k):
                 try:
-                    val = json_clean(v)
-
+                    val = jsonapi.dumps(
+                        v,
+                        default=json_default,
+                        ensure_ascii=False,
+                        allow_nan=False,
+                    )
                 except ValueError:
                     val = str(v)
                 var_list.append({
@@ -486,7 +502,7 @@ async def richInspectVariables(self, message):
             'data': {},
             'metadata': {}
         }
-        
+
         for key, value in repr_data.items():
             body['data']['key'] = value
             if repr_metadata.has_key(key):

ipykernel/inprocess/ipkernel.py

@@ -152,12 +152,12 @@ def _default_shell_class(self):
 
     @default('stdout')
     def _default_stdout(self):
-        return OutStream(self.session, self.iopub_thread, 'stdout', 
+        return OutStream(self.session, self.iopub_thread, 'stdout',
                          watchfd=False)
 
     @default('stderr')
     def _default_stderr(self):
-        return OutStream(self.session, self.iopub_thread, 'stderr', 
+        return OutStream(self.session, self.iopub_thread, 'stderr',
                          watchfd=False)
 
 #-----------------------------------------------------------------------------

ipykernel/jsonutil.py

@@ -9,6 +9,7 @@
 import types
 from datetime import datetime
 import numbers
+from jupyter_client._version import version_info as jupyter_client_version
 
 next_attr_name = '__next__'
 
@@ -42,6 +43,9 @@
 # front of PDF base64-encoded
 PDF64 = b'JVBER'
 
+JUPYTER_CLIENT_MAJOR_VERSION = jupyter_client_version[0]
+
+
 def encode_images(format_dict):
     """b64-encodes images in a displaypub format dict
 
@@ -68,7 +72,9 @@ def encode_images(format_dict):
 
 
 def json_clean(obj):
-    """Clean an object to ensure it's safe to encode in JSON.
+    """Deprecated, this is a no-op for jupyter-client>=7.
+
+    Clean an object to ensure it's safe to encode in JSON.
 
     Atomic, immutable objects are returned unmodified.  Sets and tuples are
     converted to lists, lists are copied and dicts are also copied.
@@ -89,6 +95,9 @@ def json_clean(obj):
         it simply sanitizes it so that there will be no encoding errors later.
 
     """
+    if JUPYTER_CLIENT_MAJOR_VERSION >= 7:
+        return obj
+
     # types that are 'atomic' and ok in json as-is.
     atomic_ok = (str, type(None))
 
@@ -110,10 +119,10 @@ def json_clean(obj):
         if math.isnan(obj) or math.isinf(obj):
             return repr(obj)
         return float(obj)
-    
+
     if isinstance(obj, atomic_ok):
         return obj
-    
+
     if isinstance(obj, bytes):
         # unanmbiguous binary data is base64-encoded
         # (this probably should have happened upstream)
@@ -142,6 +151,6 @@ def json_clean(obj):
         return out
     if isinstance(obj, datetime):
         return obj.strftime(ISO8601)
-    
+
     # we don't understand it, it's probably an unserializable object
     raise ValueError("Can't clean for JSON: %r" % obj)