scrapy/docs/topics/asyncio.rst

2.0 KiB

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> </head>

asyncio

System Message: ERROR/3 (<stdin>, line 7)

Unknown directive type "versionadded".

.. versionadded:: 2.0

Scrapy has partial support for :mod:`asyncio`. After you :ref:`install the asyncio reactor <install-asyncio>`, you may use :mod:`asyncio` and :mod:`asyncio`-powered libraries in any :doc:`coroutine <coroutines>`.

System Message: ERROR/3 (<stdin>, line 9); backlink

Unknown interpreted text role "mod".

System Message: ERROR/3 (<stdin>, line 9); backlink

Unknown interpreted text role "ref".

System Message: ERROR/3 (<stdin>, line 9); backlink

Unknown interpreted text role "mod".

System Message: ERROR/3 (<stdin>, line 9); backlink

Unknown interpreted text role "mod".

System Message: ERROR/3 (<stdin>, line 9); backlink

Unknown interpreted text role "doc".

Installing the asyncio reactor

To enable :mod:`asyncio` support, set the :setting:`TWISTED_REACTOR` setting to 'twisted.internet.asyncioreactor.AsyncioSelectorReactor'.

System Message: ERROR/3 (<stdin>, line 18); backlink

Unknown interpreted text role "mod".

System Message: ERROR/3 (<stdin>, line 18); backlink

Unknown interpreted text role "setting".

If you are using :class:`~scrapy.crawler.CrawlerRunner`, you also need to install the :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` reactor manually. You can do that using :func:`~scrapy.utils.reactor.install_reactor`:

System Message: ERROR/3 (<stdin>, line 21); backlink

Unknown interpreted text role "class".

System Message: ERROR/3 (<stdin>, line 21); backlink

Unknown interpreted text role "class".

System Message: ERROR/3 (<stdin>, line 21); backlink

Unknown interpreted text role "func".
install_reactor('twisted.internet.asyncioreactor.AsyncioSelectorReactor')

Using custom asyncio loops

You can also use custom asyncio event loops with the asyncio reactor. Set the :setting:`ASYNCIO_EVENT_LOOP` setting to the import path of the desired event loop class to use it instead of the default asyncio event loop.

System Message: ERROR/3 (<stdin>, line 33); backlink

Unknown interpreted text role "setting".

Awaiting on Deferreds

When the asyncio reactor isn't installed, you can await on Deferreds in the coroutines directly. When it is installed, this is not possible anymore, due to specifics of the Scrapy coroutine integration (the coroutines are wrapped into :class:`asyncio.Future` objects, not into :class:`~twisted.internet.defer.Deferred` directly), and you need to wrap them into Futures. Scrapy provides two helpers for this:

System Message: ERROR/3 (<stdin>, line 42); backlink

Unknown interpreted text role "class".

System Message: ERROR/3 (<stdin>, line 42); backlink

Unknown interpreted text role "class".

System Message: ERROR/3 (<stdin>, line 49)

Unknown directive type "autofunction".

.. autofunction:: scrapy.utils.defer.deferred_to_future

System Message: ERROR/3 (<stdin>, line 50)

Unknown directive type "autofunction".

.. autofunction:: scrapy.utils.defer.maybe_deferred_to_future

Tip

If you need to use these functions in code that aims to be compatible with lower versions of Scrapy that do not provide these functions, down to Scrapy 2.0 (earlier versions do not support :mod:`asyncio`), you can copy the implementation of these functions into your own code.

System Message: ERROR/3 (<stdin>, line 51); backlink

Unknown interpreted text role "mod".
</html>