Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation for richInspectVariables request #654

Merged
merged 3 commits into from
Jun 7, 2021
Merged

Added documentation for richInspectVariables request #654

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3e38133
Added documentation for richInspectVariables request
JohanMabille Jun 4, 2021
fd1695a
Apply suggestions from code review
Carreau Jun 7, 2021
6f07ab8
Fixed message attributes
JohanMabille Jun 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/messaging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down