Skip to main content

命令行工具

0.10 新版功能.

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

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

scrapy deploy 命令已在1.0版本中删除,以支持独立 scrapyd-deploy。参见 Deploying your project。)

配置设置

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

  1. /etc/scrapy.cfgc:\scrapy\scrapy.cfg (系统范围),

  2. ~/.config/scrapy.cfg$XDG_CONFIG_HOME)和 ~/.scrapy.cfg$HOME),用于全局(用户范围)设置和

  3. scrapy.cfg 在scrapy项目的根内(见下一节)。

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

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

例如,创建一个新的蜘蛛:

scrapy genspider mydomain mydomain.com

一些Scrapy命令(如 crawl)必须从Scrapy项目内部运行。有关哪些命令必须在项目内部运行的详细信息,请参阅下面的 命令参考

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

可用的工具命令

此部分包含可用内置命令的列表,其中包含描述和一些用法示例。记住,您可以随时通过运行获取有关每个命令的更多信息:

scrapy <command> -h

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

scrapy -h

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

全局命令:

仅项目命令:

startproject

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

  • 需要项目:no

project_dir 目录下创建一个名为 project_name 的新Scrapy项目。如果没有指定 project_dirproject_dir 将与 myproject 相同。

用法示例:

$ scrapy startproject myproject

genspider

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

  • 需要项目:no

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

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

爬行

  • 语法:scrapy crawl <spider>

  • 需要项目:yes

使用蜘蛛开始爬行。

用法示例:

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

检查

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

  • 需要项目:yes

运行合同检查。

用法示例:

$ 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

  • 需要项目:yes

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

用法示例:

$ scrapy list
spider1
spider2

编辑

  • 语法:scrapy edit <spider>

  • 需要项目:yes

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

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

用法示例:

$ scrapy edit spider1

  • 语法:scrapy fetch <url>

  • 需要项目:no

使用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>

  • 需要项目:no

在浏览器中打开给定的URL,因为您的Scrapy蜘蛛会“看到”它。有时,蜘蛛会看到与普通用户不同的网页,因此可以用来检查蜘蛛“看到了什么”并确认它是您期望的。

支持的选项:

  • --spider=SPIDER:绕过蜘蛛自动检测和强制使用特定的蜘蛛

  • --no-redirect:不遵循HTTP 3xx重定向(默认是遵循它们)

用法示例:

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

贝壳

  • 语法:scrapy shell [url]

  • 需要项目:no

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

支持的选项:

  • --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 <url> [options]

  • 需要项目:yes

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

支持的选项:

  • --spider=SPIDER:绕过蜘蛛自动检测和强制使用特定的蜘蛛

  • --a NAME=VALUE:设置蜘蛛参数(可以重复)

  • --callback-c:spider方法用作回调来解析响应

  • --pipelines:通过管道处理项目

  • --rules-r:使用 CrawlSpider 规则来发现用于解析响应的回调(即,spider方法)

  • --noitems:不显示已抓取的项目

  • --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  -----------------------------------------------------------------
[]

设置

  • 语法:scrapy settings [options]

  • 需要项目:no

获取Scrapy设置的值。

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

用法示例:

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

runspider

  • 语法:scrapy runspider <spider_file.py>

  • 需要项目:no

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

用法示例:

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

  • 语法:scrapy version [-v]

  • 需要项目:no

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

板凳

0.17 新版功能.

  • 语法:scrapy bench

  • 需要项目:no

运行快速基准测试。 基准

自定义项目命令

您还可以使用 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',
    ],
  },
 )