命令行工具

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 项目根目录内的 scrapy.cfg（见下一节）。

这些文件中的设置按列出的优先级顺序合并：用户定义的值高于系统范围的默认值，而项目范围的设置（如果定义）将覆盖所有其他设置。

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 文件所在的目录称为 项目根目录（project root directory）。该文件包含定义项目设置的 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 目录下创建一个名为 myproject 的 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_name> [project_dir]
需要项目: 否

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

用法示例

$ scrapy startproject myproject

genspider

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

版本 2.6.0 新增：增加了传递 URL 而不是域名的能力。

在当前文件夹或当前项目的 spiders 文件夹中创建新的爬虫，如果从项目内部调用的话。<name> 参数被设置为爬虫的 name，而 <domain 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'

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

crawl

语法: scrapy crawl <spider>
需要项目: 是

使用指定的爬虫开始抓取。

支持的选项

-h, --help: 显示帮助消息并退出
-a NAME=VALUE: 设置爬虫参数（可重复）
--output FILE 或 -o FILE: 将抓取的 item 追加到 FILE 末尾（使用 - 表示标准输出）。要定义输出格式，请在输出 URI 末尾设置冒号（例如 -o FILE:FORMAT）
--overwrite-output FILE 或 -O FILE: 将抓取的 item 写入 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... ]

check

语法: scrapy check [-l] <spider>
需要项目: 是

运行契约检查。

用法示例

$ 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
需要项目: 是

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

用法示例

$ scrapy list
spider1
spider2

edit

语法: scrapy edit <spider>
需要项目: 是

使用 EDITOR 环境变量或（如果未设置）EDITOR 设置中定义的编辑器编辑给定的爬虫。

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

用法示例

$ scrapy edit spider1

fetch

语法: scrapy fetch <url>
需要项目: 否

使用 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)']}

view

语法: scrapy view <url>
需要项目: 否

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

支持的选项

--spider=SPIDER: 绕过爬虫自动检测，强制使用指定的爬虫
--no-redirect: 不遵循 HTTP 3xx 重定向（默认为遵循）

用法示例

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

shell

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

启动给定 URL（如果给定）的 Scrapy shell，如果未给定 URL 则启动空 shell。还支持 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]
需要项目: 是

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

支持的选项

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

版本 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  -----------------------------------------------------------------
[]

settings

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

获取 Scrapy 设置的值。

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

用法示例

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

runspider

语法: scrapy runspider <spider_file.py>
需要项目: 否

运行一个包含在 Python 文件中的自包含爬虫，无需创建项目。

用法示例

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

version

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

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

bench

语法: scrapy bench
需要项目: 否

运行快速性能测试。性能测试。

自定义项目命令

你还可以通过使用 COMMANDS_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",
        ],
    },
)

命令行工具

配置设置

Scrapy 项目的默认结构

在项目之间共享根目录

使用 scrapy 工具

创建项目

控制项目

可用的工具命令

startproject

genspider

crawl

check

list

edit

fetch

view

shell

parse

settings

runspider

version

bench

自定义项目命令

COMMANDS_MODULE

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

使用 `scrapy` 工具