Skip to content

Commit

Permalink
Merge pull request #654 from JohanMabille/rich_inspect_variable
Browse files Browse the repository at this point in the history
Added documentation for richInspectVariables request
  • Loading branch information
Carreau authored Jun 7, 2021
2 parents 47cfe68 + 6f07ab8 commit afc5b38
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/messaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1190,6 +1190,32 @@ 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' : {
'variableName' : str,
# The frameId is used when the debugger hit a breakpoint only.
'frameId' : 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
Expand Down

0 comments on commit afc5b38

Please sign in to comment.