本文地址:https://www.jianshu.com/p/5c2995ac8c25
在Scrapy中,写好了Spider和Middleware等基本的处理逻辑后,还有许多其他的功能可以在Settings中来进行设定。
Settings允许你自行定义所有使用的Scrapy模块,包括core,extensions,pipelines和spiders。
Settings本质是提供了一个存储key-value的全局命名空间,你可以从这个命名空间中拿出需要的配置值。并且Settings可以通过多种方法来进行传递。
指定Settings
使用Scrapy必须要告诉它使用哪些设置。可以使用环境变量SCRAPY_SETTINGS_MODULE来进行制定,而且SCRAPY_SETTINGS_MODULE需要在Python的路径语法中,例如myproject.settings。
填充Settings
Scrapy设置的启用和填充可以由不同的机制来执行,并且每种机制都有不一样的优先级。以下是不同的几种机制,优先级从高到低排列:
- 命令行选项(最高优先级)
- 每个
Spider的Settings - 项目的
Settings - 每个命令的默认
Settings - 默认的全局
Settings(最低优先级)
以下是每种机制的详细介绍:
1.命令行选项
在使用命令行时提供的参数拥有最高的优先级,将会覆盖所有其他方式设置的相同Settings选项。你可以使用-s(或者--set)来明确指定覆盖一个或多个Settings。
例子:
scrapy crawl myspider -s LOG_FILE=scrapy.log
2.每个Spider的Settings
在每个Spider中,是可以定义这个Spider所特有的Settings的。只需要在Spider类中,定义好custom_settings这个类属性即可。
例子:
class MySpider(scrapy.Spider):
name = 'myspider'
custom_settings = {
'SOME_SETTING': 'some value',
}
3.项目的Settings模块
项目的Settings是Scrapy项目的标准配置文件,我们大部分的设置都会在这个地方配置好。对于一个标准的Scrapy项目来说,这意味着我们在settings.py这个文件中添加或者修改配置的字段。
这个文件会在创建项目时自动创建。
4.每个命令的默认Settings
每一个Scrapy命令都有各自的默认Settings,会覆盖掉默认的全局设置。这些Settings设定在命令类的default_settings属性中。
5.默认全局Settings
默认的全局变量设定在scrapy.settings.default_settings模块中。
如何获取Settings
在Scrapy中,我们常常需要去获取Settings中的某一个值来进行使用,或者是将我们的自定义Settings写到settings.py文件中,然后在代码中进行获取。
Scrapy提供了一些非常方便的钩子和方法来获得Settings。
在Spider中获取Settings
在Spider中获取Settings非常的方便,直接访问self.settings即可:
class MySpider(scrapy.Spider):
name = 'myspider'
start_urls = ['http://example.com']
def parse(self, response):
print("Existing settings: %s" % self.settings.attributes.keys())
注意:settings属性是在基础的Spider类中的__init__()中设定的,这意味着如果你想要在__init__()中使用settings的话,那么你需要重写from_crawler()方法。
在extensions,middlewares和item pipelines中获取Settings
在extensions,middlewares和item pipelines中想要获取Settings的话,那么就只能使用from_crawler()方法。
from_crawler()是一个类方法,这个方法一般用来生成当前这个组件的实例,在调用的时候会传入crawler参数,通过这个crawler参数为桥梁,我们就可以获取Settings了:
class MyExtension(object):
def __init__(self, log_is_enabled=False):
if log_is_enabled:
print("log is enabled!")
@classmethod
def from_crawler(cls, crawler):
settings = crawler.settings
return cls(settings.getbool('LOG_ENABLED'))
同样要注意的是,由于from_crawler()是用来生成组件的实例的,所以最终需要return一个类的实例,然后把我们要获得的Settings当作参数传递到这个实例中去,最后再在__init__()方法中进行接收。
这就是通过from_crawler()获取Settings的原理了。
内置基础设置(Built-in settings)
Scrapy中定义了许多基础的默认全局Settings,以下是一些常见设置的默认值和作用范围。
这些设置的默认范围指的是只有启用特定的组件,那么这条设置才会生效。
常见设置
-
BOT_NAME
默认值:
'scrapybot'这个
Scrapy项目的Bot名称。将用于在默认状态下构造User-Agent,也用于日志记录。当使用
startproject命令创建项目时,将会自动使用项目名称来填充这个设置。 -
DEFAULT_REQUEST_HEADERS
默认值:
{ 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8', 'Accept-Language': 'en', }Scrapy的Request中默认的请求头,将会在DefaultHeadersMiddleware中被填充。 -
DOWNLOAD_TIMEOUT
默认值:
180Downloader下载的最大超时时间。这个设置可以在每个
Spider中使用download_timeout属性进行设置,也可以在每个Request中可以使用Request.meta中的download_timeout字段进行设置。 -
ROBOTSTXT_OBEY
默认值:
False作用域:
scrapy.downloadermiddlewares.robotstxt如果设置为
True,那么Scrapy将会自动遵守robots.txt协议。注意:由于历史原因,这个值在全局变量中为
False。但是使用startproject命令生成的settings.py中,这个设置的值默认为True。所以如果不希望遵守协议的话,那么需要手动到设置中将这个设置为False。 -
COOKIES_ENABLED
默认值:
True是否开启cookies middleware。如果关闭这个设置的话,请求时将不会发送任何cookies到网站。
并发
-
CONCURRENT_ITEMS
默认值:
100在
Item的处理器中并发处理的最大Item数量。 -
CONCURRENT_REQUESTS
默认值:
16Downloader同时处理Request的最大数量。 -
CONCURRENT_REQUESTS_PER_DOMAIN
默认值:
8任何单个域名同时发起的最大
Request数量。用来控制单个域名的并发量。 -
CONCURRENT_REQUESTS_PER_IP
默认值:
0任何单个
IP同时发起的最大Request数量。如果这个值不为0的话,那么CONCURRENT_REQUESTS_PER_DOMAIN将会被忽略。也就是说,并发量的限制条件,要么只能使用IP,要么只能使用Domain。这一个设置同样会影响
DOWNLOAD_DELAY,使其判断标准变为IP。 -
DOWNLOAD_DELAY
默认值:
0Downloader从同一网站上访问页面应该等待的时间。这个设置常常被用来控制爬取的速度,以免对网站造成太大的压力。这个值的单位为秒,并且可以使用小数。这个值同样被
RANDOMIZE_DOWNLOAD_DELAY所影响。在默认的情况下,Scrapy不会每次都等待一个固定的时间,而是使用一个范围在0.5-1.5之间的值乘以DOWNLOAD_DELAY。当
CONCURRENT_REQUESTS_PER_IP的值不为0时,延迟将按照每个IP判断,而不再是Domain。这个设置可以在
Spider中通过download_delay属性进行设置。 -
RANDOMIZE_DOWNLOAD_DELAY
默认值:
True如果启用,那么
DOWNLOAD_DELAY等待的时间将会随机乘以范围在0.5-1.5之间的一个小数。这个设置的作用是使爬虫的等待时间更有随机性,更难以被检测。
启用组件
-
DOWNLOADER_MIDDLEWARES
默认值:
{} -
DOWNLOADER_MIDDLEWARES_BASE
默认值:
{ 'scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware': 100, 'scrapy.downloadermiddlewares.httpauth.HttpAuthMiddleware': 300, 'scrapy.downloadermiddlewares.downloadtimeout.DownloadTimeoutMiddleware': 350, 'scrapy.downloadermiddlewares.defaultheaders.DefaultHeadersMiddleware': 400, 'scrapy.downloadermiddlewares.useragent.UserAgentMiddleware': 500, 'scrapy.downloadermiddlewares.retry.RetryMiddleware': 550, 'scrapy.downloadermiddlewares.ajaxcrawl.AjaxCrawlMiddleware': 560, 'scrapy.downloadermiddlewares.redirect.MetaRefreshMiddleware': 580, 'scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware': 590, 'scrapy.downloadermiddlewares.redirect.RedirectMiddleware': 600, 'scrapy.downloadermiddlewares.cookies.CookiesMiddleware': 700, 'scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware': 750, 'scrapy.downloadermiddlewares.stats.DownloaderStats': 850, 'scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware': 900, } -
EXTENSIONS
默认值:
{} -
EXTENSIONS_BASE
默认值:
{ 'scrapy.extensions.corestats.CoreStats': 0, 'scrapy.extensions.telnet.TelnetConsole': 0, 'scrapy.extensions.memusage.MemoryUsage': 0, 'scrapy.extensions.memdebug.MemoryDebugger': 0, 'scrapy.extensions.closespider.CloseSpider': 0, 'scrapy.extensions.feedexport.FeedExporter': 0, 'scrapy.extensions.logstats.LogStats': 0, 'scrapy.extensions.spiderstate.SpiderState': 0, 'scrapy.extensions.throttle.AutoThrottle': 0, } -
ITEM_PIPELINES
默认值:
{} -
ITEM_PIPELINES_BASE
默认值:
{} -
SPIDER_MIDDLEWARES
默认值:
{} -
SPIDER_MIDDLEWARES_BASE
默认值:
{ 'scrapy.spidermiddlewares.httperror.HttpErrorMiddleware': 50, 'scrapy.spidermiddlewares.offsite.OffsiteMiddleware': 500, 'scrapy.spidermiddlewares.referer.RefererMiddleware': 700, 'scrapy.spidermiddlewares.urllength.UrlLengthMiddleware': 800, 'scrapy.spidermiddlewares.depth.DepthMiddleware': 900, }
记录日志
在Scrapy中,使用的是Python标准库中的logging来进行日志记录的,所以使用方式也基本相同。
-
LOG_ENABLED
默认值:
True是否开启日志记录。
-
LOG_ENCODING
默认值:
'utf-8'记录日志使用的编码。
-
LOG_FILE
默认值:
None日志输出的文件路径。
-
LOG_FORMAT
默认值:
'%(asctime)s [%(name)s] %(levelname)s: %(message)s'日志记录的格式。
-
LOG_DATEFORMAT
默认值:
'%Y-%m-%d %H:%M:%S'记录日志的时间格式。
-
LOG_LEVEL
默认值:
'DEBUG'输出日志的最小级别,可用的级别有:CRITICAL, ERROR, WARNING, INFO, DEBUG。
-
LOG_STDOUT
默认值:
False如果设置为
True,将会把所有的标准输出重定向到日志中。例如print打印的信息和异常信息。
内存控制
-
MEMDEBUG_ENABLED
默认值:
False是否开启内存调试。
-
MEMDEBUG_NOTIFY
默认值:
[]当开启内存调试的时候,可以在这个列表中设置邮箱地址,那么内存调试的报告将会发送到邮箱中。
例子:
MEMDEBUG_NOTIFY = ['user@example.com'] -
MEMUSAGE_ENABLED
默认值:
True作用域:
scrapy.extensions.memusage是否开启内存使用的扩展。这个扩展会一直跟踪进程的峰值内存使用(写入到stats中),而且它可以在
Scrapy进程使用的内存超过了限制的时候,中止掉进程,并且在这一切发生的时候使用email发出通知。 -
MEMUSAGE_LIMIT_MB
默认值:
0作用域:
scrapy.extensions.memusageScrapy最大允许使用的内存,单位为MB,超过这个值,Scrapy进程将会被终止。如果值为0,那么将被不会进行检查。 -
MEMUSAGE_CHECK_INTERVAL_SECONDS
默认值:
60.0作用域:
scrapy.extensions.memusage每隔多长时间检查一次内存的使用量,单位为秒。
-
MEMUSAGE_NOTIFY_MAIL
默认值:
False作用域:
scrapy.extensions.memusage接收内存使用报告的邮箱地址。
-
MEMUSAGE_WARNING_MB
默认值:
0作用域:
scrapy.extensions.memusage使用内存超过这个值时,将会发出email警告,单位为MB。如果值为0,那么将被不会进行检查。
广度优先和深度优先
-
DEPTH_LIMIT
默认值:
0作用域:
scrapy.spidermiddlewares.depth.DepthMiddleware对于任一网站,允许爬取的最大深度。如果值为0,则不会有任何限制。
-
DEPTH_PRIORITY
默认值:
0作用域:
scrapy.spidermiddlewares.depth.DepthMiddleware用来根据深度调整请求优先级的值。
- 如果为0,则不会有任何优先级的调整。
- 如果值为正数,那么会降低优先级,也就是说深度更深的请求将会排在爬取队列的后方。这也意味着深度较浅的请求将会优先爬取。这通常被用于广度优先爬取(BFO)。
- 如果值为负数,那么会提高优先级,也就是说深度更深的请求会优先爬取。这通常被用于深度优先爬取(DFO)。
-
DEPTH_STATS
默认值:
True作用域:
scrapy.spidermiddlewares.depth.DepthMiddleware是否收集最大深度的统计数据。
-
DEPTH_STATS_VERBOSE
默认值:
False作用域:
scrapy.spidermiddlewares.depth.DepthMiddleware是否收集最大深度的详细统计数据。如果启用,那么每个深度请求的数量将会被收集到数据中。
重试和重定向
-
REDIRECT_ENABLED
默认值:
True是否启用重定向middleware。
-
REDIRECT_MAX_TIMES
默认值:
20请求的最大重定向次数。重定向的次数超过这个值后,相应将被原样返回。
-
REDIRECT_PRIORITY_ADJUST
默认值:
+2作用域:
scrapy.downloadermiddlewares.redirect.RedirectMiddleware用来调整重定向的请求跟原始请求的优先级:
- 值为正数表示重定向的请求优先级更高。
- 值为负数表示原始请求优先级更高。
-
RETRY_ENABLED
默认值:
True是否启用重试middleware。
-
RETRY_TIMES
默认值:
2除了第一次请求外,最大的重试次数。
这个值也可以在
Request.meta中的max_retry_times字段进行设置。max_retry_times的优先级比RETRY_TIMES的优先级更高。 -
RETRY_HTTP_CODES
默认值:
[500, 502, 503, 504, 408]需要重试的响应状态码。
-
RETRY_PRIORITY_ADJUST
默认值:
-1作用域:
scrapy.downloadermiddlewares.retry.RetryMiddleware用来调整重试的请求跟原始请求的优先级:
- 值为正数表示重试的请求优先级更高。
- 值为负数表示原始请求优先级更高。
系列文章: