RomanNum3ral
/
scrapy
mirror of https://github.com/scrapy/scrapy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
scrapy/docs/topics/item-pipeline.rst

6.9 KiB
Raw Blame History

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> </head>

Item Pipeline

After an item has been scraped by a spider it is sent to the Item Pipeline which process it through several components that are executed sequentially.

Item pipeline are usually implemented on each project. Typical usage for item pipelines are:

  • HTML cleansing
  • validation
  • persistence (storing the scraped item)

Writing your own item pipeline

Writing your own item pipeline is easy. Each item pipeline component is a single Python class that must implement the following method:

System Message: ERROR/3 (<stdin>, line 24)

Unknown directive type "method".

.. method:: process_item(item, spider)

   This method is called for every item pipeline component and must either return
   a :class:`~scrapy.item.Item` (or any descendant class) object or raise a
   :exc:`~scrapy.exceptions.DropItem` exception. Dropped items are no longer
   processed by further pipeline components.

   :param item: the item scraped
   :type item: :class:`~scrapy.item.Item` object

   :param spider: the spider which scraped the item
   :type spider: :class:`~scrapy.spider.BaseSpider` object

Additionally, they may also implement the following methods:

System Message: ERROR/3 (<stdin>, line 39)

Unknown directive type "method".

.. method:: open_spider(spider)

   This method is called when the spider is opened.

   :param spider: the spider which was opened
   :type spider: :class:`~scrapy.spider.BaseSpider` object

System Message: ERROR/3 (<stdin>, line 46)

Unknown directive type "method".

.. method:: close_spider(spider)

   This method is called when the spider is closed.

   :param spider: the spider which was closed
   :type spider: :class:`~scrapy.spider.BaseSpider` object

Item pipeline example

Let's take a look at following hypothetic pipeline that adjusts the price attribute for those items that do not include VAT (price_excludes_vat attribute), and drops those items which don't contain a price:

from scrapy.exceptions import DropItem

class PricePipeline(object):

    vat_factor = 1.15

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

Activating a Item Pipeline component

To activate an Item Pipeline component you must add its class to the :setting:`ITEM_PIPELINES` list, like in the following example:

System Message: ERROR/3 (<stdin>, line 79); backlink

Unknown interpreted text role "setting".
ITEM_PIPELINES = [
    'myproject.pipeline.PricePipeline',
]

Item pipeline example with resources per spider

Sometimes you need to keep resources about the items processed grouped per spider, and delete those resource when a spider finish.

An example is a filter that looks for duplicate items, and drops those items that were already processed. Let say that our items has an unique id, but our spider returns multiples items with the same id:

from scrapy.xlib.pydispatch import dispatcher
from scrapy import signals
from scrapy.exceptions import DropItem

class DuplicatesPipeline(object):
    def __init__(self):
        self.duplicates = {}
        dispatcher.connect(self.spider_opened, signals.spider_opened)
        dispatcher.connect(self.spider_closed, signals.spider_closed)

    def spider_opened(self, spider):
        self.duplicates[spider] = set()

    def spider_closed(self, spider):
        del self.duplicates[spider]

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

Built-in Item Pipelines reference

System Message: ERROR/3 (<stdin>, line 123)

Unknown directive type "module".

.. module:: scrapy.contrib.pipeline
   :synopsis: Item Pipeline manager and built-in pipelines

Here is a list of item pipelines bundled with Scrapy.

File Export Pipeline

System Message: ERROR/3 (<stdin>, line 133)

Unknown directive type "module".

.. module:: scrapy.contrib.pipeline.fileexport

This pipeline exports all scraped items into a file, using different formats.

It is simple but convenient wrapper to use :doc:`Item Exporters <exporters>` as :ref:`Item Pipelines <topics-item-pipeline>`. If you need more custom/advanced functionality you can write your own pipeline or subclass the :doc:`Item Exporters <exporters>` .

System Message: ERROR/3 (<stdin>, line 139); backlink

Unknown interpreted text role "doc".

System Message: ERROR/3 (<stdin>, line 139); backlink

Unknown interpreted text role "ref".

System Message: ERROR/3 (<stdin>, line 139); backlink

Unknown interpreted text role "doc".

It supports the following settings:

If any mandatory setting is not set, this pipeline will be automatically disabled.

File Export Pipeline examples

Here are some usage examples of the File Export Pipeline.

To export all scraped items into a XML file:

EXPORT_FORMAT = 'xml'
EXPORT_FILE = 'scraped_items.xml'

To export all scraped items into a CSV file (with all fields in headers line):

EXPORT_FORMAT = 'csv'
EXPORT_FILE = 'scraped_items.csv'

To export all scraped items into a CSV file (with specific fields in headers line):

EXPORT_FORMAT = 'csv_headers'
EXPORT_FILE = 'scraped_items_with_headers.csv'
EXPORT_FIELDS = ['name', 'price', 'description']

File Export Pipeline settings

System Message: ERROR/3 (<stdin>, line 179)

Unknown directive type "currentmodule".

.. currentmodule:: scrapy.contrib.exporter

System Message: ERROR/3 (<stdin>, line 181)

Unknown directive type "setting".

.. setting:: EXPORT_FORMAT

EXPORT_FORMAT

The format to use for exporting. Here is a list of all available formats. Click on the respective Item Exporter to get more info.

This setting is mandatory in order to use the File Export Pipeline.

System Message: ERROR/3 (<stdin>, line 207)

Unknown directive type "setting".

.. setting:: EXPORT_FILE

EXPORT_FILE

The name of the file where the items will be exported. This setting is mandatory in order to use the File Export Pipeline.

System Message: ERROR/3 (<stdin>, line 215)

Unknown directive type "setting".

.. setting:: EXPORT_FIELDS

EXPORT_FIELDS

Default: None

The name of the item fields that will be exported. This will be use for the :attr:`~BaseItemExporter.fields_to_export` Item Exporter attribute. If None, all fields will be exported.

System Message: ERROR/3 (<stdin>, line 222); backlink

Unknown interpreted text role "attr".

System Message: ERROR/3 (<stdin>, line 226)

Unknown directive type "setting".

.. setting:: EXPORT_EMPTY

EXPORT_EMPTY

Default: False

Whether to export empty (non populated) fields. This will be used for the :attr:`~BaseItemExporter.export_empty_fields` Item Exporter attribute.

System Message: ERROR/3 (<stdin>, line 233); backlink

Unknown interpreted text role "attr".

System Message: ERROR/3 (<stdin>, line 236)

Unknown directive type "setting".

.. setting:: EXPORT_ENCODING

EXPORT_ENCODING

Default: 'utf-8'

The encoding to use for exporting. Ths will be used for the :attr:`~BaseItemExporter.encoding` Item Exporter attribute.

System Message: ERROR/3 (<stdin>, line 243); backlink

Unknown interpreted text role "attr".
</html>