Scrapy

1"""This module defines the main entry point for the Apify Actor.
2
3This module defines the main coroutine for the Apify Scrapy Actor, executed from the __main__.py file. The coroutine
4processes the Actor's input and executes the Scrapy spider. Additionally, it updates Scrapy project settings by
5applying Apify-related settings. Which includes adding a custom scheduler, retry middleware, and an item pipeline
6for pushing data to the Apify dataset.
7
8Customization:
9--------------
10
11Feel free to customize this file to add specific functionality to the Actor, such as incorporating your own Scrapy
12components like spiders and handling Actor input. However, make sure you have a clear understanding of your
13modifications. For instance, removing `apply_apify_settings` break the integration between Scrapy and Apify.
14
15Documentation:
16--------------
17
18For an in-depth description of the Apify-Scrapy integration process, our Scrapy components, known limitations and
19other stuff, please refer to the following documentation page: https://docs.apify.com/cli/docs/integrating-scrapy.
20"""
21
22from __future__ import annotations
23
24from apify import Actor
25from apify.scrapy import apply_apify_settings
26from scrapy.crawler import CrawlerRunner
27from scrapy.utils.defer import deferred_to_future
28
29# Import your Scrapy spider here.
30from .spiders import TitleSpider as Spider
31
32
33async def main() -> None:
34    """Apify Actor main coroutine for executing the Scrapy spider."""
35    async with Actor:
36        # Retrieve and process Actor input.
37        actor_input = await Actor.get_input() or {}
38        start_urls = [url['url'] for url in actor_input.get('startUrls', [])]
39        allowed_domains = actor_input.get('allowedDomains')
40        proxy_config = actor_input.get('proxyConfiguration')
41
42        # Apply Apify settings, which will override the Scrapy project settings.
43        settings = apply_apify_settings(proxy_config=proxy_config)
44
45        # Create CrawlerRunner and execute the Scrapy spider.
46        crawler_runner = CrawlerRunner(settings)
47        crawl_deferred = crawler_runner.crawl(
48            Spider,
49            start_urls=start_urls,
50            allowed_domains=allowed_domains,
51        )
52        await deferred_to_future(crawl_deferred)