Spiders

Spiders are classes which define how a certain site (or a group of sites) will be scraped, including how to perform the crawl (i.e. follow links) and how to extract structured data from their pages (i.e. scraping items). In other words, Spiders are the place where you define the custom behaviour for crawling and parsing pages for a particular site (or, in some cases, a group of sites).

For spiders, the scraping cycle goes through something like this:

  1. You start by generating the initial Requests to crawl the first URLs, and specify a callback function to be called with the response downloaded from those requests.

    The first requests to perform are obtained by calling the start_requests() method which (by default) generates Request for the URLs specified in the start_urls and the parse method as callback function for the Requests.

  2. In the callback function, you parse the response (web page) and return item objects, Request objects, or an iterable of these objects. Those Requests will also contain a callback (maybe the same) and will then be downloaded by Scrapy and then their response handled by the specified callback.

  3. In callback functions, you parse the page contents, typically using Selectors (but you can also use BeautifulSoup, lxml or whatever mechanism you prefer) and generate items with the parsed data.

  4. Finally, the items returned from the spider will be typically persisted to a database (in some Item Pipeline) or written to a file using Feed exports.

Even though this cycle applies (more or less) to any kind of spider, there are different kinds of default spiders bundled into Scrapy for different purposes. We will talk about those types here.

scrapy.Spider

class scrapy.spiders.``Spider[source]

This is the simplest spider, and the one from which every other spider must inherit (including spiders that come bundled with Scrapy, as well as spiders that you write yourself). It doesn’t provide any special functionality. It just provides a default start_requests() implementation which sends requests from the start_urls spider attribute and calls the spider’s method parse for each of the resulting responses.

  • name

    A string which defines the name for this spider. The spider name is how the spider is located (and instantiated) by Scrapy, so it must be unique. However, nothing prevents you from instantiating more than one instance of the same spider. This is the most important spider attribute and it’s required.

    If the spider scrapes a single domain, a common practice is to name the spider after the domain, with or without the TLD. So, for example, a spider that crawls mywebsite.com would often be called mywebsite.

  • allowed_domains

    An optional list of strings containing domains that this spider is allowed to crawl. Requests for URLs not belonging to the domain names specified in this list (or their subdomains) won’t be followed if OffsiteMiddleware is enabled.

    Let’s say your target url is https://www.example.com/1.html, then add 'example.com' to the list.

  • start_urls

    A list of URLs where the spider will begin to crawl from, when no particular URLs are specified. So, the first pages downloaded will be those listed here. The subsequent Request will be generated successively from data contained in the start URLs.

  • custom_settings

    A dictionary of settings that will be overridden from the project wide configuration when running this spider. It must be defined as a class attribute since the settings are updated before instantiation.

    For a list of available built-in settings see: Built-in settings reference.

  • crawler

    This attribute is set by the from_crawler() class method after initializating the class, and links to the Crawler object to which this spider instance is bound.

    Crawlers encapsulate a lot of components in the project for their single entry access (such as extensions, middlewares, signals managers, etc). See Crawler API to know more about them.

  • settings

    Configuration for running this spider. This is a Settings instance, see the Settings topic for a detailed introduction on this subject.

  • logger

    Python logger created with the Spider’s name. You can use it to send log messages through it as described on Logging from Spiders.

  • from_crawler(crawler, \args, **kwargs*)[source]

    This is the class method used by Scrapy to create your spiders.

    You probably won’t need to override this directly because the default implementation acts as a proxy to the __init__() method, calling it with the given arguments args and named arguments kwargs.

    Nonetheless, this method sets the crawler and settings attributes in the new instance so they can be accessed later inside the spider’s code.

    • Parameters

      • crawler (Crawler instance) – crawler to which the spider will be bound

      • args (list) – arguments passed to the __init__() method

      • kwargs (dict) – keyword arguments passed to the __init__() method

  • start_requests()[source]

    This method must return an iterable with the first Requests to crawl for this spider. It is called by Scrapy when the spider is opened for scraping. Scrapy calls it only once, so it is safe to implement start_requests() as a generator.

    The default implementation generates Request(url, dont_filter=True) for each url in start_urls.

    If you want to change the Requests used to start scraping a domain, this is the method to override. For example, if you need to start by logging in using a POST request, you could do:

    1. class MySpider(scrapy.Spider):
    2.     name = 'myspider'
    4.     def start_requests(self):
    5.         return [scrapy.FormRequest("http://www.example.com/login",
    6.                                    formdata={'user': 'john', 'pass': 'secret'},
    7.                                    callback=self.logged_in)]
    9.     def logged_in(self, response):
    10.         # here you would extract links to follow and return Requests for
    11.         # each of them, with another callback
    12.         pass

  • parse(response)[source]

    This is the default callback used by Scrapy to process downloaded responses, when their requests don’t specify a callback.

    The parse method is in charge of processing the response and returning scraped data and/or more URLs to follow. Other Requests callbacks have the same requirements as the Spider class.

    This method, as well as any other Request callback, must return an iterable of Request and/or item objects.

    • Parameters

      response (Response) – the response to parse

  • log(message[, level, component])[source]

    Wrapper that sends a log message through the Spider’s logger, kept for backward compatibility. For more information see Logging from Spiders.

  • closed(reason)

    Called when the spider closes. This method provides a shortcut to signals.connect() for the spider_closed signal.

Let’s see an example:

  1. import scrapy
  4. class MySpider(scrapy.Spider):
  5.     name = 'example.com'
  6.     allowed_domains = ['example.com']
  7.     start_urls = [
  8.         'http://www.example.com/1.html',
  9.         'http://www.example.com/2.html',
  10.         'http://www.example.com/3.html',
  11.     ]
  13.     def parse(self, response):
  14.         self.logger.info('A response from %s just arrived!', response.url)

Return multiple Requests and items from a single callback:

  1. import scrapy
  3. class MySpider(scrapy.Spider):
  4.     name = 'example.com'
  5.     allowed_domains = ['example.com']
  6.     start_urls = [
  7.         'http://www.example.com/1.html',
  8.         'http://www.example.com/2.html',
  9.         'http://www.example.com/3.html',
  10.     ]
  12.     def parse(self, response):
  13.         for h3 in response.xpath('//h3').getall():
  14.             yield {"title": h3}
  16.         for href in response.xpath('//a/@href').getall():
  17.             yield scrapy.Request(response.urljoin(href), self.parse)

Instead of start_urls you can use start_requests() directly; to give data more structure you can use Item objects:

  1. import scrapy
  2. from myproject.items import MyItem
  4. class MySpider(scrapy.Spider):
  5.     name = 'example.com'
  6.     allowed_domains = ['example.com']
  8.     def start_requests(self):
  9.         yield scrapy.Request('http://www.example.com/1.html', self.parse)
  10.         yield scrapy.Request('http://www.example.com/2.html', self.parse)
  11.         yield scrapy.Request('http://www.example.com/3.html', self.parse)
  13.     def parse(self, response):
  14.         for h3 in response.xpath('//h3').getall():
  15.             yield MyItem(title=h3)
  17.         for href in response.xpath('//a/@href').getall():
  18.             yield scrapy.Request(response.urljoin(href), self.parse)

Spider arguments

Spiders can receive arguments that modify their behaviour. Some common uses for spider arguments are to define the start URLs or to restrict the crawl to certain sections of the site, but they can be used to configure any functionality of the spider.

Spider arguments are passed through the crawl command using the -a option. For example:

  1. scrapy crawl myspider -a category=electronics

Spiders can access arguments in their __init__ methods:

  1. import scrapy
  3. class MySpider(scrapy.Spider):
  4.     name = 'myspider'
  6.     def __init__(self, category=None, *args, **kwargs):
  7.         super(MySpider, self).__init__(*args, **kwargs)
  8.         self.start_urls = ['http://www.example.com/categories/%s' % category]
  9.         # ...

The default __init__ method will take any spider arguments and copy them to the spider as attributes. The above example can also be written as follows:

  1. import scrapy
  3. class MySpider(scrapy.Spider):
  4.     name = 'myspider'
  6.     def start_requests(self):
  7.         yield scrapy.Request('http://www.example.com/categories/%s' % self.category)

Keep in mind that spider arguments are only strings. The spider will not do any parsing on its own. If you were to set the start_urls attribute from the command line, you would have to parse it on your own into a list using something like ast.literal_eval() or json.loads() and then set it as an attribute. Otherwise, you would cause iteration over a start_urls string (a very common python pitfall) resulting in each character being seen as a separate url.

A valid use case is to set the http auth credentials used by HttpAuthMiddleware or the user agent used by UserAgentMiddleware:

  1. scrapy crawl myspider -a http_user=myuser -a http_pass=mypassword -a user_agent=mybot

Spider arguments can also be passed through the Scrapyd schedule.json API. See Scrapyd documentation.

Generic Spiders

Scrapy comes with some useful generic spiders that you can use to subclass your spiders from. Their aim is to provide convenient functionality for a few common scraping cases, like following all links on a site based on certain rules, crawling from Sitemaps, or parsing an XML/CSV feed.

For the examples used in the following spiders, we’ll assume you have a project with a TestItem declared in a myproject.items module:

  1. import scrapy
  3. class TestItem(scrapy.Item):
  4.     id = scrapy.Field()
  5.     name = scrapy.Field()
  6.     description = scrapy.Field()

CrawlSpider

class scrapy.spiders.``CrawlSpider[source]

This is the most commonly used spider for crawling regular websites, as it provides a convenient mechanism for following links by defining a set of rules. It may not be the best suited for your particular web sites or project, but it’s generic enough for several cases, so you can start from it and override it as needed for more custom functionality, or just implement your own spider.

Apart from the attributes inherited from Spider (that you must specify), this class supports a new attribute:

  • rules

    Which is a list of one (or more) Rule objects. Each Rule defines a certain behaviour for crawling the site. Rules objects are described below. If multiple rules match the same link, the first one will be used, according to the order they’re defined in this attribute.

This spider also exposes an overrideable method:

  • parse_start_url(response, \*kwargs*)[source]

    This method is called for each response produced for the URLs in the spider’s start_urls attribute. It allows to parse the initial responses and must return either an item object, a Request object, or an iterable containing any of them.

Crawling rules

class scrapy.spiders.``Rule(link_extractor=None, callback=None, cb_kwargs=None, follow=None, process_links=None, process_request=None, errback=None)[source]

link_extractor is a Link Extractor object which defines how links will be extracted from each crawled page. Each produced link will be used to generate a Request object, which will contain the link’s text in its meta dictionary (under the link_text key). If omitted, a default link extractor created with no arguments will be used, resulting in all links being extracted.

callback is a callable or a string (in which case a method from the spider object with that name will be used) to be called for each link extracted with the specified link extractor. This callback receives a Response as its first argument and must return either a single instance or an iterable of item objects and/or Request objects (or any subclass of them). As mentioned above, the received Response object will contain the text of the link that produced the Request in its meta dictionary (under the link_text key)

cb_kwargs is a dict containing the keyword arguments to be passed to the callback function.

follow is a boolean which specifies if links should be followed from each response extracted with this rule. If callback is None follow defaults to True, otherwise it defaults to False.

process_links is a callable, or a string (in which case a method from the spider object with that name will be used) which will be called for each list of links extracted from each response using the specified link_extractor. This is mainly used for filtering purposes.

process_request is a callable (or a string, in which case a method from the spider object with that name will be used) which will be called for every Request extracted by this rule. This callable should take said request as first argument and the Response from which the request originated as second argument. It must return a Request object or None (to filter out the request).

errback is a callable or a string (in which case a method from the spider object with that name will be used) to be called if any exception is raised while processing a request generated by the rule. It receives a Twisted Failure instance as first parameter.

Warning

Because of its internal implementation, you must explicitly set callbacks for new requests when writing CrawlSpider-based spiders; unexpected behaviour can occur otherwise.

New in version 2.0: The errback parameter.

CrawlSpider example

Let’s now take a look at an example CrawlSpider with rules:

  1. import scrapy
  2. from scrapy.spiders import CrawlSpider, Rule
  3. from scrapy.linkextractors import LinkExtractor
  5. class MySpider(CrawlSpider):
  6.     name = 'example.com'
  7.     allowed_domains = ['example.com']
  8.     start_urls = ['http://www.example.com']
  10.     rules = (
  11.         # Extract links matching 'category.php' (but not matching 'subsection.php')
  12.         # and follow links from them (since no callback means follow=True by default).
  13.         Rule(LinkExtractor(allow=('category\.php', ), deny=('subsection\.php', ))),
  15.         # Extract links matching 'item.php' and parse them with the spider's method parse_item
  16.         Rule(LinkExtractor(allow=('item\.php', )), callback='parse_item'),
  17.     )
  19.     def parse_item(self, response):
  20.         self.logger.info('Hi, this is an item page! %s', response.url)
  21.         item = scrapy.Item()
  22.         item['id'] = response.xpath('//td[@id="item_id"]/text()').re(r'ID: (\d+)')
  23.         item['name'] = response.xpath('//td[@id="item_name"]/text()').get()
  24.         item['description'] = response.xpath('//td[@id="item_description"]/text()').get()
  25.         item['link_text'] = response.meta['link_text']
  26.         url = response.xpath('//td[@id="additional_data"]/@href').get()
  27.         return response.follow(url, self.parse_additional_page, cb_kwargs=dict(item=item))
  29.     def parse_additional_page(self, response, item):
  30.         item['additional_data'] = response.xpath('//p[@id="additional_data"]/text()').get()
  31.         return item

This spider would start crawling example.com’s home page, collecting category links, and item links, parsing the latter with the parse_item method. For each item response, some data will be extracted from the HTML using XPath, and an Item will be filled with it.

XMLFeedSpider

class scrapy.spiders.``XMLFeedSpider[source]

XMLFeedSpider is designed for parsing XML feeds by iterating through them by a certain node name. The iterator can be chosen from: iternodes, xml, and html. It’s recommended to use the iternodes iterator for performance reasons, since the xml and html iterators generate the whole DOM at once in order to parse it. However, using html as the iterator may be useful when parsing XML with bad markup.

To set the iterator and the tag name, you must define the following class attributes:

  • iterator

    A string which defines the iterator to use. It can be either:

    • 'iternodes' - a fast iterator based on regular expressions

    • 'html' - an iterator which uses Selector. Keep in mind this uses DOM parsing and must load all DOM in memory which could be a problem for big feeds

    • 'xml' - an iterator which uses Selector. Keep in mind this uses DOM parsing and must load all DOM in memory which could be a problem for big feeds

    It defaults to: 'iternodes'.

  • itertag

    A string with the name of the node (or element) to iterate in. Example:

    1. itertag = 'product'

  • namespaces

    A list of (prefix, uri) tuples which define the namespaces available in that document that will be processed with this spider. The prefix and uri will be used to automatically register namespaces using the register_namespace() method.

    You can then specify nodes with namespaces in the itertag attribute.

    Example:

    1. class YourSpider(XMLFeedSpider):
    3.     namespaces = [('n', 'http://www.sitemaps.org/schemas/sitemap/0.9')]
    4.     itertag = 'n:url'
    5.     # ...

Apart from these new attributes, this spider has the following overrideable methods too:

  • adapt_response(response)[source]

    A method that receives the response as soon as it arrives from the spider middleware, before the spider starts parsing it. It can be used to modify the response body before parsing it. This method receives a response and also returns a response (it could be the same or another one).

  • parse_node(response, selector)[source]

    This method is called for the nodes matching the provided tag name (itertag). Receives the response and an Selector for each node. Overriding this method is mandatory. Otherwise, you spider won’t work. This method must return an item object, a Request object, or an iterable containing any of them.

  • process_results(response, results)[source]

    This method is called for each result (item or request) returned by the spider, and it’s intended to perform any last time processing required before returning the results to the framework core, for example setting the item IDs. It receives a list of results and the response which originated those results. It must return a list of results (items or requests).

Warning

Because of its internal implementation, you must explicitly set callbacks for new requests when writing XMLFeedSpider-based spiders; unexpected behaviour can occur otherwise.

XMLFeedSpider example

These spiders are pretty easy to use, let’s have a look at one example:

  1. from scrapy.spiders import XMLFeedSpider
  2. from myproject.items import TestItem
  4. class MySpider(XMLFeedSpider):
  5.     name = 'example.com'
  6.     allowed_domains = ['example.com']
  7.     start_urls = ['http://www.example.com/feed.xml']
  8.     iterator = 'iternodes'  # This is actually unnecessary, since it's the default value
  9.     itertag = 'item'
  11.     def parse_node(self, response, node):
  12.         self.logger.info('Hi, this is a <%s> node!: %s', self.itertag, ''.join(node.getall()))
  14.         item = TestItem()
  15.         item['id'] = node.xpath('@id').get()
  16.         item['name'] = node.xpath('name').get()
  17.         item['description'] = node.xpath('description').get()
  18.         return item

Basically what we did up there was to create a spider that downloads a feed from the given start_urls, and then iterates through each of its item tags, prints them out, and stores some random data in an Item.

CSVFeedSpider

class scrapy.spiders.``CSVFeedSpider[source]

This spider is very similar to the XMLFeedSpider, except that it iterates over rows, instead of nodes. The method that gets called in each iteration is parse_row().

  • delimiter

    A string with the separator character for each field in the CSV file Defaults to ',' (comma).

  • quotechar

    A string with the enclosure character for each field in the CSV file Defaults to '"' (quotation mark).

  • headers

    A list of the column names in the CSV file.

  • parse_row(response, row)[source]

    Receives a response and a dict (representing each row) with a key for each provided (or detected) header of the CSV file. This spider also gives the opportunity to override adapt_response and process_results methods for pre- and post-processing purposes.

CSVFeedSpider example

Let’s see an example similar to the previous one, but using a CSVFeedSpider:

  1. from scrapy.spiders import CSVFeedSpider
  2. from myproject.items import TestItem
  4. class MySpider(CSVFeedSpider):
  5.     name = 'example.com'
  6.     allowed_domains = ['example.com']
  7.     start_urls = ['http://www.example.com/feed.csv']
  8.     delimiter = ';'
  9.     quotechar = "'"
  10.     headers = ['id', 'name', 'description']
  12.     def parse_row(self, response, row):
  13.         self.logger.info('Hi, this is a row!: %r', row)
  15.         item = TestItem()
  16.         item['id'] = row['id']
  17.         item['name'] = row['name']
  18.         item['description'] = row['description']
  19.         return item

SitemapSpider

class scrapy.spiders.``SitemapSpider[source]

SitemapSpider allows you to crawl a site by discovering the URLs using Sitemaps.

It supports nested sitemaps and discovering sitemap urls from robots.txt.

  • sitemap_urls

    A list of urls pointing to the sitemaps whose urls you want to crawl.

    You can also point to a robots.txt and it will be parsed to extract sitemap urls from it.

  • sitemap_rules

    A list of tuples (regex, callback) where:

    • regex is a regular expression to match urls extracted from sitemaps. regex can be either a str or a compiled regex object.

    • callback is the callback to use for processing the urls that match the regular expression. callback can be a string (indicating the name of a spider method) or a callable.

    For example:

    1. sitemap_rules = [('/product/', 'parse_product')]

    Rules are applied in order, and only the first one that matches will be used.

    If you omit this attribute, all urls found in sitemaps will be processed with the parse callback.

  • sitemap_follow

    A list of regexes of sitemap that should be followed. This is only for sites that use Sitemap index files that point to other sitemap files.

    By default, all sitemaps are followed.

  • sitemap_alternate_links

    Specifies if alternate links for one url should be followed. These are links for the same website in another language passed within the same url block.

    For example:

    1. <url>
    2.     <loc>http://example.com/</loc>
    3.     <xhtml:link rel="alternate" hreflang="de" href="http://example.com/de"/>
    4. </url>

    With sitemap_alternate_links set, this would retrieve both URLs. With sitemap_alternate_links disabled, only http://example.com/ would be retrieved.

    Default is sitemap_alternate_links disabled.

  • sitemap_filter(entries)[source]

    This is a filter function that could be overridden to select sitemap entries based on their attributes.

    For example:

    1. <url>
    2.     <loc>http://example.com/</loc>
    3.     <lastmod>2005-01-01</lastmod>
    4. </url>

    We can define a sitemap_filter function to filter entries by date:

    1. from datetime import datetime
    2. from scrapy.spiders import SitemapSpider
    4. class FilteredSitemapSpider(SitemapSpider):
    5.     name = 'filtered_sitemap_spider'
    6.     allowed_domains = ['example.com']
    7.     sitemap_urls = ['http://example.com/sitemap.xml']
    9.     def sitemap_filter(self, entries):
    10.         for entry in entries:
    11.             date_time = datetime.strptime(entry['lastmod'], '%Y-%m-%d')
    12.             if date_time.year >= 2005:
    13.                 yield entry

    This would retrieve only entries modified on 2005 and the following years.

    Entries are dict objects extracted from the sitemap document. Usually, the key is the tag name and the value is the text inside it.

    It’s important to notice that:

    • as the loc attribute is required, entries without this tag are discarded

    • alternate links are stored in a list with the key alternate (see sitemap_alternate_links)

    • namespaces are removed, so lxml tags named as {namespace}tagname become only tagname

    If you omit this method, all entries found in sitemaps will be processed, observing other attributes and their settings.

SitemapSpider examples

Simplest example: process all urls discovered through sitemaps using the parse callback:

  1. from scrapy.spiders import SitemapSpider
  3. class MySpider(SitemapSpider):
  4.     sitemap_urls = ['http://www.example.com/sitemap.xml']
  6.     def parse(self, response):
  7.         pass # ... scrape item here ...

Process some urls with certain callback and other urls with a different callback:

  1. from scrapy.spiders import SitemapSpider
  3. class MySpider(SitemapSpider):
  4.     sitemap_urls = ['http://www.example.com/sitemap.xml']
  5.     sitemap_rules = [
  6.         ('/product/', 'parse_product'),
  7.         ('/category/', 'parse_category'),
  8.     ]
  10.     def parse_product(self, response):
  11.         pass # ... scrape product ...
  13.     def parse_category(self, response):
  14.         pass # ... scrape category ...

Follow sitemaps defined in the robots.txt file and only follow sitemaps whose url contains /sitemap_shop:

  1. from scrapy.spiders import SitemapSpider
  3. class MySpider(SitemapSpider):
  4.     sitemap_urls = ['http://www.example.com/robots.txt']
  5.     sitemap_rules = [
  6.         ('/shop/', 'parse_shop'),
  7.     ]
  8.     sitemap_follow = ['/sitemap_shops']
  10.     def parse_shop(self, response):
  11.         pass # ... scrape shop here ...

Combine SitemapSpider with other sources of urls:

  1. from scrapy.spiders import SitemapSpider
  3. class MySpider(SitemapSpider):
  4.     sitemap_urls = ['http://www.example.com/robots.txt']
  5.     sitemap_rules = [
  6.         ('/shop/', 'parse_shop'),
  7.     ]
  9.     other_urls = ['http://www.example.com/about']
  11.     def start_requests(self):
  12.         requests = list(super(MySpider, self).start_requests())
  13.         requests += [scrapy.Request(x, self.parse_other) for x in self.other_urls]
  14.         return requests
  16.     def parse_shop(self, response):
  17.         pass # ... scrape shop here ...
  19.     def parse_other(self, response):
  20.         pass # ... scrape other here ...