Skip to content

[Bugfix] Set shell idle when message skipped by "should_handle" in "dispatch_shell" #1395

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

Merged
ianthomas23 merged 6 commits into from
May 16, 2025
Merged

[Bugfix] Set shell idle when message skipped by "should_handle" in "dispatch_shell" #1395

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
77f67b4
Working
dby-tmwctw May 15, 2025
077d7f0
Addressing Jason's comments.
dby-tmwctw May 15, 2025
9515620
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 15, 2025
be199a4
Adding Docstring to the function.
dby-tmwctw May 15, 2025
aaa7280
Merge branch 'execution-fix-boyuan' of github.com:dby-tmwctw/ipykerne…
dby-tmwctw May 15, 2025
64e1c2a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] May 15, 2025
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
24 changes: 10 additions & 14 deletions ipykernel/kernelbase.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,10 +331,7 @@ async def process_control(self, msg):

sys.stdout.flush()
sys.stderr.flush()
self._publish_status("idle", "control")
# flush to ensure reply is sent
if self.control_stream:
self.control_stream.flush(zmq.POLLOUT)
self._publish_status_and_flush("idle", "control", self.control_stream)

def should_handle(self, stream, msg, idents):
"""Check whether a shell-channel message should be handled
Expand Down Expand Up @@ -370,11 +367,7 @@ async def dispatch_shell(self, msg):
# Only abort execute requests
if self._aborting and msg_type == "execute_request":
self._send_abort_reply(self.shell_stream, msg, idents)
self._publish_status("idle", "shell")
# flush to ensure reply is sent before
# handling the next request
if self.shell_stream:
self.shell_stream.flush(zmq.POLLOUT)
self._publish_status_and_flush("idle", "shell", self.shell_stream)
return

# Print some info about this message and leave a '--->' marker, so it's
Expand All @@ -384,6 +377,7 @@ async def dispatch_shell(self, msg):
self.log.debug(" Content: %s\n --->\n ", msg["content"])

if not self.should_handle(self.shell_stream, msg, idents):
self._publish_status_and_flush("idle", "shell", self.shell_stream)
return

handler = self.shell_handlers.get(msg_type, None)
Expand Down Expand Up @@ -412,11 +406,7 @@ async def dispatch_shell(self, msg):

sys.stdout.flush()
sys.stderr.flush()
self._publish_status("idle", "shell")
# flush to ensure reply is sent before
# handling the next request
if self.shell_stream:
self.shell_stream.flush(zmq.POLLOUT)
self._publish_status_and_flush("idle", "shell", self.shell_stream)

def pre_handler_hook(self):
"""Hook to execute before calling message handler"""
Expand Down Expand Up @@ -603,6 +593,12 @@ def _publish_status(self, status, channel, parent=None):
ident=self._topic("status"),
)

def _publish_status_and_flush(self, status, channel, stream, parent=None):
"""send status on IOPub and flush specified stream to ensure reply is sent before handling the next reply"""
self._publish_status(status, channel, parent)
if stream:
stream.flush(zmq.POLLOUT)

def _publish_debug_event(self, event):
if not self.session:
return
Expand Down