[Scrapy][转]关于scrapy命令

Posted 2020-08-15

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

全局命令：

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

项目(Project-only)命令：

• crawl
• check
• list
• edit
• parse
• genspider
• deploy
• bench

1.startproject

• 语法: scrapy startproject <project_name>
• 是否需要项目: no

在 project_name 文件夹下创建一个名为 project_name 的 Scrapy 项目。

例子：

$ scrapy startproject myproject

View Code

 

2.genspider

• 语法: scrapy genspider [-t template] <name> <domain>
• 是否需要项目：yes
• 参数
  • -l    列出可用模板
  • -e    创建完成后编辑
  • -d    在标准输出显示
  • -t    使用用户模板

在当前项目中创建 spider。

这仅仅是创建 spider 的一种快捷方法。该方法可以使用提前定义好的模板来生成 spider。您也可以自己创建 spider 的源码文件。

例子：

$ scrapy genspider -l
Available templates:
  basic
  crawl
  csvfeed
  xmlfeed

$ scrapy genspider -d basic
import scrapy

class $classname(scrapy.Spider):
    name = "$name"
    allowed_domains = ["$domain"]
    start_urls = (
        ‘http://www.$domain/‘,
        )

    def parse(self, response):
        pass

$ scrapy genspider -t basic example example.com
Created spider ‘example‘ using template ‘basic‘ in module:
  mybot.spiders.example

View Code

 

3.crawl

• 语法: scrapy crawl  [options] <spider>
• 是否需要项目：yes
• 参数
  • -a    set spider argument
  • -o FILE     输出结果到文件
  • -t  FORMAT  确定-o的格式

使用 spider 进行爬取。

例子：

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

View Code

 

4.check

• 语法：scrapy check [options] <spider>
• 是否需要项目：yes
• 参数
  • -l     只是列出contracts,不检查
  • -v    打印所有spiders的contract 测试结果

运行 contract 检查。所以,啥叫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

View Code

 

5.list

• 语法：scrapy list
• 是否需要项目：yes

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

使用例子：

$ scrapy list
spider1
spider2

View Code

 

6.edit

• 语法：scrapy edit <spider>
• 是否需要项目：yes

使用 EDITOR 中设定的编辑器编辑给定的 spider

该命令仅仅是提供一个快捷方式。开发者可以自由选择其他工具或者 IDE 来编写调试 spider。

 

7.fetch

• 语法：scrapy fetch [options] <url>
• 是否需要项目：no
• 参数
  • --spider=SPIDER 使用这只爬虫
  • --headers 打印URL的HEADERS而非它的body

使用 Scrapy 下载器(downloader)下载给定的 URL，并将获取到的内容送到标准输出。

该命令以 spider 下载页面的方式获取页面。例如，如果 spider 有 USER_AGENT 属性修改了 User Agent，该命令将会使用该属性。

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

该命令如果非项目中运行则会使用默认 Scrapy downloader 设定。

例子：

$ 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 Code

 

8.view

• 语法：scrapy view [options] <url>
• 是否需要项目：no
• 参数
  • --spider=SPIDER 使用这只爬虫

在浏览器中打开给定的 URL，并以 Scrapy spider 获取到的形式展现。 有些时候 spider 获取到的页面和普通用户看到的并不相同。 因此该命令可以用来检查 spider 所获取到的页面，并确认这是您所期望的。

例子：

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

View Code

 

9.shell

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

以给定的 URL(如果给出)或者空(没有给出 URL)启动 Scrapy shell。查看 Scrapy 终端(Scrapy shell) 获取更多信息。

例子：

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

View Code

 

10.parse

• 语法：scrapy parse <url> [options]
• 是否需要项目：yes
• 参数
  • --spider=SPIDER：跳过自动检测 spider 并强制使用特定的 spider
  • --a NAME=VALUE：设置 spider 的参数(可能被重复)
  • --callback or -c：spider 中用于解析返回(response)的回调函数
  • --pipelines：在 pipeline 中处理 item
  • --rules or -r：使用 CrawlSpider 规则来发现用来解析返回(response)的回调函数
  • --noitems：不显示爬取到的 item
  • --nolinks：不显示提取到的链接
  • --nocolour：避免使用 pygments 对输出着色
  • --depth or -d：指定跟进链接请求的层次数(默认：1)
  • --verbose or -v：显示每个请求的详细信息

获取给定的 URL 并使用相应的 spider 分析处理。如果您提供--callback 选项，则使用 spider 的该方法处理，否则使用 parse。

 

例子：

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

View Code

 

settings

• 语法：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 文件中的 spider。

例子：

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

version

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

输出 Scrapy 版本。配合 -v 运行时，该命令同时输出 Python，Twisted 以及平台的信息，方便 bug 提交。

deploy

新版功能。

• 语法：scrapy deploy [ <target:project> | -l <target> | -L ]
• 是否需要项目：yes

将项目部署到 Scrapyd 服务。查看部署您的项目。

bench

新版功能。

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

运行 benchmark 测试。Benchmarking。

自定义项目命令

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

COMMANDS_MODULE

Default: ‘‘ (empty string)

用于查找添加自定义 Scrapy 命令的模块。

例子：

COMMANDS_MODULE = ‘mybot.commands‘