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

18 KiB
Raw Blame History

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

Feed exports

One of the most frequently required features when implementing scrapers is being able to store the scraped data properly and, quite often, that means generating an "export file" with the scraped data (commonly called "export feed") to be consumed by other systems.

Scrapy provides this functionality out of the box with the Feed Exports, which allows you to generate feeds with the scraped items, using multiple serialization formats and storage backends.

Serialization formats

For serializing the scraped data, the feed exports use the :ref:`Item exporters <topics-exporters>`. These formats are supported out of the box:

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

Unknown interpreted text role "ref".

But you can also extend the supported format through the :setting:`FEED_EXPORTERS` setting.

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

Unknown interpreted text role "setting".

JSON

JSON lines

CSV

  • Value for the format key in the :setting:`FEEDS` setting: csv

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

    Unknown interpreted text role "setting".

  • Exporter used: :class:`~scrapy.exporters.CsvItemExporter`

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

    Unknown interpreted text role "class".

  • To specify columns to export and their order use :setting:`FEED_EXPORT_FIELDS`. Other feed exporters can also use this option, but it is important for CSV because unlike many other export formats CSV uses a fixed header.

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

    Unknown interpreted text role "setting".

XML

Pickle

Marshal

Storages

When using the feed exports you define where to store the feed using one or multiple URIs (through the :setting:`FEEDS` setting). The feed exports supports multiple storage backend types which are defined by the URI scheme.

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

Unknown interpreted text role "setting".

The storages backends supported out of the box are:

Some storage backends may be unavailable if the required external libraries are not available. For example, the S3 backend is only available if the botocore library is installed.

Storage URI parameters

The storage URI can also contain parameters that get replaced when the feed is being created. These parameters are:

  • %(time)s - gets replaced by a timestamp when the feed is being created
  • %(name)s - gets replaced by the spider name

Any other named parameter gets replaced by the spider attribute of the same name. For example, %(site_id)s would get replaced by the spider.site_id attribute the moment the feed is being created.

Here are some examples to illustrate:

  • Store in FTP using one directory per spider:
    • ftp://user:password@ftp.example.com/scraping/feeds/%(name)s/%(time)s.json
  • Store in S3 using one directory per spider:
    • s3://mybucket/scraping/feeds/%(name)s/%(time)s.json

Storage backends

Local filesystem

The feeds are stored in the local filesystem.

  • URI scheme: file
  • Example URI: file:///tmp/export.csv
  • Required external libraries: none

Note that for the local filesystem storage (only) you can omit the scheme if you specify an absolute path like /tmp/export.csv. This only works on Unix systems though.

FTP

The feeds are stored in a FTP server.

  • URI scheme: ftp
  • Example URI: ftp://user:pass@ftp.example.com/path/to/export.csv
  • Required external libraries: none

FTP supports two different connection modes: active or passive. Scrapy uses the passive connection mode by default. To use the active connection mode instead, set the :setting:`FEED_STORAGE_FTP_ACTIVE` setting to True.

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

Unknown interpreted text role "setting".

This storage backend uses :ref:`delayed file delivery <delayed-file-delivery>`.

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

Unknown interpreted text role "ref".

S3

The feeds are stored on Amazon S3.

  • URI scheme: s3
  • Example URIs:
    • s3://mybucket/path/to/export.csv
    • s3://aws_key:aws_secret@mybucket/path/to/export.csv
  • Required external libraries: botocore >= 1.4.87

The AWS credentials can be passed as user/password in the URI, or they can be passed through the following settings:

You can also define a custom ACL for exported feeds using this setting:

This storage backend uses :ref:`delayed file delivery <delayed-file-delivery>`.

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

Unknown interpreted text role "ref".

Google Cloud Storage (GCS)

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

Unknown directive type "versionadded".

.. versionadded:: 2.3

The feeds are stored on Google Cloud Storage.

  • URI scheme: gs
  • Example URIs:
    • gs://mybucket/path/to/export.csv
  • Required external libraries: google-cloud-storage.

For more information about authentication, please refer to Google Cloud documentation.

You can set a Project ID and Access Control List (ACL) through the following settings:

This storage backend uses :ref:`delayed file delivery <delayed-file-delivery>`.

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

Unknown interpreted text role "ref".

Standard output

The feeds are written to the standard output of the Scrapy process.

  • URI scheme: stdout
  • Example URI: stdout:
  • Required external libraries: none

Delayed file delivery

As indicated above, some of the described storage backends use delayed file delivery.

These storage backends do not upload items to the feed URI as those items are scraped. Instead, Scrapy writes items into a temporary local file, and only once all the file contents have been written (i.e. at the end of the crawl) is that file uploaded to the feed URI.

If you want item delivery to start earlier when using one of these storage backends, use :setting:`FEED_EXPORT_BATCH_ITEM_COUNT` to split the output items in multiple files, with the specified maximum item count per file. That way, as soon as a file reaches the maximum item count, that file is delivered to the feed URI, allowing item delivery to start way before the end of the crawl.

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

Unknown interpreted text role "setting".

Settings

These are the settings used for configuring the feed exports:

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

Unknown directive type "currentmodule".

.. currentmodule:: scrapy.extensions.feedexport

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

Unknown directive type "setting".

.. setting:: FEEDS

FEEDS

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

Unknown directive type "versionadded".

.. versionadded:: 2.1

Default: {}

A dictionary in which every key is a feed URI (or a :class:`pathlib.Path` object) and each value is a nested dictionary containing configuration parameters for the specific feed.

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

Unknown interpreted text role "class".

This setting is required for enabling the feed export feature.

See :ref:`topics-feed-storage-backends` for supported URI schemes.

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

Unknown interpreted text role "ref".

For instance:

{
    'items.json': {
        'format': 'json',
        'encoding': 'utf8',
        'store_empty': False,
        'fields': None,
        'indent': 4,
        'item_export_kwargs': {
           'export_empty_fields': True,
        },
    },
    '/home/user/documents/items.xml': {
        'format': 'xml',
        'fields': ['name', 'price'],
        'encoding': 'latin1',
        'indent': 8,
    },
    pathlib.Path('items.csv'): {
        'format': 'csv',
        'fields': ['price', 'name'],
    },
}

The following is a list of the accepted keys and the setting that is used as a fallback value if that key is not provided for a specific feed definition:

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

Unknown directive type "setting".

.. setting:: FEED_EXPORT_ENCODING

FEED_EXPORT_ENCODING

Default: None

The encoding to be used for the feed.

If unset or set to None (default) it uses UTF-8 for everything except JSON output, which uses safe numeric encoding (\uXXXX sequences) for historic reasons.

Use utf-8 if you want UTF-8 for JSON too.

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

Unknown directive type "setting".

.. setting:: FEED_EXPORT_FIELDS

FEED_EXPORT_FIELDS

Default: None

A list of fields to export, optional. Example: FEED_EXPORT_FIELDS = ["foo", "bar", "baz"].

Use FEED_EXPORT_FIELDS option to define fields to export and their order.

When FEED_EXPORT_FIELDS is empty or None (default), Scrapy uses the fields defined in :ref:`item objects <topics-items>` yielded by your spider.

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

Unknown interpreted text role "ref".

If an exporter requires a fixed set of fields (this is the case for :ref:`CSV <topics-feed-format-csv>` export format) and FEED_EXPORT_FIELDS is empty or None, then Scrapy tries to infer field names from the exported data - currently it uses field names from the first item.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: FEED_EXPORT_INDENT

FEED_EXPORT_INDENT

Default: 0

Amount of spaces used to indent the output on each level. If FEED_EXPORT_INDENT is a non-negative integer, then array elements and object members will be pretty-printed with that indent level. An indent level of 0 (the default), or negative, will put each item on a new line. None selects the most compact representation.

Currently implemented only by :class:`~scrapy.exporters.JsonItemExporter` and :class:`~scrapy.exporters.XmlItemExporter`, i.e. when you are exporting to .json or .xml.

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

Unknown interpreted text role "class".

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

Unknown interpreted text role "class".

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

Unknown directive type "setting".

.. setting:: FEED_STORE_EMPTY

FEED_STORE_EMPTY

Default: False

Whether to export empty feeds (i.e. feeds with no items).

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

Unknown directive type "setting".

.. setting:: FEED_STORAGES

FEED_STORAGES

Default: {}

A dict containing additional feed storage backends supported by your project. The keys are URI schemes and the values are paths to storage classes.

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

Unknown directive type "setting".

.. setting:: FEED_STORAGE_FTP_ACTIVE

FEED_STORAGE_FTP_ACTIVE

Default: False

Whether to use the active connection mode when exporting feeds to an FTP server (True) or use the passive connection mode instead (False, default).

For information about FTP connection modes, see What is the difference between active and passive FTP?.

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

Unknown directive type "setting".

.. setting:: FEED_STORAGE_S3_ACL

FEED_STORAGE_S3_ACL

Default: '' (empty string)

A string containing a custom ACL for feeds exported to Amazon S3 by your project.

For a complete list of available values, access the Canned ACL section on Amazon S3 docs.

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

Unknown directive type "setting".

.. setting:: FEED_STORAGES_BASE

FEED_STORAGES_BASE

Default:

{
    '': 'scrapy.extensions.feedexport.FileFeedStorage',
    'file': 'scrapy.extensions.feedexport.FileFeedStorage',
    'stdout': 'scrapy.extensions.feedexport.StdoutFeedStorage',
    's3': 'scrapy.extensions.feedexport.S3FeedStorage',
    'ftp': 'scrapy.extensions.feedexport.FTPFeedStorage',
}

A dict containing the built-in feed storage backends supported by Scrapy. You can disable any of these backends by assigning None to their URI scheme in :setting:`FEED_STORAGES`. E.g., to disable the built-in FTP storage backend (without replacement), place this in your settings.py:

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

Unknown interpreted text role "setting".
FEED_STORAGES = {
    'ftp': None,
}

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

Unknown directive type "setting".

.. setting:: FEED_EXPORTERS

FEED_EXPORTERS

Default: {}

A dict containing additional exporters supported by your project. The keys are serialization formats and the values are paths to :ref:`Item exporter <topics-exporters>` classes.

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

Unknown interpreted text role "ref".

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

Unknown directive type "setting".

.. setting:: FEED_EXPORTERS_BASE

FEED_EXPORTERS_BASE

Default:

{
    'json': 'scrapy.exporters.JsonItemExporter',
    'jsonlines': 'scrapy.exporters.JsonLinesItemExporter',
    'jl': 'scrapy.exporters.JsonLinesItemExporter',
    'csv': 'scrapy.exporters.CsvItemExporter',
    'xml': 'scrapy.exporters.XmlItemExporter',
    'marshal': 'scrapy.exporters.MarshalItemExporter',
    'pickle': 'scrapy.exporters.PickleItemExporter',
}

A dict containing the built-in feed exporters supported by Scrapy. You can disable any of these exporters by assigning None to their serialization format in :setting:`FEED_EXPORTERS`. E.g., to disable the built-in CSV exporter (without replacement), place this in your settings.py:

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

Unknown interpreted text role "setting".
FEED_EXPORTERS = {
    'csv': None,
}

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

Unknown directive type "setting".

.. setting:: FEED_EXPORT_BATCH_ITEM_COUNT

FEED_EXPORT_BATCH_ITEM_COUNT

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

Unknown directive type "versionadded".

.. versionadded:: 2.3.0

Default: 0

If assigned an integer number higher than 0, Scrapy generates multiple output files storing up to the specified number of items in each output file.

When generating multiple output files, you must use at least one of the following placeholders in the feed URI to indicate how the different output file names are generated:

  • %(batch_time)s - gets replaced by a timestamp when the feed is being created (e.g. 2020-03-28T14-45-08.237134)

  • %(batch_id)d - gets replaced by the 1-based sequence number of the batch.

    Use :ref:`printf-style string formatting <python:old-string-formatting>` to alter the number format. For example, to make the batch ID a 5-digit number by introducing leading zeroes as needed, use %(batch_id)05d (e.g. 3 becomes 00003, 123 becomes 00123).

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

    Unknown interpreted text role "ref".

For instance, if your settings include:

FEED_EXPORT_BATCH_ITEM_COUNT = 100

And your :command:`crawl` command line is:

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

Unknown interpreted text role "command".
scrapy crawl spidername -o "dirname/%(batch_id)d-filename%(batch_time)s.json"

The command line above can generate a directory tree like:

->projectname
-->dirname
--->1-filename2020-03-28T14-45-08.237134.json
--->2-filename2020-03-28T14-45-09.148903.json
--->3-filename2020-03-28T14-45-10.046092.json

Where the first and second files contain exactly 100 items. The last one contains 100 items or fewer.

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

Unknown directive type "setting".

.. setting:: FEED_URI_PARAMS

FEED_URI_PARAMS

Default: None

A string with the import path of a function to set the parameters to apply with :ref:`printf-style string formatting <python:old-string-formatting>` to the feed URI.

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

Unknown interpreted text role "ref".

The function signature should be as follows:

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

Unknown directive type "function".

.. function:: uri_params(params, spider)

   Return a :class:`dict` of key-value pairs to apply to the feed URI using
   :ref:`printf-style string formatting <python:old-string-formatting>`.

   :param params: default key-value pairs

        Specifically:

        -   ``batch_id``: ID of the file batch. See
            :setting:`FEED_EXPORT_BATCH_ITEM_COUNT`.

            If :setting:`FEED_EXPORT_BATCH_ITEM_COUNT` is ``0``, ``batch_id``
            is always ``1``.

            .. versionadded:: 2.3.0

        -   ``batch_time``: UTC date and time, in ISO format with ``:``
            replaced with ``-``.

            See :setting:`FEED_EXPORT_BATCH_ITEM_COUNT`.

            .. versionadded:: 2.3.0

        -   ``time``: ``batch_time``, with microseconds set to ``0``.
   :type params: dict

   :param spider: source spider of the feed items
   :type spider: scrapy.spiders.Spider

For example, to include the :attr:`name <scrapy.spiders.Spider.name>` of the source spider in the feed URI:

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

Unknown interpreted text role "attr".

  1. Define the following function somewhere in your project:

    # myproject/utils.py
def uri_params(params, spider):
    return {**params, 'spider_name': spider.name}

  2. Point :setting:`FEED_URI_PARAMS` to that function in your settings:

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

    Unknown interpreted text role "setting".

    # myproject/settings.py
FEED_URI_PARAMS = 'myproject.utils.uri_params'

  3. Use %(spider_name)s in your feed URI:

    scrapy crawl <spider_name> -o "%(spider_name)s.jl"
</html>