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.

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

Document debug_[request|reply] and debug_event #464

Merged
merged 1 commit into from
Aug 19, 2019

Conversation

SylvainCorlay
Copy link
Member

@SylvainCorlay SylvainCorlay commented Jul 29, 2019

This is adding documentation for

  • debug_[request/reply], which are new messages on the control channel,
  • debug_event, which are sent back debugging kernels to the front-end on IOPub.

@SylvainCorlay
Copy link
Member Author

SylvainCorlay commented Jul 30, 2019

In this PR, we don't specify yet what debug_[request|reply] and debug_event messages contain, except that the former are on the Control channel (to prevent being queued after execution requests) and the latter on IOPub.

The actual protocol is almost certainly always going to be the Debug Adapter Protocol, and this is what we have implemented in the xeus-python kernel and in the (in-progress) work with in JupyterLab extensions.

All of it is functional with the latest versions of jupyter_client (5.3.1), jupyter_server (0.1.0) notebook (6.0), xeus-python (0.4.0). However, we need a (backward-compatible) PR merged in JupyterLab for the front-end extension to work.

I would argue that we should be able to move forward with merging this PR and then the JupyterLab PR. We already have a working implementation that demonstrates that this change can accomodate the Debugger Adapter Protocol. However, this is still not electing the Debugger Adapter Protocol per se at this point.

Copy link
Contributor

@MSeal MSeal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@MSeal MSeal merged commit 2a43817 into jupyter:master Aug 19, 2019
@SylvainCorlay SylvainCorlay deleted the debug-messages branch December 30, 2019 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants