Skip to content

Deduplicate awaitable check in request handlers #1507

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

Open
erikgaas wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Deduplicate awaitable check in request handlers #1507

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98dc4ab
Deduplicate awaitable check in request handlers
erikgaas Mar 6, 2026
3fad92a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 6, 2026
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
76 changes: 18 additions & 58 deletions ipykernel/kernelbase.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,6 +543,17 @@ async def _create_control_lock(self):
# This can be removed when minimum python increases to 3.10
self._control_lock = asyncio.Lock()

async def _await_result(self, result, func_name):
"""Await result if awaitable, otherwise warn about non-async do_* method."""
if inspect.isawaitable(result):
return await result
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name=func_name, target=getattr(self, func_name)),
PendingDeprecationWarning,
stacklevel=2,
)
return result

def start(self):
"""register dispatchers for streams"""
self.io_loop = ioloop.IOLoop.current()
Expand Down Expand Up @@ -830,14 +841,7 @@ async def execute_request(self, stream, ident, parent):
# Call do_execute with the appropriate arguments
reply_content = self.do_execute(**do_execute_args)

if inspect.isawaitable(reply_content):
reply_content = await reply_content
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name="do_execute", target=self.do_execute),
PendingDeprecationWarning,
stacklevel=1,
)
reply_content = await self._await_result(reply_content, "do_execute")

# Flush output before sending the reply.
if sys.stdout is not None:
Expand Down Expand Up @@ -892,14 +896,7 @@ async def complete_request(self, stream, ident, parent):
cursor_pos = content["cursor_pos"]

matches = self.do_complete(code, cursor_pos)
if inspect.isawaitable(matches):
matches = await matches
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name="do_complete", target=self.do_complete),
PendingDeprecationWarning,
stacklevel=1,
)
matches = await self._await_result(matches, "do_complete")

matches = json_clean(matches)
self.session.send(stream, "complete_reply", matches, parent, ident)
Expand All @@ -926,14 +923,7 @@ async def inspect_request(self, stream, ident, parent):
content.get("detail_level", 0),
set(content.get("omit_sections", [])),
)
if inspect.isawaitable(reply_content):
reply_content = await reply_content
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name="do_inspect", target=self.do_inspect),
PendingDeprecationWarning,
stacklevel=1,
)
reply_content = await self._await_result(reply_content, "do_inspect")

# Before we send this object over, we scrub it for JSON usage
reply_content = json_clean(reply_content)
Expand All @@ -951,14 +941,7 @@ async def history_request(self, stream, ident, parent):
content = parent["content"]

reply_content = self.do_history(**content)
if inspect.isawaitable(reply_content):
reply_content = await reply_content
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name="do_history", target=self.do_history),
PendingDeprecationWarning,
stacklevel=1,
)
reply_content = await self._await_result(reply_content, "do_history")

reply_content = json_clean(reply_content)
msg = self.session.send(stream, "history_reply", reply_content, parent, ident)
Expand Down Expand Up @@ -1079,14 +1062,7 @@ async def shutdown_request(self, stream, ident, parent):
if not self.session:
return
content = self.do_shutdown(parent["content"]["restart"])
if inspect.isawaitable(content):
content = await content
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name="do_shutdown", target=self.do_shutdown),
PendingDeprecationWarning,
stacklevel=1,
)
content = await self._await_result(content, "do_shutdown")
self.session.send(stream, "shutdown_reply", content, parent, ident=ident)
# same content, but different msg_id for broadcasting on IOPub
self._shutdown_message = self.session.msg("shutdown_reply", content, parent)
Expand Down Expand Up @@ -1118,14 +1094,7 @@ async def is_complete_request(self, stream, ident, parent):
code = content["code"]

reply_content = self.do_is_complete(code)
if inspect.isawaitable(reply_content):
reply_content = await reply_content
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(func_name="do_is_complete", target=self.do_is_complete),
PendingDeprecationWarning,
stacklevel=1,
)
reply_content = await self._await_result(reply_content, "do_is_complete")
reply_content = json_clean(reply_content)
reply_msg = self.session.send(stream, "is_complete_reply", reply_content, parent, ident)
self.log.debug("%s", reply_msg)
Expand All @@ -1140,16 +1109,7 @@ async def debug_request(self, stream, ident, parent):
return
content = parent["content"]
reply_content = self.do_debug_request(content)
if inspect.isawaitable(reply_content):
reply_content = await reply_content
else:
warnings.warn(
_AWAITABLE_MESSAGE.format(
func_name="do_debug_request", target=self.do_debug_request
),
PendingDeprecationWarning,
stacklevel=1,
)
reply_content = await self._await_result(reply_content, "do_debug_request")
reply_content = json_clean(reply_content)
reply_msg = self.session.send(stream, "debug_reply", reply_content, parent, ident)
self.log.debug("%s", reply_msg)
Expand Down
Loading