25 KiB

Raw Blame History

Settings

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

Unknown directive type "module".

.. module:: scrapy.conf
   :synopsis: Settings manager

The Scrapy settings allows you to customize the behaviour of all Scrapy components, including the core, extensions, pipelines and spiders themselves.

The infrastructure of setting provides a global namespace of key-value mappings that the code can use to pull configuration values from. The settings can be populated through different mechanisms, which are described below.

The settings is also the mechanism for selecting the currently active Scrapy project (in case you have many).

For a list of available built-in settings see: :ref:`topics-settings-ref`.

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

Unknown interpreted text role "ref".

Designating the settings

When you use Scrapy, you have to tell it which settings you're using. You can do this by using an environment variable, SCRAPY_SETTINGS_MODULE, or the --settings argument of the :doc:`scrapy-ctl.py script </topics/scrapy-ctl>`.

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

Unknown interpreted text role "doc".

The value of SCRAPY_SETTINGS_MODULE should be in Python path syntax, e.g. myproject.settings. Note that the settings module should be on the Python import search path.

Populating the settings

Settings can be populated using different mechanisms, each of which having a different precedence. Here is the list of them in decreasing order of precedence:

Global overrides (most precedence)

Environment variables

scrapy_settings

Default settings per-command

Default global settings (less precedence)

This mechanisms are described with more detail below.

1. Global overrides

Global overrides are the ones that takes most precedence, and are usually populated by command line options.

Example::

>>> from scrapy.conf import settings
>>> settings.overrides['LOG_ENABLED'] = True

You can also override one (or more) settings from command line using the --set command line argument.

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

Unknown directive type "highlight".

.. highlight:: sh

Example:

scrapy-ctl.py crawl domain.com --set LOG_FILE=scrapy.log

2. Environment variables

You can populate settings using environment variables prefixed with SCRAPY_. For example, to change the log file location un Unix systems:

$ export SCRAPY_LOG_FILE=scrapy.log
$ scrapy-ctl.py crawl example.com

In Windows systems, you can change the environment variables from the Control Panel following these guidelines.

3. scrapy_settings

scrapy_settings is the standard configuration file for your Scrapy project. It's where most of your custom settings will be populated.

4. Default settings per-command

Each :doc:`/topics/scrapy-ctl` command can have its own default settings, which override the global default settings. Those custom command settings are located inside the scrapy.conf.commands module, or you can specify custom settings to override per-comand inside your project, by writing them in the module referenced by the :setting:`COMMANDS_SETTINGS_MODULE` setting. Those settings will take more

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

Unknown interpreted text role "doc".

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

Unknown interpreted text role "setting".

5. Default global settings

The global defaults are located in scrapy.conf.default_settings and documented in the :ref:`topics-settings-ref` section.

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

Unknown interpreted text role "ref".

How to access settings

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

Unknown directive type "highlight".

.. highlight:: python

Here's an example of the simplest way to access settings from Python code:

>>> from scrapy.conf import settings
>>> print settings['LOG_ENABLED']
True

In other words, settings can be accesed like a dict, but it's usually preferred to extract the setting in the format you need it to avoid type errors. In order to do that you'll have to use one of the following methods:

The Settings object is automatically instantiated when the :mod:`scrapy.conf` module is loaded, and it's usually accessed like this:

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

Unknown interpreted text role "mod".

>>> from scrapy.conf import settings

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

Unknown directive type "method".

.. method:: Settings.get(name, default=None)

   Get a setting value without affecting its original type.

   ``name`` is a string with the setting name

   ``default`` is the value to return if no setting is found

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

Unknown directive type "method".

.. method:: Settings.getbool(name, default=False)

   Get a setting value as a boolean. For example, both ``1`` and ``'1'``, and
   ``True`` return ``True``, while ``0``, ``'0'``, ``False`` and ``None``
   return ``False````

   For example, settings populated through environment variables set to ``'0'``
   will return ``False`` when using this method.

   ``name`` is a string with the setting name

   ``default`` is the value to return if no setting is found

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

Unknown directive type "method".

.. method:: Settings.getint(name, default=0)

   Get a setting value as an int

   ``name`` is a string with the setting name

   ``default`` is the value to return if no setting is found

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

Unknown directive type "method".

.. method:: Settings.getfloat(name, default=0.0)

   Get a setting value as a float

   ``name`` is a string with the setting name

   ``default`` is the value to return if no setting is found

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

Unknown directive type "method".

.. method:: Settings.getlist(name, default=None)

   Get a setting value as a list. If the setting original type is a list it
   will be returned verbatim. If it's a string it will be splitted by ",".

   For example, settings populated through environment variables set to
   ``'one,two'`` will return a list ['one', 'two'] when using this method.

   ``name`` is a string with the setting name

   ``default`` is the value to return if no setting is found

Rationale for setting names

Setting names are usually prefixed with the component that they configure. For example, proper setting names for a fictional robots.txt extension would be ROBOTSTXT_ENABLED, ROBOTSTXT_OBEY, ROBOTSTXT_CACHEDIR, etc.

Built-in settings reference

Here's a list of all available Scrapy settings, in alphabetical order, along with their default values and the scope where they apply.

The scope, where available, shows where the setting is being used, if it's tied to any particular component. In that case the module of that component will be shown, typically an extension, middleware or pipeline. It also means that the component must be enabled in order for the setting to have any effect.

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

Unknown directive type "setting".

.. setting:: BOT_NAME

BOT_NAME

Default: scrapybot

The name of the bot implemented by this Scrapy project (also known as the project name). This will be used to construct the User-Agent by default, and also for logging.

It's automatically populated with your project name when you create your project with the :doc:`scrapy-ctl.py </topics/scrapy-ctl>` startproject command.

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

Unknown interpreted text role "doc".

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

Unknown directive type "setting".

.. setting:: BOT_VERSION

BOT_VERSION

Default: 1.0

The version of the bot implemented by this Scrapy project. This will be used to construct the User-Agent by default.

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

Unknown directive type "setting".

.. setting:: COMMANDS_MODULE

COMMANDS_MODULE

Default: '' (empty string)

A module to use for looking for custom Scrapy commands. This is used to add custom command for your Scrapy project.

Example:

COMMANDS_MODULE = 'mybot.commands'

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

Unknown directive type "setting".

.. setting:: COMMANDS_SETTINGS_MODULE

COMMANDS_SETTINGS_MODULE

Default: '' (empty string)

A module to use for looking for custom Scrapy command settings.

Example:

COMMANDS_SETTINGS_MODULE = 'mybot.conf.commands'

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

Unknown directive type "setting".

.. setting:: CONCURRENT_ITEMS

CONCURRENT_ITEMS

Default: 100

Maximum number of concurrent items (per response) to process in parallel in the Item Processor (also known as the :ref:`Item Pipeline <topics-item-pipeline>`).

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: CONCURRENT_REQUESTS_PER_SPIDER

CONCURRENT_REQUESTS_PER_SPIDER

Default: 8

Specifies how many concurrent (ie. simultaneous) requests will be performed per open spider.

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

Unknown directive type "setting".

.. setting:: CONCURRENT_SPIDERS

CONCURRENT_SPIDERS

Default: 8

Maximum number of spiders to scrape in parallel.

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

Unknown directive type "setting".

.. setting:: COOKIES_DEBUG

COOKIES_DEBUG

Default: False

Enable debugging message of Cookies Downloader Middleware.

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

Unknown directive type "setting".

.. setting:: DEFAULT_ITEM_CLASS

DEFAULT_ITEM_CLASS

Default: 'scrapy.item.Item'

The default class that will be used for instantiating items in the :ref:`the Scrapy shell <topics-shell>`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: DEFAULT_REQUEST_HEADERS

DEFAULT_REQUEST_HEADERS

Default:

{
    'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
    'Accept-Language': 'en',
}

The default headers used for Scrapy HTTP Requests. They're populated in the :class:`~scrapy.contrib.downloadermiddleware.defaultheaders.DefaultHeadersMiddleware`.

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

Unknown interpreted text role "class".

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

Unknown directive type "setting".

.. setting:: DEFAULT_RESPONSE_ENCODING

DEFAULT_RESPONSE_ENCODING

Default: 'ascii'

The default encoding to use for :class:`~scrapy.http.TextResponse` objects (and subclasses) when no encoding is declared and no encoding could be inferred from the body.

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

Unknown interpreted text role "class".

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

Unknown directive type "setting".

.. setting:: DEPTH_LIMIT

DEPTH_LIMIT

Default: 0

The maximum depth that will be allowed to crawl for any site. If zero, no limit will be imposed.

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

Unknown directive type "setting".

.. setting:: DEPTH_STATS

DEPTH_STATS

Default: True

Whether to collect depth stats.

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

Unknown directive type "setting".

.. setting:: DOWNLOADER_DEBUG

DOWNLOADER_DEBUG

Default: False

Whether to enable the Downloader debugging mode.

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

Unknown directive type "setting".

.. setting:: DOWNLOADER_MIDDLEWARES

DOWNLOADER_MIDDLEWARES

Default:: {}

A dict containing the downloader middlewares enabled in your project, and their orders. For more info see :ref:`topics-downloader-middleware-setting`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: DOWNLOADER_MIDDLEWARES_BASE

DOWNLOADER_MIDDLEWARES_BASE

Default:

{
    'scrapy.contrib.downloadermiddleware.robotstxt.RobotsTxtMiddleware': 100,
    'scrapy.contrib.downloadermiddleware.httpauth.HttpAuthMiddleware': 300,
    'scrapy.contrib.downloadermiddleware.useragent.UserAgentMiddleware': 400,
    'scrapy.contrib.downloadermiddleware.retry.RetryMiddleware': 500,
    'scrapy.contrib.downloadermiddleware.defaultheaders.DefaultHeadersMiddleware': 550,
    'scrapy.contrib.downloadermiddleware.redirect.RedirectMiddleware': 600,
    'scrapy.contrib.downloadermiddleware.cookies.CookiesMiddleware': 700,
    'scrapy.contrib.downloadermiddleware.httpproxy.HttpProxyMiddleware': 750,
    'scrapy.contrib.downloadermiddleware.httpcompression.HttpCompressionMiddleware': 800,
    'scrapy.contrib.downloadermiddleware.stats.DownloaderStats': 850,
    'scrapy.contrib.downloadermiddleware.httpcache.HttpCacheMiddleware': 900,
}

A dict containing the downloader middlewares enabled by default in Scrapy. You should never modify this setting in your project, modify :setting:`DOWNLOADER_MIDDLEWARES` instead. For more info see :ref:`topics-downloader-middleware-setting`.

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

Unknown interpreted text role "setting".

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: DOWNLOADER_STATS

DOWNLOADER_STATS

Default: True

Whether to enable downloader stats collection.

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

Unknown directive type "setting".

.. setting:: DOWNLOAD_DELAY

DOWNLOAD_DELAY

Default: 0

The amount of time (in secs) that the downloader should wait before downloading consecutive pages from the same spider. This can be used to throttle the crawling speed to avoid hitting servers too hard. Decimal numbers are supported. Example:

DOWNLOAD_DELAY = 0.25    # 250 ms of delay

This setting is also affected by the :setting:`RANDOMIZE_DOWNLOAD_DELAY` setting (which is enabled by default). By default, Scrapy doesn't wait a fixed amount of time between requests, but uses a random interval between 0.5 and 1.5 * :setting:`DOWNLOAD_DELAY`.

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

Unknown interpreted text role "setting".

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

Unknown interpreted text role "setting".

Another way to change the download delay (per spider, instead of globally) is by using the download_delay spider attribute, which takes more precedence than this setting.

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

Unknown directive type "setting".

.. setting:: DOWNLOAD_TIMEOUT

DOWNLOAD_TIMEOUT

Default: 180

The amount of time (in secs) that the downloader will wait before timing out.

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

Unknown directive type "setting".

.. setting:: DUPEFILTER_CLASS

DUPEFILTER_CLASS

Default: 'scrapy.contrib.dupefilter.RequestFingerprintDupeFilter'

The class used to detect and filter duplicate requests.

The default (RequestFingerprintDupeFilter) filters based on request fingerprint (using scrapy.utils.request.request_fingerprint) and grouping per domain.

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

Unknown directive type "setting".

.. setting:: EXTENSIONS

EXTENSIONS

Default:: {}

A dict containing the extensions enabled in your project, and their orders.

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

Unknown directive type "setting".

.. setting:: EXTENSIONS_BASE

EXTENSIONS_BASE

Default:

{
    'scrapy.contrib.corestats.CoreStats': 0,
    'scrapy.management.web.WebConsole': 0,
    'scrapy.management.telnet.TelnetConsole': 0,
    'scrapy.contrib.webconsole.scheduler.SchedulerQueue': 0,
    'scrapy.contrib.webconsole.livestats.LiveStats': 0,
    'scrapy.contrib.webconsole.spiderctl.Spiderctl': 0,
    'scrapy.contrib.webconsole.enginestatus.EngineStatus': 0,
    'scrapy.contrib.webconsole.stats.StatsDump': 0,
    'scrapy.contrib.memusage.MemoryUsage': 0,
    'scrapy.contrib.memdebug.MemoryDebugger': 0,
    'scrapy.contrib.closedomain.CloseDomain': 0,
}

The list of available extensions. Keep in mind that some of them need need to be enabled through a setting. By default, this setting contains all stable built-in extensions.

For more information See the :ref:`extensions user guide <topics-extensions>` and the :ref:`list of available extensions <topics-extensions-ref>`.

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

Unknown interpreted text role "ref".

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: GROUPSETTINGS_ENABLED

GROUPSETTINGS_ENABLED

Default: False

Whether to enable group settings where spiders pull their settings from.

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

Unknown directive type "setting".

.. setting:: GROUPSETTINGS_MODULE

GROUPSETTINGS_MODULE

Default: '' (empty string)

The module to use for pulling settings from, if the group settings is enabled.

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

Unknown directive type "setting".

.. setting:: ITEM_PIPELINES

ITEM_PIPELINES

Default: []

The item pipelines to use (a list of classes).

Example:

ITEM_PIPELINES = [
    'mybot.pipeline.validate.ValidateMyItem',
    'mybot.pipeline.validate.StoreMyItem'
]

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

Unknown directive type "setting".

.. setting:: LOG_ENABLED

LOG_ENABLED

Default: True

Whether to enable logging.

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

Unknown directive type "setting".

.. setting:: LOG_ENCODING

LOG_ENCODING

Default: 'utf-8'

The encoding to use for logging.

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

Unknown directive type "setting".

.. setting:: LOG_FILE

LOG_FILE

Default: None

File name to use for logging output. If None, standard error will be used.

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

Unknown directive type "setting".

.. setting:: LOG_LEVEL

LOG_LEVEL

Default: 'DEBUG'

Minimum level to log. Available levels are: CRITICAL, ERROR, WARNING, INFO, DEBUG. For more info see :ref:`topics-logging`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: LOG_STDOUT

LOG_STDOUT

Default: False

If True, all standard output (and error) of your process will be redirected to the log. For example if you print 'hello' it will appear in the Scrapy log.

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

Unknown directive type "setting".

.. setting:: MAIL_FROM

MAIL_FROM

Default: 'scrapy@localhost'

Email to use as sender address for sending emails using the :ref:`Scrapy e-mail sending facility <topics-email>`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: MAIL_HOST

MAIL_HOST

Default: 'localhost'

Host to use for sending emails using the :ref:`Scrapy e-mail sending facility <topics-email>`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: MEMDEBUG_ENABLED

MEMDEBUG_ENABLED

Default: False

Whether to enable memory debugging.

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

Unknown directive type "setting".

.. setting:: MEMDEBUG_NOTIFY

MEMDEBUG_NOTIFY

Default: []

When memory debugging is enabled a memory report will be sent to the specified addresses if this setting is not empty, otherwise the report will be written to the log.

Example:

MEMDEBUG_NOTIFY = ['user@example.com']

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

Unknown directive type "setting".

.. setting:: MEMUSAGE_ENABLED

MEMUSAGE_ENABLED

Default: False

Scope: scrapy.contrib.memusage

Whether to enable the memory usage extension that will shutdown the Scrapy process when it exceeds a memory limit, and also notify by email when that happened.

See :ref:`topics-extensions-ref-memusage`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: MEMUSAGE_LIMIT_MB

MEMUSAGE_LIMIT_MB

Default: 0

Scope: scrapy.contrib.memusage

The maximum amount of memory to allow (in megabytes) before shutting down Scrapy (if MEMUSAGE_ENABLED is True). If zero, no check will be performed.

See :ref:`topics-extensions-ref-memusage`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: MEMUSAGE_NOTIFY_MAIL

MEMUSAGE_NOTIFY_MAIL

Default: False

Scope: scrapy.contrib.memusage

A list of emails to notify if the memory limit has been reached.

Example:

MEMUSAGE_NOTIFY_MAIL = ['user@example.com']

See :ref:`topics-extensions-ref-memusage`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: MEMUSAGE_REPORT

MEMUSAGE_REPORT

Default: False

Scope: scrapy.contrib.memusage

Whether to send a memory usage report after each domain has been closed.

See :ref:`topics-extensions-ref-memusage`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: MEMUSAGE_WARNING_MB

MEMUSAGE_WARNING_MB

Default: 0

Scope: scrapy.contrib.memusage

The maximum amount of memory to allow (in megabytes) before sending a warning email notifying about it. If zero, no warning will be produced.

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

Unknown directive type "setting".

.. setting:: NEWSPIDER_MODULE

NEWSPIDER_MODULE

Default: ''

Module where to create new spiders using the genspider command.

Example:

NEWSPIDER_MODULE = 'mybot.spiders_dev'

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

Unknown directive type "setting".

.. setting:: RANDOMIZE_DOWNLOAD_DELAY

RANDOMIZE_DOWNLOAD_DELAY

Default: True

If enabled, Scrapy will wait a random amount of time (between 0.5 and 1.5 * :setting:`DOWNLOAD_DELAY`) while fetching requests from the same spider.

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

Unknown interpreted text role "setting".

This randomization decreases the chance of the crawler being detected (and subsequently blocked) by sites which analyze requests looking for statistically significant similarities in the time between their times.

The randomization policy is the same used by wget --random-wait option.

If :setting:`DOWNLOAD_DELAY` is zero (default) this option has no effect.

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

Unknown interpreted text role "setting".

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

Unknown directive type "setting".

.. setting:: REDIRECT_MAX_TIMES

REDIRECT_MAX_TIMES

Default: 20

Defines the maximun times a request can be redirected. After this maximun the request's response is returned as is. We used Firefox default value for the same task.

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

Unknown directive type "setting".

.. setting:: REDIRECT_MAX_METAREFRESH_DELAY

REDIRECT_MAX_METAREFRESH_DELAY

Default: 100

Some sites use meta-refresh for redirecting to a session expired page, so we restrict automatic redirection to a maximum delay (in seconds)

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

Unknown directive type "setting".

.. setting:: REDIRECT_PRIORITY_ADJUST

REDIRECT_PRIORITY_ADJUST

Default: +2

Adjust redirect request priority relative to original request. A negative priority adjust means more priority.

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

Unknown directive type "setting".

.. setting:: REQUEST_HANDLERS

REQUEST_HANDLERS

Default: {}

A dict containing the request downloader handlers enabled in your project. See REQUEST_HANDLERS_BASE for example format.

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

Unknown directive type "setting".

.. setting:: REQUEST_HANDLERS_BASE

REQUEST_HANDLERS_BASE

Default:

{
    'file': 'scrapy.core.downloader.handlers.file.download_file',
    'http': 'scrapy.core.downloader.handlers.http.download_http',
    'https': 'scrapy.core.downloader.handlers.http.download_http',
}

A dict containing the request download handlers enabled by default in Scrapy. You should never modify this setting in your project, modify :setting:`REQUEST_HANDLERS` instead.

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

Unknown interpreted text role "setting".

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

Unknown directive type "setting".

.. setting:: REQUESTS_QUEUE_SIZE

REQUESTS_QUEUE_SIZE

Default: 0

Scope: scrapy.contrib.spidermiddleware.limit

If non zero, it will be used as an upper limit for the amount of requests that can be scheduled per domain.

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

Unknown directive type "setting".

.. setting:: ROBOTSTXT_OBEY

ROBOTSTXT_OBEY

Default: False

Scope: scrapy.contrib.downloadermiddleware.robotstxt

If enabled, Scrapy will respect robots.txt policies. For more information see :ref:`topics-dlmw-robots`

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: SCHEDULER

SCHEDULER

Default: 'scrapy.core.scheduler.Scheduler'

The scheduler to use for crawling.

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

Unknown directive type "setting".

.. setting:: SCHEDULER_ORDER

SCHEDULER_ORDER

Default: 'DFO'

Scope: scrapy.core.scheduler

The order to use for the crawling scheduler. Available orders are:

'BFO': Breadth-first order - typically consumes more memory but reaches most relevant pages earlier.
'DFO': Depth-first order - typically consumes less memory than but takes longer to reach most relevant pages.

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

Unknown directive type "setting".

.. setting:: SCHEDULER_MIDDLEWARES

SCHEDULER_MIDDLEWARES

Default:: {}

A dict containing the scheduler middlewares enabled in your project, and their orders.

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

Unknown directive type "setting".

.. setting:: SCHEDULER_MIDDLEWARES_BASE

SCHEDULER_MIDDLEWARES_BASE

Default:

SCHEDULER_MIDDLEWARES_BASE = {
    'scrapy.contrib.schedulermiddleware.duplicatesfilter.DuplicatesFilterMiddleware': 500,
}

A dict containing the scheduler middlewares enabled by default in Scrapy. You should never modify this setting in your project, modify :setting:`SCHEDULER_MIDDLEWARES` instead.

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

Unknown interpreted text role "setting".

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

Unknown directive type "setting".

.. setting:: SPIDER_MIDDLEWARES

SPIDER_MIDDLEWARES

Default:: {}

A dict containing the spider middlewares enabled in your project, and their orders. For more info see :ref:`topics-spider-middleware-setting`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: SPIDER_MIDDLEWARES_BASE

SPIDER_MIDDLEWARES_BASE

Default:

{
    'scrapy.contrib.spidermiddleware.httperror.HttpErrorMiddleware': 50,
    'scrapy.contrib.itemsampler.ItemSamplerMiddleware': 100,
    'scrapy.contrib.spidermiddleware.requestlimit.RequestLimitMiddleware': 200,
    'scrapy.contrib.spidermiddleware.offsite.OffsiteMiddleware': 500,
    'scrapy.contrib.spidermiddleware.referer.RefererMiddleware': 700,
    'scrapy.contrib.spidermiddleware.urllength.UrlLengthMiddleware': 800,
    'scrapy.contrib.spidermiddleware.depth.DepthMiddleware': 900,
}

A dict containing the spider middlewares enabled by default in Scrapy. You should never modify this setting in your project, modify :setting:`SPIDER_MIDDLEWARES` instead. For more info see :ref:`topics-spider-middleware-setting`.

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

Unknown interpreted text role "setting".

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: SPIDER_MODULES

SPIDER_MODULES

Default: []

A list of modules where Scrapy will look for spiders.

Example:

SPIDER_MODULES = ['mybot.spiders_prod', 'mybot.spiders_dev']

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

Unknown directive type "setting".

.. setting:: SPIDER_SCHEDULER

SPIDER_SCHEDULER

Default: 'scrapy.contrib.spiderscheduler.FifoSpiderScheduler'

The Spider Scheduler to use. The spider scheduler returns the next spider to scrape.

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

Unknown directive type "setting".

.. setting:: STATS_CLASS

STATS_CLASS

Default: 'scrapy.stats.collector.MemoryStatsCollector'

The class to use for collecting stats (must implement the Stats Collector API, or subclass the StatsCollector class).

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

Unknown directive type "setting".

.. setting:: STATS_DUMP

STATS_DUMP

Default: False

Dump (to log) domain-specific stats collected when a domain is closed, and all global stats when the Scrapy process finishes (ie. when the engine is shutdown).

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

Unknown directive type "setting".

.. setting:: STATS_ENABLED

STATS_ENABLED

Default: True

Enable stats collection.

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

Unknown directive type "setting".

.. setting:: STATSMAILER_RCPTS

STATSMAILER_RCPTS

Default: [] (empty list)

Send Scrapy stats after domains finish scrapy. See :class:`~scrapy.contrib.statsmailer.StatsMailer` for more info.

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

Unknown interpreted text role "class".

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

Unknown directive type "setting".

.. setting:: TELNETCONSOLE_ENABLED

TELNETCONSOLE_ENABLED

Default: True

Scope: scrapy.management.telnet

A boolean which specifies if the telnet management console will be enabled (provided its extension is also enabled).

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

Unknown directive type "setting".

.. setting:: TELNETCONSOLE_PORT

TELNETCONSOLE_PORT

Default: 6023

The port to use for the telnet console. If set to None or 0, a dynamically assigned port is used. For more info see :ref:`topics-telnetconsole`.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: TEMPLATES_DIR

TEMPLATES_DIR

Default: templates dir inside scrapy module

The directory where to look for template when creating new projects with :doc:`scrapy-ctl.py startproject </topics/scrapy-ctl>` command.

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

Unknown interpreted text role "doc".

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

Unknown directive type "setting".

.. setting:: URLLENGTH_LIMIT

URLLENGTH_LIMIT

Default: 2083

Scope: contrib.spidermiddleware.urllength

The maximum URL length to allow for crawled URLs. For more information about the default value for this setting see: http://www.boutell.com/newfaq/misc/urllength.html

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

Unknown directive type "setting".

.. setting:: USER_AGENT

USER_AGENT

Default: "%s/%s" % (BOT_NAME, BOT_VERSION)

The default User-Agent to use when crawling, unless overrided.

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

Unknown directive type "setting".

.. setting:: WEBCONSOLE_ENABLED

WEBCONSOLE_ENABLED

Default: True

A boolean which specifies if the web management console will be enabled (provided its extension is also enabled).

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

Unknown directive type "setting".

.. setting:: WEBCONSOLE_LOGFILE

WEBCONSOLE_LOGFILE

Default: None

A file to use for logging HTTP requests made to the web console. If unset web the log is sent to standard scrapy log.

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

Unknown directive type "setting".

.. setting:: WEBCONSOLE_PORT

WEBCONSOLE_PORT

Default: 6080

The port to use for the web console. If set to None or 0, a dynamically assigned port is used. For more info see :ref:`topics-webconsole`.

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

Unknown interpreted text role "ref".

</html>

25 KiB Raw Blame History

Settings

Designating the settings

Populating the settings

1. Global overrides

2. Environment variables

3. scrapy_settings

4. Default settings per-command

5. Default global settings

How to access settings

Rationale for setting names

Built-in settings reference

BOT_NAME

BOT_VERSION

COMMANDS_MODULE

COMMANDS_SETTINGS_MODULE

CONCURRENT_ITEMS

CONCURRENT_REQUESTS_PER_SPIDER

CONCURRENT_SPIDERS

COOKIES_DEBUG

DEFAULT_ITEM_CLASS

DEFAULT_REQUEST_HEADERS

DEFAULT_RESPONSE_ENCODING

DEPTH_LIMIT

DEPTH_STATS

DOWNLOADER_DEBUG

DOWNLOADER_MIDDLEWARES

DOWNLOADER_MIDDLEWARES_BASE

DOWNLOADER_STATS

DOWNLOAD_DELAY

DOWNLOAD_TIMEOUT

DUPEFILTER_CLASS

EXTENSIONS

EXTENSIONS_BASE

GROUPSETTINGS_ENABLED

GROUPSETTINGS_MODULE

ITEM_PIPELINES

LOG_ENABLED

LOG_ENCODING

LOG_FILE

LOG_LEVEL

LOG_STDOUT

MAIL_FROM

MAIL_HOST

MEMDEBUG_ENABLED

MEMDEBUG_NOTIFY

MEMUSAGE_ENABLED

MEMUSAGE_LIMIT_MB

MEMUSAGE_NOTIFY_MAIL

MEMUSAGE_REPORT

MEMUSAGE_WARNING_MB

NEWSPIDER_MODULE

RANDOMIZE_DOWNLOAD_DELAY

REDIRECT_MAX_TIMES

REDIRECT_MAX_METAREFRESH_DELAY

REDIRECT_PRIORITY_ADJUST

REQUEST_HANDLERS

REQUEST_HANDLERS_BASE

REQUESTS_QUEUE_SIZE

ROBOTSTXT_OBEY

SCHEDULER

SCHEDULER_ORDER

SCHEDULER_MIDDLEWARES

SCHEDULER_MIDDLEWARES_BASE

SPIDER_MIDDLEWARES

SPIDER_MIDDLEWARES_BASE

SPIDER_MODULES

SPIDER_SCHEDULER

STATS_CLASS

STATS_DUMP

STATS_ENABLED

STATSMAILER_RCPTS

TELNETCONSOLE_ENABLED

TELNETCONSOLE_PORT

TEMPLATES_DIR

URLLENGTH_LIMIT

USER_AGENT

WEBCONSOLE_ENABLED

WEBCONSOLE_LOGFILE

WEBCONSOLE_PORT

25 KiB

Raw Blame History