From 3e3813344514741ba1b15fed04799189a7765f71 Mon Sep 17 00:00:00 2001 From: Johan Mabille Date: Fri, 4 Jun 2021 23:07:20 +0200 Subject: [PATCH 1/3] Added documentation for richInspectVariables request --- docs/messaging.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/messaging.rst b/docs/messaging.rst index 21c3698c3..bcd190567 100644 --- a/docs/messaging.rst +++ b/docs/messaging.rst @@ -1190,6 +1190,33 @@ The `inspectVariables` is meant to retrieve the values of all the variables that } } +The `richInspectVariables` request allows to get the rich representation of a variable that has been defined in the kernel. + + Content of the `richInspectVariables` request:: + + { + 'type' : 'request', + 'command' : 'richInspectVariables, + 'arguments' : { + # The variable name is used when the debugger is not stopped on a breakpoint. + 'variableName' : str, + # The variable reference is used when the debugger hit a breakpoint. + 'variableReference' : int + } + } + + Content of the `richInspectVariables` response:: + + { + 'type' : 'response', + 'success' : bool, + 'body' : { + # Dictionary of rich reprensentations of the variable + 'data' : dict, + 'metadata' : dict + } + } + .. versionadded:: 5.5 Messages on the IOPub (PUB/SUB) channel From fd1695a975cf286930c7db697cf65663ff21a2dc Mon Sep 17 00:00:00 2001 From: Matthias Bussonnier Date: Mon, 7 Jun 2021 16:36:54 +0200 Subject: [PATCH 2/3] Apply suggestions from code review --- docs/messaging.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/messaging.rst b/docs/messaging.rst index bcd190567..444acd7e7 100644 --- a/docs/messaging.rst +++ b/docs/messaging.rst @@ -1190,13 +1190,13 @@ The `inspectVariables` is meant to retrieve the values of all the variables that } } -The `richInspectVariables` request allows to get the rich representation of a variable that has been defined in the kernel. +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', - 'command' : 'richInspectVariables, + 'command' : 'richInspectVariables', 'arguments' : { # The variable name is used when the debugger is not stopped on a breakpoint. 'variableName' : str, @@ -1205,7 +1205,7 @@ The `richInspectVariables` request allows to get the rich representation of a va } } - Content of the `richInspectVariables` response:: + Content of the ``richInspectVariables`` response:: { 'type' : 'response', From 6f07ab8a6dd1a370ab93c1c236465d136d266620 Mon Sep 17 00:00:00 2001 From: Johan Mabille Date: Mon, 7 Jun 2021 17:55:06 +0200 Subject: [PATCH 3/3] Fixed message attributes --- docs/messaging.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/messaging.rst b/docs/messaging.rst index 444acd7e7..5df8ecd29 100644 --- a/docs/messaging.rst +++ b/docs/messaging.rst @@ -1198,10 +1198,9 @@ The ``richInspectVariables`` request allows to get the rich representation of a 'type' : 'request', 'command' : 'richInspectVariables', 'arguments' : { - # The variable name is used when the debugger is not stopped on a breakpoint. 'variableName' : str, - # The variable reference is used when the debugger hit a breakpoint. - 'variableReference' : int + # The frameId is used when the debugger hit a breakpoint only. + 'frameId' : int } }