命令行工具

版本0.10中的新功能。

Scrapy通过scrapy命令行工具进行控制,在这里被称为“Scrapy工具”,以区别于子命令,我们仅仅称子命令为“命令”或“Scrapy命令”。

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

(在1.0中已删除了scrapy deploy命令,以支持独立的scrapyd-deploy请参阅部署项目。)

配置设置

Scrapy将在标准位置的ini风格的scrapy.cfg文件中查找配置参数:

  1. /etc/scrapy.cfgc:\scrapy\scrapy.cfg(系统范围)
  2. ~/.config/scrapy.cfg$XDG_CONFIG_HOME)和~/.scrapy.cfg$HOME)用于全局(用户范围)设置,和
  3. 在scrapy项目根目录下的scrapy.cfg(见下一节)。

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

Scrapy理解并且可以通过一些环境变量配置。目前这些环境变量有:

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工具来控制和管理它们。

For example, to create a new spider:

scrapy genspider mydomain mydomain.com

Some Scrapy commands (like crawl) must be run from inside a Scrapy project. 有关哪些命令必须从项目内部运行,哪些不可以从项目运行的更多信息,请参见下面的命令参考

Also keep in mind that some commands may have slightly different behaviours when running them from inside projects. 例如,如果正在获取的URL与某个特定的Spider相关联,fetch命令将使用spider覆盖的行为(例如user_agent属性来覆盖用户代理)。这是有意的,因为fetch命令就是用于检查spider如何下载页面的。

可用的工具命令

此部分包含可用内置命令的列表,以及一些描述和一些用法示例。记住,你总是可以通过运行下面的命令来获得更多的信息:

scrapy <command> -h

你可以看到所有可用的命令,用:

scrapy -h

有两种命令,只能在Scrapy项目(项目特定命令)内部工作,和没有活动Scrapy项目(全局命令)的情况下工作,虽然它们在项目内部运行时可能会有些许不同(因为他们将使用项目覆盖设置)。

Global commands:

仅用于项目的命令:

startproject

  • 语法: scrapy startproject <project_name> [project_dir]
  • Requires project: no

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

用法示例:

$ scrapy startproject myproject

genspider

  • 语法: scrapy genspider [-t template] <name> <domain>
  • Requires project: no

在当前文件夹或当前项目的spiders文件夹中创建一个新的Spider(如果从项目中调用)。<name>参数设置为Spider的name,而<domain>用于生成Spider的allowed_domainsstart_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'

这只是一个方便的快捷命令,用于创建基于预定义模板的Spider,但当然不是创建Spider的唯一方式。你可以自己创建Spider源代码文件,而不是使用此命令。

crawl

  • 语法: scrapy crawl <spider>
  • Requires project: yes

Start crawling using a spider.

用法示例:

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

check

  • 语法: scrapy check [-l] <spider>
  • Requires project: yes

Run contract checks.

用法示例:

$ 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
  • Requires project: yes

List all available spiders in the current project. The output is one spider per line.

用法示例:

$ scrapy list
spider1
spider2

edit

  • 语法: scrapy edit <spider>
  • Requires project: yes

使用EDITOR设置中定义的编辑器编辑给定的Spider。

此命令仅作为最常见情况的便捷方式提供,开发人员当然可以选择任何工具或IDE来编写和调试他的Spider。

用法示例:

$ scrapy edit spider1

fetch

  • 语法: scrapy fetch <url>
  • Requires project: no

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

这个命令的有趣的事情是它用Spider下载页面的方式获取页面。例如,如果Spider具有覆盖用户代理的USER_AGENT属性,则它将使用该代理。

所以这个命令可以用来“看到”你的Spider如何获取一个页面。

如果在项目外部使用,则不会应用特定的Spider的行为,它将只使用默认的Scrapy下载器设置。

用法示例:

$ 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>
  • Requires project: no

在浏览器中打开给定的URL,这样你的Scrapy Spider将“看到”它。有时,spider会看到与普通用户不同的网页,所以这可以用来检查spider“看到了什么”,并确认它是你期望的。

用法示例:

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

shell

  • 语法: scrapy shell [url]
  • Requires project: no

启动给定URL(如果给定)的Scrapy shell,如果没有给定URL,则为空。还支持UNIX样式的本地文件路径,如相对路径的前缀./../或绝对文件路径。有关详细信息,请参阅Scrapy shell

用法示例:

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

parse

  • 语法:scrapy parse <url> [options]
  • Requires project: yes

使用--callback选项传递的方法获取给定的URL并使用处理它的Spider解析它,如果没有给出则使用parse

Supported options:

  • --spider=SPIDER: bypass spider autodetection and force use of specific spider
  • --a NAME=VALUE: set spider argument (may be repeated)
  • --callback or -c: spider method to use as callback for parsing the response
  • --pipelines: process items through pipelines
  • --rules-r:使用CrawlSpider规则来发现用于解析响应的回调(即Spider方法)
  • --noitems: don’t show scraped items
  • --nolinks: don’t show extracted links
  • --nocolour: avoid using pygments to colorize the output
  • --depth or -d: depth level for which the requests should be followed recursively (default: 1)
  • --verbose or -v: display information for each depth level

用法示例:

$ 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]
  • Requires project: no

获得Scrapy设置的值。

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

用法示例:

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

runspider

  • 语法:scrapy runspider <spider_file.py>
  • Requires project: no

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

用法示例:

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

version

  • 语法:scrapy version [-v]
  • Requires project: no

Prints the Scrapy version. 如果与-v一起使用,它还会打印Python,Twisted和Platform信息,这对于错误报告非常有用。

bench

版本0.17中的新功能。

  • 语法:scrapy bench
  • Requires project: no

运行快速基准测试。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',
    ],
  },
 )