Command line tool

版本0.10中的新功能.

Scrapy是通过scrapy命令行工具控制的,在这里称为" Scrapy工具",以将其与子命令区分开,我们仅将其称为"命令"或" Scrapy命令".

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

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

Configuration settings

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

  1. /etc/scrapy.cfg or c:\scrapy\scrapy.cfg (system-wide),
  2. ~/.config/scrapy.cfg$XDG_CONFIG_HOME )和~/.scrapy.cfg$HOME )进行全局(用户范围)设置,以及
  3. scrapy.cfg项目根目录中的scrapy.cfg(请参阅下一节).

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

Scrapy还了解并可以通过许多环境变量进行配置. 当前这些是:

Default structure of Scrapy projects

在深入研究命令行工具及其子命令之前,让我们首先了解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

Sharing the root directory between projects

一个项目根目录(包含scrapy.cfg )可以由多个Scrapy项目共享,每个项目都有自己的设置模块.

在这种情况下,必须在scrapy.cfg文件的[settings]下为这些设置模块定义一个或多个别名:

[settings]
default = myproject1.settings
project1 = myproject1.settings
project2 = myproject2.settings

默认情况下, scrapy命令行工具将使用default设置. 使用SCRAPY_PROJECT环境变量来指定其他项目以供scrapy使用:

$ scrapy settings --get BOT_NAME
Project 1 Bot
$ export SCRAPY_PROJECT=project2
$ scrapy settings --get BOT_NAME
Project 2 Bot

Using the scrapy tool

您可以先运行不带任何参数的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]

[...]

Creating projects

通常使用scrapy工具要做的第一件事是创建Scrapy项目:

scrapy startproject myproject [project_dir]

这将在project_dir目录下创建一个Scrapy项目. 如果project_dir没有指定是, project_dir将是一样myproject .

接下来,进入新项目目录:

cd project_dir

您已经准备好使用scrapy命令从那里管理和控制您的项目.

Controlling projects

您可以从项目内部使用scrapy工具来控制和管理它们.

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

scrapy genspider mydomain mydomain.com

某些Scrapy命令(例如crawl )必须从Scrapy项目内部运行. 请参阅下面的命令参考 ,以获取更多有关必须从项目内部运行哪些命令,而不是从内部运行命令的更多信息.

还请记住,从项目内部运行某些命令时,它们的行为可能略有不同. 例如,如果要获取的url与某些特定的Spider相关联,则fetch命令将使用Spider覆盖的行为(例如user_agent属性覆盖user-agent). 这是有意的,因为fetch命令用于检查Spider如何下载页面.

Available tool commands

本节包含可用的内置命令的列表,并带有说明和一些用法示例. 请记住,您始终可以通过运行以下命令获取有关每个命令的更多信息:

scrapy <command> -h

您可以使用以下命令查看所有可用命令:

scrapy -h

有两种命令,它们只能在Scrapy项目内部运行(特定于项目的命令),也可以在没有活动的Scrapy项目内部运行(全局命令),尽管它们在项目内部运行时的行为可能略有不同(因为他们会使用项目的覆盖设置).

全局命令:

仅项目命令:

startproject

  • Syntax: scrapy startproject <project_name> [project_dir]
  • 需要项目:

project_dir目录下创建一个名为project_name的新Scrapy项目. 如果project_dir没有指定是, project_dir将是一样project_name .

用法示例:

$ scrapy startproject myproject

genspider

  • Syntax: scrapy genspider [-t template] <name> <domain>
  • 需要项目:

如果从项目内部调用,请在当前文件夹或当前项目的spiders文件夹中创建一个新的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'

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

crawl

  • Syntax: scrapy crawl <spider>
  • 需要项目:

开始使用蜘蛛爬行.

用法示例:

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

check

  • Syntax: 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

  • Syntax: scrapy list
  • 需要项目:

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

用法示例:

$ scrapy list
spider1
spider2

edit

  • Syntax: scrapy edit <spider>
  • 需要项目:

使用EDITOR环境变量或(如果未设置) EDITOR设置中定义的EDITOR器来编辑给定的蜘蛛.

在大多数情况下,此命令仅作为便利快捷方式提供,开发人员当然可以选择任何工具或IDE来编写和调试Spider.

用法示例:

$ scrapy edit spider1

fetch

  • Syntax: scrapy fetch <url>
  • 需要项目:

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

关于此命令的有趣之处在于,它会获取蜘蛛如何下载页面的页面. 例如,如果蜘蛛具有覆盖用户代理的USER_AGENT属性,它将使用该属性.

因此,该命令可用于"查看"您的Spider如何获取特定页面.

如果在项目外部使用,则不会应用任何特定的行为,它只会使用默认的Scrapy下载程序设置.

支持的选项:

  • --spider=SPIDER :绕过蜘蛛自动检测并强制使用特定蜘蛛
  • --headers: print the response’s HTTP headers instead of the response’s body
  • --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

  • Syntax: scrapy view <url>
  • 需要项目:

在您的Scrapy蜘蛛会"看到"它的情况下,在浏览器中打开给定的URL. 有时,蜘蛛看到的页面与普通用户不同,因此可以用来检查蜘蛛"看到"的内容并确认它是您期望的.

支持的选项:

  • --spider=SPIDER :绕过蜘蛛自动检测并强制使用特定蜘蛛
  • --no-redirect :不遵循HTTP 3xx重定向(默认为遵循它们)

用法示例:

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

shell

  • Syntax: scrapy shell [url]
  • 需要项目:

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

支持的选项:

  • --spider=SPIDER :绕过蜘蛛自动检测并强制使用特定蜘蛛
  • -c code :评估外壳程序中的代码,打印结果并退出
  • --no-redirect :不遵循HTTP 3xx重定向(默认是遵循它们); 这只会影响您可能在命令行中作为参数传递的URL; 一旦进入外壳,默认情况下, 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

  • Syntax: scrapy parse <url> [options]
  • 需要项目:

使用与--callback选项一起传递的方法,获取给定的URL并与处理它的蜘蛛进行parse如果没有给出,则进行parse .

支持的选项:

  • --spider=SPIDER :绕过蜘蛛自动检测并强制使用特定蜘蛛
  • --a NAME=VALUE :设置蜘蛛参数(可以重复)
  • --callback-c :Spider方法用作解析响应的回调
  • --meta-m :将传递给回调请求的其他请求元. 这必须是有效的json字符串. 例如:–meta ='{" foo":" bar"}'
  • --cbkwargs :将传递给回调的其他关键字参数. 这必须是有效的json字符串. 示例:–cbkwargs ='{" foo":" bar"}'
  • --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': 'Example item',
 'category': 'Furniture',
 'length': '12 cm'}]

# Requests  -----------------------------------------------------------------
[]

settings

  • Syntax: scrapy settings [options]
  • 需要项目:

获取Scrapy设置的值.

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

用法示例:

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

runspider

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

无需创建项目即可运行包含在Python文件中的蜘蛛程序.

用法示例:

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

version

  • Syntax: scrapy version [-v]
  • 需要项目:

Prints the Scrapy version. If used with -v it also prints Python, Twisted and Platform info, which is useful for bug reports.

bench

版本0.17中的新功能.

  • Syntax: scrapy bench
  • 需要项目:

运行快速基准测试. 标杆管理 .

Custom project commands

您还可以使用COMMANDS_MODULE设置添加自定义项目命令. 有关如何实现命令的示例,请参见scrapy / commands中的Scrapy命令.

COMMANDS_MODULE

默认值: '' (空字符串)

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

Example:

COMMANDS_MODULE = 'mybot.commands'

Register commands via setup.py entry points

Note

这是一项实验性功能,请谨慎使用.

您还可以通过在库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',
    ],
  },
 )