Merge pull request #3160 from bdarnell/ioloop-docs

ioloop: Update docs for IOLoop constructor
This commit is contained in:
Ben Darnell 2022-06-17 14:28:57 -04:00 committed by GitHub
commit 6cfa37ab4e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions

View File

@ -119,10 +119,12 @@ class IOLoop(Configurable):
.. testoutput::
:hide:
Do not attempt to construct an `IOLoop` directly; this is deprecated since
Tornado 6.2. Instead, initialize the `asyncio` event loop and use
`IOLoop.current()` to access an `IOLoop` wrapper around the current event
loop.
Most applications should not attempt to construct an `IOLoop` directly,
and instead initialize the `asyncio` event loop and use `IOLoop.current()`.
In some cases, such as in test frameworks when initializing an `IOLoop`
to be run in a secondary thread, it may be appropriate to construct
an `IOLoop` with ``IOLoop(make_current=False)``. Constructing an `IOLoop`
without the ``make_current=False`` argument is deprecated since Tornado 6.2.
In general, an `IOLoop` cannot survive a fork or be shared across processes
in any way. When multiple processes are being used, each process should