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

3 4 5
========
Settings
========
6

P
Pablo Hoffman 已提交
7 8 9
.. module:: scrapy.conf
   :synopsis: Settings manager

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

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

17
The settings are also the mechanism for selecting the currently active Scrapy
18
project (in case you have many).
19

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

Designating the settings
23 24
========================

25
When you use Scrapy, you have to tell it which settings you're using. You can
P
Pablo Hoffman 已提交
26
do this by using an environment variable, ``SCRAPY_SETTINGS_MODULE``.
27 28 29 30 31 32 33 34 35 36

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

.. _import search path: http://diveintopython.org/getting_to_know_python/everything_is_an_object.html

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

37 38 39 40 41
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:

 1. Global overrides (most precedence)
42 43 44
 2. Project settings module
 3. Default settings per-command
 4. Default global settings (less precedence)
45

46
These mechanisms are described in more detail below.
47 48 49 50

1. Global overrides
-------------------

51 52
Global overrides are the ones that take most precedence, and are usually
populated by command-line options.
53 54 55 56 57

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

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

P
Pablo Hoffman 已提交
61 62
.. highlight:: sh

63 64
Example::

65
    scrapy crawl domain.com --set LOG_FILE=scrapy.log
66

67 68
2. Project settings module
--------------------------
69

70 71 72
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``.
73

74
3. Default settings per-command
P
Pablo Hoffman 已提交
75 76
-------------------------------

77 78 79 80
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 已提交
81

82
4. Default global settings
P
Pablo Hoffman 已提交
83
--------------------------
84

85 86
The global defaults are located in the ``scrapy.settings.default_settings``
module and documented in the :ref:`topics-settings-ref` section.
87 88 89 90

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

P
Pablo Hoffman 已提交
91 92
.. highlight:: python

P
Pablo Hoffman 已提交
93
Here's an example of the simplest way to access settings from Python code::
94 95 96 97 98

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

P
Pablo Hoffman 已提交
99 100 101 102
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:

103 104
.. class:: Settings()

P
Pablo Hoffman 已提交
105
   There is a (singleton) Settings object automatically instantiated when the
106 107 108
   :mod:`scrapy.conf` module is loaded, and it's usually accessed like this::

   >>> from scrapy.conf import settings
P
Pablo Hoffman 已提交
109

P
Pablo Hoffman 已提交
110
    .. method:: get(name, default=None)
P
Pablo Hoffman 已提交
111

P
Pablo Hoffman 已提交
112
       Get a setting value without affecting its original type.
P
Pablo Hoffman 已提交
113

P
Pablo Hoffman 已提交
114 115
       :param name: the setting name
       :type name: string
P
Pablo Hoffman 已提交
116

P
Pablo Hoffman 已提交
117 118
       :param default: the value to return if no setting is found
       :type default: any
P
Pablo Hoffman 已提交
119

P
Pablo Hoffman 已提交
120
    .. method:: getbool(name, default=False)
P
Pablo Hoffman 已提交
121

P
Pablo Hoffman 已提交
122 123 124
       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````
P
Pablo Hoffman 已提交
125

P
Pablo Hoffman 已提交
126 127
       For example, settings populated through environment variables set to ``'0'``
       will return ``False`` when using this method.
P
Pablo Hoffman 已提交
128

P
Pablo Hoffman 已提交
129 130
       :param name: the setting name
       :type name: string
P
Pablo Hoffman 已提交
131

P
Pablo Hoffman 已提交
132 133
       :param default: the value to return if no setting is found
       :type default: any
P
Pablo Hoffman 已提交
134

P
Pablo Hoffman 已提交
135
    .. method:: getint(name, default=0)
P
Pablo Hoffman 已提交
136

P
Pablo Hoffman 已提交
137
       Get a setting value as an int
P
Pablo Hoffman 已提交
138

P
Pablo Hoffman 已提交
139 140
       :param name: the setting name
       :type name: string
P
Pablo Hoffman 已提交
141

P
Pablo Hoffman 已提交
142 143
       :param default: the value to return if no setting is found
       :type default: any
P
Pablo Hoffman 已提交
144

P
Pablo Hoffman 已提交
145
    .. method:: getfloat(name, default=0.0)
P
Pablo Hoffman 已提交
146

P
Pablo Hoffman 已提交
147
       Get a setting value as a float
P
Pablo Hoffman 已提交
148

P
Pablo Hoffman 已提交
149 150
       :param name: the setting name
       :type name: string
P
Pablo Hoffman 已提交
151

P
Pablo Hoffman 已提交
152 153
       :param default: the value to return if no setting is found
       :type default: any
P
Pablo Hoffman 已提交
154

P
Pablo Hoffman 已提交
155
    .. method:: getlist(name, default=None)
P
Pablo Hoffman 已提交
156

P
Pablo Hoffman 已提交
157 158
       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 split by ",".
P
Pablo Hoffman 已提交
159

P
Pablo Hoffman 已提交
160 161
       For example, settings populated through environment variables set to
       ``'one,two'`` will return a list ['one', 'two'] when using this method.
P
Pablo Hoffman 已提交
162

P
Pablo Hoffman 已提交
163 164 165 166 167
       :param name: the setting name
       :type name: string

       :param default: the value to return if no setting is found
       :type default: any
P
Pablo Hoffman 已提交
168 169


170 171 172 173
Rationale for setting names
===========================

Setting names are usually prefixed with the component that they configure. For
P
Pablo Hoffman 已提交
174
example, proper setting names for a fictional robots.txt extension would be
175
``ROBOTSTXT_ENABLED``, ``ROBOTSTXT_OBEY``, ``ROBOTSTXT_CACHEDIR``, etc.
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190


.. _topics-settings-ref:

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.

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
.. 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>`.

211 212 213 214 215
.. setting:: BOT_NAME

BOT_NAME
--------

216
Default: ``'scrapybot'``
217

218 219 220 221 222
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
223
project with the :command:`startproject` command.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242

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

.. setting:: CONCURRENT_ITEMS

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

Default: ``100``

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

245
.. setting:: CONCURRENT_REQUESTS
246

247 248 249 250 251 252 253 254 255 256 257 258
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
259 260 261 262
------------------------------

Default: ``8``

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
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.
278 279 280 281 282 283 284 285 286

.. setting:: CONCURRENT_SPIDERS

CONCURRENT_SPIDERS
------------------

Default: ``8``

Maximum number of spiders to scrape in parallel.
287 288 289 290 291 292

.. setting:: DEFAULT_ITEM_CLASS

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

293
Default: ``'scrapy.item.Item'``
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312

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

313 314 315 316 317 318 319 320 321 322 323
.. 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.

324 325 326 327 328 329 330 331 332 333
.. 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.

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
.. setting:: DEPTH_PRIORITY

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

Default: ``1``

An integer that is used to set the request priority based on request depth.

To crawl in `breath-first order`_, set :setting:`DEPTH_PRIORITY` to ``1``.

To crawl in `depth-first order`_, set :setting:`DEPTH_PRIORITY` to ``-1``.

To disable any priority adjustment based on depth, set
:setting:`DEPTH_PRIORITY` to ``0``.

350 351 352 353 354 355 356
.. setting:: DEPTH_STATS

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

Default: ``True``

357 358 359 360 361 362 363 364 365 366 367
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.
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397

.. setting:: DOWNLOADER_DEBUG

DOWNLOADER_DEBUG
----------------

Default: ``False``

Whether to enable the Downloader debugging mode.

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

Default:: 

    {
        'scrapy.contrib.downloadermiddleware.robotstxt.RobotsTxtMiddleware': 100,
        'scrapy.contrib.downloadermiddleware.httpauth.HttpAuthMiddleware': 300,
P
Pablo Hoffman 已提交
398
        'scrapy.contrib.downloadermiddleware.downloadtimeout.DownloadTimeoutMiddleware': 350,
399 400 401 402 403
        '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,
404
        'scrapy.contrib.downloadermiddleware.httpproxy.HttpProxyMiddleware': 750,
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
        '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`.

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

438 439 440 441 442
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`.

443
You can also change this setting per spider.
444

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
.. 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
----------------------

Default:: 

    {
        '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
:setting:`DOWNLOAD_HANDLERS` instead. 

473 474 475 476 477 478 479 480 481 482 483 484 485 486
.. setting:: DOWNLOAD_TIMEOUT

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

Default: ``180``

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

.. setting:: DUPEFILTER_CLASS

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

487
Default: ``'scrapy.dupefilter.RFPDupeFilter'``
488 489 490

The class used to detect and filter duplicate requests.

491 492
The default (``RFPDupeFilter``) filters based on request fingerprint using
the ``scrapy.utils.request.request_fingerprint`` function.
493

P
Pablo Hoffman 已提交
494 495 496 497 498 499 500 501 502
.. setting:: EDITOR

EDITOR
------

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

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
.. setting:: ENCODING_ALIASES

ENCODING_ALIASES
----------------

Default: ``{}``

A mapping of custom encoding aliases for your project, where the keys are the
aliases (and must be lower case) and the values are the encodings they map to.

This setting extends the :setting:`ENCODING_ALIASES_BASE` setting which
contains some default mappings.

.. setting:: ENCODING_ALIASES_BASE

ENCODING_ALIASES_BASE
---------------------

Default::

    {
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
        # gb2312 is superseded by gb18030
        'gb2312': 'gb18030',
        'chinese': 'gb18030',
        'csiso58gb231280': 'gb18030',
        'euc- cn': 'gb18030',
        'euccn': 'gb18030',
        'eucgb2312-cn': 'gb18030',
        'gb2312-1980': 'gb18030',
        'gb2312-80': 'gb18030',
        'iso- ir-58': 'gb18030',
        # gbk is superseded by gb18030
        'gbk': 'gb18030',
        '936': 'gb18030',
        'cp936': 'gb18030',
        'ms936': 'gb18030',
        # latin_1 is a subset of cp1252
        'latin_1': 'cp1252',
541 542 543 544 545 546 547
        'iso-8859-1': 'cp1252',
        'iso8859-1': 'cp1252',
        '8859': 'cp1252',
        'cp819': 'cp1252',
        'latin': 'cp1252',
        'latin1': 'cp1252',
        'l1': 'cp1252',
548 549 550 551 552
        # others
        'zh-cn': 'gb18030',
        'win-1251': 'cp1251',
        'macintosh' : 'mac_roman',
        'x-sjis': 'shift_jis',
553 554 555 556 557 558 559 560 561 562 563
    }

The default encoding aliases defined in Scrapy. Don't override this setting in
your project, override :setting:`ENCODING_ALIASES` instead.

The reason why `ISO-8859-1`_ (and all its aliases) are mapped to `CP1252`_ is
due to a well known browser hack. For more information see: `Character
encodings in HTML`_.

.. _ISO-8859-1: http://en.wikipedia.org/wiki/ISO/IEC_8859-1
.. _CP1252: http://en.wikipedia.org/wiki/Windows-1252
P
Pablo Hoffman 已提交
564
.. _Character encodings in HTML: http://en.wikipedia.org/wiki/Character_encodings_in_HTML
565

566 567 568 569 570 571 572 573 574 575 576 577 578 579
.. setting:: EXTENSIONS

EXTENSIONS
----------

Default:: ``{}``

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

.. setting:: EXTENSIONS_BASE

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

P
Pablo Hoffman 已提交
580
Default::
581 582

    {
583
        'scrapy.contrib.corestats.CoreStats': 0,
584 585
        'scrapy.webservice.WebService': 0,
        'scrapy.telnet.TelnetConsole': 0,
586 587
        'scrapy.contrib.memusage.MemoryUsage': 0,
        'scrapy.contrib.memdebug.MemoryDebugger': 0,
P
Pablo Hoffman 已提交
588 589 590
        'scrapy.contrib.closespider.CloseSpider': 0,
        'scrapy.contrib.feedexport.FeedExporter': 0,
        'scrapy.contrib.spidercontext.SpiderContext': 0,
591
        'scrapy.contrib.logstats.LogStats': 0,
592 593
    }

594
The list of available extensions. Keep in mind that some of them need to
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
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>`.

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

.. setting:: LOG_ENABLED

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

Default: ``True``

P
Pablo Hoffman 已提交
624 625 626 627 628 629 630 631 632 633
Whether to enable logging.

.. setting:: LOG_ENCODING

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

Default: ``'utf-8'``

The encoding to use for logging.
634

635
.. setting:: LOG_FILE
636

637 638
LOG_FILE
--------
639 640 641

Default: ``None``

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

644
.. setting:: LOG_LEVEL
645

646 647
LOG_LEVEL
---------
648 649 650

Default: ``'DEBUG'``

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

654 655 656 657 658 659 660
.. setting:: LOG_STDOUT

LOG_STDOUT
----------

Default: ``False``

661 662 663
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.
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 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
.. 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 已提交
744
Whether to send a memory usage report after each spider has been closed.
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766

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: ``''``

767
Module where to create new spiders using the :command:`genspider` command.
768 769 770 771 772

Example::

    NEWSPIDER_MODULE = 'mybot.spiders_dev'

773 774 775 776 777 778 779 780 781 782 783 784 785
.. 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.

This randomization decreases the chance of the crawler being detected (and
subsequently blocked) by sites which analyze requests looking for statistically
786
significant similarities in the time between their requests.
787 788 789 790 791 792 793

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

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
.. 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.

.. 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 已提交
818
------------------------
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834

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
835
:ref:`topics-dlmw-robots`
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 882 883 884 885 886 887 888

.. setting:: SCHEDULER

SCHEDULER
---------

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

The scheduler to use for crawling.

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

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

889 890 891 892 893 894 895 896 897 898 899 900
.. setting:: SQLITE_DB

SQLITE_DB
---------

Default: ``'scrapy.db'``

The location of the project SQLite database, used for storing the spider queue
and other persistent data of the project. If a relative path is given, is taken
relative to the project data dir. For more info see:
:ref:`topics-project-structure`.

901 902 903 904 905
.. setting:: STATS_CLASS

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

906
Default: ``'scrapy.statscol.MemoryStatsCollector'``
907 908 909 910 911 912 913 914 915

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

.. setting:: STATS_DUMP

STATS_DUMP
----------

916 917 918 919 920
Default: ``True``

Dump (to the Scrapy log) the :ref:`Scrapy stats <topics-stats>` collected
during the crawl. The spider-specific stats are logged when the spider is
closed, while the global stats are dumped when the Scrapy process finishes.
921

922
For more info see: :ref:`topics-stats`.
923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939

.. setting:: STATS_ENABLED

STATS_ENABLED
-------------

Default: ``True``

Enable stats collection.

.. setting:: STATSMAILER_RCPTS

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

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

P
Pablo Hoffman 已提交
940
Send Scrapy stats after spiders finish scraping. See
941 942 943 944 945 946 947 948 949
:class:`~scrapy.contrib.statsmailer.StatsMailer` for more info.

.. setting:: TELNETCONSOLE_ENABLED

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

Default: ``True``

950 951
A boolean which specifies if the :ref:`telnet console <topics-telnetconsole>`
will be enabled (provided its extension is also enabled).
952 953 954 955 956 957

.. setting:: TELNETCONSOLE_PORT

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

958
Default: ``[6023, 6073]``
959

960
The port range to use for the telnet console. If set to ``None`` or ``0``, a
961 962 963 964 965 966 967 968 969 970
dynamically assigned port is used. For more info see
:ref:`topics-telnetconsole`.

.. setting:: TEMPLATES_DIR

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

Default: ``templates`` dir inside scrapy module

971 972
The directory where to look for templates when creating new projects with
:command:`startproject` command.
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992

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

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

993
The default User-Agent to use when crawling, unless overridden. 
994

995
.. _Amazon web services: http://aws.amazon.com/
996 997
.. _breadth-first order: http://en.wikipedia.org/wiki/Breadth-first_search
.. _depth-first order: http://en.wikipedia.org/wiki/Depth-first_search