search

jupyter / jupyter_client

Jupyter protocol client APIs
https://jupyter-client.readthedocs.io
BSD 3-Clause "New" or "Revised" License
390 stars 283 forks source link

is_complete_reply status conflicts with general reply status #442

Open jasongrout opened 5 years ago

jasongrout commented 5 years ago

In https://jupyter-client.readthedocs.io/en/latest/messaging.html#request-reply, we see that the status in a reply message content can be 'ok', 'error', or 'abort'. However, for is_complete_reply, it lists the status possibilities as one of 'complete', 'incomplete', 'invalid', 'unknown'.

These are in conflict with each other. It would be great to get some clarification.

And perhaps the completion status should be a different content attribute in the next spec version?

vidartf commented 5 years ago

Inspecting a few completion messages from ipykernel, I only see the status field being set to 'ok'. I see no field with a value from the other list (it might be overridden?). Maybe the field for code completion should be renamed?

jasongrout commented 5 years ago

This is the is_complete_reply message, not a completion message. These messages are used, for example, in the console when it is checking to see if the current input is valid and can be run, or if we should wait for more input. For example, make sure the jlab console is set so that it runs on pressing enter. Then type some input and you should see an is_complete_request message.

vidartf commented 5 years ago

Ah, sorry for the noise.