Skip to content

bpo-35465: Document _UnixSelectorEventLoop.add_signal_handler. #11145

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
1st1 merged 2 commits into from
Dec 18, 2018
Merged

bpo-35465: Document _UnixSelectorEventLoop.add_signal_handler. #11145

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed6d891
bpo-35465: Document _UnixSelectorEventLoop.add_signal_handler.
hniksic Dec 13, 2018
a836fbe
Don't give a false impression that signal delivery will work in loops…
hniksic Dec 17, 2018
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
8 changes: 8 additions & 0 deletions Doc/library/asyncio-eventloop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -966,12 +966,20 @@ Unix signals

Set *callback* as the handler for the *signum* signal.

The callback will be invoked by *loop*, along with other queued callbacks
and runnable coroutines of that event loop. Unlike signal handlers
registered using :func:`signal.signal`, a callback registered with this
function is allowed to interact with the event loop.

Raise :exc:`ValueError` if the signal number is invalid or uncatchable.
Raise :exc:`RuntimeError` if there is a problem setting up the handler.

Use :func:`functools.partial` :ref:`to pass keyword arguments
<asyncio-pass-keywords>` to *callback*.

Like :func:`signal.signal`, this function must be invoked in the main
thread.

.. method:: loop.remove_signal_handler(sig)

Remove the handler for the *sig* signal.
Expand Down