Skip to content

add comments to explain signal handling under jupyterhub #1452

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
merged 1 commit into from
Nov 5, 2024
Merged

add comments to explain signal handling under jupyterhub #1452

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 15 additions & 2 deletions jupyter_server/serverapp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2388,7 +2388,14 @@ def init_signal(self) -> None:
signal.signal(signal.SIGINFO, self._signal_info)

def _handle_sigint(self, sig: t.Any, frame: t.Any) -> None:
"""SIGINT handler spawns confirmation dialog"""
"""SIGINT handler spawns confirmation dialog

Note:
JupyterHub replaces this method with _signal_stop
in order to bypass the interactive prompt.
https://github.com/jupyterhub/jupyterhub/pull/4864

"""
# register more forceful signal handler for ^C^C case
signal.signal(signal.SIGINT, self._signal_stop)
# request confirmation dialog in bg thread, to avoid
Expand Down Expand Up @@ -2446,7 +2453,13 @@ def _confirm_exit(self) -> None:
self.io_loop.add_callback_from_signal(self._restore_sigint_handler)

def _signal_stop(self, sig: t.Any, frame: t.Any) -> None:
"""Handle a stop signal."""
"""Handle a stop signal.

Note:
JupyterHub configures this method to be called for SIGINT.
https://github.com/jupyterhub/jupyterhub/pull/4864

"""
self.log.critical(_i18n("received signal %s, stopping"), sig)
self.stop(from_signal=True)

Expand Down
Loading