Scrapy1.5基本概念（一）——命令行工具

最新推荐文章于 2022-08-13 15:18:29 发布

Regan-Hmily-Du

最新推荐文章于 2022-08-13 15:18:29 发布

阅读量305

点赞数

分类专栏： Scrapy 文章标签： Scrapy

Scrapy 专栏收录该内容

16 篇文章 0 订阅

订阅专栏

本文为译文，原文见地址：https://docs.scrapy.org/en/latest/topics/commands.html

命令行工具

于版本0.10新增。

通过scrapy命令行工具可以控制Scrapy，这里将其称为“Scrapy tool”，以便将其与子命令区分开来，子命令我们将其称为“commands”或者“Scrapy Commands”。

处于多种目的，Scrapy工具提供了几个命令，并且每个命令接受不同的参数和可选项。

（scrapy deploy命令已经在1.0版本中被移除了，取而代之的是scrapyd-deploy。可以查阅创建你的工程一文。）

配置选项

Scrapy将在标准的位置，找到ini样式的文件scrapy.cfg，并在文件中查找配置参数：

/etc/scrapy.cfg或者c:\scrapy\scrapy.cfg（系统级的），
~/.config/scrapy.cfg( $XDG_CONFIG_HOME</kbd>)和<kbd>~/.scrapy.cfg</kbd>(<kbd>$ HOME)支持全局（用户级的）设置，以及
scrapy.cfg在Scrapy项目的根目录下（见下一部分）。

这些文件将按照顺序组合成一个列表：用户定义的值优先级高于系统级默认值，项目级的设置被定义后将会覆盖所有配置项。

Scrapy也能通过许多环境变量进行配置。目前有：

SCRAPY_SETTINGS_MODULE（见Designating the settings）
SCRAPY_PROJECT
SCRAPY_PYTHON_SHELL（见Scrapy shell）

Scrapy工程的默认结构

在深入研究命令行工具及其子命令之前，让我们先了解Scrapy项目的目录结构。

尽管目录结构能被修改，但是默认情况下，所有Scrapy项目都有相同的文件结构，与下面类似：

scrapy.cfg
myproject/
	__init__.py
	item.py
	middlewares.py
	pipelines.py
	settings.py
	spiders/
		__init__.py
		spider1.py
		spider2.py
		...

scrapy.cfg所在的目录，即为项目的根目录。scrapy.cfg文件中包含了项目设置的python模块的名称。示例如下：

[settings]
default = myproject.settings

使用scrapy工具

你可以不带参数地运行Scrapy工具，它将打印一些使用帮助和可用的命令：

Scrapy X.Y - no active project

Usage:
	scrapy <command> [options] [args]

Available commands:
	crawl		Run a spider
	fetch		Fetch a URL using the Scrapy downloader
[...]

Scrapy你正处于一个Scrapy项目，那么第一行将打印当前活动的项目。在这个示例中，它是从项目外部运行的。如果从项目内部运行，就会打印出这样的东西：

Scrapy X.Y - project: myproject

Usage:
	scrapy <command> [options] [args]

[...]

创建工程

使用scrapy工具的第一件事是创建你的Scrapy项目：

scrapy startproject myproject [project_dir]

这条命令将在project_dir目录下创建一个Scrapy项目。如果project_dir没有被指定，project_dir将会与myproject赋值一样。

下一步，你将进入这个新项目的文件夹中：

cd project_dir

然后你就可以使用scrapy命令来管理和控制你的项目。

控制工程

你可以在你的项目内部，使用scrapy命令来管理和控制它。

举个栗子，创建一个新的爬虫：

scrapy genspider mydomain mydomain.com

一些Scrapy命令（比如crawl）必须在一个Scrapy项目中运行。有关哪些命令必须在项目内部运行，哪些不能从项目内部运行的更多信息，请参阅下面的命令相关。

请记住，一些命令在项目的内部运行时，可能会稍微有一点不同的行为。举个栗子，如果正在获取的url与某个特定的爬虫关联，fetch命令将使用被爬虫覆盖的行为（比如user_agent属性来覆盖user-agent）。这是有意的，因为fetch命令用于检查爬虫如何下载页面。

可用的工具命令

这一节包含了一组可用的内置命令的描述以及一些使用示例。请记住，你可能总是希望获取每个命令的更多信息，你可以运行：

scrapy <command> -h

并且你可以查看可用的命令：

scrapy -h

这是两种不同的命令，一个是仅在Scrapy项目（项目特定的命令）内部才会工作，一个可以在没有Scrapy项目（全局命令）下工作，尽管在项目内部运行时，它们的行为可能略有不同（因为它们将使用项目覆盖设置）。

全局命令：

startproject
genspider
settings
runspider
shell
fetch
view
version

项目级命令：

crawl
check
list
edit
parse
bench

startproject

语法：scrapy startproject <projct_name> [project_dir]
需要工程：no

创建一个新的Scrapy项目，名称为project_name，在project_dir目录下。如果project_dir没有被指定，那么project_dir的值将与project_name一致。

使用示例：

$ scrapy startproject myproject

genspider

语法：scrapy genspider [-t template] <name> <domain>
需要工程：no

在当前文件夹创建一个新的爬虫，或者如果在一个项目的内部调用此命令，则在当前工程的spiders文件夹下创建一个新的爬虫。参数被设置为爬虫的name，同时被用来生成爬虫的属性：allowed_domains和start_urls。

使用示例：

$ scrapy genspider -l
Available templates:
	basic
	crawl
	csvfeed
	xmlfeed

$ scrapy genspider example example.com
Created spider 'example' using template 'basic'

$ scrapy gensipder -t crawl scrapyorg scrapy.org
Created spider 'scrapyorg' using template 'crawl'

这只是一个基于预定义模板创建爬虫的快捷命令，但需要注意的是，这并不是创建爬虫的唯一方式。你也可以自己创建爬虫源代码文件。

crawl

语法：scrapy crawl <spider>
需要工程：yes

使用一个爬虫开始爬取。

使用示例：

scrapy crawl myspider
[ ... myspider starts crawling ... ]

check

语法：scrapy check [-l] <spider>
需要工程：yes

运行约束的检查。

使用示例：

$ scrapy check -l
first_spider
	* parse
	* parse_item
second_spider
	* parse
	* parse_item

$ scrapy check
[FAILED] first_spider:parse_item
>>> 'RetailPricex' field is missing

[FAILED] first_spider:parse
>>> Returned 92 requests, expected 0..4

list

语法：scrapy list
需要工程：yes

列出当前项目的所有可用爬虫。每行输出就是一个爬虫。

使用示例：

$ scrapy list
spider1
spider2

edit

语法：scrapy edit <spider>
需要工程：yes

使用环境变量EDITOR定义或者（如果没有设置环境变量）EDITOR设置项定义的编辑器，编辑给定的爬虫。

此命令仅作为最常见情况下的快捷方式才会提供，开发人员当然可以选择任何工具或IDE来编写和调试爬虫。

使用示例：

$ scrapy edit spider1

fetch

语法：scrapy fetch <url>
需要工程：no

使用Scrapy下载器对给定的URL进行下载，并且将内容写入标准输出中。

这个命令的有趣之处在于，它获取了爬虫将如何下载页面。例如，如果爬虫具有覆盖用户代理的USER_AGENT属性，它将使用该属性。

因此，这个命令可以用来“查看”你的爬虫是如何爬取网页的。

如果在一个项目外部使用，则不会应用到特定的爬虫行为，并且它只会使用默认的Scrapy下载器的设置。

支持参数：

–spider=SPIDER：忽略爬虫的自动检测，并且强制使用特定的爬虫。
–headers：打印响应对象的HTTP头，而不是相应的body。
–no-redirect：不会跟踪HTTP 3xx的重定向（默认会跟踪）。

使用示例：

$ scrapy fetch --nolog http://www.example.com/some/page.html
[ ... html content here ... ]

$ scrapy fetch --nolog --headers http://www.example.com/
{'Accept-Ranges': ['bytes'],
 'Age': ['1263   '],
 'Connection': ['close     '],
 'Content-Length': ['596'],
 'Content-Type': ['text/html; charset=UTF-8'],
 'Date': ['Wed, 18 Aug 2010 23:59:46 GMT'],
 'Etag': ['"573c1-254-48c9c87349680"'],
 'Last-Modified': ['Fri, 30 Jul 2010 15:30:18 GMT'],
 'Server': ['Apache/2.2.3 (CentOS)']}

view

语法：scrapy view <url>
需要工程：no

在浏览器中打开给定的URL，就像你的Scrapy中的爬虫会“看到”的一样。有时候爬虫查看页面的方式与普通用户不同，因此这可以用于检查爬虫“看到”的内容，并确认它是你所期望的。

支持参数：

–spider=SPIDER：忽略爬虫的自动检测，并且强制使用特定的爬虫。
–no-redirect：不会跟踪HTTP 3xx的重定向（默认会跟踪）。

使用示例：

$ scrapy view http://www.example.com/some/page.html
[ ... browser starts ... ]

shell

语法：scrapy shell [url]
需要工程：no

开启Scrapy shell，给定的URL（如果给了的话）返回Response对象，或者为没有给定URL的返回None。还支持UNIX风格的本地文件路径，支持./或者…/的相对路径或者绝对路径。查看Scrapy shell获取更多信息。

支持参数：

–spider=SPIDER：忽略爬虫的自动检测，并且强制使用特定的爬虫。
–c code：在shell中评估代码，打印器结果和退出。
–no-redirect：不会跟踪HTTP 3xx的重定向（默认会跟踪）；这只会影响在命令行中作为参数传递的URL；一旦进入shell，fetch(url)在默认情况下仍然遵循HTTP重定向。

使用示例：

$ scrapy shell http://www.example.com/some/page.html
[ ... scrapy shell starts ... ]

$ scrapy shell --nolog http://www.example.com/ -c '(response.status, response.url)'
(200, 'http://www.example.com/')

# shell follows HTTP redirects by default
$ scrapy shell --nolog http://httpbin.org/redirect-to?url=http%3A%2F%2Fexample.com%2F -c '(response.status, response.url)'
(200, 'http://example.com/')

# you can disable this with --no-redirect
# (only for the URL passed as command line argument)
$ scrapy shell --no-redirect --nolog http://httpbin.org/redirect-to?url=http%3A%2F%2Fexample.com%2F -c '(response.status, response.url)'
(302, 'http://httpbin.org/redirect-to?url=http%3A%2F%2Fexample.com%2F')

parse

语法：scrapy parse <url> [options]
需要工程：yes

获取给定的URL并使用处理它的爬虫来解析它，使用传递的方法–callback，或者在没有给定的时候使用parse。

支持参数：

–spider=SPIDER：忽略爬虫的自动检测，并且强制使用特定的爬虫。
–a NAME=VALUE：设置爬虫参数（可以被替换）。
–callback或者-c：爬虫函数，就像是回调函数，用来解析响应对象。
–meta或者-m：附加的请求meta，将被传递给回调请求。这必须是一个有效的json字符串。例如：-meta=’{“foo”:“bar”}’。
–pipelines：通过管道来处理数据项
–rules或者-r：使用CrawlSpider规则来发现回调函数（比如爬虫函数），用于解析响应对象。
–noitems：不显示爬取的数据项。
–nolinks：不显示提取的连接。
–nocolour：避免使用pygments对输出进行着色。
–depth或者-d：递归地追踪请求的深度级别（默认为1）。
–verbose或者-v：显示每个深度等级的信息。

使用示例：

$ scrapy parse http://www.example.com/ -c parse_item
[ ... scrapy log lines crawling example.com spider ... ]

>>> STATUS DEPTH LEVEL 1 <<<
# Scraped Items  ------------------------------------------------------------
[{'name': u'Example item',
 'category': u'Furniture',
 'length': u'12 cm'}]

# Requests  -----------------------------------------------------------------
[]

settings

语法：scrapy settings [options]
需要工程：no

获取Scrapy配置项的值。

如果在项目内部使用这个命令，那么将显示项目的配置项和值；否则将显示Scrapy的默认配置值。

使用示例：

$ scrapy settings --get BOT_NAME
scrapybot
$ scrapy settings --get DOWNLOAD_DELAY
0

runspider

语法：scrapy runspider <spider_file.py>
需要工程：no

运行在Python文件中包含的某个爬虫，而不必创建一个工程。

使用示例：

$ scrapy runspider myspider.py
[ ... spider starts crawling ... ]

version

语法：scrapy version [-v]
需要工程：no

打印Scrapy版本。如果使用-v，那么也会打印Python、Twisted和Platform的信息，这对于bug报告是非常有用的（比如版本兼容测试报告）。

bench

语法：scrapy bench
需要工程：no

运行一个快速的基准测试。详情见Benchmarking。

自定义的工程命令

你也可以通过设置项目配置的COMMAND_MODULE值，来添加你自定义的命令。查看scrapy/commands的例子，你可以更清晰看到如何实现你自己的Scrapy命令。

COMMANDS_MODULE

默认值：’’（空字符串）

这个模块用于查找自定义的Scrapy命令。这被用来在你的Scrapy项目中添加自定义命令。

举个栗子：

COMMANDS_MODULE = 'mybot.commands'

通过setup.py注册命令入口点

注意：这是一个实验中的特性，请谨慎使用。

你也可以通过在库setup.py的入口点中添加一个scrapy.commands节点，以便从外部库中添加Scrapy命令。

下面的示例添加了my_command命令：

from setuptools import setup, find_packages

setup(name='scrapy-mymodule',
	entry_points={
		'scrapy.commands': [
			'my_command=my_scrapy_module.commands:MyCommand',
		],
	},
)

Regan-Hmily-Du

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Scrapy1.5基本概念（一）——命令行工具

本文为译文，原文见地址：https://docs.scrapy.org/en/latest/topics/commands.html命令行工具于版本0.10新增。通过scrapy命令行工具可以控制Scrapy，这里将其称为“Scrapy tool”，以便将其与子命令区分开来，子命令我们将其称为“commands”或者“Scrapy Commands”。处于多种目的，Scrapy工具...
复制链接

扫一扫

专栏目录