settings.rst 24.3 KB
Newer Older
P
Pablo Hoffman 已提交
1 2
.. _topics-settings:

3 4 5
========
Settings
========
6 7 8 9

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

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

14
The settings are also the mechanism for selecting the currently active Scrapy
15
project (in case you have many).
16

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

Designating the settings
20 21
========================

22
When you use Scrapy, you have to tell it which settings you're using. You can
P
Pablo Hoffman 已提交
23
do this by using an environment variable, ``SCRAPY_SETTINGS_MODULE``.
24 25 26 27 28

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`_.

29
.. _import search path: http://docs.python.org/2/tutorial/modules.html#the-module-search-path
30 31 32 33

Populating the settings
=======================

34 35 36 37
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:

J
Julia Medina 已提交
38
 1. Command line options (most precedence)
J
Julia Medina 已提交
39 40 41 42
 2. Settings per-spider
 3. Project settings module
 4. Default settings per-command
 5. Default global settings (less precedence)
43

J
Julia Medina 已提交
44 45 46
The population of these settings sources is taken care of internally, but a
manual handling is possible using API calls. See the
:ref:`topics-api-settings` topic for reference.
47

J
Julia Medina 已提交
48
These mechanisms are described in more detail below.
49

J
Julia Medina 已提交
50 51
1. Command line options
-----------------------
52

J
Julia Medina 已提交
53 54 55
Arguments provided by the command line are the ones that take most precedence,
overriding any other options. You can explicitly override one (or more)
settings using the ``-s`` (or ``--set``) command line option.
56

P
Pablo Hoffman 已提交
57 58
.. highlight:: sh

59 60
Example::

61
    scrapy crawl myspider -s LOG_FILE=scrapy.log
62

J
Julia Medina 已提交
63 64 65 66 67 68 69 70
2. Settings per-spider
----------------------

Spiders (See the :ref:`topics-spiders` chapter for reference) can define their
own settings that will take precedence and override the project ones. They can
do so by setting their :attr:`scrapy.spider.Spider.custom_settings` attribute.

3. Project settings module
71
--------------------------
72

73 74 75
The project settings module is the standard configuration file for your Scrapy
project.  It's where most of your custom settings will be populated. For
example:: ``myproject.settings``.
76

J
Julia Medina 已提交
77
4. Default settings per-command
P
Pablo Hoffman 已提交
78 79
-------------------------------

80 81 82 83
Each :doc:`Scrapy tool </topics/commands>` command can have its own default
settings, which override the global default settings. Those custom command
settings are specified in the ``default_settings`` attribute of the command
class.
P
Pablo Hoffman 已提交
84

J
Julia Medina 已提交
85
5. Default global settings
P
Pablo Hoffman 已提交
86
--------------------------
87

88 89
The global defaults are located in the ``scrapy.settings.default_settings``
module and documented in the :ref:`topics-settings-ref` section.
90 91 92 93

How to access settings
======================

P
Pablo Hoffman 已提交
94 95
.. highlight:: python

96 97 98 99 100
Settings can be accessed through the :attr:`scrapy.crawler.Crawler.settings`
attribute of the Crawler that is passed to ``from_crawler`` method in
extensions and middlewares::

    class MyExtension(object):
101

102 103 104 105 106
        @classmethod
        def from_crawler(cls, crawler):
            settings = crawler.settings
            if settings['LOG_ENABLED']:
                print "log is enabled!"
107

108
In other words, settings can be accessed like a dict, but it's usually preferred
P
Pablo Hoffman 已提交
109
to extract the setting in the format you need it to avoid type errors. In order
110 111
to do that you'll have to use one of the methods provided the
:class:`~scrapy.settings.Settings` API.
P
Pablo Hoffman 已提交
112

113 114 115 116
Rationale for setting names
===========================

Setting names are usually prefixed with the component that they configure. For
P
Pablo Hoffman 已提交
117
example, proper setting names for a fictional robots.txt extension would be
118
``ROBOTSTXT_ENABLED``, ``ROBOTSTXT_OBEY``, ``ROBOTSTXT_CACHEDIR``, etc.
119 120 121 122 123 124 125 126


.. _topics-settings-ref:

Built-in settings reference
===========================

Here's a list of all available Scrapy settings, in alphabetical order, along
127
with their default values and the scope where they apply.
128 129 130 131 132 133

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.

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
.. setting:: AWS_ACCESS_KEY_ID

AWS_ACCESS_KEY_ID
-----------------

Default: ``None``

The AWS access key used by code that requires access to `Amazon Web services`_,
such as the :ref:`S3 feed storage backend <topics-feed-storage-s3>`.

.. setting:: AWS_SECRET_ACCESS_KEY

AWS_SECRET_ACCESS_KEY
---------------------

Default: ``None``

The AWS secret key used by code that requires access to `Amazon Web services`_,
such as the :ref:`S3 feed storage backend <topics-feed-storage-s3>`.

154 155 156 157 158
.. setting:: BOT_NAME

BOT_NAME
--------

159
Default: ``'scrapybot'``
160

161 162 163 164 165
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
166
project with the :command:`startproject` command.
167 168 169 170 171 172 173 174 175

.. setting:: CONCURRENT_ITEMS

CONCURRENT_ITEMS
----------------

Default: ``100``

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

178
.. setting:: CONCURRENT_REQUESTS
179

180 181 182 183 184 185 186 187 188 189 190 191
CONCURRENT_REQUESTS
-------------------

Default: ``16``

The maximum number of concurrent (ie. simultaneous) requests that will be
performed by the Scrapy downloader.


.. setting:: CONCURRENT_REQUESTS_PER_DOMAIN

CONCURRENT_REQUESTS_PER_DOMAIN
192 193 194 195
------------------------------

Default: ``8``

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
The maximum number of concurrent (ie. simultaneous) requests that will be
performed to any single domain.

.. setting:: CONCURRENT_REQUESTS_PER_IP

CONCURRENT_REQUESTS_PER_IP
--------------------------

Default: ``0``

The maximum number of concurrent (ie. simultaneous) requests that will be
performed to any single IP. If non-zero, the
:setting:`CONCURRENT_REQUESTS_PER_DOMAIN` setting is ignored, and this one is
used instead. In other words, concurrency limits will be applied per IP, not
per domain.
211

212 213 214 215 216
This setting also affects :setting:`DOWNLOAD_DELAY`:
if :setting:`CONCURRENT_REQUESTS_PER_IP` is non-zero, download delay is
enforced per IP, not per domain.


217 218 219 220 221
.. setting:: DEFAULT_ITEM_CLASS

DEFAULT_ITEM_CLASS
------------------

222
Default: ``'scrapy.item.Item'``
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

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

.. 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`.

.. 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.

252 253 254 255 256
.. setting:: DEPTH_PRIORITY

DEPTH_PRIORITY
--------------

257
Default: ``0``
258

259
An integer that is used to adjust the request priority based on its depth.
260

261
If zero, no priority adjustment is made from depth.
262

263 264 265 266 267 268 269
.. setting:: DEPTH_STATS

DEPTH_STATS
-----------

Default: ``True``

270 271 272 273 274 275 276 277 278 279 280
Whether to collect maximum depth stats.

.. setting:: DEPTH_STATS_VERBOSE

DEPTH_STATS_VERBOSE
-------------------

Default: ``False``

Whether to collect verbose depth stats. If this is enabled, the number of
requests for each depth is collected in the stats.
281

282 283 284 285 286 287 288 289 290
.. setting:: DNSCACHE_ENABLED

DNSCACHE_ENABLED
----------------

Default: ``True``

Whether to enable DNS in-memory cache.

A
Alexander Chekunkov 已提交
291 292 293
.. setting:: DOWNLOADER

DOWNLOADER
A
Alexander Chekunkov 已提交
294
----------
A
Alexander Chekunkov 已提交
295 296 297 298 299

Default: ``'scrapy.core.downloader.Downloader'``

The downloader to use for crawling.

300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
.. 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`.

.. setting:: DOWNLOADER_MIDDLEWARES_BASE

DOWNLOADER_MIDDLEWARES_BASE
---------------------------

315
Default::
316 317 318 319

    {
        'scrapy.contrib.downloadermiddleware.robotstxt.RobotsTxtMiddleware': 100,
        'scrapy.contrib.downloadermiddleware.httpauth.HttpAuthMiddleware': 300,
P
Pablo Hoffman 已提交
320
        'scrapy.contrib.downloadermiddleware.downloadtimeout.DownloadTimeoutMiddleware': 350,
321 322 323
        'scrapy.contrib.downloadermiddleware.useragent.UserAgentMiddleware': 400,
        'scrapy.contrib.downloadermiddleware.retry.RetryMiddleware': 500,
        'scrapy.contrib.downloadermiddleware.defaultheaders.DefaultHeadersMiddleware': 550,
324 325
        'scrapy.contrib.downloadermiddleware.redirect.MetaRefreshMiddleware': 580,
        'scrapy.contrib.downloadermiddleware.httpcompression.HttpCompressionMiddleware': 590,
326 327
        'scrapy.contrib.downloadermiddleware.redirect.RedirectMiddleware': 600,
        'scrapy.contrib.downloadermiddleware.cookies.CookiesMiddleware': 700,
328
        'scrapy.contrib.downloadermiddleware.httpproxy.HttpProxyMiddleware': 750,
329
        'scrapy.contrib.downloadermiddleware.chunked.ChunkedTransferMiddleware': 830,
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
        '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`.

.. setting:: DOWNLOADER_STATS

DOWNLOADER_STATS
----------------

Default: ``True``

Whether to enable downloader stats collection.

.. setting:: DOWNLOAD_DELAY

DOWNLOAD_DELAY
--------------

Default: ``0``

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

360
    DOWNLOAD_DELAY = 0.25    # 250 ms of delay
361

362 363 364 365 366
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`.

367 368 369 370 371
When :setting:`CONCURRENT_REQUESTS_PER_IP` is non-zero, delays are enforced
per ip address instead of per domain.

You can also change this setting per spider by setting ``download_delay``
spider attribute.
372

373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
.. setting:: DOWNLOAD_HANDLERS

DOWNLOAD_HANDLERS
-----------------

Default: ``{}``

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

.. setting:: DOWNLOAD_HANDLERS_BASE

DOWNLOAD_HANDLERS_BASE
----------------------

388
Default::
389 390 391 392 393 394 395 396 397 398

    {
        'file': 'scrapy.core.downloader.handlers.file.FileDownloadHandler',
        'http': 'scrapy.core.downloader.handlers.http.HttpDownloadHandler',
        'https': 'scrapy.core.downloader.handlers.http.HttpDownloadHandler',
        's3': 'scrapy.core.downloader.handlers.s3.S3DownloadHandler',
    }

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

401 402 403 404 405 406 407 408 409
If you want to disable any of the above download handlers you must define them
in your project's :setting:`DOWNLOAD_HANDLERS` setting and assign `None`
as their value.  For example, if you want to disable the file download
handler::

    DOWNLOAD_HANDLERS = {
        'file': None,
    }

410 411 412 413 414 415 416 417 418
.. setting:: DOWNLOAD_TIMEOUT

DOWNLOAD_TIMEOUT
----------------

Default: ``180``

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

419 420 421 422 423 424
.. note::

    This timeout can be set per spider using :attr:`download_timeout`
    spider attribute and per-request using :reqmeta:`download_timeout`
    Request.meta key.

T
tpeng 已提交
425 426 427 428 429
.. setting:: DOWNLOAD_MAXSIZE

DOWNLOAD_MAXSIZE
----------------

T
tpeng 已提交
430
Default: `1073741824` (1024MB)
T
tpeng 已提交
431 432 433 434 435

The maximum response size (in bytes) that downloader will download.

If you want to disable it set to 0.

436 437
.. reqmeta:: download_maxsize

T
tpeng 已提交
438 439 440 441 442 443
.. note::

    This size can be set per spider using :attr:`download_maxsize`
    spider attribute and per-request using :reqmeta:`download_maxsize`
    Request.meta key.

T
tpeng 已提交
444 445
    This feature needs Twisted >= 11.1.

T
tpeng 已提交
446 447 448
.. setting:: DOWNLOAD_WARNSIZE

DOWNLOAD_WARNSIZE
T
tpeng 已提交
449
-----------------
T
tpeng 已提交
450

T
tpeng 已提交
451
Default: `33554432` (32MB)
T
tpeng 已提交
452 453 454 455 456 457 458 459 460 461 462

The response size (in bytes) that downloader will start to warn.

If you want to disable it set to 0.

.. note::

    This size can be set per spider using :attr:`download_warnsize`
    spider attribute and per-request using :reqmeta:`download_warnsize`
    Request.meta key.

T
tpeng 已提交
463 464
    This feature needs Twisted >= 11.1.

465 466 467 468 469
.. setting:: DUPEFILTER_CLASS

DUPEFILTER_CLASS
----------------

470
Default: ``'scrapy.dupefilter.RFPDupeFilter'``
471 472 473

The class used to detect and filter duplicate requests.

474
The default (``RFPDupeFilter``) filters based on request fingerprint using
475 476
the ``scrapy.utils.request.request_fingerprint`` function. In order to change
the way duplicates are checked you could subclass ``RFPDupeFilter`` and
477 478 479
override its ``request_fingerprint`` method. This method should accept
scrapy :class:`~scrapy.http.Request` object and return its fingerprint
(a string).
480

481 482 483 484 485 486 487 488 489 490 491
.. setting:: DUPEFILTER_DEBUG

DUPEFILTER_DEBUG
----------------

Default: ``False``

By default, ``RFPDupeFilter`` only logs the first duplicate request.
Setting :setting:`DUPEFILTER_DEBUG` to ``True`` will make it log all duplicate requests.

.. setting:: EDITOR
P
Pablo Hoffman 已提交
492 493 494 495

EDITOR
------

496 497
Default: `depends on the environment`

P
Pablo Hoffman 已提交
498 499 500 501
The editor to use for editing spiders with the :command:`edit` command. It
defaults to the ``EDITOR`` environment variable, if set. Otherwise, it defaults
to ``vi`` (on Unix systems) or the IDLE editor (on Windows).

502 503 504 505 506 507 508
.. setting:: EXTENSIONS

EXTENSIONS
----------

Default:: ``{}``

509
A dict containing the extensions enabled in your project, and their orders.
510 511 512 513 514 515

.. setting:: EXTENSIONS_BASE

EXTENSIONS_BASE
---------------

P
Pablo Hoffman 已提交
516
Default::
517 518

    {
519
        'scrapy.contrib.corestats.CoreStats': 0,
520
        'scrapy.telnet.TelnetConsole': 0,
521 522
        'scrapy.contrib.memusage.MemoryUsage': 0,
        'scrapy.contrib.memdebug.MemoryDebugger': 0,
P
Pablo Hoffman 已提交
523 524
        'scrapy.contrib.closespider.CloseSpider': 0,
        'scrapy.contrib.feedexport.FeedExporter': 0,
525
        'scrapy.contrib.logstats.LogStats': 0,
P
Pablo Hoffman 已提交
526
        'scrapy.contrib.spiderstate.SpiderState': 0,
527
        'scrapy.contrib.throttle.AutoThrottle': 0,
528 529
    }

530
The list of available extensions. Keep in mind that some of them need to
531
be enabled through a setting. By default, this setting contains all stable
532
built-in extensions.
533 534 535 536 537 538 539 540 541

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

.. setting:: ITEM_PIPELINES

ITEM_PIPELINES
--------------

542 543 544 545 546
Default: ``{}``

A dict containing the item pipelines to use, and their orders. The dict is
empty by default order values are arbitrary but it's customary to define them
in the 0-1000 range.
547

548 549
Lists are supported in :setting:`ITEM_PIPELINES` for backwards compatibility,
but they are deprecated.
550 551 552

Example::

553
   ITEM_PIPELINES = {
554 555
       'mybot.pipelines.validate.ValidateMyItem': 300,
       'mybot.pipelines.validate.StoreMyItem': 800,
556 557 558 559 560 561 562 563 564 565 566
   }

.. setting:: ITEM_PIPELINES_BASE

ITEM_PIPELINES_BASE
-------------------

Default: ``{}``

A dict containing the pipelines enabled by default in Scrapy. You should never
modify this setting in your project, modify :setting:`ITEM_PIPELINES` instead.
567 568 569 570 571 572 573 574

.. setting:: LOG_ENABLED

LOG_ENABLED
-----------

Default: ``True``

P
Pablo Hoffman 已提交
575 576 577 578 579 580 581 582 583 584
Whether to enable logging.

.. setting:: LOG_ENCODING

LOG_ENCODING
------------

Default: ``'utf-8'``

The encoding to use for logging.
585

586
.. setting:: LOG_FILE
587

588 589
LOG_FILE
--------
590 591 592

Default: ``None``

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

595
.. setting:: LOG_LEVEL
596

597 598
LOG_LEVEL
---------
599 600 601

Default: ``'DEBUG'``

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

605 606 607 608 609 610 611
.. setting:: LOG_STDOUT

LOG_STDOUT
----------

Default: ``False``

612 613 614
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.
615

616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
.. setting:: MEMDEBUG_ENABLED

MEMDEBUG_ENABLED
----------------

Default: ``False``

Whether to enable memory debugging.

.. 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']

.. 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`.

.. 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`.

.. 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`.

.. setting:: MEMUSAGE_REPORT

MEMUSAGE_REPORT
---------------

Default: ``False``

Scope: ``scrapy.contrib.memusage``

P
Pablo Hoffman 已提交
695
Whether to send a memory usage report after each spider has been closed.
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717

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

.. 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.

.. setting:: NEWSPIDER_MODULE

NEWSPIDER_MODULE
----------------

Default: ``''``

718
Module where to create new spiders using the :command:`genspider` command.
719 720 721 722 723

Example::

    NEWSPIDER_MODULE = 'mybot.spiders_dev'

724 725 726 727 728 729 730 731 732
.. 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
733
website.
734 735 736

This randomization decreases the chance of the crawler being detected (and
subsequently blocked) by sites which analyze requests looking for statistically
737
significant similarities in the time between their requests.
738 739 740 741 742 743 744

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

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

.. _wget: http://www.gnu.org/software/wget/manual/wget.html

745 746 747 748 749 750 751
.. setting:: REDIRECT_MAX_TIMES

REDIRECT_MAX_TIMES
------------------

Default: ``20``

752
Defines the maximum times a request can be redirected. After this maximum the
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768
request's response is returned as is. We used Firefox default value for the
same task.

.. 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)

.. setting:: REDIRECT_PRIORITY_ADJUST

REDIRECT_PRIORITY_ADJUST
P
Pablo Hoffman 已提交
769
------------------------
770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785

Default: ``+2``

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

.. setting:: ROBOTSTXT_OBEY

ROBOTSTXT_OBEY
--------------

Default: ``False``

Scope: ``scrapy.contrib.downloadermiddleware.robotstxt``

If enabled, Scrapy will respect robots.txt policies. For more information see
786
:ref:`topics-dlmw-robots`
787 788 789 790 791 792 793 794 795 796

.. setting:: SCHEDULER

SCHEDULER
---------

Default: ``'scrapy.core.scheduler.Scheduler'``

The scheduler to use for crawling.

P
Pablo Hoffman 已提交
797
.. setting:: SPIDER_CONTRACTS
798 799 800 801 802 803 804

SPIDER_CONTRACTS
----------------

Default:: ``{}``

A dict containing the scrapy contracts enabled in your project, used for
805
testing spiders. For more info see :ref:`topics-contracts`.
806

P
Pablo Hoffman 已提交
807 808
.. setting:: SPIDER_CONTRACTS_BASE

809 810 811 812 813 814 815 816 817 818 819 820 821
SPIDER_CONTRACTS_BASE
---------------------

Default::

    {
        'scrapy.contracts.default.UrlContract' : 1,
        'scrapy.contracts.default.ReturnsContract': 2,
        'scrapy.contracts.default.ScrapesContract': 3,
    }

A dict containing the scrapy contracts enabled by default in Scrapy. You should
never modify this setting in your project, modify :setting:`SPIDER_CONTRACTS`
822
instead. For more info see :ref:`topics-contracts`.
823

J
Julia Medina 已提交
824 825 826 827 828 829 830 831 832 833
.. setting:: SPIDER_MANAGER_CLASS

SPIDER_MANAGER_CLASS
--------------------

Default: ``'scrapy.spidermanager.SpiderManager'``

The class that will be used for handling spiders, which must implement the
:ref:`topics-api-spidermanager`.

P
Pablo Hoffman 已提交
834 835
.. setting:: SPIDER_MIDDLEWARES

836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
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`.

.. setting:: SPIDER_MIDDLEWARES_BASE

SPIDER_MIDDLEWARES_BASE
-----------------------

Default::

    {
        'scrapy.contrib.spidermiddleware.httperror.HttpErrorMiddleware': 50,
        '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`.

.. 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']

.. setting:: STATS_CLASS

STATS_CLASS
-----------

882
Default: ``'scrapy.statscol.MemoryStatsCollector'``
883

884 885
The class to use for collecting stats, who must implement the
:ref:`topics-api-stats`.
886 887 888 889 890 891

.. setting:: STATS_DUMP

STATS_DUMP
----------

892 893
Default: ``True``

894 895
Dump the :ref:`Scrapy stats <topics-stats>` (to the Scrapy log) once the spider
finishes.
896

897
For more info see: :ref:`topics-stats`.
898 899 900 901 902 903 904 905

.. setting:: STATSMAILER_RCPTS

STATSMAILER_RCPTS
-----------------

Default: ``[]`` (empty list)

P
Pablo Hoffman 已提交
906
Send Scrapy stats after spiders finish scraping. See
907 908 909 910 911 912 913 914 915
:class:`~scrapy.contrib.statsmailer.StatsMailer` for more info.

.. setting:: TELNETCONSOLE_ENABLED

TELNETCONSOLE_ENABLED
---------------------

Default: ``True``

916 917
A boolean which specifies if the :ref:`telnet console <topics-telnetconsole>`
will be enabled (provided its extension is also enabled).
918 919 920 921 922 923

.. setting:: TELNETCONSOLE_PORT

TELNETCONSOLE_PORT
------------------

924
Default: ``[6023, 6073]``
925

926
The port range to use for the telnet console. If set to ``None`` or ``0``, a
927 928 929 930 931 932 933 934 935 936
dynamically assigned port is used. For more info see
:ref:`topics-telnetconsole`.

.. setting:: TEMPLATES_DIR

TEMPLATES_DIR
-------------

Default: ``templates`` dir inside scrapy module

937 938
The directory where to look for templates when creating new projects with
:command:`startproject` command.
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956

.. 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

.. setting:: USER_AGENT

USER_AGENT
----------

957
Default: ``"Scrapy/VERSION (+http://scrapy.org)"``
958

959
The default User-Agent to use when crawling, unless overridden.
960

961
.. _Amazon web services: http://aws.amazon.com/
962 963
.. _breadth-first order: http://en.wikipedia.org/wiki/Breadth-first_search
.. _depth-first order: http://en.wikipedia.org/wiki/Depth-first_search