bpo-35465: Document _UnixSelectorEventLoop.add_signal_handler. (GH-11145) (GH-11221)

(cherry picked from commit e3666fc8ef)

Co-authored-by: Hrvoje Nikšić <hniksic@gmail.com>
This commit is contained in:
Miss Islington (bot) 2018-12-18 13:52:37 -08:00 committed by Yury Selivanov
parent 60c919b58b
commit 12f3979b38
1 changed files with 8 additions and 0 deletions

View File

@ -960,12 +960,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.