Item Pipeline

蜘蛛抓取了一个项目后,将其发送到项目管道,该管道通过依次执行的几个组件对其进行处理.

每个项目管道组件(有时也称为"项目管道")都是一个实现简单方法的Python类. 他们接收到一个项目并对其执行操作,还决定该项目是否应继续通过管道或被删除并不再处理.

项目管道的典型用途是:

  • 清理HTML数据
  • 验证抓取的数据(检查项目是否包含某些字段)
  • 检查重复项(并将其删除)
  • 将刮擦的物品存储在数据库中

Writing your own item pipeline

每个项目管道组件都是一个Python类,必须实现以下方法:

process_item(self, item, spider)

每个项目管道组件都调用此方法. process_item()必须:返回带有数据的字典,返回Item (或任何后代类)对象,返回Twisted Deferred或引发DropItem异常. 删除的项目不再由其他管道组件处理.

Parameters:
  • 物品Item对象或字典)–抓取的物品
  • 蜘蛛Spider对象)–抓取物品的蜘蛛

此外,他们还可以实现以下方法:

open_spider(self, spider)

打开蜘蛛网后将调用此方法.

Parameters: 蜘蛛Spider对象)–已打开的蜘蛛
close_spider(self, spider)

关闭蜘蛛网时将调用此方法.

Parameters: 蜘蛛Spider对象)–已关闭的蜘蛛
from_crawler(cls, crawler)

如果存在,则调用此类方法以从Crawler创建管道实例. 它必须返回管道的新实例. 搜寻器对象提供对所有Scrapy核心组件(如设置和信号)的访问; 这是管道访问它们并将其功能挂钩到Scrapy中的一种方式.

Parameters: 搜寻器Crawler对象)–使用此管道的搜寻器

Item pipeline example

Price validation and dropping items with no prices

让我们看一下下面的假设管道,该管道调整那些不包含增值税的商品的price属性( price_excludes_vat属性),并删除那些不包含价格的商品:

from scrapy.exceptions import DropItem

class PricePipeline(object):

    vat_factor = 1.15

    def process_item(self, item, spider):
        if item.get('price'):
            if item.get('price_excludes_vat'):
                item['price'] = item['price'] * self.vat_factor
            return item
        else:
            raise DropItem("Missing price in %s" % item)

Write items to a JSON file

以下管道将所有(从所有Spider items.jl )刮取的项目存储在单个items.jl文件中,每行包含一个以JSON格式序列化的项目:

import json

class JsonWriterPipeline(object):

    def open_spider(self, spider):
        self.file = open('items.jl', 'w')

    def close_spider(self, spider):
        self.file.close()

    def process_item(self, item, spider):
        line = json.dumps(dict(item)) + "\n"
        self.file.write(line)
        return item

Note

JsonWriterPipeline的目的只是介绍如何编写项目管道. 如果您真的想将所有报废的项目存储到JSON文件中,则应使用Feed导出 .

Write items to MongoDB

在此示例中,我们将使用pymongo将项目写入MongoDB . 在Scrapy设置中指定了MongoDB地址和数据库名称; MongoDB集合以项类命名.

该示例的主要目的是演示如何使用from_crawler()方法以及如何正确清理资源.

import pymongo

class MongoPipeline(object):

    collection_name = 'scrapy_items'

    def __init__(self, mongo_uri, mongo_db):
        self.mongo_uri = mongo_uri
        self.mongo_db = mongo_db

    @classmethod
    def from_crawler(cls, crawler):
        return cls(
            mongo_uri=crawler.settings.get('MONGO_URI'),
            mongo_db=crawler.settings.get('MONGO_DATABASE', 'items')
        )

    def open_spider(self, spider):
        self.client = pymongo.MongoClient(self.mongo_uri)
        self.db = self.client[self.mongo_db]

    def close_spider(self, spider):
        self.client.close()

    def process_item(self, item, spider):
        self.db[self.collection_name].insert_one(dict(item))
        return item

Take screenshot of item

本示例演示如何从process_item()方法返回Deferred . 它使用Splash渲染项目url的屏幕截图. 管道向本地运行的Splash实例发出请求. 下载请求并触发Deferred回调后,它将项目保存到文件,并将文件名添加到项目.

import scrapy
import hashlib
from urllib.parse import quote


class ScreenshotPipeline(object):
    """Pipeline that uses Splash to render screenshot of
    every Scrapy item."""

    SPLASH_URL = "http://localhost:8050/render.png?url={}"

    def process_item(self, item, spider):
        encoded_item_url = quote(item["url"])
        screenshot_url = self.SPLASH_URL.format(encoded_item_url)
        request = scrapy.Request(screenshot_url)
        dfd = spider.crawler.engine.download(request, spider)
        dfd.addBoth(self.return_item, item)
        return dfd

    def return_item(self, response, item):
        if response.status != 200:
            # Error happened, return item.
            return item

        # Save screenshot to file, filename will be hash of url.
        url = item["url"]
        url_hash = hashlib.md5(url.encode("utf8")).hexdigest()
        filename = "{}.png".format(url_hash)
        with open(filename, "wb") as f:
            f.write(response.body)

        # Store filename in item.
        item["screenshot_filename"] = filename
        return item

Duplicates filter

一个过滤器,用于查找重复项,并删除那些已经处理过的项. 假设我们的商品具有唯一的ID,但我们的Spider会返回具有相同ID的多个商品:

from scrapy.exceptions import DropItem

class DuplicatesPipeline(object):

    def __init__(self):
        self.ids_seen = set()

    def process_item(self, item, spider):
        if item['id'] in self.ids_seen:
            raise DropItem("Duplicate item found: %s" % item)
        else:
            self.ids_seen.add(item['id'])
            return item

Activating an Item Pipeline component

要激活项目管道组件,您必须将其类添加到ITEM_PIPELINES设置中,如以下示例所示:

ITEM_PIPELINES = {
    'myproject.pipelines.PricePipeline': 300,
    'myproject.pipelines.JsonWriterPipeline': 800,
}

您在此设置中分配给类的整数值确定它们运行的​​顺序:项目从值较低的类转到值较高的类. 通常将这些数字定义在0-1000范围内.