命令行工具¶

Scrapy 通过 scrapy 命令行工具进行控制，这里称为“Scrapy 工具”以区别于子命令，我们通常称之为“命令”或“Scrapy 命令”。

Scrapy工具提供了多个命令，用于不同的目的，每个命令接受一组不同的参数和选项。

（scrapy deploy 命令在1.0版本中已被移除，取而代之的是独立的 scrapyd-deploy。请参阅部署你的项目。）

配置设置¶

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

/etc/scrapy.cfg 或 c:\scrapy\scrapy.cfg（系统范围内），
~/.config/scrapy.cfg ($XDG_CONFIG_HOME) 和 ~/.scrapy.cfg ($HOME) 用于全局（用户范围）设置，以及
scrapy.cfg 位于 Scrapy 项目的根目录中（见下一节）。

这些文件中的设置按以下优先顺序合并：用户定义的值比系统范围的默认值具有更高的优先级，并且在定义时，项目范围的设置将覆盖所有其他设置。

Scrapy 也理解并可以通过许多环境变量进行配置。目前这些是：

SCRAPY_SETTINGS_MODULE (参见指定设置)
SCRAPY_PROJECT (参见在项目之间共享根目录)
SCRAPY_PYTHON_SHELL (参见 Scrapy shell)

Scrapy项目的默认结构¶

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

虽然可以修改，但默认情况下，所有Scrapy项目都具有相同的文件结构，类似于这样：

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

包含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 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属性来覆盖用户代理）。这是有意为之的，因为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 [project_dir]
需要项目：否

创建一个名为 project_name 的新 Scrapy 项目，位于 project_dir 目录下。如果未指定 project_dir，则 project_dir 将与 project_name 相同。

使用示例：

$ scrapy startproject myproject

genspider¶

语法: scrapy genspider [-t template] or URL>
需要项目：否

版本2.6.0新增：能够传递URL而不是域名的功能。

在当前文件夹或当前项目的spiders文件夹中创建一个新的蜘蛛，如果从项目内部调用。参数被设置为蜘蛛的name，而 or URL>用于生成蜘蛛的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 genspider -t crawl scrapyorg scrapy.org
Created spider 'scrapyorg' using template 'crawl'

这只是一个基于预定义模板创建蜘蛛的便捷快捷命令，但肯定不是创建蜘蛛的唯一方法。你可以自己创建蜘蛛源代码文件，而不是使用这个命令。

爬取¶

语法: scrapy crawl
需要项目：是

开始使用爬虫进行爬取。

支持的选项：

-h, --help: 显示帮助信息并退出
-a NAME=VALUE: 设置一个爬虫参数（可以重复使用）
--output FILE 或 -o FILE: 将抓取的项目追加到 FILE 的末尾（使用 - 表示标准输出）。要定义输出格式，请在输出 URI 的末尾设置冒号（即 -o FILE:FORMAT）
--overwrite-output FILE 或 -O FILE: 将抓取的项目转储到文件中，覆盖任何现有文件。要定义输出格式，请在输出URI的末尾设置冒号（即 -O FILE:FORMAT）

使用示例：

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

$ scrapy crawl -o myfile:csv myspider
[ ... myspider starts crawling and appends the result to the file myfile in csv format ... ]

$ scrapy crawl -O myfile:json myspider
[ ... myspider starts crawling and saves the result in myfile in json format overwriting the original content... ]

检查¶

语法: scrapy check [-l]
需要项目：是

运行合同检查。

使用示例：

$ 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

列表¶

语法: scrapy list
需要项目：是

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

使用示例：

$ scrapy list
spider1
spider2

编辑¶

语法: scrapy edit
需要项目：是

使用在EDITOR环境变量中定义的编辑器编辑给定的蜘蛛，或者（如果未设置）使用EDITOR设置。

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

使用示例：

$ scrapy edit spider1

获取¶

语法: scrapy fetch
需要项目：否

使用Scrapy下载器下载给定的URL并将内容写入标准输出。

这个命令的有趣之处在于，它以蜘蛛下载页面的方式获取页面。例如，如果蜘蛛有一个USER_AGENT属性覆盖了用户代理，它将使用那个属性。

因此，此命令可用于“查看”您的蜘蛛将如何抓取某个页面。

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

支持的选项：

--spider=SPIDER: 绕过蜘蛛自动检测并强制使用特定的蜘蛛
--headers: 打印响应的HTTP头信息，而不是响应的主体内容
--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)']}

查看¶

语法: scrapy view
需要项目：否

在浏览器中打开给定的URL，就像你的Scrapy爬虫“看到”的那样。有时爬虫看到的页面与普通用户不同，因此这可以用来检查爬虫“看到”的内容并确认它是否符合你的预期。

支持的选项：

--spider=SPIDER: 绕过蜘蛛自动检测并强制使用特定的蜘蛛
--no-redirect: 不跟随HTTP 3xx重定向（默认是跟随它们）

使用示例：

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

shell¶

语法: scrapy shell [url]
需要项目：否

启动Scrapy shell以处理给定的URL（如果提供了URL），如果没有提供URL则为空。还支持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')

解析¶

语法: scrapy parse [options]
需要项目：是

获取给定的URL并使用处理它的爬虫进行解析，使用通过--callback选项传递的方法，如果未提供则使用parse。

支持的选项：

--spider=SPIDER: 绕过蜘蛛自动检测并强制使用特定的蜘蛛
--a NAME=VALUE: 设置爬虫参数（可以重复使用）
--callback 或 -c: 用于解析响应的蜘蛛方法作为回调
--meta 或 -m: 额外的请求元数据，将传递给回调请求。这必须是一个有效的json字符串。示例：–meta=’{“foo” : “bar”}’
--cbkwargs: 将传递给回调函数的额外关键字参数。这必须是一个有效的json字符串。示例：–cbkwargs=’{“foo” : “bar”}’
--pipelines: 通过管道处理项目
--rules 或 -r: 使用 CrawlSpider 规则来发现用于解析响应的回调（即爬虫方法）
--noitems: 不显示抓取的项目
--nolinks: 不显示提取的链接
--nocolour: 避免使用pygments对输出进行着色
--depth 或 -d: 请求应递归跟随的深度级别（默认值：1）
--verbose 或 -v: 显示每个深度级别的信息
--output 或 -o: 将抓取的项目转储到文件中

新版本2.3新增。

使用示例：

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

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

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

设置¶

语法: scrapy settings [options]
需要项目：否

获取Scrapy设置的值。

如果在项目内部使用，它将显示项目设置值，否则它将显示该设置的默认Scrapy值。

示例用法：

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

runspider¶

语法: scrapy runspider
需要项目：否

运行一个包含在Python文件中的蜘蛛，而无需创建项目。

示例用法：

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

版本¶

语法: scrapy version [-v]
需要项目：否

打印Scrapy版本。如果与-v一起使用，它还会打印Python、Twisted和平台信息，这对于错误报告非常有用。

基准¶

语法: scrapy bench
需要项目：否

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

自定义项目命令¶

你也可以通过使用 COMMANDS_MODULE 设置来添加你的自定义项目命令。查看 scrapy/commands 中的Scrapy命令，了解如何实现你的命令的示例。

命令模块¶

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

一个用于查找自定义Scrapy命令的模块。这用于为您的Scrapy项目添加自定义命令。

示例：

COMMANDS_MODULE = "mybot.commands"

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

你也可以通过在库的入口点中添加一个scrapy.commands部分来从外部库中添加Scrapy命令，具体是在库的setup.py文件中。

以下示例添加了 my_command 命令：

from setuptools import setup, find_packages

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

命令行工具¶

配置设置¶

Scrapy项目的默认结构¶

在项目之间共享根目录¶

使用 scrapy 工具¶

创建项目¶

控制项目¶

可用工具命令¶

startproject¶

genspider¶

爬取¶

检查¶

列表¶

编辑¶

获取¶

查看¶

shell¶

解析¶

设置¶

runspider¶

版本¶

基准¶

自定义项目命令¶

命令模块¶

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

使用 `scrapy` 工具¶