8.3 KiB
Built-in extensions reference
This document explains all extensions that come with Scrapy. For information on how to use them and how to write your own extensions, see the :ref:`extensions usage guide <topics-extensions>`.
System Message: ERROR/3 (<stdin>, line 7); backlink
Unknown interpreted text role "ref".General purpose extensions
Core Stats extension
System Message: ERROR/3 (<stdin>, line 18)
Unknown directive type "module".
.. module:: scrapy.stats.corestats :synopsis: Core stats collection
Enable the collection of core statistics, provided the stats collection are enabled (see :ref:`topics-stats`).
System Message: ERROR/3 (<stdin>, line 23); backlink
Unknown interpreted text role "ref".Response Libxml2 extension
System Message: ERROR/3 (<stdin>, line 29)
Unknown directive type "module".
.. module:: scrapy.xpath.extension :synopsis: Libxml2 document caching for Responses
Causes the :class:`~scrapy.http.Response` objects to grow a new method (getlibxml2doc()) which returns a (cached) libxml2 document of their contents. :ref:`XPath Selectors <topics-selectors>` use this extension for better performance, so it's highly recommended not to disable it.
System Message: ERROR/3 (<stdin>, line 34); backlink
Unknown interpreted text role "class".System Message: ERROR/3 (<stdin>, line 34); backlink
Unknown interpreted text role "ref".Web console extension
System Message: ERROR/3 (<stdin>, line 44)
Unknown directive type "module".
.. module:: scrapy.management.web :synopsis: Web management console
Provides an extensible web server for managing a Scrapy process. It's enabled by the :setting:`WEBCONSOLE_ENABLED` setting. The server will listen in the port specified in :setting:`WEBCONSOLE_PORT`, and will log to the file specified in :setting:`WEBCONSOLE_LOGFILE`.
System Message: ERROR/3 (<stdin>, line 49); backlink
Unknown interpreted text role "setting".System Message: ERROR/3 (<stdin>, line 49); backlink
Unknown interpreted text role "setting".System Message: ERROR/3 (<stdin>, line 49); backlink
Unknown interpreted text role "setting".The web server is designed to be extended by other extensions which can add their own management web interfaces.
See also :ref:`topics-webconsole` for information on how to write your own web console extension, and "Web console extensions" below for a list of available built-in (web console) extensions.
System Message: ERROR/3 (<stdin>, line 57); backlink
Unknown interpreted text role "ref".Telnet console extension
System Message: ERROR/3 (<stdin>, line 64)
Unknown directive type "module".
.. module:: scrapy.management.telnet :synopsis: Telnet management console
Provides a telnet console for getting into a Python interpreter inside the currently running Scrapy process, which can be very useful for debugging.
The telnet console must be enabled by the :setting:`TELNETCONSOLE_ENABLED` setting, and the server will listen in the port specified in :setting:`WEBCONSOLE_PORT`.
System Message: ERROR/3 (<stdin>, line 72); backlink
Unknown interpreted text role "setting".System Message: ERROR/3 (<stdin>, line 72); backlink
Unknown interpreted text role "setting".Spider reloader extension
System Message: ERROR/3 (<stdin>, line 79)
Unknown directive type "module".
.. module:: scrapy.contrib.spider.reloader :synopsis: Spider reloader extension
Reload spider objects once they've finished scraping, to release the resources and references to other objects they may hold.
Memory usage extension
System Message: ERROR/3 (<stdin>, line 92)
Unknown directive type "module".
.. module:: scrapy.contrib.memusage :synopsis: Memory usage extension
Allows monitoring the memory used by a Scrapy process and:
1, send a notification email when it exceeds a certain value 2. terminate the Scrapy process when it exceeds a certain value
The notification emails can be triggered when a certain warning value is reached (:setting:`MEMUSAGE_WARNING_MB`) and when the maximum value is reached (:setting:`MEMUSAGE_LIMIT_MB`) which will also cause the Scrapy process to be terminated.
System Message: ERROR/3 (<stdin>, line 102); backlink
Unknown interpreted text role "setting".System Message: ERROR/3 (<stdin>, line 102); backlink
Unknown interpreted text role "setting".This extension is enabled by the :setting:`MEMUSAGE_ENABLED` setting and can be configured with the following settings:
System Message: ERROR/3 (<stdin>, line 107); backlink
Unknown interpreted text role "setting".-
System Message: ERROR/3 (<stdin>, line 110); backlink
Unknown interpreted text role "setting".
:setting:`MEMUSAGE_WARNING_MB`
System Message: ERROR/3 (<stdin>, line 111); backlink
Unknown interpreted text role "setting".
:setting:`MEMUSAGE_NOTIFY_MAIL`
System Message: ERROR/3 (<stdin>, line 112); backlink
Unknown interpreted text role "setting".
-
System Message: ERROR/3 (<stdin>, line 113); backlink
Unknown interpreted text role "setting".
Memory debugger extension
System Message: ERROR/3 (<stdin>, line 118)
Unknown directive type "module".
.. module:: scrapy.contrib.memdebug :synopsis: Memory debugger extension
A memory debugger which collects some info about objects uncollected by the garbage collector and libxml2 memory leaks. To enable this extension turn on the :setting:`MEMDEBUG_ENABLED` setting. The report will be printed to standard output. If the :setting:`MEMDEBUG_NOTIFY` setting contains a list of emails the report will also be sent to those addresses.
System Message: ERROR/3 (<stdin>, line 123); backlink
Unknown interpreted text role "setting".System Message: ERROR/3 (<stdin>, line 123); backlink
Unknown interpreted text role "setting".Close domain extension
System Message: ERROR/3 (<stdin>, line 132)
Unknown directive type "module".
.. module:: scrapy.contrib.closedomain :synopsis: Close domain extension
Allows a domain/spider to be automatically closed when some conditions are met and optionally notifies a list of emails if the :setting:`CLOSEDOMAIN_NOTIFY` is set.
System Message: ERROR/3 (<stdin>, line 137); backlink
Unknown interpreted text role "setting".The conditions for auto-closing a domain can be configured thorough these settings:
:setting:`CLOSEDOMAIN_TIMEOUT` - an integer which specifies a number of seconds. If the domain remains open for more than that time, it will be closed.
System Message: ERROR/3 (<stdin>, line 144); backlink
Unknown interpreted text role "setting".
Other conditions will be supported in the future.
Stack trace dump extension
System Message: ERROR/3 (<stdin>, line 153)
Unknown directive type "module".
.. module:: scrapy.contrib.debug :synopsis: Extensions for debugging Scrapy
Adds a SIGUSR1 signal handler which dumps the stack trace of a runnning Scrapy process when a SIGUSR1 signal is catched. After the stack trace is dumped, the Scrapy process continues to run normally.
The stack trace is sent to standard output, or to the Scrapy log file if :setting:`LOG_STDOUT` is enabled.
System Message: ERROR/3 (<stdin>, line 162); backlink
Unknown interpreted text role "setting".This extension only works on POSIX-compliant platforms (ie. not Windows).
Response soup extension
System Message: ERROR/3 (<stdin>, line 172)
Unknown directive type "module".
.. module:: scrapy.contrib.response.soup :synopsis: Response soup extension
The ResponseSoup extension causes the :class:`~scrapy.http.Response` objects to grow a new method (getsoup()) which returns a cached BeautifulSoup object of their body, and a soup attribute with the same effect. The soup attribute is provided only for convenience, as you cannot pass pass any BeautifulSoup constructor arguments (use the getsoup() method for those cases).
System Message: ERROR/3 (<stdin>, line 177); backlink
Unknown interpreted text role "class".The advantage of using the Response soup extension over instantiating a BeautifulSoup object directly is performance, as BeautifulSoup is known to be very slow.
For example, if you have a downloader middleware and a spider that both need to construct a BeautifulSoup object of the responses, you would be constructing two BeautifulSoup objects unless you use this extension which caches the first one.
Web console extensions
System Message: ERROR/3 (<stdin>, line 199)
Unknown directive type "module".
.. module:: scrapy.contrib.webconsole :synopsis: Contains most built-in web console extensions
Here is a list of built-in web console extensions. For clarity "web console extension" is abbreviated as "WC extension".
For more information see the see the :ref:`web console documentation <topics-webconsole>`.
System Message: ERROR/3 (<stdin>, line 205); backlink
Unknown interpreted text role "ref".Scheduler queue WC extension
System Message: ERROR/3 (<stdin>, line 211)
Unknown directive type "module".
.. module:: scrapy.contrib.webconsole.scheduler :synopsis: Scheduler queue web console extension
Display a list of all pending Requests in the Scheduler queue, grouped by domain/spider.
Spider live stats WC extension
System Message: ERROR/3 (<stdin>, line 222)
Unknown directive type "module".
.. module:: scrapy.contrib.webconsole.livestats :synopsis: Spider live stats web console extension
Display a table with stats of all spider crawled by the current Scrapy run, including:
- Number of items scraped
- Number of pages crawled
- Number of pending requests in the scheduler
- Number of pending requests in the downloader queue
- Number of requests currently being downloaded
Engine status WC extension
System Message: ERROR/3 (<stdin>, line 239)
Unknown directive type "module".
.. module:: scrapy.contrib.webconsole.enginestatus :synopsis: Engine status web console extension
Display the current status of the Scrapy Engine, which is just the output of the Scrapy engine getstatus() method.
Stats collector dump WC extension
System Message: ERROR/3 (<stdin>, line 250)
Unknown directive type "module".
.. module:: scrapy.contrib.webconsole.stats :synopsis: Stats dump web console extension
Display the stats collected so far by the stats collector.
Spider stats WC extension
System Message: ERROR/3 (<stdin>, line 260)
Unknown directive type "module".
.. module:: scrapy.contrib.webconsole.spiderstats :synopsis: Spider stats web console extension
System Message: ERROR/3 (<stdin>, line 265)
No suitable element following "class" directive
.. class:: scrapy.contrib.webconsole.spiderstats.SpiderStats