命令行工具¶

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_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 文件夹中创建一个新的爬虫，如果从项目内部调用，则在当前项目的 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：将抓取的项目追加到 FILE 的末尾（使用 - 表示标准输出）。要定义输出格式，请在输出 URI 的末尾设置冒号（即 -o FILE:FORMAT）
--overwrite-output FILE 或 -O FILE：将抓取到的项目数据转储到 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 则为空。还支持 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：将传递给回调请求的其他请求元数据。这必须是有效的 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  -----------------------------------------------------------------
[]

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
需要项目：否

运行快速基准测试。 Benchmarking。

自定义项目命令¶

您还可以通过使用 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` 工具¶