Scrapy Documentation Release 1.4.0 Scrapy developers Jul 05, 2017 First steps 1 Getting help 3 2 First steps 5 2.1 Scrapy at a glance............................................5 2.2 Installation guide.............................................7 2.3 Scrapy Tutorial.............................................. 10 2.4 Examples................................................. 21 3 Basic concepts 23 3.1 Command line tool............................................ 23 3.2 Spiders.................................................. 32 3.3 Selectors................................................. 42 3.4 Items................................................... 54 3.5 Item Loaders............................................... 58 3.6 Scrapy shell............................................... 68 3.7 Item Pipeline............................................... 72 3.8 Feed exports............................................... 76 3.9 Requests and Responses......................................... 81 3.10 Link Extractors.............................................. 91 3.11 Settings.................................................. 93 3.12 Exceptions................................................ 115 4 Built-in services 119 4.1 Logging.................................................. 119 4.2 Stats Collection.............................................. 123 4.3 Sending e-mail.............................................. 125 4.4 Telnet Console.............................................. 127 4.5 Web Service............................................... 129 5 Solving specific problems 131 5.1 Frequently Asked Questions....................................... 131 5.2 Debugging Spiders............................................ 136 5.3 Spiders Contracts............................................. 138 5.4 Common Practices............................................ 140 5.5 Broad Crawls............................................... 143 5.6 Using Firefox for scraping........................................ 146 5.7 Using Firebug for scraping........................................ 147 i 5.8 Debugging memory leaks........................................ 152 5.9 Downloading and processing files and images.............................. 156 5.10 Deploying Spiders............................................ 162 5.11 AutoThrottle extension.......................................... 163 5.12 Benchmarking.............................................. 165 5.13 Jobs: pausing and resuming crawls................................... 167 5.14 XPath Tutorial.............................................. 169 6 Extending Scrapy 193 6.1 Architecture overview.......................................... 193 6.2 Downloader Middleware......................................... 196 6.3 Spider Middleware............................................ 209 6.4 Extensions................................................ 215 6.5 Core API................................................. 220 6.6 Signals.................................................. 228 6.7 Item Exporters.............................................. 232 7 All the rest 239 7.1 Release notes............................................... 239 7.2 Contributing to Scrapy.......................................... 282 7.3 Versioning and API Stability....................................... 284 Python Module Index 287 ii Scrapy Documentation, Release 1.4.0 This documentation contains everything you need to know about Scrapy. First steps 1 Scrapy Documentation, Release 1.4.0 2 First steps CHAPTER 1 Getting help Having trouble? We’d like to help! • Try the FAQ – it’s got answers to some common questions. • Looking for specific information? Try the genindex or modindex. • Ask or search questions in StackOverflow using the scrapy tag. • Ask or search questions in the Scrapy subreddit. • Search for questions on the archives of the scrapy-users mailing list. • Ask a question in the #scrapy IRC channel, • Report bugs with Scrapy in our issue tracker. 3 Scrapy Documentation, Release 1.4.0 4 Chapter 1. Getting help CHAPTER 2 First steps Scrapy at a glance Scrapy is an application framework for crawling web sites and extracting structured data which can be used for a wide range of useful applications, like data mining, information processing or historical archival. Even though Scrapy was originally designed for web scraping, it can also be used to extract data using APIs (such as Amazon Associates Web Services) or as a general purpose web crawler. Walk-through of an example spider In order to show you what Scrapy brings to the table, we’ll walk you through an example of a Scrapy Spider using the simplest way to run a spider. Here’s the code for a spider that scrapes famous quotes from website http://quotes.toscrape.com, following the pagi- nation: import scrapy class QuotesSpider(scrapy.Spider): name="quotes" start_urls=[ 'http://quotes.toscrape.com/tag/humor/', ] def parse(self, response): for quote in response.css('div.quote'): yield { 'text': quote.css('span.text::text').extract_first(), 'author': quote.xpath('span/small/text()').extract_first(), } next_page= response.css('li.next a::attr("href")').extract_first() 5 Scrapy Documentation, Release 1.4.0 if next_page is not None: yield response.follow(next_page, self.parse) Put this in a text file, name it to something like quotes_spider.py and run the spider using the runspider command: scrapy runspider quotes_spider.py-o quotes.json When this finishes you will have in the quotes.json file a list of the quotes in JSON format, containing text and author, looking like this (reformatted here for better readability): [{ "author":"Jane Austen", "text":" \u201cThe person, be it gentleman or lady, who has not pleasure in a ,!good novel, must be intolerably stupid.\u201d" }, { "author":"Groucho Marx", "text":" \u201cOutside of a dog, a book is man's best friend. Inside of a dog it ,!'s too dark to read.\u201d" }, { "author":"Steve Martin", "text":" \u201cA day without sunshine is like, you know, night.\u201d" }, ...] What just happened? When you ran the command scrapy runspider quotes_spider.py, Scrapy looked for a Spider definition inside it and ran it through its crawler engine. The crawl started by making requests to the URLs defined in the start_urls attribute (in this case, only the URL for quotes in humor category) and called the default callback method parse, passing the response object as an argument. In the parse callback, we loop through the quote elements using a CSS Selector, yield a Python dict with the extracted quote text and author, look for a link to the next page and schedule another request using the same parse method as callback. Here you notice one of the main advantages about Scrapy: requests are scheduled and processed asynchronously. This means that Scrapy doesn’t need to wait for a request to be finished and processed, it can send another request or do other things in the meantime. This also means that other requests can keep going even if some request fails or an error happens while handling it. While this enables you to do very fast crawls (sending multiple concurrent requests at the same time, in a fault-tolerant way) Scrapy also gives you control over the politeness of the crawl through a few settings. You can do things like setting a download delay between each request, limiting amount of concurrent requests per domain or per IP, and even using an auto-throttling extension that tries to figure out these automatically. Note: This is using feed exports to generate the JSON file, you can easily change the export format (XML or CSV, for example) or the storage backend (FTP or Amazon S3, for example). You can also write an item pipeline to store the items in a database. 6 Chapter 2. First steps Scrapy Documentation, Release 1.4.0 What else? You’ve seen how to extract and store items from a website using Scrapy, but this is just the surface. Scrapy provides a lot of powerful features for making scraping easy and efficient, such as: • Built-in support for selecting and extracting data from HTML/XML sources using extended CSS selectors and XPath expressions, with helper methods to extract using regular expressions. • An interactive shell console (IPython aware) for trying out the CSS and XPath expressions to scrape data, very useful when writing or debugging your spiders. • Built-in support for generating feed exports in multiple formats (JSON, CSV, XML) and storing them in multiple backends (FTP, S3, local filesystem) • Robust encoding support and auto-detection, for dealing with foreign, non-standard and broken encoding dec- larations. • Strong extensibility support, allowing you to plug in your own functionality using signals and a well-defined API (middlewares, extensions, and pipelines). • Wide range of built-in extensions and middlewares for handling: – cookies and session handling – HTTP features like compression, authentication, caching – user-agent spoofing – robots.txt – crawl depth restriction – and more •A Telnet console for hooking into a Python console running inside your Scrapy process, to introspect and debug your crawler • Plus other goodies like reusable spiders to crawl sites from Sitemaps and XML/CSV feeds, a media pipeline for automatically downloading images (or any other media) associated with the scraped items, a caching DNS resolver, and much more! What’s next? The next steps for you are to install Scrapy, follow through the tutorial to learn how to create a full-blown Scrapy project and join the community. Thanks for your interest! Installation