项目管道

当一个项目被蜘蛛抓取后,它会被发送到项目管道,通过几个依次执行的组件进行处理。

每个项目管道组件(有时简称为“项目管道”)是一个实现简单方法的Python类。它们接收一个项目并对其执行操作,同时决定该项目是否应继续通过管道或被丢弃并不再处理。

项目管道的典型用途是:

  • 清理HTML数据

  • 验证抓取的数据(检查项目是否包含某些字段)

  • 检查重复项(并删除它们)

  • 将抓取的项目存储在数据库中

编写您自己的项目管道

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

process_item(self, item, spider)

此方法为每个项目管道组件调用。

item 是一个 item 对象,请参阅 支持所有项目类型

process_item() 必须:返回一个 项目对象, 返回一个 Deferred 或者抛出一个 DropItem 异常。

丢弃的项目不再由后续管道组件处理。

Parameters:
  • item (item object) – 抓取的项目

  • spider (Spider 对象) – 抓取该项目的爬虫

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

open_spider(self, spider)

当蜘蛛被打开时调用此方法。

Parameters:

spider (Spider 对象) – 被打开的爬虫

close_spider(self, spider)

当蜘蛛关闭时调用此方法。

Parameters:

spider (Spider 对象) – 被关闭的爬虫

classmethod from_crawler(cls, crawler)

如果存在,这个类方法被调用来从Crawler创建一个管道实例。它必须返回一个新的管道实例。Crawler对象提供了对Scrapy所有核心组件的访问,如设置和信号;这是管道访问它们并将其功能集成到Scrapy中的一种方式。

Parameters:

爬虫 (Crawler 对象) – 使用此管道的爬虫

项目管道示例

价格验证和删除没有价格的物品

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

from itemadapter import ItemAdapter
from scrapy.exceptions import DropItem


class PricePipeline:
    vat_factor = 1.15

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

将项目写入JSON行文件

以下管道将所有抓取的项目(来自所有蜘蛛)存储到一个单一的 items.jsonl 文件中,每行包含一个以 JSON 格式序列化的项目:

import json

from itemadapter import ItemAdapter


class JsonWriterPipeline:
    def open_spider(self, spider):
        self.file = open("items.jsonl", "w")

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

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

注意

JsonWriterPipeline 的目的只是为了介绍如何编写项目管道。如果你真的想将所有抓取的项目存储到一个 JSON 文件中,你应该使用 Feed exports

将项目写入MongoDB

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

这个示例的主要目的是展示如何使用from_crawler()方法以及如何正确清理资源。

import pymongo
from itemadapter import ItemAdapter


class MongoPipeline:
    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(ItemAdapter(item).asdict())
        return item

拍摄项目的截图

这个例子演示了如何在process_item()方法中使用coroutine syntax

此项目管道向本地运行的Splash实例发出请求,以渲染项目URL的截图。下载请求响应后,项目管道将截图保存到文件并将文件名添加到项目中。

import hashlib
from pathlib import Path
from urllib.parse import quote

import scrapy
from itemadapter import ItemAdapter
from scrapy.http.request import NO_CALLBACK
from scrapy.utils.defer import maybe_deferred_to_future


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

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

    async def process_item(self, item, spider):
        adapter = ItemAdapter(item)
        encoded_item_url = quote(adapter["url"])
        screenshot_url = self.SPLASH_URL.format(encoded_item_url)
        request = scrapy.Request(screenshot_url, callback=NO_CALLBACK)
        response = await maybe_deferred_to_future(
            spider.crawler.engine.download(request)
        )

        if response.status != 200:
            # Error happened, return item.
            return item

        # Save screenshot to file, filename will be hash of url.
        url = adapter["url"]
        url_hash = hashlib.md5(url.encode("utf8")).hexdigest()
        filename = f"{url_hash}.png"
        Path(filename).write_bytes(response.body)

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

重复项过滤器

一个用于查找重复项并丢弃已处理项的过滤器。假设我们的项目有一个唯一的ID,但我们的爬虫返回了多个具有相同ID的项目:

from itemadapter import ItemAdapter
from scrapy.exceptions import DropItem


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

    def process_item(self, item, spider):
        adapter = ItemAdapter(item)
        if adapter["id"] in self.ids_seen:
            raise DropItem(f"Item ID already seen: {adapter['id']}")
        else:
            self.ids_seen.add(adapter["id"])
            return item

激活一个项目管道组件

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

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

在此设置中,您为类分配的整数值决定了它们的运行顺序:项目从较低值的类到较高值的类依次进行。通常将这些数字定义在0-1000范围内。