Scrapy & Autoextract API integration

This library integrates Zyte's AI Enabled Automatic Data Extraction into a Scrapy spider by two different means:

• with a downloader middleware that injects the AutoExtract responses into response.meta['autoextract'] for consumption by the spider.
• with a scrapy-poet provider that injects the responses as callback parameters.

Installation

pip install scrapy-autoextract

scrapy-autoextract requires Python 3.7+ for the download middleware and Python 3.7+ for the scrapy-poet provider

Usage

There are two different ways to consume the AutoExtract API with this library:

• using our Scrapy middleware
• using our Page Object provider

The middleware

The middleware is opt-in and can be explicitly enabled per request, with the {'autoextract': {'enabled': True}} request meta. All the options below can be set either in the project settings file, or just for specific spiders, in the custom_settings dict.

Within the spider, consuming the AutoExtract result is as easy as:

def parse(self, response):
    yield response.meta['autoextract']

Configuration

Add the AutoExtract downloader middleware in the settings file:

DOWNLOADER_MIDDLEWARES = {
    'scrapy_autoextract.AutoExtractMiddleware': 543,
}

Note that this should be the last downloader middleware to be executed.

The providers

Another way of consuming AutoExtract API is using the Page Objects pattern proposed by the web-poet library and implemented by scrapy-poet.

Items returned by Page Objects are defined in the autoextract-poet library.

Within the spider, consuming the AutoExtract result is as easy as:

import scrapy
from autoextract_poet.pages import AutoExtractArticlePage

class SampleSpider(scrapy.Spider):
    name = "sample"

    def parse(self, response, article_page: AutoExtractArticlePage):
        # We're making two requests here:
        # - one through Scrapy to build the response argument
        # - the other through the providers to build the article_page argument
        yield article_page.to_item()

Note that on the example above, we're going to perform two requests:

• one goes through Scrapy (it might use Smart Proxy, Splash or no proxy at all, depending on your configuration)
• another goes through AutoExtract API using zyte-autoextract

If you don't need the additional request going through Scrapy, you can annotate the response argument of your callback with DummyResponse. This will ignore the Scrapy request and only the AutoExtract API will be fetched.

For example:

import scrapy
from autoextract_poet.pages import AutoExtractArticlePage
from scrapy_poet import DummyResponse

class SampleSpider(scrapy.Spider):
    name = "sample"

    def parse(self, response: DummyResponse, article_page: AutoExtractArticlePage):
        # We're making a single request here to build the article argument
        yield article_page.to_item()

The examples above extract an article from the page, but you may want to extract a different type of item, like a product or a job posting. It is as easy as using the correct type annotation in the callback. This is how the callback looks like if we need to extract a real state from the page:

def parse(self,
          response: DummyResponse,
          real_estate_page: AutoExtractRealEstatePage):
    yield real_estate_page.to_item()

You can even use AutoExtractWebPage if what you need is the raw browser HTML to extract some additional data. Visit the full list of `supported page types`_ to get a better idea of the supported pages.

Configuration

First, you need to configure scrapy-poet as described on scrapy-poet's documentation and then enable AutoExtract providers by putting the following code to Scrapy's settings.py file:

# Install AutoExtract provider
SCRAPY_POET_PROVIDERS = {"scrapy_autoextract.AutoExtractProvider": 500}

# Enable scrapy-poet's provider injection middleware
DOWNLOADER_MIDDLEWARES = {
    'scrapy_poet.InjectionMiddleware': 543,
}

# Configure Twisted's reactor for asyncio support on Scrapy
TWISTED_REACTOR = 'twisted.internet.asyncioreactor.AsyncioSelectorReactor'

Currently, our providers are implemented using asyncio. Scrapy has introduced asyncio support since version 2.0 but as of Scrapy 2.3 you need to manually enable it by configuring Twisted's default reactor. Check Scrapy's asyncio documentation for more information.

Checklist:

• scrapy-poet is installed and downloader/injector middleware is configured
• autoextract-poet is installed (page inputs are imported from this lib)
• providers are configured on settings.py
• Scrapy's asyncio support is enabled on settings.py

Now you should be ready to use our AutoExtract providers.

Exceptions

While trying to fetch AutoExtract API, providers might raise some exceptions. Those exceptions might come from scrapy-autoextract providers themselves, zyte-autoextract, or by other means (e.g. ConnectionError). For example:

• autoextract.aio.errors.RequestError: raised when a Request-level error is returned
• scrapy_autoextract.errors.QueryError: raised when a Query-level error is returned

Check zyte-autoextract's async errors for other exception definitions.

You can capture those exceptions using an error callback (errback):

import scrapy
from autoextract.aio.errors import RequestError
from autoextract_poet.pages import AutoExtractArticlePage
from scrapy_autoextract.errors import QueryError
from scrapy_poet import DummyResponse
from twisted.python.failure import Failure

class SampleSpider(scrapy.Spider):
    name = "sample"
    urls = [...]

    def start_requests(self):
        for url in self.urls:
            yield scrapy.Request(url, callback=self.parse_article,
                                 errback=self.errback_article)

    def parse_article(self, response: DummyResponse,
                      article_page: AutoExtractArticlePage):
        yield article_page.to_item()

    def errback_article(self, failure: Failure):
        if failure.check(RequestError):
            self.logger.error(f"RequestError on {failure.request.url}")

        if failure.check(QueryError):
            self.logger.error(f"QueryError: {failure.value.message}")

See Scrapy documentation for more details on how to capture exceptions using request's errback.

Settings

Middleware settings

• AUTOEXTRACT_USER [mandatory] your AutoExtract API key.
• AUTOEXTRACT_URL [optional] the AutoExtract service url. Defaults to autoextract.scrapinghub.com.
• AUTOEXTRACT_TIMEOUT [optional] sets the response timeout from AutoExtract. Defaults to 660 seconds. Can also be defined by setting the "download_timeout" in the request.meta.
• AUTOEXTRACT_PAGE_TYPE [mandatory] defines the kind of document to be extracted. See currently supported page types. Can also be defined on spider.page_type, or {'autoextract': {'pageType': '...'}} request meta. This is required for the AutoExtract classifier to know what the extraction result should be (article, job posting, product, etc.).
• extra [optional] allows sending extra payload data to your AutoExtract request. Must be specified as {'autoextract': {'extra': {}}} request meta and must be a dict.
• AUTOEXTRACT_SLOT_POLICY [optional] Download concurrency options. Defaults to SlotPolicy.PER_DOMAIN - If set to SlotPolicy.PER_DOMAIN, then consider setting SCHEDULER_PRIORITY_QUEUE = 'scrapy.pqueues.DownloaderAwarePriorityQueue' to make better usage of AutoExtract concurrency and avoid delays.

Provider settings

• AUTOEXTRACT_USER [optional] is your AutoExtract API key. If not set, it is taken from ZYTE_AUTOEXTRACT_KEY environment variable.
• AUTOEXTRACT_URL [optional] the AutoExtract service url. Defaults to the official AutoExtract endpoint.
• AUTOEXTRACT_MAX_QUERY_ERROR_RETRIES [optional] Max number of retries for Query-level errors. Defaults to 0.
• AUTOEXTRACT_CONCURRENT_REQUESTS_PER_DOMAIN [optional] Max number of concurrent requests per domain. If not set, the provider will search for the CONCURRENT_REQUESTS_PER_DOMAIN (defaults to 8) setting instead.
• AUTOEXTRACT_CACHE_FILENAME [optional] Filename of a .sqlite file that will be placed in the .scrapy folder. File will be created if it doesn't exist. Cache is useful for development; AutoExtract requests bypass standard Scrapy cache when providers are used.
• AUTOEXTRACT_CACHE_GZIP [optional] when True (default), cached AutoExtract responses are compressed using gzip. Set this option to False to turn compression off.

Limitations

When using the AutoExtract middleware, there are some limitations.

• The incoming spider request is rendered by AutoExtract, not just downloaded by Scrapy, which can change the result - the IP is different, headers are different, etc.
• Only GET requests are supported
• Custom headers and cookies are not supported (i.e. Scrapy features to set them don't work)
• Proxies are not supported (they would work incorrectly, sitting between Scrapy and AutoExtract, instead of AutoExtract and website)
• AutoThrottle extension can work incorrectly for AutoExtract requests, because AutoExtract timing can be much larger than time required to download a page, so it's best to use AUTHTHROTTLE_ENABLED=False in the settings.
• Redirects are handled by AutoExtract, not by Scrapy, so these kinds of middlewares might have no effect
• 429 errors could be handled as standard retries when using Scrapy middleware, but they're handled properly and automatically with scrapy-poet integration, as it relies on zyte-autoextract. You may lose some responses with the middleware approach.
• Overall, retries have a better behavior with scrapy-poet integration and it includes support for automatic Query-level errors retries with no need to change RETRY_HTTP_CODES.
• AutoExtract-specific cache (AUTOEXTRACT_CACHE_FILENAME) is not supported

When using the AutoExtract providers, be aware that:

• With scrapy-poet integration, retry requests don't go through Scrapy