scrapy 命令行工具

命令行工具（Command line tools）

0.10 版本新功能

Scrapy 是通过 scrapy 命令行工具来控制的，在这里被称为“Scrapy工具”，以区别于子命令，对于子命令，我们称为“命令”或“Scrapy命令”。

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

（scrapy deploy 命令已经在1.0中被删除，有利于独立的scrapyd-deploy。请参阅 部署项目?。）

配置设置

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

1. /etc/scrapy.cfg 或 c:\scrapy\scrapy.cfg (全系统)
2. ~/.config/scrapy.cfg ($XDG_CONFIG_HOME) 和 ~/.scrapy.cfg ($HOME)（用户范围）
3. scrapy.cfg 在 scrapy 项目的根目录（见下一节）。

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

Scrapy 也可以通过配置一些环境变量。目前这些是：

• SCRAPY_SETTINGS_MODULE （请参阅 指定设置）
• SCRAPY_PROJECT
• SCRAPY_PYTHON_SHELL (请参阅 Scrapy终端（Scrapy shell）)

Scrapy项目的默认结构

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

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

scrapy.cfg
myproject/
    __init__.py
    items.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 了解哪些命令必须从项目内部运行的信息，哪些不是。

还要记住，一些命令在从项目中运行时可能有稍微不同的行为。例如，如果正在获取的 URL 与某个特定的爬虫关联，fetch 命令将使用爬虫覆盖的行为（例如 user_agent属性覆盖用户代理）。这是有意的，因为 fetch 命令用于检查爬虫程序如何下载页面。

 

此部分包含可用内置命令的列表，以及一些描述和一些用法示例。记住，您总是可以通过运行以下命令获得有关每个命令的更多信息：

scrapy <command> -h

您可以看到所有可用的命令：

scrapy -h

Scrapy 提供了两种类型的命令。一种必须在 Scrapy 项目中运行(针对项目(Project-specific)的命令)，另外一种则不需要(全局命令)。全局命令在项目中运行时的表现可能会与在非项目中运行有些许差别(因为可能会使用项目的设定)。

全局命令：

• startproject
• genspider
• settings
• runspider
• shell
• fetch
• view
• version

项目（Project-only）命令：

• crawl
• check
• list
• edit
• parse
• bench

startproject

• 语法：`scrapy startproject <project_name> [project_dir]
• 是否需要项目：否

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

用法示例：

$ scrapy startproject myproject

genspider

• 语法：scrapy genspider [-t template] <name> <domain>
• 是否需要项目：否

在当前文件夹或当前项目的 spiders 文件夹中创建一个新的爬虫，如果从项目内部调用。 <name> 参数设置为爬虫的名称，而 <domain> 用于生成 allowed_domains 和 start_urls spider 的属性。

用法示例：

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

使用爬虫开始爬行。

用法示例：

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

check

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

运行 contract 检查。用法示例：

$ 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? 设置中定义的编辑器编辑给定的蜘蛛。此命令仅作为最常见情况的方便快捷方式提供，开发人员当然可以选择任何工具或IDE来编写和调试他的爬虫。用法示例：

$ scrapy edit spider1

fetch

• 语法：scrapy fetch <url>
• 是否需要项目：否

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

这个命令的有趣的地方是它使用爬虫（spider）的方式提取的网页。例如，如果爬虫使用USER_AGENT属性覆盖了 User Agent，则它将使用覆盖后的代理。

因此，您可以使用该命令来查看爬虫如何获取某个特定页面。

如果在项目外部使用该命令，它将只使用默认的 Scrapy下载器设置。

支持的选项：

• --spider = SPIDER：绕过 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 获取到的形式展现。有时，爬虫会看到网页与普通用户不一样，因此可以用来检查爬虫“看到了什么”并确认它是您期望的。

用法示例：

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

shell

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

以给定的URL(如果给出)或者空(没有给出URL)启动Scrapy shell。还支持UNIX样式的本地文件路径，带有./或../前缀的相对或绝对文件路径。有关详细信息，请参阅 Scrapy终端（Scrapy shell）。

支持的选项：

• --spider = SPIDER：绕过 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 并使用响应的spider处理解析，如果您提供 --callback 选项，则使用spider的该方法处理，否则使用 parse 。

支持的选项：

• --spider = SPIDER：绕过spider自动检测，强制使用特定的spider
• --a NAME = VALUE：设置spider的参数（可能会重复）
• --callback或-c：spider方法用作解析响应（response）的回调函数
• --pipelines：通过管道（pipeline）中处理项目
• --rules或-r：使用 CrawlSpider 规则来发现用于解析响应的回调函数
• --noitems：不显示抓取的Item
• --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]
• 是否需要项目：否

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

用法示例：

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

runspider

• 语法：scrapy runspider <spider_file.py>
• 是否需要项目：否

运行一个自包含在Python文件中的spider，而不必创建一个项目。

用法示例：

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

version

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

打印Scrapy版本。如果与 -v 一起使用，它还会打印Python，Twisted和Platform信息，这对于bug提交非常有用。

bench

0.17版本新功能。

• 语法：`scrapy bench
• 是否需要项目：否

运行快速基准测试。Benchmarking。

自定义项目命令

 

您也可以通过 COMMANDS_MODULE 来添加您自己的项目命令。您可以以 scrapy/commands 中Scrapy commands 为例来了解如何实现您的命令。

COMMANDS_MODULE

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

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

例子：

COMMANDS_MODULE = 'mybot.commands'

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

注意！

这是一个实验功能，请谨慎使用。

您还可以添加Scrapy命令从外部库中通过在库 setup.py 文件的入口点中添加 scrapy.commands部分。以下示例添加 my_command 命令：

from setuptools import setup, find_packages

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