Merge pull request #793 from fcollonval/fix/rich-inspect

Fix rich variables inspection

Author: Steven Silvester

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+omit = ipykernel/tests/*

MANIFEST.in

@@ -23,3 +23,5 @@ global-exclude .ipynb_checkpoints
 prune data_kernelspec
 exclude .mailmap
 exclude readthedocs.yml
+
+exclude .coveragerc

ipykernel/debugger.py

@@ -511,66 +511,53 @@ async def inspectVariables(self, message):
 
     async def richInspectVariables(self, message):
         reply = {
-            'type': 'response',
-            'sequence_seq': message['seq'],
-            'success': False,
-            'command': message['command']
+            "type": "response",
+            "sequence_seq": message["seq"],
+            "success": False,
+            "command": message["command"],
         }
-        
-        var_name = message['arguments']['variableName']
+
+        var_name = message["arguments"]["variableName"]
         valid_name = str.isidentifier(var_name)
         if not valid_name:
-            reply['body'] = {
-                'data': {},
-                'metadata': {}
-            }
-            if var_name == 'special variables' or var_name == 'function variables':
-                reply['success'] = True
+            reply["body"] = {"data": {}, "metadata": {}}
+            if var_name == "special variables" or var_name == "function variables":
+                reply["success"] = True
             return reply
 
-        var_repr_data = var_name + '_repr_data'
-        var_repr_metadata = var_name + '_repr_metadata'
-
-        if not self.breakpoint_list:
+        repr_data = {}
+        repr_metadata = {}
+        if not self.stopped_threads:
             # The code did not hit a breakpoint, we use the intepreter
             # to get the rich representation of the variable
-            var_repr_data, var_repr_metadata = get_ipython().display_formatter.format(var_name)
+            result = get_ipython().user_expressions({var_name: var_name})[var_name]
+            if result.get("status", "error") == "ok":
+                repr_data = result.get("data", {})
+                repr_metadata = result.get("metadata", {})
         else:
             # The code has stopped on a breakpoint, we use the setExpression
             # request to get the rich representation of the variable
-            lvalue = var_repr_data + ',' + var_repr_metadata
-            code = 'get_ipython().display_formatter.format(' + var_name+')'
-            frame_id = message['arguments']['frameId']
-            seq = message['seq']
-            request = {
-                'type': 'request',
-                'command': 'setExpression',
-                'seq': seq+1,
-                'arguments': {
-                    'expression': lvalue,
-                    'value': code,
-                    'frameId': frame_id
+            code = "get_ipython().display_formatter.format(" + var_name + ")"
+            frame_id = message["arguments"]["frameId"]
+            seq = message["seq"]
+            reply = await self._forward_message(
+                {
+                    "type": "request",
+                    "command": "evaluate",
+                    "seq": seq + 1,
+                    "arguments": {"expression": code, "frameId": frame_id},
                 }
-            }
-            await self._forward_message(request)
+            )
+            if reply["success"]:
+                repr_data, repr_metadata = eval(reply["body"]["result"], {}, {})
 
-        repr_data = globals()[var_repr_data]
-        repr_metadata = globals()[var_repr_metadata]
         body = {
-            'data': {},
-            'metadata': {}
+            "data": repr_data,
+            "metadata": {k: v for k, v in repr_metadata.items() if k in repr_data},
         }
 
-        for key, value in repr_data.items():
-            body['data']['key'] = value
-            if key in repr_metadata:
-                body['metadata'][key] = repr_metadata[key]
-
-        globals().pop(var_repr_data)
-        globals().pop(var_repr_metadata)
-
-        reply['body'] = body
-        reply['success'] = True
+        reply["body"] = body
+        reply["success"] = True
         return reply
 
     async def process_request(self, message):

ipykernel/tests/test_debugger.py

@@ -0,0 +1,202 @@
+import pytest
+
+from .utils import new_kernel, get_reply
+
+seq = 0
+
+# Skip if debugpy is not available
+pytest.importorskip("debugpy")
+
+
+def wait_for_debug_request(kernel, command, arguments=None):
+    """Carry out a debug request and return the reply content.
+
+    It does not check if the request was successful.
+    """
+    global seq
+    seq += 1
+
+    msg = kernel.session.msg(
+        "debug_request",
+        {
+            "type": "request",
+            "seq": seq,
+            "command": command,
+            "arguments": arguments or {},
+        },
+    )
+    kernel.control_channel.send(msg)
+    reply = get_reply(kernel, msg["header"]["msg_id"], channel="control")
+    return reply["content"]
+
+
+@pytest.fixture
+def kernel():
+    with new_kernel() as kc:
+        yield kc
+
+
+@pytest.fixture
+def kernel_with_debug(kernel):
+    # Initialize
+    wait_for_debug_request(
+        kernel,
+        "initialize",
+        {
+            "clientID": "test-client",
+            "clientName": "testClient",
+            "adapterID": "",
+            "pathFormat": "path",
+            "linesStartAt1": True,
+            "columnsStartAt1": True,
+            "supportsVariableType": True,
+            "supportsVariablePaging": True,
+            "supportsRunInTerminalRequest": True,
+            "locale": "en",
+        },
+    )
+
+    # Attach
+    wait_for_debug_request(kernel, "attach")
+
+    try:
+        yield kernel
+    finally:
+        # Detach
+        wait_for_debug_request(
+            kernel, "disconnect", {"restart": False, "terminateDebuggee": True}
+        )
+
+
+def test_debug_initialize(kernel):
+    reply = wait_for_debug_request(
+        kernel,
+        "initialize",
+        {
+            "clientID": "test-client",
+            "clientName": "testClient",
+            "adapterID": "",
+            "pathFormat": "path",
+            "linesStartAt1": True,
+            "columnsStartAt1": True,
+            "supportsVariableType": True,
+            "supportsVariablePaging": True,
+            "supportsRunInTerminalRequest": True,
+            "locale": "en",
+        },
+    )
+    assert reply["success"]
+
+
+def test_attach_debug(kernel_with_debug):
+    reply = wait_for_debug_request(
+        kernel_with_debug, "evaluate", {"expression": "'a' + 'b'", "context": "repl"}
+    )
+    assert reply["success"]
+    assert reply["body"]["result"] == ""
+
+
+def test_set_breakpoints(kernel_with_debug):
+    code = """def f(a, b):
+    c = a + b
+    return c
+
+f(2, 3)"""
+
+    r = wait_for_debug_request(kernel_with_debug, "dumpCell", {"code": code})
+    source = r["body"]["sourcePath"]
+
+    reply = wait_for_debug_request(
+        kernel_with_debug,
+        "setBreakpoints",
+        {
+            "breakpoints": [{"line": 2}],
+            "source": {"path": source},
+            "sourceModified": False,
+        },
+    )
+    assert reply["success"]
+    assert len(reply["body"]["breakpoints"]) == 1
+    assert reply["body"]["breakpoints"][0]["verified"]
+    assert reply["body"]["breakpoints"][0]["source"]["path"] == source
+
+    r = wait_for_debug_request(kernel_with_debug, "debugInfo")
+    assert source in map(lambda b: b["source"], r["body"]["breakpoints"])
+
+    r = wait_for_debug_request(kernel_with_debug, "configurationDone")
+    assert r["success"]
+
+
+def test_rich_inspect_not_at_breakpoint(kernel_with_debug):
+    var_name = "text"
+    value = "Hello the world"
+    code = """{0}='{1}'
+print({0})
+""".format(var_name, value)
+
+    msg_id = kernel_with_debug.execute(code)
+    get_reply(kernel_with_debug, msg_id)
+
+    r = wait_for_debug_request(kernel_with_debug, "inspectVariables")
+    assert var_name in list(map(lambda v: v["name"], r["body"]["variables"]))
+
+    reply = wait_for_debug_request(
+        kernel_with_debug,
+        "richInspectVariables",
+        {"variableName": var_name},
+    )
+
+    assert reply["body"]["data"] == {"text/plain": "'{}'".format(value)}
+
+
+def test_rich_inspect_at_breakpoint(kernel_with_debug):
+    code = """def f(a, b):
+    c = a + b
+    return c
+
+f(2, 3)"""
+
+    r = wait_for_debug_request(kernel_with_debug, "dumpCell", {"code": code})
+    source = r["body"]["sourcePath"]
+
+    wait_for_debug_request(
+        kernel_with_debug,
+        "setBreakpoints",
+        {
+            "breakpoints": [{"line": 2}],
+            "source": {"path": source},
+            "sourceModified": False,
+        },
+    )
+
+    r = wait_for_debug_request(kernel_with_debug, "debugInfo")
+
+    r = wait_for_debug_request(kernel_with_debug, "configurationDone")
+
+    kernel_with_debug.execute(code)
+
+    stacks = wait_for_debug_request(kernel_with_debug, "stackTrace", {"threadId": 1})[
+        "body"
+    ]["stackFrames"]
+
+    scopes = wait_for_debug_request(
+        kernel_with_debug, "scopes", {"frameId": stacks[0]["id"]}
+    )["body"]["scopes"]
+
+    locals_ = wait_for_debug_request(
+        kernel_with_debug,
+        "variables",
+        {
+            "variablesReference": next(filter(lambda s: s["name"] == "Locals", scopes))[
+                "variablesReference"
+            ]
+        },
+    )["body"]["variables"]
+
+    reply = wait_for_debug_request(
+        kernel_with_debug,
+        "richInspectVariables",
+        {"variableName": locals_[0]["name"], "frameId": stacks[0]["id"]},
+    )
+
+    assert reply["body"]["data"] == {"text/plain": locals_[0]["value"]}