pax_global_header00006660000000000000000000000064150312513020014502gustar00rootroot0000000000000052 comment=155a504f24b9dd180b8786a4fa709f87cfe8fb66 scrapy-2.13.3/000077500000000000000000000000001503125130200130715ustar00rootroot00000000000000scrapy-2.13.3/.git-blame-ignore-revs000066400000000000000000000005011503125130200171650ustar00rootroot00000000000000# .git-blame-ignore-revs # adding black formatter to all the code e211ec0aa26ecae0da8ae55d064ea60e1efe4d0d # reapplying black to the code with default line length 303f0a70fcf8067adf0a909c2096a5009162383a # reapplying black again and removing line length on pre-commit black config c5cdd0d30ceb68ccba04af0e71d1b8e6678e2962scrapy-2.13.3/.gitattributes000066400000000000000000000000341503125130200157610ustar00rootroot00000000000000tests/sample_data/** binary scrapy-2.13.3/.github/000077500000000000000000000000001503125130200144315ustar00rootroot00000000000000scrapy-2.13.3/.github/ISSUE_TEMPLATE/000077500000000000000000000000001503125130200166145ustar00rootroot00000000000000scrapy-2.13.3/.github/ISSUE_TEMPLATE/bug_report.md000066400000000000000000000027631503125130200213160ustar00rootroot00000000000000--- name: Bug report about: Report a problem to help us improve --- ### Description [Description of the issue] ### Steps to Reproduce 1. [First Step] 2. [Second Step] 3. [and so on...] **Expected behavior:** [What you expect to happen] **Actual behavior:** [What actually happens] **Reproduces how often:** [What percentage of the time does it reproduce?] ### Versions Please paste here the output of executing `scrapy version --verbose` in the command line. ### Additional context Any additional information, configuration, data or output from commands that might be necessary to reproduce or understand the issue. Please try not to include screenshots of code or the command line, paste the contents as text instead. You can use [GitHub Flavored Markdown](https://help.github.com/en/articles/creating-and-highlighting-code-blocks) to make the text look better. scrapy-2.13.3/.github/ISSUE_TEMPLATE/feature_request.md000066400000000000000000000023701503125130200223430ustar00rootroot00000000000000--- name: Feature request about: Suggest an idea for an enhancement or new feature --- ## Summary One paragraph explanation of the feature. ## Motivation Why are we doing this? What use cases does it support? What is the expected outcome? ## Describe alternatives you've considered A clear and concise description of the alternative solutions you've considered. Be sure to explain why Scrapy's existing customizability isn't suitable for this feature. ## Additional context Any additional information about the feature request here. scrapy-2.13.3/.github/ISSUE_TEMPLATE/question.md000066400000000000000000000006441503125130200210110ustar00rootroot00000000000000--- name: Question / Help about: Ask a question about Scrapy or ask for help with your Scrapy code. --- Thanks for taking an interest in Scrapy! The Scrapy GitHub issue tracker is not meant for questions or help. Please ask for help in the [Scrapy community resources](https://scrapy.org/community/) instead. The GitHub issue tracker's purpose is to deal with bug reports and feature requests for the project itself. scrapy-2.13.3/.github/workflows/000077500000000000000000000000001503125130200164665ustar00rootroot00000000000000scrapy-2.13.3/.github/workflows/checks.yml000066400000000000000000000021611503125130200204510ustar00rootroot00000000000000name: Checks on: push: branches: - master - '[0-9]+.[0-9]+' pull_request: concurrency: group: ${{github.workflow}}-${{ github.ref }} cancel-in-progress: true jobs: checks: runs-on: ubuntu-latest strategy: fail-fast: false matrix: include: - python-version: "3.13" env: TOXENV: pylint - python-version: "3.9" env: TOXENV: typing - python-version: "3.9" env: TOXENV: typing-tests - python-version: "3.13" # Keep in sync with .readthedocs.yml env: TOXENV: docs - python-version: "3.13" env: TOXENV: twinecheck steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Run check env: ${{ matrix.env }} run: | pip install -U tox tox pre-commit: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - uses: pre-commit/action@v3.0.1 scrapy-2.13.3/.github/workflows/publish.yml000066400000000000000000000012061503125130200206560ustar00rootroot00000000000000name: Publish on: push: tags: - '[0-9]+.[0-9]+.[0-9]+' concurrency: group: ${{github.workflow}}-${{ github.ref }} cancel-in-progress: true jobs: publish: name: Upload release to PyPI runs-on: ubuntu-latest environment: name: pypi url: https://pypi.org/p/Scrapy permissions: id-token: write steps: - uses: actions/checkout@v4 - uses: actions/setup-python@v5 with: python-version: "3.13" - run: | python -m pip install --upgrade build python -m build - name: Publish to PyPI uses: pypa/gh-action-pypi-publish@release/v1 scrapy-2.13.3/.github/workflows/tests-macos.yml000066400000000000000000000014351503125130200214560ustar00rootroot00000000000000name: macOS on: push: branches: - master - '[0-9]+.[0-9]+' pull_request: concurrency: group: ${{github.workflow}}-${{ github.ref }} cancel-in-progress: true jobs: tests: runs-on: macos-latest strategy: fail-fast: false matrix: python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Run tests run: | pip install -U tox tox -e py - name: Upload coverage report uses: codecov/codecov-action@v5 - name: Upload test results if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 scrapy-2.13.3/.github/workflows/tests-ubuntu.yml000066400000000000000000000043521503125130200216770ustar00rootroot00000000000000name: Ubuntu on: push: branches: - master - '[0-9]+.[0-9]+' pull_request: concurrency: group: ${{github.workflow}}-${{ github.ref }} cancel-in-progress: true jobs: tests: runs-on: ubuntu-latest strategy: fail-fast: false matrix: include: - python-version: "3.9" env: TOXENV: py - python-version: "3.10" env: TOXENV: py - python-version: "3.11" env: TOXENV: py - python-version: "3.12" env: TOXENV: py - python-version: "3.13" env: TOXENV: py - python-version: "3.13" env: TOXENV: default-reactor - python-version: pypy3.10 env: TOXENV: pypy3 - python-version: pypy3.11 env: TOXENV: pypy3 # pinned deps - python-version: "3.9.21" env: TOXENV: pinned - python-version: "3.9.21" env: TOXENV: default-reactor-pinned - python-version: pypy3.10 env: TOXENV: pypy3-pinned - python-version: "3.9.21" env: TOXENV: extra-deps-pinned - python-version: "3.9.21" env: TOXENV: botocore-pinned - python-version: "3.13" env: TOXENV: extra-deps - python-version: pypy3.11 env: TOXENV: pypy3-extra-deps - python-version: "3.13" env: TOXENV: botocore steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Install system libraries if: contains(matrix.python-version, 'pypy') || contains(matrix.env.TOXENV, 'pinned') run: | sudo apt-get update sudo apt-get install libxml2-dev libxslt-dev - name: Run tests env: ${{ matrix.env }} run: | pip install -U tox tox - name: Upload coverage report uses: codecov/codecov-action@v5 - name: Upload test results if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 scrapy-2.13.3/.github/workflows/tests-windows.yml000066400000000000000000000027131503125130200220460ustar00rootroot00000000000000name: Windows on: push: branches: - master - '[0-9]+.[0-9]+' pull_request: concurrency: group: ${{github.workflow}}-${{ github.ref }} cancel-in-progress: true jobs: tests: runs-on: windows-latest strategy: fail-fast: false matrix: include: - python-version: "3.9" env: TOXENV: py - python-version: "3.10" env: TOXENV: py - python-version: "3.11" env: TOXENV: py - python-version: "3.12" env: TOXENV: py - python-version: "3.13" env: TOXENV: py - python-version: "3.13" env: TOXENV: default-reactor # pinned deps - python-version: "3.9.13" env: TOXENV: pinned - python-version: "3.9.13" env: TOXENV: extra-deps-pinned - python-version: "3.13" env: TOXENV: extra-deps steps: - uses: actions/checkout@v4 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v5 with: python-version: ${{ matrix.python-version }} - name: Run tests env: ${{ matrix.env }} run: | pip install -U tox tox - name: Upload coverage report uses: codecov/codecov-action@v5 - name: Upload test results if: ${{ !cancelled() }} uses: codecov/test-results-action@v1 scrapy-2.13.3/.gitignore000066400000000000000000000005131503125130200150600ustar00rootroot00000000000000/.vagrant /scrapy.iml *.pyc _trial_temp* dropin.cache docs/build *egg-info .tox/ venv/ .venv/ build/ dist/ .idea/ .vscode/ htmlcov/ .pytest_cache/ .coverage .coverage.* coverage.* *.junit.xml test-output.* .cache/ .mypy_cache/ /tests/keys/localhost.crt /tests/keys/localhost.key # Windows Thumbs.db # OSX miscellaneous .DS_Store scrapy-2.13.3/.pre-commit-config.yaml000066400000000000000000000006111503125130200173500ustar00rootroot00000000000000repos: - repo: https://github.com/astral-sh/ruff-pre-commit rev: v0.9.3 hooks: - id: ruff args: [ --fix ] - id: ruff-format - repo: https://github.com/adamchainz/blacken-docs rev: 1.19.1 hooks: - id: blacken-docs additional_dependencies: - black==24.10.0 - repo: https://github.com/pre-commit/pre-commit-hooks rev: v5.0.0 hooks: - id: trailing-whitespace scrapy-2.13.3/.readthedocs.yml000066400000000000000000000006011503125130200161540ustar00rootroot00000000000000version: 2 formats: all sphinx: configuration: docs/conf.py fail_on_warning: true build: os: ubuntu-24.04 tools: # For available versions, see: # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools-python python: "3.13" # Keep in sync with .github/workflows/checks.yml python: install: - requirements: docs/requirements.txt - path: . scrapy-2.13.3/AUTHORS000066400000000000000000000024041503125130200141410ustar00rootroot00000000000000Scrapy was brought to life by Shane Evans while hacking a scraping framework prototype for Mydeco (mydeco.com). It soon became maintained, extended and improved by Insophia (insophia.com), with the initial sponsorship of Mydeco to bootstrap the project. In mid-2011, Scrapinghub (now Zyte) became the new official maintainer. Here is the list of the primary authors & contributors: * Pablo Hoffman * Daniel Graña * Martin Olveyra * Gabriel García * Michael Cetrulo * Artem Bogomyagkov * Damian Canabal * Andres Moreira * Ismael Carnales * Matías Aguirre * German Hoffmann * Anibal Pacheco * Bruno Deferrari * Shane Evans * Ezequiel Rivero * Patrick Mezard * Rolando Espinoza * Ping Yin * Lucian Ursu * Shuaib Khan * Didier Deshommes * Vikas Dhiman * Jochen Maes * Darian Moody * Jordi Lonch * Zuhao Wan * Steven Almeroth * Tom Mortimer-Jones * Chris Tilden * Alexandr N Zamaraev * Emanuel Schorsch * Michal Danilak * Natan Lao * Hasnain Lakhani * Pedro Faustino * Alex Cepoi * Ilya Baryshev * Libor Nenadál * Jae-Myoung Yu * Vladislav Poluhin * Marc Abramowitz * Valentin-Costel Hăloiu * Jason Yeo * Сергей Прохоров * Simon Ratne * Julien Duponchelle * Jochen Maes * Vikas Dhiman * Juan Picca * Nicolás Ramírez scrapy-2.13.3/CODE_OF_CONDUCT.md000066400000000000000000000125551503125130200157000ustar00rootroot00000000000000 # Contributor Covenant Code of Conduct ## Our Pledge We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards Examples of behavior that contributes to a positive environment for our community include: * Demonstrating empathy and kindness toward other people * Being respectful of differing opinions, viewpoints, and experiences * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience * Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: * The use of sexualized language or imagery, and sexual attention or advances of any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at opensource@zyte.com. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. ### 2. Warning **Community Impact**: A violation through a single incident or series of actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. ### 3. Temporary Ban **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within the community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. [homepage]: https://www.contributor-covenant.org [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html [Mozilla CoC]: https://github.com/mozilla/diversity [FAQ]: https://www.contributor-covenant.org/faq [translations]: https://www.contributor-covenant.org/translations scrapy-2.13.3/CONTRIBUTING.md000066400000000000000000000004571503125130200153300ustar00rootroot00000000000000The guidelines for contributing are available here: https://docs.scrapy.org/en/master/contributing.html Please do not abuse the issue tracker for support questions. If your issue topic can be rephrased to "How to ...?", please use the support channels to get it answered: https://scrapy.org/community/ scrapy-2.13.3/INSTALL.md000066400000000000000000000002331503125130200145170ustar00rootroot00000000000000For information about installing Scrapy see: * [Local docs](docs/intro/install.rst) * [Online docs](https://docs.scrapy.org/en/latest/intro/install.html) scrapy-2.13.3/LICENSE000066400000000000000000000027551503125130200141070ustar00rootroot00000000000000Copyright (c) Scrapy developers. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of Scrapy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. scrapy-2.13.3/NEWS000066400000000000000000000000221503125130200135620ustar00rootroot00000000000000See docs/news.rst scrapy-2.13.3/README.rst000066400000000000000000000041451503125130200145640ustar00rootroot00000000000000|logo| .. |logo| image:: https://raw.githubusercontent.com/scrapy/scrapy/master/docs/_static/logo.svg :target: https://scrapy.org :alt: Scrapy :width: 480px |version| |python_version| |ubuntu| |macos| |windows| |coverage| |conda| |deepwiki| .. |version| image:: https://img.shields.io/pypi/v/Scrapy.svg :target: https://pypi.org/pypi/Scrapy :alt: PyPI Version .. |python_version| image:: https://img.shields.io/pypi/pyversions/Scrapy.svg :target: https://pypi.org/pypi/Scrapy :alt: Supported Python Versions .. |ubuntu| image:: https://github.com/scrapy/scrapy/workflows/Ubuntu/badge.svg :target: https://github.com/scrapy/scrapy/actions?query=workflow%3AUbuntu :alt: Ubuntu .. |macos| image:: https://github.com/scrapy/scrapy/workflows/macOS/badge.svg :target: https://github.com/scrapy/scrapy/actions?query=workflow%3AmacOS :alt: macOS .. |windows| image:: https://github.com/scrapy/scrapy/workflows/Windows/badge.svg :target: https://github.com/scrapy/scrapy/actions?query=workflow%3AWindows :alt: Windows .. |coverage| image:: https://img.shields.io/codecov/c/github/scrapy/scrapy/master.svg :target: https://codecov.io/github/scrapy/scrapy?branch=master :alt: Coverage report .. |conda| image:: https://anaconda.org/conda-forge/scrapy/badges/version.svg :target: https://anaconda.org/conda-forge/scrapy :alt: Conda Version .. |deepwiki| image:: https://deepwiki.com/badge.svg :target: https://deepwiki.com/scrapy/scrapy :alt: Ask DeepWiki Scrapy_ is a web scraping framework to extract structured data from websites. It is cross-platform, and requires Python 3.9+. It is maintained by Zyte_ (formerly Scrapinghub) and `many other contributors`_. .. _many other contributors: https://github.com/scrapy/scrapy/graphs/contributors .. _Scrapy: https://scrapy.org/ .. _Zyte: https://www.zyte.com/ Install with: .. code:: bash pip install scrapy And follow the documentation_ to learn how to use it. .. _documentation: https://docs.scrapy.org/en/latest/ If you wish to contribute, see Contributing_. .. _Contributing: https://docs.scrapy.org/en/master/contributing.html scrapy-2.13.3/SECURITY.md000066400000000000000000000004631503125130200146650ustar00rootroot00000000000000# Security Policy ## Supported Versions | Version | Supported | | ------- | ------------------ | | 2.13.x | :white_check_mark: | | < 2.13.x | :x: | ## Reporting a Vulnerability Please report the vulnerability using https://github.com/scrapy/scrapy/security/advisories/new. scrapy-2.13.3/codecov.yml000066400000000000000000000001201503125130200152270ustar00rootroot00000000000000comment: layout: "header, diff, tree" coverage: status: project: false scrapy-2.13.3/conftest.py000066400000000000000000000063761503125130200153040ustar00rootroot00000000000000from pathlib import Path import pytest from twisted.web.http import H2_ENABLED from scrapy.utils.reactor import install_reactor from tests.keys import generate_keys def _py_files(folder): return (str(p) for p in Path(folder).rglob("*.py")) collect_ignore = [ # not a test, but looks like a test "scrapy/utils/testproc.py", "scrapy/utils/testsite.py", "tests/ftpserver.py", "tests/mockserver.py", "tests/pipelines.py", "tests/spiders.py", # contains scripts to be run by tests/test_crawler.py::CrawlerProcessSubprocess *_py_files("tests/CrawlerProcess"), # contains scripts to be run by tests/test_crawler.py::CrawlerRunnerSubprocess *_py_files("tests/CrawlerRunner"), ] base_dir = Path(__file__).parent ignore_file_path = base_dir / "tests" / "ignores.txt" with ignore_file_path.open(encoding="utf-8") as reader: for line in reader: file_path = line.strip() if file_path and file_path[0] != "#": collect_ignore.append(file_path) if not H2_ENABLED: collect_ignore.extend( ( "scrapy/core/downloader/handlers/http2.py", *_py_files("scrapy/core/http2"), ) ) @pytest.fixture def chdir(tmpdir): """Change to pytest-provided temporary directory""" tmpdir.chdir() def pytest_addoption(parser): parser.addoption( "--reactor", default="asyncio", choices=["default", "asyncio"], ) @pytest.fixture(scope="class") def reactor_pytest(request): if not request.cls: # doctests return None request.cls.reactor_pytest = request.config.getoption("--reactor") return request.cls.reactor_pytest @pytest.fixture(autouse=True) def only_asyncio(request, reactor_pytest): if request.node.get_closest_marker("only_asyncio") and reactor_pytest == "default": pytest.skip("This test is only run without --reactor=default") @pytest.fixture(autouse=True) def only_not_asyncio(request, reactor_pytest): if ( request.node.get_closest_marker("only_not_asyncio") and reactor_pytest != "default" ): pytest.skip("This test is only run with --reactor=default") @pytest.fixture(autouse=True) def requires_uvloop(request): if not request.node.get_closest_marker("requires_uvloop"): return try: import uvloop del uvloop except ImportError: pytest.skip("uvloop is not installed") @pytest.fixture(autouse=True) def requires_botocore(request): if not request.node.get_closest_marker("requires_botocore"): return try: import botocore del botocore except ImportError: pytest.skip("botocore is not installed") @pytest.fixture(autouse=True) def requires_boto3(request): if not request.node.get_closest_marker("requires_boto3"): return try: import boto3 del boto3 except ImportError: pytest.skip("boto3 is not installed") def pytest_configure(config): if config.getoption("--reactor") != "default": install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor") else: # install the reactor explicitly from twisted.internet import reactor # noqa: F401 # Generate localhost certificate files, needed by some tests generate_keys() scrapy-2.13.3/docs/000077500000000000000000000000001503125130200140215ustar00rootroot00000000000000scrapy-2.13.3/docs/Makefile000066400000000000000000000011711503125130200154610ustar00rootroot00000000000000# Minimal makefile for Sphinx documentation # # You can set these variables from the command line, and also # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) .PHONY: help Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) scrapy-2.13.3/docs/README.rst000066400000000000000000000030551503125130200155130ustar00rootroot00000000000000:orphan: ====================================== Scrapy documentation quick start guide ====================================== This file provides a quick guide on how to compile the Scrapy documentation. Setup the environment --------------------- To compile the documentation you need Sphinx Python library. To install it and all its dependencies run the following command from this dir :: pip install -r requirements.txt Compile the documentation ------------------------- To compile the documentation (to classic HTML output) run the following command from this dir:: make html Documentation will be generated (in HTML format) inside the ``build/html`` dir. View the documentation ---------------------- To view the documentation run the following command:: make htmlview This command will fire up your default browser and open the main page of your (previously generated) HTML documentation. Start over ---------- To clean up all generated documentation files and start from scratch run:: make clean Keep in mind that this command won't touch any documentation source files. Recreating documentation on the fly ----------------------------------- There is a way to recreate the doc automatically when you make changes, you need to install watchdog (``pip install watchdog``) and then use:: make watch Alternative method using tox ---------------------------- To compile the documentation to HTML run the following command:: tox -e docs Documentation will be generated (in HTML format) inside the ``.tox/docs/tmp/html`` dir. scrapy-2.13.3/docs/_ext/000077500000000000000000000000001503125130200147605ustar00rootroot00000000000000scrapy-2.13.3/docs/_ext/scrapydocs.py000066400000000000000000000114511503125130200175060ustar00rootroot00000000000000# pylint: disable=import-error from collections.abc import Sequence from operator import itemgetter from typing import Any, TypedDict from docutils import nodes from docutils.nodes import Element, General, Node, document from docutils.parsers.rst import Directive from sphinx.application import Sphinx from sphinx.util.nodes import make_refnode class SettingData(TypedDict): docname: str setting_name: str refid: str class SettingslistNode(General, Element): pass class SettingsListDirective(Directive): def run(self) -> Sequence[Node]: return [SettingslistNode()] def is_setting_index(node: Node) -> bool: if node.tagname == "index" and node["entries"]: # type: ignore[index,attr-defined] # index entries for setting directives look like: # [('pair', 'SETTING_NAME; setting', 'std:setting-SETTING_NAME', '')] entry_type, info, refid = node["entries"][0][:3] # type: ignore[index] return entry_type == "pair" and info.endswith("; setting") return False def get_setting_name_and_refid(node: Node) -> tuple[str, str]: """Extract setting name from directive index node""" entry_type, info, refid = node["entries"][0][:3] # type: ignore[index] return info.replace("; setting", ""), refid def collect_scrapy_settings_refs(app: Sphinx, doctree: document) -> None: env = app.builder.env if not hasattr(env, "scrapy_all_settings"): emptyList: list[SettingData] = [] env.scrapy_all_settings = emptyList # type: ignore[attr-defined] for node in doctree.findall(is_setting_index): setting_name, refid = get_setting_name_and_refid(node) env.scrapy_all_settings.append( # type: ignore[attr-defined] SettingData( docname=env.docname, setting_name=setting_name, refid=refid, ) ) def make_setting_element( setting_data: SettingData, app: Sphinx, fromdocname: str ) -> Any: refnode = make_refnode( app.builder, fromdocname, todocname=setting_data["docname"], targetid=setting_data["refid"], child=nodes.Text(setting_data["setting_name"]), ) p = nodes.paragraph() p += refnode item = nodes.list_item() item += p return item def replace_settingslist_nodes( app: Sphinx, doctree: document, fromdocname: str ) -> None: env = app.builder.env for node in doctree.findall(SettingslistNode): settings_list = nodes.bullet_list() settings_list.extend( [ make_setting_element(d, app, fromdocname) for d in sorted(env.scrapy_all_settings, key=itemgetter("setting_name")) # type: ignore[attr-defined] if fromdocname != d["docname"] ] ) node.replace_self(settings_list) def source_role( name, rawtext, text: str, lineno, inliner, options=None, content=None ) -> tuple[list[Any], list[Any]]: ref = "https://github.com/scrapy/scrapy/blob/master/" + text node = nodes.reference(rawtext, text, refuri=ref, **options) return [node], [] def issue_role( name, rawtext, text: str, lineno, inliner, options=None, content=None ) -> tuple[list[Any], list[Any]]: ref = "https://github.com/scrapy/scrapy/issues/" + text node = nodes.reference(rawtext, "issue " + text, refuri=ref) return [node], [] def commit_role( name, rawtext, text: str, lineno, inliner, options=None, content=None ) -> tuple[list[Any], list[Any]]: ref = "https://github.com/scrapy/scrapy/commit/" + text node = nodes.reference(rawtext, "commit " + text, refuri=ref) return [node], [] def rev_role( name, rawtext, text: str, lineno, inliner, options=None, content=None ) -> tuple[list[Any], list[Any]]: ref = "http://hg.scrapy.org/scrapy/changeset/" + text node = nodes.reference(rawtext, "r" + text, refuri=ref) return [node], [] def setup(app: Sphinx) -> None: app.add_crossref_type( directivename="setting", rolename="setting", indextemplate="pair: %s; setting", ) app.add_crossref_type( directivename="signal", rolename="signal", indextemplate="pair: %s; signal", ) app.add_crossref_type( directivename="command", rolename="command", indextemplate="pair: %s; command", ) app.add_crossref_type( directivename="reqmeta", rolename="reqmeta", indextemplate="pair: %s; reqmeta", ) app.add_role("source", source_role) app.add_role("commit", commit_role) app.add_role("issue", issue_role) app.add_role("rev", rev_role) app.add_node(SettingslistNode) app.add_directive("settingslist", SettingsListDirective) app.connect("doctree-read", collect_scrapy_settings_refs) app.connect("doctree-resolved", replace_settingslist_nodes) scrapy-2.13.3/docs/_ext/scrapyfixautodoc.py000066400000000000000000000010741503125130200207230ustar00rootroot00000000000000""" Must be included after 'sphinx.ext.autodoc'. Fixes unwanted 'alias of' behavior. https://github.com/sphinx-doc/sphinx/issues/4422 """ # pylint: disable=import-error from sphinx.application import Sphinx def maybe_skip_member(app: Sphinx, what, name: str, obj, skip: bool, options) -> bool: if not skip: # autodocs was generating a text "alias of" for the following members return name in {"default_item_class", "default_selector_class"} return skip def setup(app: Sphinx) -> None: app.connect("autodoc-skip-member", maybe_skip_member) scrapy-2.13.3/docs/_static/000077500000000000000000000000001503125130200154475ustar00rootroot00000000000000scrapy-2.13.3/docs/_static/custom.css000066400000000000000000000032271503125130200174770ustar00rootroot00000000000000/* Move lists closer to their introducing paragraph */ .rst-content .section ol p, .rst-content .section ul p { margin-bottom: 0px; } .rst-content p + ol, .rst-content p + ul { margin-top: -18px; /* Compensates margin-top: 24px of p */ } .rst-content dl p + ol, .rst-content dl p + ul { margin-top: -6px; /* Compensates margin-top: 12px of p */ } /*override some styles in sphinx-rtd-dark-mode/static/dark_mode_css/general.css*/ .theme-switcher { right: 0.4em !important; top: 0.6em !important; -webkit-box-shadow: 0px 3px 14px 4px rgba(0, 0, 0, 0.30) !important; box-shadow: 0px 3px 14px 4px rgba(0, 0, 0, 0.30) !important; height: 2em !important; width: 2em !important; } /*place the toggle button for dark mode at the bottom right corner on small screens*/ @media (max-width: 768px) { .theme-switcher { right: 0.4em !important; bottom: 2.6em !important; top: auto !important; } } /*persist blue color at the top left used in default rtd theme*/ html[data-theme="dark"] .wy-side-nav-search, html[data-theme="dark"] .wy-nav-top { background-color: #1d577d !important; } /*all the styles below used to present API objects nicely in dark mode*/ html[data-theme="dark"] .sig.sig-object { border-left-color: #3e4446 !important; background-color: #202325 !important } html[data-theme="dark"] .sig-name, html[data-theme="dark"] .sig-prename, html[data-theme="dark"] .property, html[data-theme="dark"] .sig-param, html[data-theme="dark"] .sig-paren, html[data-theme="dark"] .sig-return-icon, html[data-theme="dark"] .sig-return-typehint, html[data-theme="dark"] .optional { color: #e8e6e3 !important } scrapy-2.13.3/docs/_static/logo.svg000066400000000000000000000167371503125130200171460ustar00rootroot00000000000000 scrapy-2.13.3/docs/_static/selectors-sample1.html000066400000000000000000000012331503125130200216770ustar00rootroot00000000000000 Example website
Name: My image 1
image1 Name: My image 2
image2 Name: My image 3
image3 Name: My image 4
image4 Name: My image 5
image5
scrapy-2.13.3/docs/_templates/000077500000000000000000000000001503125130200161565ustar00rootroot00000000000000scrapy-2.13.3/docs/_templates/layout.html000066400000000000000000000015221503125130200203610ustar00rootroot00000000000000{% extends "!layout.html" %} {# Overriden to include a link to scrapy.org, not just to the docs root #} {%- block sidebartitle %} {# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #} {# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #} {%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %} {%- set _root_doc = root_doc|default(master_doc) %} scrapy.org / docs {%- if READTHEDOCS or DEBUG %} {%- if theme_version_selector or theme_language_selector %}
{%- endif %} {%- endif %} {%- include "searchbox.html" %} {%- endblock %} scrapy-2.13.3/docs/_tests/000077500000000000000000000000001503125130200153225ustar00rootroot00000000000000scrapy-2.13.3/docs/_tests/quotes.html000066400000000000000000000241351503125130200175350ustar00rootroot00000000000000 Quotes to Scrape

Quotes to Scrape

Login

“The world as we have created it is a process of our thinking. It cannot be changed without changing our thinking.” by (about)
Tags: change deep-thoughts thinking world
“It is our choices, Harry, that show what we truly are, far more than our abilities.” by (about)
Tags: abilities choices
“There are only two ways to live your life. One is as though nothing is a miracle. The other is as though everything is a miracle.” by (about)
Tags: inspirational life live miracle miracles
“The person, be it gentleman or lady, who has not pleasure in a good novel, must be intolerably stupid.” by (about)
Tags: aliteracy books classic humor
“Imperfection is beauty, madness is genius and it's better to be absolutely ridiculous than absolutely boring.” by (about)
Tags: be-yourself inspirational
“Try not to become a man of success. Rather become a man of value.” by (about)
Tags: adulthood success value
“It is better to be hated for what you are than to be loved for what you are not.” by (about)
Tags: life love
“I have not failed. I've just found 10,000 ways that won't work.” by (about)
Tags: edison failure inspirational paraphrased
“A woman is like a tea bag; you never know how strong it is until it's in hot water.” by (about)
Tags: misattributed-eleanor-roosevelt
“A day without sunshine is like, you know, night.” by (about)
Tags: humor obvious simile

Top Ten tags

love inspirational life humor books reading friendship friends truth simile
scrapy-2.13.3/docs/_tests/quotes1.html000066400000000000000000000241351503125130200176160ustar00rootroot00000000000000 Quotes to Scrape

Quotes to Scrape

Login

“The world as we have created it is a process of our thinking. It cannot be changed without changing our thinking.” by (about)
Tags: change deep-thoughts thinking world
“It is our choices, Harry, that show what we truly are, far more than our abilities.” by (about)
Tags: abilities choices
“There are only two ways to live your life. One is as though nothing is a miracle. The other is as though everything is a miracle.” by (about)
Tags: inspirational life live miracle miracles
“The person, be it gentleman or lady, who has not pleasure in a good novel, must be intolerably stupid.” by (about)
Tags: aliteracy books classic humor
“Imperfection is beauty, madness is genius and it's better to be absolutely ridiculous than absolutely boring.” by (about)
Tags: be-yourself inspirational
“Try not to become a man of success. Rather become a man of value.” by (about)
Tags: adulthood success value
“It is better to be hated for what you are than to be loved for what you are not.” by (about)
Tags: life love
“I have not failed. I've just found 10,000 ways that won't work.” by (about)
Tags: edison failure inspirational paraphrased
“A woman is like a tea bag; you never know how strong it is until it's in hot water.” by (about)
Tags: misattributed-eleanor-roosevelt
“A day without sunshine is like, you know, night.” by (about)
Tags: humor obvious simile

Top Ten tags

love inspirational life humor books reading friendship friends truth simile
scrapy-2.13.3/docs/conf.py000066400000000000000000000156171503125130200153320ustar00rootroot00000000000000# Configuration file for the Sphinx documentation builder. # # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # pylint: disable=import-error import os import sys from collections.abc import Sequence from pathlib import Path # If your extensions are in another directory, add it here. If the directory # is relative to the documentation root, use Path.absolute to make it absolute. sys.path.append(str(Path(__file__).parent / "_ext")) sys.path.insert(0, str(Path(__file__).parent.parent)) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "Scrapy" project_copyright = "Scrapy developers" author = "Scrapy developers" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ "hoverxref.extension", "notfound.extension", "scrapydocs", "sphinx.ext.autodoc", "scrapyfixautodoc", # Must be after "sphinx.ext.autodoc" "sphinx.ext.coverage", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", "sphinx_rtd_dark_mode", ] templates_path = ["_templates"] exclude_patterns = ["build", "Thumbs.db", ".DS_Store"] # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. try: import scrapy version = ".".join(map(str, scrapy.version_info[:2])) release = scrapy.__version__ except ImportError: version = "" release = "" suppress_warnings = ["epub.unknown_project_files"] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = "sphinx_rtd_theme" html_static_path = ["_static"] html_last_updated_fmt = "%b %d, %Y" html_css_files = [ "custom.css", ] # Set canonical URL from the Read the Docs Domain html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") # -- Options for LaTeX output ------------------------------------------------ # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-latex-output # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ ("index", "Scrapy.tex", "Scrapy Documentation", "Scrapy developers", "manual"), ] # -- Options for the linkcheck builder --------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder linkcheck_ignore = [ r"http://localhost:\d+", "http://hg.scrapy.org", r"https://github.com/scrapy/scrapy/commit/\w+", r"https://github.com/scrapy/scrapy/issues/\d+", ] linkcheck_anchors_ignore_for_url = ["https://github.com/pyca/cryptography/issues/2692"] # -- Options for the Coverage extension -------------------------------------- # https://www.sphinx-doc.org/en/master/usage/extensions/coverage.html#configuration coverage_ignore_pyobjects = [ # Contract’s add_pre_hook and add_post_hook are not documented because # they should be transparent to contract developers, for whom pre_hook and # post_hook should be the actual concern. r"\bContract\.add_(pre|post)_hook$", # ContractsManager is an internal class, developers are not expected to # interact with it directly in any way. r"\bContractsManager\b$", # For default contracts we only want to document their general purpose in # their __init__ method, the methods they reimplement to achieve that purpose # should be irrelevant to developers using those contracts. r"\w+Contract\.(adjust_request_args|(pre|post)_process)$", # Methods of downloader middlewares are not documented, only the classes # themselves, since downloader middlewares are controlled through Scrapy # settings. r"^scrapy\.downloadermiddlewares\.\w*?\.(\w*?Middleware|DownloaderStats)\.", # Base classes of downloader middlewares are implementation details that # are not meant for users. r"^scrapy\.downloadermiddlewares\.\w*?\.Base\w*?Middleware", # The interface methods of duplicate request filtering classes are already # covered in the interface documentation part of the DUPEFILTER_CLASS # setting documentation. r"^scrapy\.dupefilters\.[A-Z]\w*?\.(from_settings|request_seen|open|close|log)$", # Private exception used by the command-line interface implementation. r"^scrapy\.exceptions\.UsageError", # Methods of BaseItemExporter subclasses are only documented in # BaseItemExporter. r"^scrapy\.exporters\.(?!BaseItemExporter\b)\w*?\.", # Extension behavior is only modified through settings. Methods of # extension classes, as well as helper functions, are implementation # details that are not documented. r"^scrapy\.extensions\.[a-z]\w*?\.[A-Z]\w*?\.", # methods r"^scrapy\.extensions\.[a-z]\w*?\.[a-z]", # helper functions # Never documented before, and deprecated now. r"^scrapy\.linkextractors\.FilteringLinkExtractor$", # Implementation detail of LxmlLinkExtractor r"^scrapy\.linkextractors\.lxmlhtml\.LxmlParserLinkExtractor", ] # -- Options for the InterSphinx extension ----------------------------------- # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration intersphinx_mapping = { "attrs": ("https://www.attrs.org/en/stable/", None), "coverage": ("https://coverage.readthedocs.io/en/latest", None), "cryptography": ("https://cryptography.io/en/latest/", None), "cssselect": ("https://cssselect.readthedocs.io/en/latest", None), "itemloaders": ("https://itemloaders.readthedocs.io/en/latest/", None), "parsel": ("https://parsel.readthedocs.io/en/latest/", None), "pytest": ("https://docs.pytest.org/en/latest", None), "python": ("https://docs.python.org/3", None), "sphinx": ("https://www.sphinx-doc.org/en/master", None), "tox": ("https://tox.wiki/en/latest/", None), "twisted": ("https://docs.twisted.org/en/stable/", None), "twistedapi": ("https://docs.twisted.org/en/stable/api/", None), "w3lib": ("https://w3lib.readthedocs.io/en/latest", None), } intersphinx_disabled_reftypes: Sequence[str] = [] # -- Options for sphinx-hoverxref extension ---------------------------------- # https://sphinx-hoverxref.readthedocs.io/en/latest/configuration.html hoverxref_auto_ref = True hoverxref_role_types = { "class": "tooltip", "command": "tooltip", "confval": "tooltip", "hoverxref": "tooltip", "mod": "tooltip", "ref": "tooltip", "reqmeta": "tooltip", "setting": "tooltip", "signal": "tooltip", } hoverxref_roles = ["command", "reqmeta", "setting", "signal"] default_dark_mode = False scrapy-2.13.3/docs/conftest.py000066400000000000000000000016311503125130200162210ustar00rootroot00000000000000from doctest import ELLIPSIS, NORMALIZE_WHITESPACE from pathlib import Path from sybil import Sybil from sybil.parsers.doctest import DocTestParser from sybil.parsers.skip import skip try: # >2.0.1 from sybil.parsers.codeblock import PythonCodeBlockParser except ImportError: from sybil.parsers.codeblock import CodeBlockParser as PythonCodeBlockParser from scrapy.http.response.html import HtmlResponse def load_response(url: str, filename: str) -> HtmlResponse: input_path = Path(__file__).parent / "_tests" / filename return HtmlResponse(url, body=input_path.read_bytes()) def setup(namespace): namespace["load_response"] = load_response pytest_collect_file = Sybil( parsers=[ DocTestParser(optionflags=ELLIPSIS | NORMALIZE_WHITESPACE), PythonCodeBlockParser(future_imports=["print_function"]), skip, ], pattern="*.rst", setup=setup, ).pytest() scrapy-2.13.3/docs/contributing.rst000066400000000000000000000403271503125130200172700ustar00rootroot00000000000000.. _topics-contributing: ====================== Contributing to Scrapy ====================== .. important:: Double check that you are reading the most recent version of this document at https://docs.scrapy.org/en/master/contributing.html By participating in this project you agree to abide by the terms of our `Code of Conduct `_. Please report unacceptable behavior to opensource@zyte.com. There are many ways to contribute to Scrapy. Here are some of them: * Report bugs and request features in the `issue tracker`_, trying to follow the guidelines detailed in `Reporting bugs`_ below. * Submit patches for new functionalities and/or bug fixes. Please read :ref:`writing-patches` and `Submitting patches`_ below for details on how to write and submit a patch. * Blog about Scrapy. Tell the world how you're using Scrapy. This will help newcomers with more examples and will help the Scrapy project to increase its visibility. * Join the `Scrapy subreddit`_ and share your ideas on how to improve Scrapy. We're always open to suggestions. * Answer Scrapy questions at `Stack Overflow `__. Reporting bugs ============== .. note:: Please report security issues **only** to scrapy-security@googlegroups.com. This is a private list only open to trusted Scrapy developers, and its archives are not public. Well-written bug reports are very helpful, so keep in mind the following guidelines when you're going to report a new bug. * check the :ref:`FAQ ` first to see if your issue is addressed in a well-known question * if you have a general question about Scrapy usage, please ask it at `Stack Overflow `__ (use "scrapy" tag). * check the `open issues`_ to see if the issue has already been reported. If it has, don't dismiss the report, but check the ticket history and comments. If you have additional useful information, please leave a comment, or consider :ref:`sending a pull request ` with a fix. * search the `scrapy-users`_ list and `Scrapy subreddit`_ to see if it has been discussed there, or if you're not sure if what you're seeing is a bug. You can also ask in the ``#scrapy`` IRC channel. * write **complete, reproducible, specific bug reports**. The smaller the test case, the better. Remember that other developers won't have your project to reproduce the bug, so please include all relevant files required to reproduce it. See for example StackOverflow's guide on creating a `Minimal, Complete, and Verifiable example`_ exhibiting the issue. * the most awesome way to provide a complete reproducible example is to send a pull request which adds a failing test case to the Scrapy testing suite (see :ref:`submitting-patches`). This is helpful even if you don't have an intention to fix the issue yourselves. * include the output of ``scrapy version -v`` so developers working on your bug know exactly which version and platform it occurred on, which is often very helpful for reproducing it, or knowing if it was already fixed. .. _Minimal, Complete, and Verifiable example: https://stackoverflow.com/help/mcve .. _find-work: Finding work ============ If you have decided to make a contribution to Scrapy, but you do not know what to contribute, you have a few options to find pending work: - Check out the `contribution GitHub page`_, which lists open issues tagged as **good first issue**. .. _contribution GitHub page: https://github.com/scrapy/scrapy/contribute There are also `help wanted issues`_ but mind that some may require familiarity with the Scrapy code base. You can also target any other issue provided it is not tagged as **discuss**. - If you enjoy writing documentation, there are `documentation issues`_ as well, but mind that some may require familiarity with the Scrapy code base as well. .. _documentation issues: https://github.com/scrapy/scrapy/issues?q=is%3Aissue+is%3Aopen+label%3Adocs+ - If you enjoy :ref:`writing automated tests `, you can work on increasing our `test coverage`_. - If you enjoy code cleanup, we welcome fixes for issues detected by our static analysis tools. See ``pyproject.toml`` for silenced issues that may need addressing. Mind that some issues we do not aim to address at all, and usually include a comment on them explaining the reason; not to confuse with comments that state what the issue is about, for non-descriptive issue codes. If you have found an issue, make sure you read the entire issue thread before you ask questions. That includes related issues and pull requests that show up in the issue thread when the issue is mentioned elsewhere. We do not assign issues, and you do not need to announce that you are going to start working on an issue either. If you want to work on an issue, just go ahead and :ref:`write a patch for it `. Do not discard an issue simply because there is an open pull request for it. Check if open pull requests are active first. And even if some are active, if you think you can build a better implementation, feel free to create a pull request with your approach. If you decide to work on something without an open issue, please: - Do not create an issue to work on code coverage or code cleanup, create a pull request directly. - Do not create both an issue and a pull request right away. Either open an issue first to get feedback on whether or not the issue is worth addressing, and create a pull request later only if the feedback from the team is positive, or create only a pull request, if you think a discussion will be easier over your code. - Do not add docstrings for the sake of adding docstrings, or only to address silenced Ruff issues. We expect docstrings to exist only when they add something significant to readers, such as explaining something that is not easier to understand from reading the corresponding code, summarizing a long, hard-to-read implementation, providing context about calling code, or indicating purposely uncaught exceptions from called code. - Do not add tests that use as much mocking as possible just to touch a given line of code and hence improve line coverage. While we do aim to maximize test coverage, tests should be written for real scenarios, with minimum mocking. We usually prefer end-to-end tests. .. _writing-patches: Writing patches =============== The better a patch is written, the higher the chances that it'll get accepted and the sooner it will be merged. Well-written patches should: * contain the minimum amount of code required for the specific change. Small patches are easier to review and merge. So, if you're doing more than one change (or bug fix), please consider submitting one patch per change. Do not collapse multiple changes into a single patch. For big changes consider using a patch queue. * pass all unit-tests. See `Running tests`_ below. * include one (or more) test cases that check the bug fixed or the new functionality added. See `Writing tests`_ below. * if you're adding or changing a public (documented) API, please include the documentation changes in the same patch. See `Documentation policies`_ below. * if you're adding a private API, please add a regular expression to the ``coverage_ignore_pyobjects`` variable of ``docs/conf.py`` to exclude the new private API from documentation coverage checks. To see if your private API is skipped properly, generate a documentation coverage report as follows:: tox -e docs-coverage * if you are removing deprecated code, first make sure that at least 1 year (12 months) has passed since the release that introduced the deprecation. See :ref:`deprecation-policy`. .. _submitting-patches: Submitting patches ================== The best way to submit a patch is to issue a `pull request`_ on GitHub, optionally creating a new issue first. Remember to explain what was fixed or the new functionality (what it is, why it's needed, etc). The more info you include, the easier will be for core developers to understand and accept your patch. If your pull request aims to resolve an open issue, `link it accordingly `__, e.g.: .. code-block:: none Resolves #123 You can also discuss the new functionality (or bug fix) before creating the patch, but it's always good to have a patch ready to illustrate your arguments and show that you have put some additional thought into the subject. A good starting point is to send a pull request on GitHub. It can be simple enough to illustrate your idea, and leave documentation/tests for later, after the idea has been validated and proven useful. Alternatively, you can start a conversation in the `Scrapy subreddit`_ to discuss your idea first. Sometimes there is an existing pull request for the problem you'd like to solve, which is stalled for some reason. Often the pull request is in a right direction, but changes are requested by Scrapy maintainers, and the original pull request author hasn't had time to address them. In this case consider picking up this pull request: open a new pull request with all commits from the original pull request, as well as additional changes to address the raised issues. Doing so helps a lot; it is not considered rude as long as the original author is acknowledged by keeping his/her commits. You can pull an existing pull request to a local branch by running ``git fetch upstream pull/$PR_NUMBER/head:$BRANCH_NAME_TO_CREATE`` (replace 'upstream' with a remote name for scrapy repository, ``$PR_NUMBER`` with an ID of the pull request, and ``$BRANCH_NAME_TO_CREATE`` with a name of the branch you want to create locally). See also: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally#modifying-an-inactive-pull-request-locally. When writing GitHub pull requests, try to keep titles short but descriptive. E.g. For bug #411: "Scrapy hangs if an exception raises in start_requests" prefer "Fix hanging when exception occurs in start_requests (#411)" instead of "Fix for #411". Complete titles make it easy to skim through the issue tracker. Finally, try to keep aesthetic changes (:pep:`8` compliance, unused imports removal, etc) in separate commits from functional changes. This will make pull requests easier to review and more likely to get merged. .. _coding-style: Coding style ============ Please follow these coding conventions when writing code for inclusion in Scrapy: * We use `Ruff `_ for code formatting. There is a hook in the pre-commit config that will automatically format your code before every commit. You can also run Ruff manually with ``tox -e pre-commit``. * Don't put your name in the code you contribute; git provides enough metadata to identify author of the code. See https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git for setup instructions. .. _scrapy-pre-commit: Pre-commit ========== We use `pre-commit`_ to automatically address simple code issues before every commit. .. _pre-commit: https://pre-commit.com/ After your create a local clone of your fork of the Scrapy repository: #. `Install pre-commit `_. #. On the root of your local clone of the Scrapy repository, run the following command: .. code-block:: bash pre-commit install Now pre-commit will check your changes every time you create a Git commit. Upon finding issues, pre-commit aborts your commit, and either fixes those issues automatically, or only reports them to you. If it fixes those issues automatically, creating your commit again should succeed. Otherwise, you may need to address the corresponding issues manually first. .. _documentation-policies: Documentation policies ====================== For reference documentation of API members (classes, methods, etc.) use docstrings and make sure that the Sphinx documentation uses the :mod:`~sphinx.ext.autodoc` extension to pull the docstrings. API reference documentation should follow docstring conventions (`PEP 257`_) and be IDE-friendly: short, to the point, and it may provide short examples. Other types of documentation, such as tutorials or topics, should be covered in files within the ``docs/`` directory. This includes documentation that is specific to an API member, but goes beyond API reference documentation. In any case, if something is covered in a docstring, use the :mod:`~sphinx.ext.autodoc` extension to pull the docstring into the documentation instead of duplicating the docstring in files within the ``docs/`` directory. Documentation updates that cover new or modified features must use Sphinx’s :rst:dir:`versionadded` and :rst:dir:`versionchanged` directives. Use ``VERSION`` as version, we will replace it with the actual version right before the corresponding release. When we release a new major or minor version of Scrapy, we remove these directives if they are older than 3 years. Documentation about deprecated features must be removed as those features are deprecated, so that new readers do not run into it. New deprecations and deprecation removals are documented in the :ref:`release notes `. .. _write-tests: Tests ===== Tests are implemented using the :doc:`Twisted unit-testing framework `. Running tests requires :doc:`tox `. .. _running-tests: Running tests ------------- To run all tests:: tox To run a specific test (say ``tests/test_loader.py``) use: ``tox -- tests/test_loader.py`` To run the tests on a specific :doc:`tox ` environment, use ``-e `` with an environment name from ``tox.ini``. For example, to run the tests with Python 3.10 use:: tox -e py310 You can also specify a comma-separated list of environments, and use :ref:`tox’s parallel mode ` to run the tests on multiple environments in parallel:: tox -e py39,py310 -p auto To pass command-line options to :doc:`pytest `, add them after ``--`` in your call to :doc:`tox `. Using ``--`` overrides the default positional arguments defined in ``tox.ini``, so you must include those default positional arguments (``scrapy tests``) after ``--`` as well:: tox -- scrapy tests -x # stop after first failure You can also use the `pytest-xdist`_ plugin. For example, to run all tests on the Python 3.10 :doc:`tox ` environment using all your CPU cores:: tox -e py310 -- scrapy tests -n auto To see coverage report install :doc:`coverage ` (``pip install coverage``) and run: ``coverage report`` see output of ``coverage --help`` for more options like html or xml report. Writing tests ------------- All functionality (including new features and bug fixes) must include a test case to check that it works as expected, so please include tests for your patches if you want them to get accepted sooner. Scrapy uses unit-tests, which are located in the `tests/`_ directory. Their module name typically resembles the full path of the module they're testing. For example, the item loaders code is in:: scrapy.loader And their unit-tests are in:: tests/test_loader.py .. _issue tracker: https://github.com/scrapy/scrapy/issues .. _scrapy-users: https://groups.google.com/forum/#!forum/scrapy-users .. _Scrapy subreddit: https://reddit.com/r/scrapy .. _AUTHORS: https://github.com/scrapy/scrapy/blob/master/AUTHORS .. _tests/: https://github.com/scrapy/scrapy/tree/master/tests .. _open issues: https://github.com/scrapy/scrapy/issues .. _PEP 257: https://peps.python.org/pep-0257/ .. _pull request: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request .. _pytest-xdist: https://github.com/pytest-dev/pytest-xdist .. _help wanted issues: https://github.com/scrapy/scrapy/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 .. _test coverage: https://app.codecov.io/gh/scrapy/scrapy scrapy-2.13.3/docs/faq.rst000066400000000000000000000362661503125130200153370ustar00rootroot00000000000000.. _faq: Frequently Asked Questions ========================== .. _faq-scrapy-bs-cmp: How does Scrapy compare to BeautifulSoup or lxml? ------------------------------------------------- `BeautifulSoup`_ and `lxml`_ are libraries for parsing HTML and XML. Scrapy is an application framework for writing web spiders that crawl web sites and extract data from them. Scrapy provides a built-in mechanism for extracting data (called :ref:`selectors `) but you can easily use `BeautifulSoup`_ (or `lxml`_) instead, if you feel more comfortable working with them. After all, they're just parsing libraries which can be imported and used from any Python code. In other words, comparing `BeautifulSoup`_ (or `lxml`_) to Scrapy is like comparing `jinja2`_ to `Django`_. .. _BeautifulSoup: https://www.crummy.com/software/BeautifulSoup/ .. _lxml: https://lxml.de/ .. _jinja2: https://palletsprojects.com/projects/jinja/ .. _Django: https://www.djangoproject.com/ Can I use Scrapy with BeautifulSoup? ------------------------------------ Yes, you can. As mentioned :ref:`above `, `BeautifulSoup`_ can be used for parsing HTML responses in Scrapy callbacks. You just have to feed the response's body into a ``BeautifulSoup`` object and extract whatever data you need from it. Here's an example spider using BeautifulSoup API, with ``lxml`` as the HTML parser: .. skip: next .. code-block:: python from bs4 import BeautifulSoup import scrapy class ExampleSpider(scrapy.Spider): name = "example" allowed_domains = ["example.com"] start_urls = ("http://www.example.com/",) def parse(self, response): # use lxml to get decent HTML parsing speed soup = BeautifulSoup(response.text, "lxml") yield {"url": response.url, "title": soup.h1.string} .. note:: ``BeautifulSoup`` supports several HTML/XML parsers. See `BeautifulSoup's official documentation`_ on which ones are available. .. _BeautifulSoup's official documentation: https://www.crummy.com/software/BeautifulSoup/bs4/doc/#specifying-the-parser-to-use Did Scrapy "steal" X from Django? --------------------------------- Probably, but we don't like that word. We think Django_ is a great open source project and an example to follow, so we've used it as an inspiration for Scrapy. We believe that, if something is already done well, there's no need to reinvent it. This concept, besides being one of the foundations for open source and free software, not only applies to software but also to documentation, procedures, policies, etc. So, instead of going through each problem ourselves, we choose to copy ideas from those projects that have already solved them properly, and focus on the real problems we need to solve. We'd be proud if Scrapy serves as an inspiration for other projects. Feel free to steal from us! Does Scrapy work with HTTP proxies? ----------------------------------- Yes. Support for HTTP proxies is provided (since Scrapy 0.8) through the HTTP Proxy downloader middleware. See :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware`. How can I scrape an item with attributes in different pages? ------------------------------------------------------------ See :ref:`topics-request-response-ref-request-callback-arguments`. How can I simulate a user login in my spider? --------------------------------------------- See :ref:`topics-request-response-ref-request-userlogin`. .. _faq-bfo-dfo: Does Scrapy crawl in breadth-first or depth-first order? -------------------------------------------------------- :ref:`DFO by default, but other orders are possible `. My Scrapy crawler has memory leaks. What can I do? -------------------------------------------------- See :ref:`topics-leaks`. Also, Python has a builtin memory leak issue which is described in :ref:`topics-leaks-without-leaks`. How can I make Scrapy consume less memory? ------------------------------------------ See previous question. How can I prevent memory errors due to many allowed domains? ------------------------------------------------------------ If you have a spider with a long list of :attr:`~scrapy.Spider.allowed_domains` (e.g. 50,000+), consider replacing the default :class:`~scrapy.downloadermiddlewares.offsite.OffsiteMiddleware` downloader middleware with a :ref:`custom downloader middleware ` that requires less memory. For example: - If your domain names are similar enough, use your own regular expression instead joining the strings in :attr:`~scrapy.Spider.allowed_domains` into a complex regular expression. - If you can meet the installation requirements, use pyre2_ instead of Python’s re_ to compile your URL-filtering regular expression. See :issue:`1908`. See also `other suggestions at StackOverflow `__. .. note:: Remember to disable :class:`scrapy.downloadermiddlewares.offsite.OffsiteMiddleware` when you enable your custom implementation: .. code-block:: python DOWNLOADER_MIDDLEWARES = { "scrapy.downloadermiddlewares.offsite.OffsiteMiddleware": None, "myproject.middlewares.CustomOffsiteMiddleware": 50, } .. _pyre2: https://github.com/andreasvc/pyre2 .. _re: https://docs.python.org/3/library/re.html Can I use Basic HTTP Authentication in my spiders? -------------------------------------------------- Yes, see :class:`~scrapy.downloadermiddlewares.httpauth.HttpAuthMiddleware`. Why does Scrapy download pages in English instead of my native language? ------------------------------------------------------------------------ Try changing the default `Accept-Language`_ request header by overriding the :setting:`DEFAULT_REQUEST_HEADERS` setting. .. _Accept-Language: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4 Where can I find some example Scrapy projects? ---------------------------------------------- See :ref:`intro-examples`. Can I run a spider without creating a project? ---------------------------------------------- Yes. You can use the :command:`runspider` command. For example, if you have a spider written in a ``my_spider.py`` file you can run it with:: scrapy runspider my_spider.py See :command:`runspider` command for more info. I get "Filtered offsite request" messages. How can I fix them? -------------------------------------------------------------- Those messages (logged with ``DEBUG`` level) don't necessarily mean there is a problem, so you may not need to fix them. Those messages are thrown by :class:`~scrapy.downloadermiddlewares.offsite.OffsiteMiddleware`, which is a downloader middleware (enabled by default) whose purpose is to filter out requests to domains outside the ones covered by the spider. What is the recommended way to deploy a Scrapy crawler in production? --------------------------------------------------------------------- See :ref:`topics-deploy`. Can I use JSON for large exports? --------------------------------- It'll depend on how large your output is. See :ref:`this warning ` in :class:`~scrapy.exporters.JsonItemExporter` documentation. Can I return (Twisted) deferreds from signal handlers? ------------------------------------------------------ Some signals support returning deferreds from their handlers, others don't. See the :ref:`topics-signals-ref` to know which ones. What does the response status code 999 mean? -------------------------------------------- 999 is a custom response status code used by Yahoo sites to throttle requests. Try slowing down the crawling speed by using a download delay of ``2`` (or higher) in your spider: .. code-block:: python from scrapy.spiders import CrawlSpider class MySpider(CrawlSpider): name = "myspider" download_delay = 2 # [ ... rest of the spider code ... ] Or by setting a global download delay in your project with the :setting:`DOWNLOAD_DELAY` setting. Can I call ``pdb.set_trace()`` from my spiders to debug them? ------------------------------------------------------------- Yes, but you can also use the Scrapy shell which allows you to quickly analyze (and even modify) the response being processed by your spider, which is, quite often, more useful than plain old ``pdb.set_trace()``. For more info see :ref:`topics-shell-inspect-response`. Simplest way to dump all my scraped items into a JSON/CSV/XML file? ------------------------------------------------------------------- To dump into a JSON file:: scrapy crawl myspider -O items.json To dump into a CSV file:: scrapy crawl myspider -O items.csv To dump into an XML file:: scrapy crawl myspider -O items.xml For more information see :ref:`topics-feed-exports` What's this huge cryptic ``__VIEWSTATE`` parameter used in some forms? ---------------------------------------------------------------------- The ``__VIEWSTATE`` parameter is used in sites built with ASP.NET/VB.NET. For more info on how it works see `this page`_. Also, here's an `example spider`_ which scrapes one of these sites. .. _this page: https://metacpan.org/release/ECARROLL/HTML-TreeBuilderX-ASP_NET-0.09/view/lib/HTML/TreeBuilderX/ASP_NET.pm .. _example spider: https://github.com/AmbientLighter/rpn-fas/blob/master/fas/spiders/rnp.py What's the best way to parse big XML/CSV data feeds? ---------------------------------------------------- Parsing big feeds with XPath selectors can be problematic since they need to build the DOM of the entire feed in memory, and this can be quite slow and consume a lot of memory. In order to avoid parsing all the entire feed at once in memory, you can use the :func:`~scrapy.utils.iterators.xmliter_lxml` and :func:`~scrapy.utils.iterators.csviter` functions. In fact, this is what :class:`~scrapy.spiders.XMLFeedSpider` uses. .. autofunction:: scrapy.utils.iterators.xmliter_lxml .. autofunction:: scrapy.utils.iterators.csviter Does Scrapy manage cookies automatically? ----------------------------------------- Yes, Scrapy receives and keeps track of cookies sent by servers, and sends them back on subsequent requests, like any regular web browser does. For more info see :ref:`topics-request-response` and :ref:`cookies-mw`. How can I see the cookies being sent and received from Scrapy? -------------------------------------------------------------- Enable the :setting:`COOKIES_DEBUG` setting. How can I instruct a spider to stop itself? ------------------------------------------- Raise the :exc:`~scrapy.exceptions.CloseSpider` exception from a callback. For more info see: :exc:`~scrapy.exceptions.CloseSpider`. How can I prevent my Scrapy bot from getting banned? ---------------------------------------------------- See :ref:`bans`. Should I use spider arguments or settings to configure my spider? ----------------------------------------------------------------- Both :ref:`spider arguments ` and :ref:`settings ` can be used to configure your spider. There is no strict rule that mandates to use one or the other, but settings are more suited for parameters that, once set, don't change much, while spider arguments are meant to change more often, even on each spider run and sometimes are required for the spider to run at all (for example, to set the start url of a spider). To illustrate with an example, assuming you have a spider that needs to log into a site to scrape data, and you only want to scrape data from a certain section of the site (which varies each time). In that case, the credentials to log in would be settings, while the url of the section to scrape would be a spider argument. I'm scraping a XML document and my XPath selector doesn't return any items -------------------------------------------------------------------------- You may need to remove namespaces. See :ref:`removing-namespaces`. .. _faq-split-item: How to split an item into multiple items in an item pipeline? ------------------------------------------------------------- :ref:`Item pipelines ` cannot yield multiple items per input item. :ref:`Create a spider middleware ` instead, and use its :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` method for this purpose. For example: .. code-block:: python from copy import deepcopy from itemadapter import ItemAdapter from scrapy import Request class MultiplyItemsMiddleware: def process_spider_output(self, response, result, spider): for item_or_request in result: if isinstance(item_or_request, Request): continue adapter = ItemAdapter(item) for _ in range(adapter["multiply_by"]): yield deepcopy(item) Does Scrapy support IPv6 addresses? ----------------------------------- Yes, by setting :setting:`DNS_RESOLVER` to ``scrapy.resolver.CachingHostnameResolver``. Note that by doing so, you lose the ability to set a specific timeout for DNS requests (the value of the :setting:`DNS_TIMEOUT` setting is ignored). .. _faq-specific-reactor: How to deal with ``: filedescriptor out of range in select()`` exceptions? ---------------------------------------------------------------------------------------------- This issue `has been reported`_ to appear when running broad crawls in macOS, where the default Twisted reactor is :class:`twisted.internet.selectreactor.SelectReactor`. Switching to a different reactor is possible by using the :setting:`TWISTED_REACTOR` setting. .. _faq-stop-response-download: How can I cancel the download of a given response? -------------------------------------------------- In some situations, it might be useful to stop the download of a certain response. For instance, sometimes you can determine whether or not you need the full contents of a response by inspecting its headers or the first bytes of its body. In that case, you could save resources by attaching a handler to the :class:`~scrapy.signals.bytes_received` or :class:`~scrapy.signals.headers_received` signals and raising a :exc:`~scrapy.exceptions.StopDownload` exception. Please refer to the :ref:`topics-stop-response-download` topic for additional information and examples. .. _faq-blank-request: How can I make a blank request? ------------------------------- .. code-block:: python from scrapy import Request blank_request = Request("data:,") In this case, the URL is set to a data URI scheme. Data URLs allow you to include data inline within web pages, similar to external resources. The "data:" scheme with an empty content (",") essentially creates a request to a data URL without any specific content. Running ``runspider`` I get ``error: No spider found in file: `` -------------------------------------------------------------------------- This may happen if your Scrapy project has a spider module with a name that conflicts with the name of one of the `Python standard library modules`_, such as ``csv.py`` or ``os.py``, or any `Python package`_ that you have installed. See :issue:`2680`. .. _has been reported: https://github.com/scrapy/scrapy/issues/2905 .. _Python standard library modules: https://docs.python.org/3/py-modindex.html .. _Python package: https://pypi.org/ .. _user agents: https://en.wikipedia.org/wiki/User_agent scrapy-2.13.3/docs/index.rst000066400000000000000000000153441503125130200156710ustar00rootroot00000000000000.. _topics-index: ============================== Scrapy |version| documentation ============================== Scrapy is a fast high-level `web crawling`_ and `web scraping`_ framework, used to crawl websites and extract structured data from their pages. It can be used for a wide range of purposes, from data mining to monitoring and automated testing. .. _web crawling: https://en.wikipedia.org/wiki/Web_crawler .. _web scraping: https://en.wikipedia.org/wiki/Web_scraping .. _getting-help: Getting help ============ Having trouble? We'd like to help! * Try the :doc:`FAQ ` -- it's got answers to some common questions. * Looking for specific information? Try the :ref:`genindex` or :ref:`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`_. * Join the Discord community `Scrapy Discord`_. .. _scrapy-users mailing list: https://groups.google.com/forum/#!forum/scrapy-users .. _Scrapy subreddit: https://www.reddit.com/r/scrapy/ .. _StackOverflow using the scrapy tag: https://stackoverflow.com/tags/scrapy .. _#scrapy IRC channel: irc://irc.freenode.net/scrapy .. _issue tracker: https://github.com/scrapy/scrapy/issues .. _Scrapy Discord: https://discord.com/invite/mv3yErfpvq First steps =========== .. toctree:: :caption: First steps :hidden: intro/overview intro/install intro/tutorial intro/examples :doc:`intro/overview` Understand what Scrapy is and how it can help you. :doc:`intro/install` Get Scrapy installed on your computer. :doc:`intro/tutorial` Write your first Scrapy project. :doc:`intro/examples` Learn more by playing with a pre-made Scrapy project. .. _section-basics: Basic concepts ============== .. toctree:: :caption: Basic concepts :hidden: topics/commands topics/spiders topics/selectors topics/items topics/loaders topics/shell topics/item-pipeline topics/feed-exports topics/request-response topics/link-extractors topics/settings topics/exceptions :doc:`topics/commands` Learn about the command-line tool used to manage your Scrapy project. :doc:`topics/spiders` Write the rules to crawl your websites. :doc:`topics/selectors` Extract the data from web pages using XPath. :doc:`topics/shell` Test your extraction code in an interactive environment. :doc:`topics/items` Define the data you want to scrape. :doc:`topics/loaders` Populate your items with the extracted data. :doc:`topics/item-pipeline` Post-process and store your scraped data. :doc:`topics/feed-exports` Output your scraped data using different formats and storages. :doc:`topics/request-response` Understand the classes used to represent HTTP requests and responses. :doc:`topics/link-extractors` Convenient classes to extract links to follow from pages. :doc:`topics/settings` Learn how to configure Scrapy and see all :ref:`available settings `. :doc:`topics/exceptions` See all available exceptions and their meaning. Built-in services ================= .. toctree:: :caption: Built-in services :hidden: topics/logging topics/stats topics/email topics/telnetconsole :doc:`topics/logging` Learn how to use Python's builtin logging on Scrapy. :doc:`topics/stats` Collect statistics about your scraping crawler. :doc:`topics/email` Send email notifications when certain events occur. :doc:`topics/telnetconsole` Inspect a running crawler using a built-in Python console. Solving specific problems ========================= .. toctree:: :caption: Solving specific problems :hidden: faq topics/debug topics/contracts topics/practices topics/broad-crawls topics/developer-tools topics/dynamic-content topics/leaks topics/media-pipeline topics/deploy topics/autothrottle topics/benchmarking topics/jobs topics/coroutines topics/asyncio :doc:`faq` Get answers to most frequently asked questions. :doc:`topics/debug` Learn how to debug common problems of your Scrapy spider. :doc:`topics/contracts` Learn how to use contracts for testing your spiders. :doc:`topics/practices` Get familiar with some Scrapy common practices. :doc:`topics/broad-crawls` Tune Scrapy for crawling a lot domains in parallel. :doc:`topics/developer-tools` Learn how to scrape with your browser's developer tools. :doc:`topics/dynamic-content` Read webpage data that is loaded dynamically. :doc:`topics/leaks` Learn how to find and get rid of memory leaks in your crawler. :doc:`topics/media-pipeline` Download files and/or images associated with your scraped items. :doc:`topics/deploy` Deploying your Scrapy spiders and run them in a remote server. :doc:`topics/autothrottle` Adjust crawl rate dynamically based on load. :doc:`topics/benchmarking` Check how Scrapy performs on your hardware. :doc:`topics/jobs` Learn how to pause and resume crawls for large spiders. :doc:`topics/coroutines` Use the :ref:`coroutine syntax `. :doc:`topics/asyncio` Use :mod:`asyncio` and :mod:`asyncio`-powered libraries. .. _extending-scrapy: Extending Scrapy ================ .. toctree:: :caption: Extending Scrapy :hidden: topics/architecture topics/addons topics/downloader-middleware topics/spider-middleware topics/extensions topics/signals topics/scheduler topics/exporters topics/components topics/api :doc:`topics/architecture` Understand the Scrapy architecture. :doc:`topics/addons` Enable and configure third-party extensions. :doc:`topics/downloader-middleware` Customize how pages get requested and downloaded. :doc:`topics/spider-middleware` Customize the input and output of your spiders. :doc:`topics/extensions` Extend Scrapy with your custom functionality :doc:`topics/signals` See all available signals and how to work with them. :doc:`topics/scheduler` Understand the scheduler component. :doc:`topics/exporters` Quickly export your scraped items to a file (XML, CSV, etc). :doc:`topics/components` Learn the common API and some good practices when building custom Scrapy components. :doc:`topics/api` Use it on extensions and middlewares to extend Scrapy functionality. All the rest ============ .. toctree:: :caption: All the rest :hidden: news contributing versioning :doc:`news` See what has changed in recent Scrapy versions. :doc:`contributing` Learn how to contribute to the Scrapy project. :doc:`versioning` Understand Scrapy versioning and API stability. scrapy-2.13.3/docs/intro/000077500000000000000000000000001503125130200151545ustar00rootroot00000000000000scrapy-2.13.3/docs/intro/examples.rst000066400000000000000000000013511503125130200175240ustar00rootroot00000000000000.. _intro-examples: ======== Examples ======== The best way to learn is with examples, and Scrapy is no exception. For this reason, there is an example Scrapy project named quotesbot_, that you can use to play and learn more about Scrapy. It contains two spiders for https://quotes.toscrape.com, one using CSS selectors and another one using XPath expressions. The quotesbot_ project is available at: https://github.com/scrapy/quotesbot. You can find more information about it in the project's README. If you're familiar with git, you can checkout the code. Otherwise you can download the project as a zip file by clicking `here `_. .. _quotesbot: https://github.com/scrapy/quotesbot scrapy-2.13.3/docs/intro/install.rst000066400000000000000000000236051503125130200173620ustar00rootroot00000000000000.. _intro-install: ================== Installation guide ================== .. _faq-python-versions: Supported Python versions ========================= Scrapy requires Python 3.9+, either the CPython implementation (default) or the PyPy implementation (see :ref:`python:implementations`). .. _intro-install-scrapy: Installing Scrapy ================= If you're using `Anaconda`_ or `Miniconda`_, you can install the package from the `conda-forge`_ channel, which has up-to-date packages for Linux, Windows and macOS. To install Scrapy using ``conda``, run:: conda install -c conda-forge scrapy Alternatively, if you’re already familiar with installation of Python packages, you can install Scrapy and its dependencies from PyPI with:: pip install Scrapy We strongly recommend that you install Scrapy in :ref:`a dedicated virtualenv `, to avoid conflicting with your system packages. Note that sometimes this may require solving compilation issues for some Scrapy dependencies depending on your operating system, so be sure to check the :ref:`intro-install-platform-notes`. For more detailed and platform-specific instructions, as well as troubleshooting information, read on. Things that are good to know ---------------------------- Scrapy is written in pure Python and depends on a few key Python packages (among others): * `lxml`_, an efficient XML and HTML parser * `parsel`_, an HTML/XML data extraction library written on top of lxml, * `w3lib`_, a multi-purpose helper for dealing with URLs and web page encodings * `twisted`_, an asynchronous networking framework * `cryptography`_ and `pyOpenSSL`_, to deal with various network-level security needs Some of these packages themselves depend on non-Python packages that might require additional installation steps depending on your platform. Please check :ref:`platform-specific guides below `. In case of any trouble related to these dependencies, please refer to their respective installation instructions: * `lxml installation`_ * :doc:`cryptography installation ` .. _lxml installation: https://lxml.de/installation.html .. _intro-using-virtualenv: Using a virtual environment (recommended) ----------------------------------------- TL;DR: We recommend installing Scrapy inside a virtual environment on all platforms. Python packages can be installed either globally (a.k.a system wide), or in user-space. We do not recommend installing Scrapy system wide. Instead, we recommend that you install Scrapy within a so-called "virtual environment" (:mod:`venv`). Virtual environments allow you to not conflict with already-installed Python system packages (which could break some of your system tools and scripts), and still install packages normally with ``pip`` (without ``sudo`` and the likes). See :ref:`tut-venv` on how to create your virtual environment. Once you have created a virtual environment, you can install Scrapy inside it with ``pip``, just like any other Python package. (See :ref:`platform-specific guides ` below for non-Python dependencies that you may need to install beforehand). .. _intro-install-platform-notes: Platform specific installation notes ==================================== .. _intro-install-windows: Windows ------- Though it's possible to install Scrapy on Windows using pip, we recommend you install `Anaconda`_ or `Miniconda`_ and use the package from the `conda-forge`_ channel, which will avoid most installation issues. Once you've installed `Anaconda`_ or `Miniconda`_, install Scrapy with:: conda install -c conda-forge scrapy To install Scrapy on Windows using ``pip``: .. warning:: This installation method requires “Microsoft Visual C++” for installing some Scrapy dependencies, which demands significantly more disk space than Anaconda. #. Download and execute `Microsoft C++ Build Tools`_ to install the Visual Studio Installer. #. Run the Visual Studio Installer. #. Under the Workloads section, select **C++ build tools**. #. Check the installation details and make sure following packages are selected as optional components: * **MSVC** (e.g MSVC v142 - VS 2019 C++ x64/x86 build tools (v14.23) ) * **Windows SDK** (e.g Windows 10 SDK (10.0.18362.0)) #. Install the Visual Studio Build Tools. Now, you should be able to :ref:`install Scrapy ` using ``pip``. .. _intro-install-ubuntu: Ubuntu 14.04 or above --------------------- Scrapy is currently tested with recent-enough versions of lxml, twisted and pyOpenSSL, and is compatible with recent Ubuntu distributions. But it should support older versions of Ubuntu too, like Ubuntu 14.04, albeit with potential issues with TLS connections. **Don't** use the ``python-scrapy`` package provided by Ubuntu, they are typically too old and slow to catch up with the latest Scrapy release. To install Scrapy on Ubuntu (or Ubuntu-based) systems, you need to install these dependencies:: sudo apt-get install python3 python3-dev python3-pip libxml2-dev libxslt1-dev zlib1g-dev libffi-dev libssl-dev - ``python3-dev``, ``zlib1g-dev``, ``libxml2-dev`` and ``libxslt1-dev`` are required for ``lxml`` - ``libssl-dev`` and ``libffi-dev`` are required for ``cryptography`` Inside a :ref:`virtualenv `, you can install Scrapy with ``pip`` after that:: pip install scrapy .. note:: The same non-Python dependencies can be used to install Scrapy in Debian Jessie (8.0) and above. .. _intro-install-macos: macOS ----- Building Scrapy's dependencies requires the presence of a C compiler and development headers. On macOS this is typically provided by Apple’s Xcode development tools. To install the Xcode command-line tools, open a terminal window and run:: xcode-select --install There's a `known issue `_ that prevents ``pip`` from updating system packages. This has to be addressed to successfully install Scrapy and its dependencies. Here are some proposed solutions: * *(Recommended)* **Don't** use system Python. Install a new, updated version that doesn't conflict with the rest of your system. Here's how to do it using the `homebrew`_ package manager: * Install `homebrew`_ following the instructions in https://brew.sh/ * Update your ``PATH`` variable to state that homebrew packages should be used before system packages (Change ``.bashrc`` to ``.zshrc`` accordingly if you're using `zsh`_ as default shell):: echo "export PATH=/usr/local/bin:/usr/local/sbin:$PATH" >> ~/.bashrc * Reload ``.bashrc`` to ensure the changes have taken place:: source ~/.bashrc * Install python:: brew install python * *(Optional)* :ref:`Install Scrapy inside a Python virtual environment `. This method is a workaround for the above macOS issue, but it's an overall good practice for managing dependencies and can complement the first method. After any of these workarounds you should be able to install Scrapy:: pip install Scrapy PyPy ---- We recommend using the latest PyPy version. For PyPy3, only Linux installation was tested. Most Scrapy dependencies now have binary wheels for CPython, but not for PyPy. This means that these dependencies will be built during installation. On macOS, you are likely to face an issue with building the Cryptography dependency. The solution to this problem is described `here `_, that is to ``brew install openssl`` and then export the flags that this command recommends (only needed when installing Scrapy). Installing on Linux has no special issues besides installing build dependencies. Installing Scrapy with PyPy on Windows is not tested. You can check that Scrapy is installed correctly by running ``scrapy bench``. If this command gives errors such as ``TypeError: ... got 2 unexpected keyword arguments``, this means that setuptools was unable to pick up one PyPy-specific dependency. To fix this issue, run ``pip install 'PyPyDispatcher>=2.1.0'``. .. _intro-install-troubleshooting: Troubleshooting =============== AttributeError: 'module' object has no attribute 'OP_NO_TLSv1_1' ---------------------------------------------------------------- After you install or upgrade Scrapy, Twisted or pyOpenSSL, you may get an exception with the following traceback:: […] File "[…]/site-packages/twisted/protocols/tls.py", line 63, in from twisted.internet._sslverify import _setAcceptableProtocols File "[…]/site-packages/twisted/internet/_sslverify.py", line 38, in TLSVersion.TLSv1_1: SSL.OP_NO_TLSv1_1, AttributeError: 'module' object has no attribute 'OP_NO_TLSv1_1' The reason you get this exception is that your system or virtual environment has a version of pyOpenSSL that your version of Twisted does not support. To install a version of pyOpenSSL that your version of Twisted supports, reinstall Twisted with the :code:`tls` extra option:: pip install twisted[tls] For details, see `Issue #2473 `_. .. _Python: https://www.python.org/ .. _pip: https://pip.pypa.io/en/latest/installing/ .. _lxml: https://lxml.de/index.html .. _parsel: https://pypi.org/project/parsel/ .. _w3lib: https://pypi.org/project/w3lib/ .. _twisted: https://twisted.org/ .. _cryptography: https://cryptography.io/en/latest/ .. _pyOpenSSL: https://pypi.org/project/pyOpenSSL/ .. _setuptools: https://pypi.org/pypi/setuptools .. _homebrew: https://brew.sh/ .. _zsh: https://www.zsh.org/ .. _Anaconda: https://docs.anaconda.com/anaconda/ .. _Miniconda: https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html .. _Visual Studio: https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio .. _Microsoft C++ Build Tools: https://visualstudio.microsoft.com/visual-cpp-build-tools/ .. _conda-forge: https://conda-forge.org/ scrapy-2.13.3/docs/intro/overview.rst000066400000000000000000000150371503125130200175620ustar00rootroot00000000000000.. _intro-overview: ================== Scrapy at a glance ================== Scrapy (/ˈskreɪpaɪ/) 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 https://quotes.toscrape.com, following the pagination: .. code-block:: python import scrapy class QuotesSpider(scrapy.Spider): name = "quotes" start_urls = [ "https://quotes.toscrape.com/tag/humor/", ] def parse(self, response): for quote in response.css("div.quote"): yield { "author": quote.xpath("span/small/text()").get(), "text": quote.css("span.text::text").get(), } next_page = response.css('li.next a::attr("href")').get() if next_page is not None: yield response.follow(next_page, self.parse) Put this in a text file, name it something like ``quotes_spider.py`` and run the spider using the :command:`runspider` command:: scrapy runspider quotes_spider.py -o quotes.jsonl When this finishes you will have in the ``quotes.jsonl`` file a list of the quotes in JSON Lines format, containing the text and author, which will look like this:: {"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": "Steve Martin", "text": "\u201cA day without sunshine is like, you know, night.\u201d"} {"author": "Garrison Keillor", "text": "\u201cAnyone who thinks sitting in church can make you a Christian must also think that sitting in a garage can make you a car.\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 the *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 will notice one of the main advantages of Scrapy: requests are :ref:`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 a 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 :ref:`a few settings `. You can do things like setting a download delay between each request, limiting the amount of concurrent requests per domain or per IP, and even :ref:`using an auto-throttling extension ` that tries to figure these settings out automatically. .. note:: This is using :ref:`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 :ref:`item pipeline ` to store the items in a database. .. _topics-whatelse: 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 :ref:`selecting and extracting ` data from HTML/XML sources using extended CSS selectors and XPath expressions, with helper methods for extraction using regular expressions. * An :ref:`interactive shell console ` (IPython aware) for trying out the CSS and XPath expressions to scrape data, which is very useful when writing or debugging your spiders. * Built-in support for :ref:`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 declarations. * :ref:`Strong extensibility support `, allowing you to plug in your own functionality using :ref:`signals ` and a well-defined API (middlewares, :ref:`extensions `, and :ref:`pipelines `). * A 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 :ref:`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 :ref:`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 :ref:`install Scrapy `, :ref:`follow through the tutorial ` to learn how to create a full-blown Scrapy project and `join the community`_. Thanks for your interest! .. _join the community: https://scrapy.org/community/ .. _web scraping: https://en.wikipedia.org/wiki/Web_scraping .. _Amazon Associates Web Services: https://affiliate-program.amazon.com/welcome/ecs .. _Amazon S3: https://aws.amazon.com/s3/ .. _Sitemaps: https://www.sitemaps.org/index.html scrapy-2.13.3/docs/intro/tutorial.rst000066400000000000000000000736241503125130200175650ustar00rootroot00000000000000.. _intro-tutorial: =============== Scrapy Tutorial =============== In this tutorial, we'll assume that Scrapy is already installed on your system. If that's not the case, see :ref:`intro-install`. We are going to scrape `quotes.toscrape.com `_, a website that lists quotes from famous authors. This tutorial will walk you through these tasks: 1. Creating a new Scrapy project 2. Writing a :ref:`spider ` to crawl a site and extract data 3. Exporting the scraped data using the command line 4. Changing spider to recursively follow links 5. Using spider arguments Scrapy is written in Python_. The more you learn about Python, the more you can get out of Scrapy. If you're already familiar with other languages and want to learn Python quickly, the `Python Tutorial`_ is a good resource. If you're new to programming and want to start with Python, the following books may be useful to you: * `Automate the Boring Stuff With Python`_ * `How To Think Like a Computer Scientist`_ * `Learn Python 3 The Hard Way`_ You can also take a look at `this list of Python resources for non-programmers`_, as well as the `suggested resources in the learnpython-subreddit`_. .. _Python: https://www.python.org/ .. _this list of Python resources for non-programmers: https://wiki.python.org/moin/BeginnersGuide/NonProgrammers .. _Python Tutorial: https://docs.python.org/3/tutorial .. _Automate the Boring Stuff With Python: https://automatetheboringstuff.com/ .. _How To Think Like a Computer Scientist: http://openbookproject.net/thinkcs/python/english3e/ .. _Learn Python 3 The Hard Way: https://learnpythonthehardway.org/python3/ .. _suggested resources in the learnpython-subreddit: https://www.reddit.com/r/learnpython/wiki/index#wiki_new_to_python.3F Creating a project ================== Before you start scraping, you will have to set up a new Scrapy project. Enter a directory where you'd like to store your code and run:: scrapy startproject tutorial This will create a ``tutorial`` directory with the following contents:: tutorial/ scrapy.cfg # deploy configuration file tutorial/ # project's Python module, you'll import your code from here __init__.py items.py # project items definition file middlewares.py # project middlewares file pipelines.py # project pipelines file settings.py # project settings file spiders/ # a directory where you'll later put your spiders __init__.py Our first Spider ================ Spiders are classes that you define and that Scrapy uses to scrape information from a website (or a group of websites). They must subclass :class:`~scrapy.Spider` and define the initial requests to be made, and optionally, how to follow links in pages and parse the downloaded page content to extract data. This is the code for our first Spider. Save it in a file named ``quotes_spider.py`` under the ``tutorial/spiders`` directory in your project: .. code-block:: python from pathlib import Path import scrapy class QuotesSpider(scrapy.Spider): name = "quotes" async def start(self): urls = [ "https://quotes.toscrape.com/page/1/", "https://quotes.toscrape.com/page/2/", ] for url in urls: yield scrapy.Request(url=url, callback=self.parse) def parse(self, response): page = response.url.split("/")[-2] filename = f"quotes-{page}.html" Path(filename).write_bytes(response.body) self.log(f"Saved file {filename}") As you can see, our Spider subclasses :class:`scrapy.Spider ` and defines some attributes and methods: * :attr:`~scrapy.Spider.name`: identifies the Spider. It must be unique within a project, that is, you can't set the same name for different Spiders. * :meth:`~scrapy.Spider.start`: must be an asynchronous generator that yields requests (and, optionally, items) for the spider to start crawling. Subsequent requests will be generated successively from these initial requests. * :meth:`~scrapy.Spider.parse`: a method that will be called to handle the response downloaded for each of the requests made. The response parameter is an instance of :class:`~scrapy.http.TextResponse` that holds the page content and has further helpful methods to handle it. The :meth:`~scrapy.Spider.parse` method usually parses the response, extracting the scraped data as dicts and also finding new URLs to follow and creating new requests (:class:`~scrapy.Request`) from them. How to run our spider --------------------- To put our spider to work, go to the project's top level directory and run:: scrapy crawl quotes This command runs the spider named ``quotes`` that we've just added, that will send some requests for the ``quotes.toscrape.com`` domain. You will get an output similar to this:: ... (omitted for brevity) 2016-12-16 21:24:05 [scrapy.core.engine] INFO: Spider opened 2016-12-16 21:24:05 [scrapy.extensions.logstats] INFO: Crawled 0 pages (at 0 pages/min), scraped 0 items (at 0 items/min) 2016-12-16 21:24:05 [scrapy.extensions.telnet] DEBUG: Telnet console listening on 127.0.0.1:6023 2016-12-16 21:24:05 [scrapy.core.engine] DEBUG: Crawled (404) (referer: None) 2016-12-16 21:24:05 [scrapy.core.engine] DEBUG: Crawled (200) (referer: None) 2016-12-16 21:24:05 [scrapy.core.engine] DEBUG: Crawled (200) (referer: None) 2016-12-16 21:24:05 [quotes] DEBUG: Saved file quotes-1.html 2016-12-16 21:24:05 [quotes] DEBUG: Saved file quotes-2.html 2016-12-16 21:24:05 [scrapy.core.engine] INFO: Closing spider (finished) ... Now, check the files in the current directory. You should notice that two new files have been created: *quotes-1.html* and *quotes-2.html*, with the content for the respective URLs, as our ``parse`` method instructs. .. note:: If you are wondering why we haven't parsed the HTML yet, hold on, we will cover that soon. What just happened under the hood? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Scrapy sends the first :class:`scrapy.Request ` objects yielded by the :meth:`~scrapy.Spider.start` spider method. Upon receiving a response for each one, Scrapy calls the callback method associated with the request (in this case, the ``parse`` method) with a :class:`~scrapy.http.Response` object. A shortcut to the ``start`` method ---------------------------------- Instead of implementing a :meth:`~scrapy.Spider.start` method that yields :class:`~scrapy.Request` objects from URLs, you can define a :attr:`~scrapy.Spider.start_urls` class attribute with a list of URLs. This list will then be used by the default implementation of :meth:`~scrapy.Spider.start` to create the initial requests for your spider. .. code-block:: python from pathlib import Path import scrapy class QuotesSpider(scrapy.Spider): name = "quotes" start_urls = [ "https://quotes.toscrape.com/page/1/", "https://quotes.toscrape.com/page/2/", ] def parse(self, response): page = response.url.split("/")[-2] filename = f"quotes-{page}.html" Path(filename).write_bytes(response.body) The :meth:`~scrapy.Spider.parse` method will be called to handle each of the requests for those URLs, even though we haven't explicitly told Scrapy to do so. This happens because :meth:`~scrapy.Spider.parse` is Scrapy's default callback method, which is called for requests without an explicitly assigned callback. Extracting data --------------- The best way to learn how to extract data with Scrapy is trying selectors using the :ref:`Scrapy shell `. Run:: scrapy shell 'https://quotes.toscrape.com/page/1/' .. note:: Remember to always enclose URLs in quotes when running Scrapy shell from the command line, otherwise URLs containing arguments (i.e. ``&`` character) will not work. On Windows, use double quotes instead:: scrapy shell "https://quotes.toscrape.com/page/1/" You will see something like:: [ ... Scrapy log here ... ] 2016-09-19 12:09:27 [scrapy.core.engine] DEBUG: Crawled (200) (referer: None) [s] Available Scrapy objects: [s] scrapy scrapy module (contains scrapy.Request, scrapy.Selector, etc) [s] crawler [s] item {} [s] request [s] response <200 https://quotes.toscrape.com/page/1/> [s] settings [s] spider [s] Useful shortcuts: [s] shelp() Shell help (print this help) [s] fetch(req_or_url) Fetch request (or URL) and update local objects [s] view(response) View response in a browser Using the shell, you can try selecting elements using `CSS`_ with the response object: .. invisible-code-block: python response = load_response('https://quotes.toscrape.com/page/1/', 'quotes1.html') .. code-block:: pycon >>> response.css("title") [] The result of running ``response.css('title')`` is a list-like object called :class:`~scrapy.selector.SelectorList`, which represents a list of :class:`~scrapy.Selector` objects that wrap around XML/HTML elements and allow you to run further queries to refine the selection or extract the data. To extract the text from the title above, you can do: .. code-block:: pycon >>> response.css("title::text").getall() ['Quotes to Scrape'] There are two things to note here: one is that we've added ``::text`` to the CSS query, to mean we want to select only the text elements directly inside ```` element. If we don't specify ``::text``, we'd get the full title element, including its tags: .. code-block:: pycon >>> response.css("title").getall() ['<title>Quotes to Scrape'] The other thing is that the result of calling ``.getall()`` is a list: it is possible that a selector returns more than one result, so we extract them all. When you know you just want the first result, as in this case, you can do: .. code-block:: pycon >>> response.css("title::text").get() 'Quotes to Scrape' As an alternative, you could've written: .. code-block:: pycon >>> response.css("title::text")[0].get() 'Quotes to Scrape' Accessing an index on a :class:`~scrapy.selector.SelectorList` instance will raise an :exc:`IndexError` exception if there are no results: .. code-block:: pycon >>> response.css("noelement")[0].get() Traceback (most recent call last): ... IndexError: list index out of range You might want to use ``.get()`` directly on the :class:`~scrapy.selector.SelectorList` instance instead, which returns ``None`` if there are no results: .. code-block:: pycon >>> response.css("noelement").get() There's a lesson here: for most scraping code, you want it to be resilient to errors due to things not being found on a page, so that even if some parts fail to be scraped, you can at least get **some** data. Besides the :meth:`~scrapy.selector.SelectorList.getall` and :meth:`~scrapy.selector.SelectorList.get` methods, you can also use the :meth:`~scrapy.selector.SelectorList.re` method to extract using :doc:`regular expressions `: .. code-block:: pycon >>> response.css("title::text").re(r"Quotes.*") ['Quotes to Scrape'] >>> response.css("title::text").re(r"Q\w+") ['Quotes'] >>> response.css("title::text").re(r"(\w+) to (\w+)") ['Quotes', 'Scrape'] In order to find the proper CSS selectors to use, you might find it useful to open the response page from the shell in your web browser using ``view(response)``. You can use your browser's developer tools to inspect the HTML and come up with a selector (see :ref:`topics-developer-tools`). `Selector Gadget`_ is also a nice tool to quickly find CSS selector for visually selected elements, which works in many browsers. .. _Selector Gadget: https://selectorgadget.com/ XPath: a brief intro ^^^^^^^^^^^^^^^^^^^^ Besides `CSS`_, Scrapy selectors also support using `XPath`_ expressions: .. code-block:: pycon >>> response.xpath("//title") [] >>> response.xpath("//title/text()").get() 'Quotes to Scrape' XPath expressions are very powerful, and are the foundation of Scrapy Selectors. In fact, CSS selectors are converted to XPath under-the-hood. You can see that if you read the text representation of the selector objects in the shell closely. While perhaps not as popular as CSS selectors, XPath expressions offer more power because besides navigating the structure, it can also look at the content. Using XPath, you're able to select things like: *the link that contains the text "Next Page"*. This makes XPath very fitting to the task of scraping, and we encourage you to learn XPath even if you already know how to construct CSS selectors, it will make scraping much easier. We won't cover much of XPath here, but you can read more about :ref:`using XPath with Scrapy Selectors here `. To learn more about XPath, we recommend `this tutorial to learn XPath through examples `_, and `this tutorial to learn "how to think in XPath" `_. .. _XPath: https://www.w3.org/TR/xpath-10/ .. _CSS: https://www.w3.org/TR/selectors Extracting quotes and authors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Now that you know a bit about selection and extraction, let's complete our spider by writing the code to extract the quotes from the web page. Each quote in https://quotes.toscrape.com is represented by HTML elements that look like this: .. code-block:: html
“The world as we have created it is a process of our thinking. It cannot be changed without changing our thinking.” by Albert Einstein (about)
Tags: change deep-thoughts thinking world
Let's open up scrapy shell and play a bit to find out how to extract the data we want:: scrapy shell 'https://quotes.toscrape.com' We get a list of selectors for the quote HTML elements with: .. code-block:: pycon >>> response.css("div.quote") [, , ...] Each of the selectors returned by the query above allows us to run further queries over their sub-elements. Let's assign the first selector to a variable, so that we can run our CSS selectors directly on a particular quote: .. code-block:: pycon >>> quote = response.css("div.quote")[0] Now, let's extract the ``text``, ``author`` and ``tags`` from that quote using the ``quote`` object we just created: .. code-block:: pycon >>> text = quote.css("span.text::text").get() >>> text '“The world as we have created it is a process of our thinking. It cannot be changed without changing our thinking.”' >>> author = quote.css("small.author::text").get() >>> author 'Albert Einstein' Given that the tags are a list of strings, we can use the ``.getall()`` method to get all of them: .. code-block:: pycon >>> tags = quote.css("div.tags a.tag::text").getall() >>> tags ['change', 'deep-thoughts', 'thinking', 'world'] .. invisible-code-block: python from sys import version_info Having figured out how to extract each bit, we can now iterate over all the quote elements and put them together into a Python dictionary: .. code-block:: pycon >>> for quote in response.css("div.quote"): ... text = quote.css("span.text::text").get() ... author = quote.css("small.author::text").get() ... tags = quote.css("div.tags a.tag::text").getall() ... print(dict(text=text, author=author, tags=tags)) ... {'text': '“The world as we have created it is a process of our thinking. It cannot be changed without changing our thinking.”', 'author': 'Albert Einstein', 'tags': ['change', 'deep-thoughts', 'thinking', 'world']} {'text': '“It is our choices, Harry, that show what we truly are, far more than our abilities.”', 'author': 'J.K. Rowling', 'tags': ['abilities', 'choices']} ... Extracting data in our spider ----------------------------- Let's get back to our spider. Until now, it hasn't extracted any data in particular, just saving the whole HTML page to a local file. Let's integrate the extraction logic above into our spider. A Scrapy spider typically generates many dictionaries containing the data extracted from the page. To do that, we use the ``yield`` Python keyword in the callback, as you can see below: .. code-block:: python import scrapy class QuotesSpider(scrapy.Spider): name = "quotes" start_urls = [ "https://quotes.toscrape.com/page/1/", "https://quotes.toscrape.com/page/2/", ] def parse(self, response): for quote in response.css("div.quote"): yield { "text": quote.css("span.text::text").get(), "author": quote.css("small.author::text").get(), "tags": quote.css("div.tags a.tag::text").getall(), } To run this spider, exit the scrapy shell by entering:: quit() Then, run:: scrapy crawl quotes Now, it should output the extracted data with the log:: 2016-09-19 18:57:19 [scrapy.core.scraper] DEBUG: Scraped from <200 https://quotes.toscrape.com/page/1/> {'tags': ['life', 'love'], 'author': 'André Gide', 'text': '“It is better to be hated for what you are than to be loved for what you are not.”'} 2016-09-19 18:57:19 [scrapy.core.scraper] DEBUG: Scraped from <200 https://quotes.toscrape.com/page/1/> {'tags': ['edison', 'failure', 'inspirational', 'paraphrased'], 'author': 'Thomas A. Edison', 'text': "“I have not failed. I've just found 10,000 ways that won't work.”"} .. _storing-data: Storing the scraped data ======================== The simplest way to store the scraped data is by using :ref:`Feed exports `, with the following command:: scrapy crawl quotes -O quotes.json That will generate a ``quotes.json`` file containing all scraped items, serialized in `JSON`_. The ``-O`` command-line switch overwrites any existing file; use ``-o`` instead to append new content to any existing file. However, appending to a JSON file makes the file contents invalid JSON. When appending to a file, consider using a different serialization format, such as `JSON Lines`_:: scrapy crawl quotes -o quotes.jsonl The `JSON Lines`_ format is useful because it's stream-like, so you can easily append new records to it. It doesn't have the same problem as JSON when you run twice. Also, as each record is a separate line, you can process big files without having to fit everything in memory, there are tools like `JQ`_ to help do that at the command-line. In small projects (like the one in this tutorial), that should be enough. However, if you want to perform more complex things with the scraped items, you can write an :ref:`Item Pipeline `. A placeholder file for Item Pipelines has been set up for you when the project is created, in ``tutorial/pipelines.py``. Though you don't need to implement any item pipelines if you just want to store the scraped items. .. _JSON Lines: https://jsonlines.org .. _JQ: https://stedolan.github.io/jq Following links =============== Let's say, instead of just scraping the stuff from the first two pages from https://quotes.toscrape.com, you want quotes from all the pages in the website. Now that you know how to extract data from pages, let's see how to follow links from them. The first thing to do is extract the link to the page we want to follow. Examining our page, we can see there is a link to the next page with the following markup: .. code-block:: html We can try extracting it in the shell: >>> response.css('li.next a').get() 'Next ' This gets the anchor element, but we want the attribute ``href``. For that, Scrapy supports a CSS extension that lets you select the attribute contents, like this: .. code-block:: pycon >>> response.css("li.next a::attr(href)").get() '/page/2/' There is also an ``attrib`` property available (see :ref:`selecting-attributes` for more): .. code-block:: pycon >>> response.css("li.next a").attrib["href"] '/page/2/' Now let's see our spider, modified to recursively follow the link to the next page, extracting data from it: .. code-block:: python import scrapy class QuotesSpider(scrapy.Spider): name = "quotes" start_urls = [ "https://quotes.toscrape.com/page/1/", ] def parse(self, response): for quote in response.css("div.quote"): yield { "text": quote.css("span.text::text").get(), "author": quote.css("small.author::text").get(), "tags": quote.css("div.tags a.tag::text").getall(), } next_page = response.css("li.next a::attr(href)").get() if next_page is not None: next_page = response.urljoin(next_page) yield scrapy.Request(next_page, callback=self.parse) Now, after extracting the data, the ``parse()`` method looks for the link to the next page, builds a full absolute URL using the :meth:`~scrapy.http.Response.urljoin` method (since the links can be relative) and yields a new request to the next page, registering itself as callback to handle the data extraction for the next page and to keep the crawling going through all the pages. What you see here is Scrapy's mechanism of following links: when you yield a Request in a callback method, Scrapy will schedule that request to be sent and register a callback method to be executed when that request finishes. Using this, you can build complex crawlers that follow links according to rules you define, and extract different kinds of data depending on the page it's visiting. In our example, it creates a sort of loop, following all the links to the next page until it doesn't find one -- handy for crawling blogs, forums and other sites with pagination. .. _response-follow-example: A shortcut for creating Requests -------------------------------- As a shortcut for creating Request objects you can use :meth:`response.follow `: .. code-block:: python import scrapy class QuotesSpider(scrapy.Spider): name = "quotes" start_urls = [ "https://quotes.toscrape.com/page/1/", ] def parse(self, response): for quote in response.css("div.quote"): yield { "text": quote.css("span.text::text").get(), "author": quote.css("span small::text").get(), "tags": quote.css("div.tags a.tag::text").getall(), } next_page = response.css("li.next a::attr(href)").get() if next_page is not None: yield response.follow(next_page, callback=self.parse) Unlike scrapy.Request, ``response.follow`` supports relative URLs directly - no need to call urljoin. Note that ``response.follow`` just returns a Request instance; you still have to yield this Request. .. skip: start You can also pass a selector to ``response.follow`` instead of a string; this selector should extract necessary attributes: .. code-block:: python for href in response.css("ul.pager a::attr(href)"): yield response.follow(href, callback=self.parse) For ```` elements there is a shortcut: ``response.follow`` uses their href attribute automatically. So the code can be shortened further: .. code-block:: python for a in response.css("ul.pager a"): yield response.follow(a, callback=self.parse) To create multiple requests from an iterable, you can use :meth:`response.follow_all ` instead: .. code-block:: python anchors = response.css("ul.pager a") yield from response.follow_all(anchors, callback=self.parse) or, shortening it further: .. code-block:: python yield from response.follow_all(css="ul.pager a", callback=self.parse) .. skip: end More examples and patterns -------------------------- Here is another spider that illustrates callbacks and following links, this time for scraping author information: .. code-block:: python import scrapy class AuthorSpider(scrapy.Spider): name = "author" start_urls = ["https://quotes.toscrape.com/"] def parse(self, response): author_page_links = response.css(".author + a") yield from response.follow_all(author_page_links, self.parse_author) pagination_links = response.css("li.next a") yield from response.follow_all(pagination_links, self.parse) def parse_author(self, response): def extract_with_css(query): return response.css(query).get(default="").strip() yield { "name": extract_with_css("h3.author-title::text"), "birthdate": extract_with_css(".author-born-date::text"), "bio": extract_with_css(".author-description::text"), } This spider will start from the main page, it will follow all the links to the authors pages calling the ``parse_author`` callback for each of them, and also the pagination links with the ``parse`` callback as we saw before. Here we're passing callbacks to :meth:`response.follow_all ` as positional arguments to make the code shorter; it also works for :class:`~scrapy.Request`. The ``parse_author`` callback defines a helper function to extract and cleanup the data from a CSS query and yields the Python dict with the author data. Another interesting thing this spider demonstrates is that, even if there are many quotes from the same author, we don't need to worry about visiting the same author page multiple times. By default, Scrapy filters out duplicated requests to URLs already visited, avoiding the problem of hitting servers too much because of a programming mistake. This can be configured in the :setting:`DUPEFILTER_CLASS` setting. Hopefully by now you have a good understanding of how to use the mechanism of following links and callbacks with Scrapy. As yet another example spider that leverages the mechanism of following links, check out the :class:`~scrapy.spiders.CrawlSpider` class for a generic spider that implements a small rules engine that you can use to write your crawlers on top of it. Also, a common pattern is to build an item with data from more than one page, using a :ref:`trick to pass additional data to the callbacks `. Using spider arguments ====================== You can provide command line arguments to your spiders by using the ``-a`` option when running them:: scrapy crawl quotes -O quotes-humor.json -a tag=humor These arguments are passed to the Spider's ``__init__`` method and become spider attributes by default. In this example, the value provided for the ``tag`` argument will be available via ``self.tag``. You can use this to make your spider fetch only quotes with a specific tag, building the URL based on the argument: .. code-block:: python import scrapy class QuotesSpider(scrapy.Spider): name = "quotes" async def start(self): url = "https://quotes.toscrape.com/" tag = getattr(self, "tag", None) if tag is not None: url = url + "tag/" + tag yield scrapy.Request(url, self.parse) def parse(self, response): for quote in response.css("div.quote"): yield { "text": quote.css("span.text::text").get(), "author": quote.css("small.author::text").get(), } next_page = response.css("li.next a::attr(href)").get() if next_page is not None: yield response.follow(next_page, self.parse) If you pass the ``tag=humor`` argument to this spider, you'll notice that it will only visit URLs from the ``humor`` tag, such as ``https://quotes.toscrape.com/tag/humor``. You can :ref:`learn more about handling spider arguments here `. Next steps ========== This tutorial covered only the basics of Scrapy, but there's a lot of other features not mentioned here. Check the :ref:`topics-whatelse` section in the :ref:`intro-overview` chapter for a quick overview of the most important ones. You can continue from the section :ref:`section-basics` to know more about the command-line tool, spiders, selectors and other things the tutorial hasn't covered like modeling the scraped data. If you'd prefer to play with an example project, check the :ref:`intro-examples` section. .. _JSON: https://en.wikipedia.org/wiki/JSON scrapy-2.13.3/docs/news.rst000066400000000000000000011334121503125130200155340ustar00rootroot00000000000000.. _news: Release notes ============= .. _release-2.13.3: Scrapy 2.13.3 (2025-07-02) -------------------------- - Changed the values for :setting:`DOWNLOAD_DELAY` (from ``0`` to ``1``) and :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` (from ``8`` to ``1``) in the default project template. (:issue:`6597`, :issue:`6918`, :issue:`6923`) - Improved :class:`scrapy.core.engine.ExecutionEngine` logic related to initialization and exception handling, fixing several cases where the spider would crash, hang or log an unhandled exception. (:issue:`6783`, :issue:`6784`, :issue:`6900`, :issue:`6908`, :issue:`6910`, :issue:`6911`) - Fixed a Windows issue with :ref:`feed exports ` using :class:`scrapy.extensions.feedexport.FileFeedStorage` that caused the file to be created on the wrong drive. (:issue:`6894`, :issue:`6897`) - Allowed running tests with Twisted 25.5.0+ again. Pytest 8.4.1+ is now required for running tests in non-pinned envs as support for the new Twisted version was added in that version. (:issue:`6893`) - Fixed running tests with lxml 6.0.0+. (:issue:`6919`) - Added a deprecation notice for ``scrapy.spidermiddlewares.offsite.OffsiteMiddleware`` to :ref:`the Scrapy 2.11.2 release notes `. (:issue:`6926`) - Updated :ref:`contribution docs ` to refer to ruff_ instead of black_. (:issue:`6903`) - Added ``.venv/`` and ``.vscode/`` to ``.gitignore``. (:issue:`6901`, :issue:`6907`) .. _release-2.13.2: Scrapy 2.13.2 (2025-06-09) -------------------------- - Fixed a bug introduced in Scrapy 2.13.0 that caused results of request errbacks to be ignored when the errback was called because of a downloader error. (:issue:`6861`, :issue:`6863`) - Added a note about the behavior change of :func:`scrapy.utils.reactor.is_asyncio_reactor_installed` to its docs and to the "Backward-incompatible changes" section of :ref:`the Scrapy 2.13.0 release notes `. (:issue:`6866`) - Improved the message in the exception raised by :func:`scrapy.utils.test.get_reactor_settings` when there is no reactor installed. (:issue:`6866`) - Updated the :class:`scrapy.crawler.CrawlerRunner` examples in :ref:`topics-practices` to install the reactor explicitly, to fix reactor-related errors with Scrapy 2.13.0 and later. (:issue:`6865`) - Fixed ``scrapy fetch`` not working with scrapy-poet_. (:issue:`6872`) - Fixed an exception produced by :class:`scrapy.core.engine.ExecutionEngine` when it's closed before being fully initialized. (:issue:`6857`, :issue:`6867`) - Improved the README, updated the Scrapy logo in it. (:issue:`6831`, :issue:`6833`, :issue:`6839`) - Restricted the Twisted version used in tests to below 25.5.0, as some tests fail with 25.5.0. (:issue:`6878`, :issue:`6882`) - Updated type hints for Twisted 25.5.0 changes. (:issue:`6882`) - Removed the old artwork. (:issue:`6874`) .. _release-2.13.1: Scrapy 2.13.1 (2025-05-28) -------------------------- - Give callback requests precedence over start requests when priority values are the same. This makes changes from 2.13.0 to start request handling more intuitive and backward compatible. For scenarios where all requests have the same priorities, in 2.13.0 all start requests were sent before the first callback request. In 2.13.1, same as in 2.12 and lower, start requests are only sent when there are not enough pending callback requests to reach concurrency limits. (:issue:`6828`) - Added a deepwiki_ badge to the README. (:issue:`6793`) .. _deepwiki: https://deepwiki.com/scrapy/scrapy - Fixed a typo in the code example of :ref:`start-requests-lazy`. (:issue:`6812`, :issue:`6815`) - Fixed a typo in the :ref:`coroutine-support` section of the documentation. (:issue:`6822`) - Made this page more prominently listed in PyPI project links. (:issue:`6826`) .. _release-2.13.0: Scrapy 2.13.0 (2025-05-08) -------------------------- Highlights: - The asyncio reactor is now enabled by default - Replaced ``start_requests()`` (sync) with :meth:`~scrapy.Spider.start` (async) and changed how it is iterated. - Added the :reqmeta:`allow_offsite` request meta key - :ref:`Spider middlewares that don't support asynchronous spider output ` are deprecated - Added a base class for :ref:`universal spider middlewares ` Modified requirements ~~~~~~~~~~~~~~~~~~~~~ - Dropped support for PyPy 3.9. (:issue:`6613`) - Added support for PyPy 3.11. (:issue:`6697`) Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The default value of the :setting:`TWISTED_REACTOR` setting was changed from ``None`` to ``"twisted.internet.asyncioreactor.AsyncioSelectorReactor"``. This value was used in newly generated projects since Scrapy 2.7.0 but now existing projects that don't explicitly set this setting will also use the asyncio reactor. You can :ref:`change this setting in your project ` to use a different reactor. (:issue:`6659`, :issue:`6713`) - The iteration of start requests and items no longer stops once there are requests in the scheduler, and instead runs continuously until all start requests have been scheduled. To reproduce the previous behavior, see :ref:`start-requests-lazy`. (:issue:`6729`) - An unhandled exception from the :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.open_spider` method of a :ref:`spider middleware ` no longer stops the crawl. (:issue:`6729`) - In ``scrapy.core.engine.ExecutionEngine``: - The second parameter of ``open_spider()``, ``start_requests``, has been removed. The start requests are determined by the ``spider`` parameter instead (see :meth:`~scrapy.Spider.start`). - The ``slot`` attribute has been renamed to ``_slot`` and should not be used. (:issue:`6729`) - In ``scrapy.core.engine``, the ``Slot`` class has been renamed to ``_Slot`` and should not be used. (:issue:`6729`) - The ``slot`` :ref:`telnet variable ` has been removed. (:issue:`6729`) - In ``scrapy.core.spidermw.SpiderMiddlewareManager``, ``process_start_requests()`` has been replaced by ``process_start()``. (:issue:`6729`) - The now-deprecated ``start_requests()`` method, when it returns an iterable instead of being defined as a generator, is now executed *after* the :ref:`scheduler ` instance has been created. (:issue:`6729`) - When using :setting:`JOBDIR`, :ref:`start requests ` are now serialized into their own, ``s``-suffixed priority folders. You can set :setting:`SCHEDULER_START_DISK_QUEUE` to ``None`` or ``""`` to change that, but the side effects may be undesirable. See :setting:`SCHEDULER_START_DISK_QUEUE` for details. (:issue:`6729`) - The URL length limit, set by the :setting:`URLLENGTH_LIMIT` setting, is now also enforced for start requests. (:issue:`6777`) - Calling :func:`scrapy.utils.reactor.is_asyncio_reactor_installed` without an installed reactor now raises an exception instead of installing a reactor. This shouldn't affect normal Scrapy use cases, but it may affect 3rd-party test suites that use Scrapy internals such as :class:`~scrapy.crawler.Crawler` and don't install a reactor explicitly. If you are affected by this change, you most likely need to install the reactor before running Scrapy code that expects it to be installed. (:issue:`6732`, :issue:`6735`) - The ``from_settings()`` method of :class:`~scrapy.spidermiddlewares.urllength.UrlLengthMiddleware`, deprecated in Scrapy 2.12.0, is removed earlier than the usual deprecation period (this was needed because after the introduction of the :class:`~scrapy.spidermiddlewares.base.BaseSpiderMiddleware` base class and switching built-in spider middlewares to it those middlewares need the :class:`~scrapy.crawler.Crawler` instance at run time). Please use ``from_crawler()`` instead. (:issue:`6693`) - ``scrapy.utils.url.escape_ajax()`` is no longer called when a :class:`~scrapy.Request` instance is created. It was only useful for websites supporting the ``_escaped_fragment_`` feature which most modern websites don't support. If you still need this you can modify the URLs before passing them to :class:`~scrapy.Request`. (:issue:`6523`, :issue:`6651`) Deprecation removals ~~~~~~~~~~~~~~~~~~~~ - Removed old deprecated name aliases for some signals: - ``stats_spider_opened`` (use ``spider_opened`` instead) - ``stats_spider_closing`` and ``stats_spider_closed`` (use ``spider_closed`` instead) - ``item_passed`` (use ``item_scraped`` instead) - ``request_received`` (use ``request_scheduled`` instead) (:issue:`6654`, :issue:`6655`) Deprecations ~~~~~~~~~~~~ - The ``start_requests()`` method of :class:`~scrapy.Spider` is deprecated, use :meth:`~scrapy.Spider.start` instead, or both to maintain support for lower Scrapy versions. (:issue:`456`, :issue:`3477`, :issue:`4467`, :issue:`5627`, :issue:`6729`) - The ``process_start_requests()`` method of :ref:`spider middlewares ` is deprecated, use :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_start` instead, or both to maintain support for lower Scrapy versions. (:issue:`456`, :issue:`3477`, :issue:`4467`, :issue:`5627`, :issue:`6729`) - The ``__init__`` method of priority queue classes (see :setting:`SCHEDULER_PRIORITY_QUEUE`) should now support a keyword-only ``start_queue_cls`` parameter. (:issue:`6752`) - :ref:`Spider middlewares that don't support asynchronous spider output ` are deprecated. The async iterable downgrading feature, needed for using such middlewares with asynchronous callbacks and with other spider middlewares that produce asynchronous iterables, is also deprecated. Please update all such middlewares to support asynchronous spider output. (:issue:`6664`) - Functions that were imported from :mod:`w3lib.url` and re-exported in :mod:`scrapy.utils.url` are now deprecated, you should import them from :mod:`w3lib.url` directly. They are: - ``scrapy.utils.url.add_or_replace_parameter()`` - ``scrapy.utils.url.add_or_replace_parameters()`` - ``scrapy.utils.url.any_to_uri()`` - ``scrapy.utils.url.canonicalize_url()`` - ``scrapy.utils.url.file_uri_to_path()`` - ``scrapy.utils.url.is_url()`` - ``scrapy.utils.url.parse_data_uri()`` - ``scrapy.utils.url.parse_url()`` - ``scrapy.utils.url.path_to_file_uri()`` - ``scrapy.utils.url.safe_download_url()`` - ``scrapy.utils.url.safe_url_string()`` - ``scrapy.utils.url.url_query_cleaner()`` - ``scrapy.utils.url.url_query_parameter()`` (:issue:`4577`, :issue:`6583`, :issue:`6586`) - HTTP/1.0 support code is deprecated. It was disabled by default and couldn't be used together with HTTP/1.1. If you still need it, you should write your own download handler or copy the code from Scrapy. The deprecations include: - ``scrapy.core.downloader.handlers.http10.HTTP10DownloadHandler`` - ``scrapy.core.downloader.webclient.ScrapyHTTPClientFactory`` - ``scrapy.core.downloader.webclient.ScrapyHTTPPageGetter`` - Overriding ``scrapy.core.downloader.contextfactory.ScrapyClientContextFactory.getContext()`` (:issue:`6634`) - The following modules and functions used only in tests are deprecated: - the ``scrapy/utils/testproc`` module - the ``scrapy/utils/testsite`` module - ``scrapy.utils.test.assert_gcs_environ()`` - ``scrapy.utils.test.get_ftp_content_and_delete()`` - ``scrapy.utils.test.get_gcs_content_and_delete()`` - ``scrapy.utils.test.mock_google_cloud_storage()`` - ``scrapy.utils.test.skip_if_no_boto()`` If you need to use them in your tests or code, you can copy the code from Scrapy. (:issue:`6696`) - ``scrapy.utils.test.TestSpider`` is deprecated. If you need an empty spider class you can use :class:`scrapy.utils.spider.DefaultSpider` or create your own subclass of :class:`scrapy.Spider`. (:issue:`6678`) - ``scrapy.downloadermiddlewares.ajaxcrawl.AjaxCrawlMiddleware`` is deprecated. It was disabled by default and isn't useful for most of the existing websites. (:issue:`6523`, :issue:`6651`, :issue:`6656`) - ``scrapy.utils.url.escape_ajax()`` is deprecated. (:issue:`6523`, :issue:`6651`) - ``scrapy.spiders.init.InitSpider`` is deprecated. If you find it useful, you can copy its code from Scrapy. (:issue:`6708`, :issue:`6714`) - ``scrapy.utils.versions.scrapy_components_versions()`` is deprecated, use :func:`scrapy.utils.versions.get_versions()` instead. (:issue:`6582`) - ``BaseDupeFilter.log()`` is deprecated. It does nothing and shouldn't be called. (:issue:`4151`) - Passing the ``spider`` argument to the following methods of :class:`~scrapy.core.scraper.Scraper` is deprecated: - ``close_spider()`` - ``enqueue_scrape()`` - ``handle_spider_error()`` - ``handle_spider_output()`` (:issue:`6764`) New features ~~~~~~~~~~~~ - You can now yield the start requests and items of a spider from the :meth:`~scrapy.Spider.start` spider method and from the :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_start` spider middleware method, both :term:`asynchronous generators `. This makes it possible to use asynchronous code to generate those start requests and items, e.g. reading them from a queue service or database using an asynchronous client, without workarounds. (:issue:`456`, :issue:`3477`, :issue:`4467`, :issue:`5627`, :issue:`6729`) - Start requests are now :ref:`scheduled ` as soon as possible. As a result, their :attr:`~scrapy.Request.priority` is now taken into account as soon as :setting:`CONCURRENT_REQUESTS` is reached. (:issue:`456`, :issue:`3477`, :issue:`4467`, :issue:`5627`, :issue:`6729`) - :class:`Crawler.signals ` has a new :meth:`~scrapy.signalmanager.SignalManager.wait_for` method. (:issue:`6729`) - Added a new :signal:`scheduler_empty` signal. (:issue:`6729`) - Added new settings: :setting:`SCHEDULER_START_DISK_QUEUE` and :setting:`SCHEDULER_START_MEMORY_QUEUE`. (:issue:`6729`) - Added :class:`~scrapy.spidermiddlewares.start.StartSpiderMiddleware`, which sets :reqmeta:`is_start_request` to ``True`` on :ref:`start requests `. (:issue:`6729`) - Exposed a new method of :class:`Crawler.engine `: :meth:`~scrapy.core.engine.ExecutionEngine.needs_backout`. (:issue:`6729`) - Added the :reqmeta:`allow_offsite` request meta key that can be used instead of the more general :attr:`~scrapy.Request.dont_filter` request attribute to skip processing of the request by :class:`~scrapy.downloadermiddlewares.offsite.OffsiteMiddleware` (but not by other code that checks :attr:`~scrapy.Request.dont_filter`). (:issue:`3690`, :issue:`6151`, :issue:`6366`) - Added an optional base class for spider middlewares, :class:`~scrapy.spidermiddlewares.base.BaseSpiderMiddleware`, which can be helpful for writing :ref:`universal spider middlewares ` without boilerplate and code duplication. The built-in spider middlewares now inherit from this class. (:issue:`6693`, :issue:`6777`) - :ref:`Scrapy add-ons ` can now define a class method called ``update_pre_crawler_settings()`` to update :ref:`pre-crawler settings `. (:issue:`6544`, :issue:`6568`) - Added :ref:`helpers ` for modifying :ref:`component priority dictionary ` settings. (:issue:`6614`) - Responses that use an unknown/unsupported encoding now produce a warning. If Scrapy knows that installing an additional package (such as brotli_) will allow decoding the response, that will be mentioned in the warning. (:issue:`4697`, :issue:`6618`) - Added the ``spider_exceptions/count`` stat which tracks the total count of exceptions (tracked also by per-type ``spider_exceptions/*`` stats). (:issue:`6739`, :issue:`6740`) - Added the :setting:`DEFAULT_DROPITEM_LOG_LEVEL` setting and the :attr:`scrapy.exceptions.DropItem.log_level` attribute that allow customizing the log level of the message that is logged when an item is dropped. (:issue:`6603`, :issue:`6608`) - Added support for the ``-b, --cookie`` curl argument to :meth:`scrapy.Request.from_curl`. (:issue:`6684`) - Added the :setting:`LOG_VERSIONS` setting that allows customizing the list of software whose versions are logged when the spider starts. (:issue:`6582`) - Added the :setting:`WARN_ON_GENERATOR_RETURN_VALUE` setting that allows disabling run time analysis of callback code used to warn about incorrect ``return`` statements in generator-based callbacks. You may need to disable this setting if this analysis breaks on your callback code. (:issue:`6731`, :issue:`6738`) Improvements ~~~~~~~~~~~~ - Removed or postponed some calls of :func:`itemadapter.is_item` to increase performance. (:issue:`6719`) - Improved the error message when running a ``scrapy`` command that requires a project (such as ``scrapy crawl``) outside of a project directory. (:issue:`2349`, :issue:`3426`) - Added an empty :setting:`ADDONS` setting to the ``settings.py`` template for new projects. (:issue:`6587`) Bug fixes ~~~~~~~~~ - Yielding an item from :meth:`Spider.start ` or from :meth:`SpiderMiddleware.process_start ` no longer delays the next iteration of starting requests and items by up to 5 seconds. (:issue:`6729`) - Fixed calculation of ``items_per_minute`` and ``responses_per_minute`` stats. (:issue:`6599`) - Fixed an error initializing :class:`scrapy.extensions.feedexport.GCSFeedStorage`. (:issue:`6617`, :issue:`6628`) - Fixed an error running ``scrapy bench``. (:issue:`6632`, :issue:`6633`) - Fixed duplicated log messages about the reactor and the event loop. (:issue:`6636`, :issue:`6657`) - Fixed resolving type annotations of ``SitemapSpider._parse_sitemap()`` at run time, required by tools such as scrapy-poet_. (:issue:`6665`, :issue:`6671`) .. _scrapy-poet: https://github.com/scrapinghub/scrapy-poet - Calling :func:`scrapy.utils.reactor.is_asyncio_reactor_installed` without an installed reactor now raises an exception instead of installing a reactor. (:issue:`6732`, :issue:`6735`) - Restored support for the ``x-gzip`` content encoding. (:issue:`6618`) Documentation ~~~~~~~~~~~~~ - Documented the setting values set in the default project template. (:issue:`6762`, :issue:`6775`) - Improved the :ref:`docs ` about asynchronous iterable support in spider middlewares. (:issue:`6688`) - Improved the :ref:`docs ` about using :class:`~twisted.internet.defer.Deferred`-based APIs in coroutine-based code and included a list of such APIs. (:issue:`6677`, :issue:`6734`, :issue:`6776`) - Improved the :ref:`contribution docs `. (:issue:`6561`, :issue:`6575`) - Removed the ``Splash`` recommendation from the :ref:`headless browser ` suggestion. We no longer recommend using ``Splash`` and recommend using other headless browser solutions instead. (:issue:`6642`, :issue:`6701`) - Added the dark mode to the HTML documentation. (:issue:`6653`) - Other documentation improvements and fixes. (:issue:`4151`, :issue:`6526`, :issue:`6620`, :issue:`6621`, :issue:`6622`, :issue:`6623`, :issue:`6624`, :issue:`6721`, :issue:`6723`, :issue:`6780`) Packaging ~~~~~~~~~ - Switched from ``setup.py`` to ``pyproject.toml``. (:issue:`6514`, :issue:`6547`) - Switched the build backend from setuptools_ to hatchling_. (:issue:`6771`) .. _hatchling: https://pypi.org/project/hatchling/ Quality assurance ~~~~~~~~~~~~~~~~~ - Replaced most linters with ruff_. (:issue:`6565`, :issue:`6576`, :issue:`6577`, :issue:`6581`, :issue:`6584`, :issue:`6595`, :issue:`6601`, :issue:`6631`) .. _ruff: https://docs.astral.sh/ruff/ - Improved accuracy and performance of collecting test coverage. (:issue:`6255`, :issue:`6610`) - Fixed an error that prevented running tests from directories other than the top level source directory. (:issue:`6567`) - Reduced the amount of ``mockserver`` calls in tests to improve the overall test run time. (:issue:`6637`, :issue:`6648`) - Fixed tests that were running the same test code more than once. (:issue:`6646`, :issue:`6647`, :issue:`6650`) - Refactored tests to use more ``pytest`` features instead of ``unittest`` ones where possible. (:issue:`6678`, :issue:`6680`, :issue:`6695`, :issue:`6699`, :issue:`6700`, :issue:`6702`, :issue:`6709`, :issue:`6710`, :issue:`6711`, :issue:`6712`, :issue:`6725`) - Type hints improvements and fixes. (:issue:`6578`, :issue:`6579`, :issue:`6593`, :issue:`6605`, :issue:`6694`) - CI and test improvements and fixes. (:issue:`5360`, :issue:`6271`, :issue:`6547`, :issue:`6560`, :issue:`6602`, :issue:`6607`, :issue:`6609`, :issue:`6613`, :issue:`6619`, :issue:`6626`, :issue:`6679`, :issue:`6703`, :issue:`6704`, :issue:`6716`, :issue:`6720`, :issue:`6722`, :issue:`6724`, :issue:`6741`, :issue:`6743`, :issue:`6766`, :issue:`6770`, :issue:`6772`, :issue:`6773`) - Code cleanups. (:issue:`6600`, :issue:`6606`, :issue:`6635`, :issue:`6764`) .. _release-2.12.0: Scrapy 2.12.0 (2024-11-18) -------------------------- Highlights: - Dropped support for Python 3.8, added support for Python 3.13 - ``scrapy.Spider.start_requests()`` can now yield items - Added :class:`~scrapy.http.JsonResponse` - Added :setting:`CLOSESPIDER_PAGECOUNT_NO_ITEM` Modified requirements ~~~~~~~~~~~~~~~~~~~~~ - Dropped support for Python 3.8. (:issue:`6466`, :issue:`6472`) - Added support for Python 3.13. (:issue:`6166`) - Minimum versions increased for these dependencies: - Twisted_: 18.9.0 → 21.7.0 - cryptography_: 36.0.0 → 37.0.0 - pyOpenSSL_: 21.0.0 → 22.0.0 - lxml_: 4.4.1 → 4.6.0 - Removed ``setuptools`` from the dependency list. (:issue:`6487`) Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - User-defined cookies for HTTPS requests will have the ``secure`` flag set to ``True`` unless it's set to ``False`` explictly. This is important when these cookies are reused in HTTP requests, e.g. after a redirect to an HTTP URL. (:issue:`6357`) - The Reppy-based ``robots.txt`` parser, ``scrapy.robotstxt.ReppyRobotParser``, was removed, as it doesn't support Python 3.9+. (:issue:`5230`, :issue:`6099`, :issue:`6499`) - The initialization API of :class:`scrapy.pipelines.media.MediaPipeline` and its subclasses was improved and it's possible that some previously working usage scenarios will no longer work. It can only affect you if you define custom subclasses of ``MediaPipeline`` or create instances of these pipelines via ``from_settings()`` or ``__init__()`` calls instead of ``from_crawler()`` calls. Previously, ``MediaPipeline.from_crawler()`` called the ``from_settings()`` method if it existed or the ``__init__()`` method otherwise, and then did some additional initialization using the ``crawler`` instance. If the ``from_settings()`` method existed (like in ``FilesPipeline``) it called ``__init__()`` to create the instance. It wasn't possible to override ``from_crawler()`` without calling ``MediaPipeline.from_crawler()`` from it which, in turn, couldn't be called in some cases (including subclasses of ``FilesPipeline``). Now, in line with the general usage of ``from_crawler()`` and ``from_settings()`` and the deprecation of the latter the recommended initialization order is the following one: - All ``__init__()`` methods should take a ``crawler`` argument. If they also take a ``settings`` argument they should ignore it, using ``crawler.settings`` instead. When they call ``__init__()`` of the base class they should pass the ``crawler`` argument to it too. - A ``from_settings()`` method shouldn't be defined. Class-specific initialization code should go into either an overriden ``from_crawler()`` method or into ``__init__()``. - It's now possible to override ``from_crawler()`` and it's not necessary to call ``MediaPipeline.from_crawler()`` in it if other recommendations were followed. - If pipeline instances were created with ``from_settings()`` or ``__init__()`` calls (which wasn't supported even before, as it missed important initialization code), they should now be created with ``from_crawler()`` calls. (:issue:`6540`) - The ``response_body`` argument of :meth:`ImagesPipeline.convert_image ` is now positional-only, as it was changed from optional to required. (:issue:`6500`) - The ``convert`` argument of :func:`scrapy.utils.conf.build_component_list` is now positional-only, as the preceding argument (``custom``) was removed. (:issue:`6500`) - The ``overwrite_output`` argument of :func:`scrapy.utils.conf.feed_process_params_from_cli` is now positional-only, as the preceding argument (``output_format``) was removed. (:issue:`6500`) Deprecation removals ~~~~~~~~~~~~~~~~~~~~ - Removed the ``scrapy.utils.request.request_fingerprint()`` function, deprecated in Scrapy 2.7.0. (:issue:`6212`, :issue:`6213`) - Removed support for value ``"2.6"`` of setting ``REQUEST_FINGERPRINTER_IMPLEMENTATION``, deprecated in Scrapy 2.7.0. (:issue:`6212`, :issue:`6213`) - :class:`~scrapy.dupefilters.RFPDupeFilter` subclasses now require supporting the ``fingerprinter`` parameter in their ``__init__`` method, introduced in Scrapy 2.7.0. (:issue:`6102`, :issue:`6113`) - Removed the ``scrapy.downloadermiddlewares.decompression`` module, deprecated in Scrapy 2.7.0. (:issue:`6100`, :issue:`6113`) - Removed the ``scrapy.utils.response.response_httprepr()`` function, deprecated in Scrapy 2.6.0. (:issue:`6111`, :issue:`6116`) - Spiders with spider-level HTTP authentication, i.e. with the ``http_user`` or ``http_pass`` attributes, must now define ``http_auth_domain`` as well, which was introduced in Scrapy 2.5.1. (:issue:`6103`, :issue:`6113`) - :ref:`Media pipelines ` methods ``file_path()``, ``file_downloaded()``, ``get_images()``, ``image_downloaded()``, ``media_downloaded()``, ``media_to_download()``, and ``thumb_path()`` must now support an ``item`` parameter, added in Scrapy 2.4.0. (:issue:`6107`, :issue:`6113`) - The ``__init__()`` and ``from_crawler()`` methods of :ref:`feed storage backend classes ` must now support the keyword-only ``feed_options`` parameter, introduced in Scrapy 2.4.0. (:issue:`6105`, :issue:`6113`) - Removed the ``scrapy.loader.common`` and ``scrapy.loader.processors`` modules, deprecated in Scrapy 2.3.0. (:issue:`6106`, :issue:`6113`) - Removed the ``scrapy.utils.misc.extract_regex()`` function, deprecated in Scrapy 2.3.0. (:issue:`6106`, :issue:`6113`) - Removed the ``scrapy.http.JSONRequest`` class, replaced with ``JsonRequest`` in Scrapy 1.8.0. (:issue:`6110`, :issue:`6113`) - ``scrapy.utils.log.logformatter_adapter`` no longer supports missing ``args``, ``level``, or ``msg`` parameters, and no longer supports a ``format`` parameter, all scenarios that were deprecated in Scrapy 1.0.0. (:issue:`6109`, :issue:`6116`) - A custom class assigned to the :setting:`SPIDER_LOADER_CLASS` setting that does not implement the :class:`~scrapy.interfaces.ISpiderLoader` interface will now raise a :exc:`zope.interface.verify.DoesNotImplement` exception at run time. Non-compliant classes have been triggering a deprecation warning since Scrapy 1.0.0. (:issue:`6101`, :issue:`6113`) - Removed the ``--output-format``/``-t`` command line option, deprecated in Scrapy 2.1.0. ``-O :`` should be used instead. (:issue:`6500`) - Running :meth:`~scrapy.crawler.Crawler.crawl` more than once on the same :class:`~scrapy.crawler.Crawler` instance, deprecated in Scrapy 2.11.0, now raises an exception. (:issue:`6500`) - Subclassing :class:`~scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware` without support for the ``crawler`` argument in ``__init__()`` and without a custom ``from_crawler()`` method, deprecated in Scrapy 2.5.0, is no longer allowed. (:issue:`6500`) - Removed the ``EXCEPTIONS_TO_RETRY`` attribute of :class:`~scrapy.downloadermiddlewares.retry.RetryMiddleware`, deprecated in Scrapy 2.10.0. (:issue:`6500`) - Removed support for :ref:`S3 feed exports ` without the boto3_ package installed, deprecated in Scrapy 2.10.0. (:issue:`6500`) - Removed the ``scrapy.extensions.feedexport._FeedSlot`` class, deprecated in Scrapy 2.10.0. (:issue:`6500`) - Removed the ``scrapy.pipelines.images.NoimagesDrop`` exception, deprecated in Scrapy 2.8.0. (:issue:`6500`) - The ``response_body`` argument of :meth:`ImagesPipeline.convert_image ` is now required, not passing it was deprecated in Scrapy 2.8.0. (:issue:`6500`) - Removed the ``custom`` argument of :func:`scrapy.utils.conf.build_component_list`, deprecated in Scrapy 2.10.0. (:issue:`6500`) - Removed the ``scrapy.utils.reactor.get_asyncio_event_loop_policy()`` function, deprecated in Scrapy 2.9.0. Use :func:`asyncio.get_event_loop` and related standard library functions instead. (:issue:`6500`) Deprecations ~~~~~~~~~~~~ - The ``from_settings()`` methods of the :ref:`Scrapy components ` that have them are now deprecated. ``from_crawler()`` should now be used instead. Affected components: - :class:`scrapy.dupefilters.RFPDupeFilter` - :class:`scrapy.mail.MailSender` - :class:`scrapy.middleware.MiddlewareManager` - :class:`scrapy.core.downloader.contextfactory.ScrapyClientContextFactory` - :class:`scrapy.pipelines.files.FilesPipeline` - :class:`scrapy.pipelines.images.ImagesPipeline` - :class:`scrapy.spidermiddlewares.urllength.UrlLengthMiddleware` (:issue:`6540`) - It's now deprecated to have a ``from_settings()`` method but no ``from_crawler()`` method in 3rd-party :ref:`Scrapy components `. You can define a simple ``from_crawler()`` method that calls ``cls.from_settings(crawler.settings)`` to fix this if you don't want to refactor the code. Note that if you have a ``from_crawler()`` method Scrapy will not call the ``from_settings()`` method so the latter can be removed. (:issue:`6540`) - The initialization API of :class:`scrapy.pipelines.media.MediaPipeline` and its subclasses was improved and some old usage scenarios are now deprecated (see also the "Backward-incompatible changes" section). Specifically: - It's deprecated to define an ``__init__()`` method that doesn't take a ``crawler`` argument. - It's deprecated to call an ``__init__()`` method without passing a ``crawler`` argument. If it's passed, it's also deprecated to pass a ``settings`` argument, which will be ignored anyway. - Calling ``from_settings()`` is deprecated, use ``from_crawler()`` instead. - Overriding ``from_settings()`` is deprecated, override ``from_crawler()`` instead. (:issue:`6540`) - The ``REQUEST_FINGERPRINTER_IMPLEMENTATION`` setting is now deprecated. (:issue:`6212`, :issue:`6213`) - The ``scrapy.utils.misc.create_instance()`` function is now deprecated, use :func:`scrapy.utils.misc.build_from_crawler` instead. (:issue:`5523`, :issue:`5884`, :issue:`6162`, :issue:`6169`, :issue:`6540`) - ``scrapy.core.downloader.Downloader._get_slot_key()`` is deprecated, use :meth:`scrapy.core.downloader.Downloader.get_slot_key` instead. (:issue:`6340`, :issue:`6352`) - ``scrapy.utils.defer.process_chain_both()`` is now deprecated. (:issue:`6397`) - ``scrapy.twisted_version`` is now deprecated, you should instead use :attr:`twisted.version` directly (but note that it's an ``incremental.Version`` object, not a tuple). (:issue:`6509`, :issue:`6512`) - ``scrapy.utils.python.flatten()`` and ``scrapy.utils.python.iflatten()`` are now deprecated. (:issue:`6517`, :issue:`6519`) - ``scrapy.utils.python.equal_attributes()`` is now deprecated. (:issue:`6517`, :issue:`6519`) - ``scrapy.utils.request.request_authenticate()`` is now deprecated, you should instead just set the ``Authorization`` header directly. (:issue:`6517`, :issue:`6519`) - ``scrapy.utils.serialize.ScrapyJSONDecoder`` is now deprecated, it didn't contain any code since Scrapy 1.0.0. (:issue:`6517`, :issue:`6519`) - ``scrapy.utils.test.assert_samelines()`` is now deprecated. (:issue:`6517`, :issue:`6519`) - ``scrapy.extensions.feedexport.build_storage()`` is now deprecated. You can instead call the builder callable directly. (:issue:`6540`) New features ~~~~~~~~~~~~ - ``scrapy.Spider.start_requests()`` can now yield items. (:issue:`5289`, :issue:`6417`) .. note:: Some spider middlewares may need to be updated for Scrapy 2.12 support before you can use them in combination with the ability to yield items from ``start_requests()``. - Added a new :class:`~scrapy.http.Response` subclass, :class:`~scrapy.http.JsonResponse`, for responses with a `JSON MIME type `_. (:issue:`6069`, :issue:`6171`, :issue:`6174`) - The :class:`~scrapy.extensions.logstats.LogStats` extension now adds ``items_per_minute`` and ``responses_per_minute`` to the :ref:`stats ` when the spider closes. (:issue:`4110`, :issue:`4111`) - Added :setting:`CLOSESPIDER_PAGECOUNT_NO_ITEM` which allows closing the spider if no items were scraped in a set amount of time. (:issue:`6434`) - User-defined cookies can now include the ``secure`` field. (:issue:`6357`) - Added component getters to :class:`~scrapy.crawler.Crawler`: :meth:`~scrapy.crawler.Crawler.get_addon`, :meth:`~scrapy.crawler.Crawler.get_downloader_middleware`, :meth:`~scrapy.crawler.Crawler.get_extension`, :meth:`~scrapy.crawler.Crawler.get_item_pipeline`, :meth:`~scrapy.crawler.Crawler.get_spider_middleware`. (:issue:`6181`) - Slot delay updates by the :ref:`AutoThrottle extension ` based on response latencies can now be disabled for specific requests via the :reqmeta:`autothrottle_dont_adjust_delay` meta key. (:issue:`6246`, :issue:`6527`) - If :setting:`SPIDER_LOADER_WARN_ONLY` is set to ``True``, :class:`~scrapy.spiderloader.SpiderLoader` does not raise :exc:`SyntaxError` but emits a warning instead. (:issue:`6483`, :issue:`6484`) - Added support for multiple-compressed responses (ones with several encodings in the ``Content-Encoding`` header). (:issue:`5143`, :issue:`5964`, :issue:`6063`) - Added support for multiple standard values in :setting:`REFERRER_POLICY`. (:issue:`6381`) - Added support for brotlicffi_ (previously named brotlipy_). brotli_ is still recommended but only brotlicffi_ works on PyPy. (:issue:`6263`, :issue:`6269`) .. _brotlicffi: https://github.com/python-hyper/brotlicffi - Added :class:`~scrapy.contracts.default.MetadataContract` that sets the request meta. (:issue:`6468`, :issue:`6469`) Improvements ~~~~~~~~~~~~ - Extended the list of file extensions that :class:`LinkExtractor ` ignores by default. (:issue:`6074`, :issue:`6125`) - :func:`scrapy.utils.httpobj.urlparse_cached` is now used in more places instead of :func:`urllib.parse.urlparse`. (:issue:`6228`, :issue:`6229`) Bug fixes ~~~~~~~~~ - :class:`~scrapy.pipelines.media.MediaPipeline` is now an abstract class and its methods that were expected to be overridden in subclasses are now abstract methods. (:issue:`6365`, :issue:`6368`) - Fixed handling of invalid ``@``-prefixed lines in contract extraction. (:issue:`6383`, :issue:`6388`) - Importing ``scrapy.extensions.telnet`` no longer installs the default reactor. (:issue:`6432`) - Reduced log verbosity for dropped requests that was increased in 2.11.2. (:issue:`6433`, :issue:`6475`) Documentation ~~~~~~~~~~~~~ - Added ``SECURITY.md`` that documents the security policy. (:issue:`5364`, :issue:`6051`) - Example code for :ref:`running Scrapy from a script ` no longer imports ``twisted.internet.reactor`` at the top level, which caused problems with non-default reactors when this code was used unmodified. (:issue:`6361`, :issue:`6374`) - Documented the :class:`~scrapy.extensions.spiderstate.SpiderState` extension. (:issue:`6278`, :issue:`6522`) - Other documentation improvements and fixes. (:issue:`5920`, :issue:`6094`, :issue:`6177`, :issue:`6200`, :issue:`6207`, :issue:`6216`, :issue:`6223`, :issue:`6317`, :issue:`6328`, :issue:`6389`, :issue:`6394`, :issue:`6402`, :issue:`6411`, :issue:`6427`, :issue:`6429`, :issue:`6440`, :issue:`6448`, :issue:`6449`, :issue:`6462`, :issue:`6497`, :issue:`6506`, :issue:`6507`, :issue:`6524`) Quality assurance ~~~~~~~~~~~~~~~~~ - Added ``py.typed``, in line with `PEP 561 `_. (:issue:`6058`, :issue:`6059`) - Fully covered the code with type hints (except for the most complicated parts, mostly related to ``twisted.web.http`` and other Twisted parts without type hints). (:issue:`5989`, :issue:`6097`, :issue:`6127`, :issue:`6129`, :issue:`6130`, :issue:`6133`, :issue:`6143`, :issue:`6191`, :issue:`6268`, :issue:`6274`, :issue:`6275`, :issue:`6276`, :issue:`6279`, :issue:`6325`, :issue:`6326`, :issue:`6333`, :issue:`6335`, :issue:`6336`, :issue:`6337`, :issue:`6341`, :issue:`6353`, :issue:`6356`, :issue:`6370`, :issue:`6371`, :issue:`6384`, :issue:`6385`, :issue:`6387`, :issue:`6391`, :issue:`6395`, :issue:`6414`, :issue:`6422`, :issue:`6460`, :issue:`6466`, :issue:`6472`, :issue:`6494`, :issue:`6498`, :issue:`6516`) - Improved Bandit_ checks. (:issue:`6260`, :issue:`6264`, :issue:`6265`) - Added pyupgrade_ to the ``pre-commit`` configuration. (:issue:`6392`) .. _pyupgrade: https://github.com/asottile/pyupgrade - Added ``flake8-bugbear``, ``flake8-comprehensions``, ``flake8-debugger``, ``flake8-docstrings``, ``flake8-string-format`` and ``flake8-type-checking`` to the ``pre-commit`` configuration. (:issue:`6406`, :issue:`6413`) - CI and test improvements and fixes. (:issue:`5285`, :issue:`5454`, :issue:`5997`, :issue:`6078`, :issue:`6084`, :issue:`6087`, :issue:`6132`, :issue:`6153`, :issue:`6154`, :issue:`6201`, :issue:`6231`, :issue:`6232`, :issue:`6235`, :issue:`6236`, :issue:`6242`, :issue:`6245`, :issue:`6253`, :issue:`6258`, :issue:`6259`, :issue:`6270`, :issue:`6272`, :issue:`6286`, :issue:`6290`, :issue:`6296` :issue:`6367`, :issue:`6372`, :issue:`6403`, :issue:`6416`, :issue:`6435`, :issue:`6489`, :issue:`6501`, :issue:`6504`, :issue:`6511`, :issue:`6543`, :issue:`6545`) - Code cleanups. (:issue:`6196`, :issue:`6197`, :issue:`6198`, :issue:`6199`, :issue:`6254`, :issue:`6257`, :issue:`6285`, :issue:`6305`, :issue:`6343`, :issue:`6349`, :issue:`6386`, :issue:`6415`, :issue:`6463`, :issue:`6470`, :issue:`6499`, :issue:`6505`, :issue:`6510`, :issue:`6531`, :issue:`6542`) Other ~~~~~ - Issue tracker improvements. (:issue:`6066`) .. _release-2.11.2: Scrapy 2.11.2 (2024-05-14) -------------------------- Security bug fixes ~~~~~~~~~~~~~~~~~~ - Redirects to non-HTTP protocols are no longer followed. Please, see the `23j4-mw76-5v7h security advisory`_ for more information. (:issue:`457`) .. _23j4-mw76-5v7h security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-23j4-mw76-5v7h - The ``Authorization`` header is now dropped on redirects to a different scheme (``http://`` or ``https://``) or port, even if the domain is the same. Please, see the `4qqq-9vqf-3h3f security advisory`_ for more information. .. _4qqq-9vqf-3h3f security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-4qqq-9vqf-3h3f - When using system proxy settings that are different for ``http://`` and ``https://``, redirects to a different URL scheme will now also trigger the corresponding change in proxy settings for the redirected request. Please, see the `jm3v-qxmh-hxwv security advisory`_ for more information. (:issue:`767`) .. _jm3v-qxmh-hxwv security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-jm3v-qxmh-hxwv - :attr:`Spider.allowed_domains ` is now enforced for all requests, and not only requests from spider callbacks. (:issue:`1042`, :issue:`2241`, :issue:`6358`) - :func:`~scrapy.utils.iterators.xmliter_lxml` no longer resolves XML entities. (:issue:`6265`) - defusedxml_ is now used to make :class:`scrapy.http.request.rpc.XmlRpcRequest` more secure. (:issue:`6250`, :issue:`6251`) .. _defusedxml: https://github.com/tiran/defusedxml Deprecations ~~~~~~~~~~~~ - ``scrapy.spidermiddlewares.offsite.OffsiteMiddleware`` (a spider middleware) is now deprecated and not enabled by default. The new downloader middleware with the same functionality, :class:`scrapy.downloadermiddlewares.offsite.OffsiteMiddleware`, is enabled instead. (:issue:`2241`, :issue:`6358`) Bug fixes ~~~~~~~~~ - Restored support for brotlipy_, which had been dropped in Scrapy 2.11.1 in favor of brotli_. (:issue:`6261`) .. note:: brotlipy is deprecated, both in Scrapy and upstream. Use brotli instead if you can. - Make :setting:`METAREFRESH_IGNORE_TAGS` ``["noscript"]`` by default. This prevents :class:`~scrapy.downloadermiddlewares.redirect.MetaRefreshMiddleware` from following redirects that would not be followed by web browsers with JavaScript enabled. (:issue:`6342`, :issue:`6347`) - During :ref:`feed export `, do not close the underlying file from :ref:`built-in post-processing plugins `. (:issue:`5932`, :issue:`6178`, :issue:`6239`) - :class:`LinkExtractor ` now properly applies the ``unique`` and ``canonicalize`` parameters. (:issue:`3273`, :issue:`6221`) - Do not initialize the scheduler disk queue if :setting:`JOBDIR` is an empty string. (:issue:`6121`, :issue:`6124`) - Fix :attr:`Spider.logger ` not logging custom extra information. (:issue:`6323`, :issue:`6324`) - ``robots.txt`` files with a non-UTF-8 encoding no longer prevent parsing the UTF-8-compatible (e.g. ASCII) parts of the document. (:issue:`6292`, :issue:`6298`) - :meth:`scrapy.http.cookies.WrappedRequest.get_header` no longer raises an exception if ``default`` is ``None``. (:issue:`6308`, :issue:`6310`) - :class:`~scrapy.Selector` now uses :func:`scrapy.utils.response.get_base_url` to determine the base URL of a given :class:`~scrapy.http.Response`. (:issue:`6265`) - The :meth:`media_to_download` method of :ref:`media pipelines ` now logs exceptions before stripping them. (:issue:`5067`, :issue:`5068`) - When passing a callback to the :command:`parse` command, build the callback callable with the right signature. (:issue:`6182`) Documentation ~~~~~~~~~~~~~ - Add a FAQ entry about :ref:`creating blank requests `. (:issue:`6203`, :issue:`6208`) - Document that :attr:`scrapy.Selector.type` can be ``"json"``. (:issue:`6328`, :issue:`6334`) Quality assurance ~~~~~~~~~~~~~~~~~ - Make builds reproducible. (:issue:`5019`, :issue:`6322`) - Packaging and test fixes. (:issue:`6286`, :issue:`6290`, :issue:`6312`, :issue:`6316`, :issue:`6344`) .. _release-2.11.1: Scrapy 2.11.1 (2024-02-14) -------------------------- Highlights: - Security bug fixes. - Support for Twisted >= 23.8.0. - Documentation improvements. Security bug fixes ~~~~~~~~~~~~~~~~~~ - Addressed `ReDoS vulnerabilities`_: - ``scrapy.utils.iterators.xmliter`` is now deprecated in favor of :func:`~scrapy.utils.iterators.xmliter_lxml`, which :class:`~scrapy.spiders.XMLFeedSpider` now uses. To minimize the impact of this change on existing code, :func:`~scrapy.utils.iterators.xmliter_lxml` now supports indicating the node namespace with a prefix in the node name, and big files with highly nested trees when using libxml2 2.7+. - Fixed regular expressions in the implementation of the :func:`~scrapy.utils.response.open_in_browser` function. Please, see the `cc65-xxvf-f7r9 security advisory`_ for more information. .. _ReDoS vulnerabilities: https://owasp.org/www-community/attacks/Regular_expression_Denial_of_Service_-_ReDoS .. _cc65-xxvf-f7r9 security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-cc65-xxvf-f7r9 - :setting:`DOWNLOAD_MAXSIZE` and :setting:`DOWNLOAD_WARNSIZE` now also apply to the decompressed response body. Please, see the `7j7m-v7m3-jqm7 security advisory`_ for more information. .. _7j7m-v7m3-jqm7 security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-7j7m-v7m3-jqm7 - Also in relation with the `7j7m-v7m3-jqm7 security advisory`_, the deprecated ``scrapy.downloadermiddlewares.decompression`` module has been removed. - The ``Authorization`` header is now dropped on redirects to a different domain. Please, see the `cw9j-q3vf-hrrv security advisory`_ for more information. .. _cw9j-q3vf-hrrv security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-cw9j-q3vf-hrrv Modified requirements ~~~~~~~~~~~~~~~~~~~~~ - The Twisted dependency is no longer restricted to < 23.8.0. (:issue:`6024`, :issue:`6064`, :issue:`6142`) Bug fixes ~~~~~~~~~ - The OS signal handling code was refactored to no longer use private Twisted functions. (:issue:`6024`, :issue:`6064`, :issue:`6112`) Documentation ~~~~~~~~~~~~~ - Improved documentation for :class:`~scrapy.crawler.Crawler` initialization changes made in the 2.11.0 release. (:issue:`6057`, :issue:`6147`) - Extended documentation for :attr:`.Request.meta`. (:issue:`5565`) - Fixed the :reqmeta:`dont_merge_cookies` documentation. (:issue:`5936`, :issue:`6077`) - Added a link to Zyte's export guides to the :ref:`feed exports ` documentation. (:issue:`6183`) - Added a missing note about backward-incompatible changes in :class:`~scrapy.exporters.PythonItemExporter` to the 2.11.0 release notes. (:issue:`6060`, :issue:`6081`) - Added a missing note about removing the deprecated ``scrapy.utils.boto.is_botocore()`` function to the 2.8.0 release notes. (:issue:`6056`, :issue:`6061`) - Other documentation improvements. (:issue:`6128`, :issue:`6144`, :issue:`6163`, :issue:`6190`, :issue:`6192`) Quality assurance ~~~~~~~~~~~~~~~~~ - Added Python 3.12 to the CI configuration, re-enabled tests that were disabled when the pre-release support was added. (:issue:`5985`, :issue:`6083`, :issue:`6098`) - Fixed a test issue on PyPy 7.3.14. (:issue:`6204`, :issue:`6205`) .. _release-2.11.0: Scrapy 2.11.0 (2023-09-18) -------------------------- Highlights: - Spiders can now modify :ref:`settings ` in their :meth:`~scrapy.Spider.from_crawler` methods, e.g. based on :ref:`spider arguments `. - Periodic logging of stats. Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Most of the initialization of :class:`scrapy.crawler.Crawler` instances is now done in :meth:`~scrapy.crawler.Crawler.crawl`, so the state of instances before that method is called is now different compared to older Scrapy versions. We do not recommend using the :class:`~scrapy.crawler.Crawler` instances before :meth:`~scrapy.crawler.Crawler.crawl` is called. (:issue:`6038`) - :meth:`scrapy.Spider.from_crawler` is now called before the initialization of various components previously initialized in :meth:`scrapy.crawler.Crawler.__init__` and before the settings are finalized and frozen. This change was needed to allow changing the settings in :meth:`scrapy.Spider.from_crawler`. If you want to access the final setting values and the initialized :class:`~scrapy.crawler.Crawler` attributes in the spider code as early as possible you can do this in ``scrapy.Spider.start_requests()`` or in a handler of the :signal:`engine_started` signal. (:issue:`6038`) - The :meth:`TextResponse.json ` method now requires the response to be in a valid JSON encoding (UTF-8, UTF-16, or UTF-32). If you need to deal with JSON documents in an invalid encoding, use ``json.loads(response.text)`` instead. (:issue:`6016`) - :class:`~scrapy.exporters.PythonItemExporter` used the binary output by default but it no longer does. (:issue:`6006`, :issue:`6007`) Deprecation removals ~~~~~~~~~~~~~~~~~~~~ - Removed the binary export mode of :class:`~scrapy.exporters.PythonItemExporter`, deprecated in Scrapy 1.1.0. (:issue:`6006`, :issue:`6007`) .. note:: If you are using this Scrapy version on Scrapy Cloud with a stack that includes an older Scrapy version and get a "TypeError: Unexpected options: binary" error, you may need to add ``scrapinghub-entrypoint-scrapy >= 0.14.1`` to your project requirements or switch to a stack that includes Scrapy 2.11. - Removed the ``CrawlerRunner.spiders`` attribute, deprecated in Scrapy 1.0.0, use :attr:`CrawlerRunner.spider_loader ` instead. (:issue:`6010`) - The :func:`scrapy.utils.response.response_httprepr` function, deprecated in Scrapy 2.6.0, has now been removed. (:issue:`6111`) Deprecations ~~~~~~~~~~~~ - Running :meth:`~scrapy.crawler.Crawler.crawl` more than once on the same :class:`scrapy.crawler.Crawler` instance is now deprecated. (:issue:`1587`, :issue:`6040`) New features ~~~~~~~~~~~~ - Spiders can now modify settings in their :meth:`~scrapy.Spider.from_crawler` method, e.g. based on :ref:`spider arguments `. (:issue:`1305`, :issue:`1580`, :issue:`2392`, :issue:`3663`, :issue:`6038`) - Added the :class:`~scrapy.extensions.periodic_log.PeriodicLog` extension which can be enabled to log stats and/or their differences periodically. (:issue:`5926`) - Optimized the memory usage in :meth:`TextResponse.json ` by removing unnecessary body decoding. (:issue:`5968`, :issue:`6016`) - Links to ``.webp`` files are now ignored by :ref:`link extractors `. (:issue:`6021`) Bug fixes ~~~~~~~~~ - Fixed logging enabled add-ons. (:issue:`6036`) - Fixed :class:`~scrapy.mail.MailSender` producing invalid message bodies when the ``charset`` argument is passed to :meth:`~scrapy.mail.MailSender.send`. (:issue:`5096`, :issue:`5118`) - Fixed an exception when accessing ``self.EXCEPTIONS_TO_RETRY`` from a subclass of :class:`~scrapy.downloadermiddlewares.retry.RetryMiddleware`. (:issue:`6049`, :issue:`6050`) - :meth:`scrapy.settings.BaseSettings.getdictorlist`, used to parse :setting:`FEED_EXPORT_FIELDS`, now handles tuple values. (:issue:`6011`, :issue:`6013`) - Calls to ``datetime.utcnow()``, no longer recommended to be used, have been replaced with calls to ``datetime.now()`` with a timezone. (:issue:`6014`) Documentation ~~~~~~~~~~~~~ - Updated a deprecated function call in a pipeline example. (:issue:`6008`, :issue:`6009`) Quality assurance ~~~~~~~~~~~~~~~~~ - Extended typing hints. (:issue:`6003`, :issue:`6005`, :issue:`6031`, :issue:`6034`) - Pinned brotli_ to 1.0.9 for the PyPy tests as 1.1.0 breaks them. (:issue:`6044`, :issue:`6045`) - Other CI and pre-commit improvements. (:issue:`6002`, :issue:`6013`, :issue:`6046`) .. _release-2.10.1: Scrapy 2.10.1 (2023-08-30) -------------------------- Marked ``Twisted >= 23.8.0`` as unsupported. (:issue:`6024`, :issue:`6026`) .. _release-2.10.0: Scrapy 2.10.0 (2023-08-04) -------------------------- Highlights: - Added Python 3.12 support, dropped Python 3.7 support. - The new add-ons framework simplifies configuring 3rd-party components that support it. - Exceptions to retry can now be configured. - Many fixes and improvements for feed exports. Modified requirements ~~~~~~~~~~~~~~~~~~~~~ - Dropped support for Python 3.7. (:issue:`5953`) - Added support for the upcoming Python 3.12. (:issue:`5984`) - Minimum versions increased for these dependencies: - lxml_: 4.3.0 → 4.4.1 - cryptography_: 3.4.6 → 36.0.0 - ``pkg_resources`` is no longer used. (:issue:`5956`, :issue:`5958`) - boto3_ is now recommended instead of botocore_ for exporting to S3. (:issue:`5833`). Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The value of the :setting:`FEED_STORE_EMPTY` setting is now ``True`` instead of ``False``. In earlier Scrapy versions empty files were created even when this setting was ``False`` (which was a bug that is now fixed), so the new default should keep the old behavior. (:issue:`872`, :issue:`5847`) Deprecation removals ~~~~~~~~~~~~~~~~~~~~ - When a function is assigned to the :setting:`FEED_URI_PARAMS` setting, returning ``None`` or modifying the ``params`` input parameter, deprecated in Scrapy 2.6, is no longer supported. (:issue:`5994`, :issue:`5996`) - The ``scrapy.utils.reqser`` module, deprecated in Scrapy 2.6, is removed. (:issue:`5994`, :issue:`5996`) - The ``scrapy.squeues`` classes ``PickleFifoDiskQueueNonRequest``, ``PickleLifoDiskQueueNonRequest``, ``MarshalFifoDiskQueueNonRequest``, and ``MarshalLifoDiskQueueNonRequest``, deprecated in Scrapy 2.6, are removed. (:issue:`5994`, :issue:`5996`) - The property ``open_spiders`` and the methods ``has_capacity`` and ``schedule`` of :class:`scrapy.core.engine.ExecutionEngine`, deprecated in Scrapy 2.6, are removed. (:issue:`5994`, :issue:`5998`) - Passing a ``spider`` argument to the :meth:`~scrapy.core.engine.ExecutionEngine.spider_is_idle`, :meth:`~scrapy.core.engine.ExecutionEngine.crawl` and :meth:`~scrapy.core.engine.ExecutionEngine.download` methods of :class:`scrapy.core.engine.ExecutionEngine`, deprecated in Scrapy 2.6, is no longer supported. (:issue:`5994`, :issue:`5998`) Deprecations ~~~~~~~~~~~~ - :class:`scrapy.utils.datatypes.CaselessDict` is deprecated, use :class:`scrapy.utils.datatypes.CaseInsensitiveDict` instead. (:issue:`5146`) - Passing the ``custom`` argument to :func:`scrapy.utils.conf.build_component_list` is deprecated, it was used in the past to merge ``FOO`` and ``FOO_BASE`` setting values but now Scrapy uses :func:`scrapy.settings.BaseSettings.getwithbase` to do the same. Code that uses this argument and cannot be switched to ``getwithbase()`` can be switched to merging the values explicitly. (:issue:`5726`, :issue:`5923`) New features ~~~~~~~~~~~~ - Added support for :ref:`Scrapy add-ons `. (:issue:`5950`) - Added the :setting:`RETRY_EXCEPTIONS` setting that configures which exceptions will be retried by :class:`~scrapy.downloadermiddlewares.retry.RetryMiddleware`. (:issue:`2701`, :issue:`5929`) - Added the possiiblity to close the spider if no items were produced in the specified time, configured by :setting:`CLOSESPIDER_TIMEOUT_NO_ITEM`. (:issue:`5979`) - Added support for the :setting:`AWS_REGION_NAME` setting to feed exports. (:issue:`5980`) - Added support for using :class:`pathlib.Path` objects that refer to absolute Windows paths in the :setting:`FEEDS` setting. (:issue:`5939`) Bug fixes ~~~~~~~~~ - Fixed creating empty feeds even with ``FEED_STORE_EMPTY=False``. (:issue:`872`, :issue:`5847`) - Fixed using absolute Windows paths when specifying output files. (:issue:`5969`, :issue:`5971`) - Fixed problems with uploading large files to S3 by switching to multipart uploads (requires boto3_). (:issue:`960`, :issue:`5735`, :issue:`5833`) - Fixed the JSON exporter writing extra commas when some exceptions occur. (:issue:`3090`, :issue:`5952`) - Fixed the "read of closed file" error in the CSV exporter. (:issue:`5043`, :issue:`5705`) - Fixed an error when a component added by the class object throws :exc:`~scrapy.exceptions.NotConfigured` with a message. (:issue:`5950`, :issue:`5992`) - Added the missing :meth:`scrapy.settings.BaseSettings.pop` method. (:issue:`5959`, :issue:`5960`, :issue:`5963`) - Added :class:`~scrapy.utils.datatypes.CaseInsensitiveDict` as a replacement for :class:`~scrapy.utils.datatypes.CaselessDict` that fixes some API inconsistencies. (:issue:`5146`) Documentation ~~~~~~~~~~~~~ - Documented :meth:`scrapy.Spider.update_settings`. (:issue:`5745`, :issue:`5846`) - Documented possible problems with early Twisted reactor installation and their solutions. (:issue:`5981`, :issue:`6000`) - Added examples of making additional requests in callbacks. (:issue:`5927`) - Improved the feed export docs. (:issue:`5579`, :issue:`5931`) - Clarified the docs about request objects on redirection. (:issue:`5707`, :issue:`5937`) Quality assurance ~~~~~~~~~~~~~~~~~ - Added support for running tests against the installed Scrapy version. (:issue:`4914`, :issue:`5949`) - Extended typing hints. (:issue:`5925`, :issue:`5977`) - Fixed the ``test_utils_asyncio.AsyncioTest.test_set_asyncio_event_loop`` test. (:issue:`5951`) - Fixed the ``test_feedexport.BatchDeliveriesTest.test_batch_path_differ`` test on Windows. (:issue:`5847`) - Enabled CI runs for Python 3.11 on Windows. (:issue:`5999`) - Simplified skipping tests that depend on ``uvloop``. (:issue:`5984`) - Fixed the ``extra-deps-pinned`` tox env. (:issue:`5948`) - Implemented cleanups. (:issue:`5965`, :issue:`5986`) .. _release-2.9.0: Scrapy 2.9.0 (2023-05-08) ------------------------- Highlights: - Per-domain download settings. - Compatibility with new cryptography_ and new parsel_. - JMESPath selectors from the new parsel_. - Bug fixes. Deprecations ~~~~~~~~~~~~ - :class:`scrapy.extensions.feedexport._FeedSlot` is renamed to :class:`scrapy.extensions.feedexport.FeedSlot` and the old name is deprecated. (:issue:`5876`) New features ~~~~~~~~~~~~ - Settings corresponding to :setting:`DOWNLOAD_DELAY`, :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` and :setting:`RANDOMIZE_DOWNLOAD_DELAY` can now be set on a per-domain basis via the new :setting:`DOWNLOAD_SLOTS` setting. (:issue:`5328`) - Added :meth:`.TextResponse.jmespath`, a shortcut for JMESPath selectors available since parsel_ 1.8.1. (:issue:`5894`, :issue:`5915`) - Added :signal:`feed_slot_closed` and :signal:`feed_exporter_closed` signals. (:issue:`5876`) - Added :func:`scrapy.utils.request.request_to_curl`, a function to produce a curl command from a :class:`~scrapy.Request` object. (:issue:`5892`) - Values of :setting:`FILES_STORE` and :setting:`IMAGES_STORE` can now be :class:`pathlib.Path` instances. (:issue:`5801`) Bug fixes ~~~~~~~~~ - Fixed a warning with Parsel 1.8.1+. (:issue:`5903`, :issue:`5918`) - Fixed an error when using feed postprocessing with S3 storage. (:issue:`5500`, :issue:`5581`) - Added the missing :meth:`scrapy.settings.BaseSettings.setdefault` method. (:issue:`5811`, :issue:`5821`) - Fixed an error when using cryptography_ 40.0.0+ and :setting:`DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING` is enabled. (:issue:`5857`, :issue:`5858`) - The checksums returned by :class:`~scrapy.pipelines.files.FilesPipeline` for files on Google Cloud Storage are no longer Base64-encoded. (:issue:`5874`, :issue:`5891`) - :func:`scrapy.utils.request.request_from_curl` now supports $-prefixed string values for the curl ``--data-raw`` argument, which are produced by browsers for data that includes certain symbols. (:issue:`5899`, :issue:`5901`) - The :command:`parse` command now also works with async generator callbacks. (:issue:`5819`, :issue:`5824`) - The :command:`genspider` command now properly works with HTTPS URLs. (:issue:`3553`, :issue:`5808`) - Improved handling of asyncio loops. (:issue:`5831`, :issue:`5832`) - :class:`LinkExtractor ` now skips certain malformed URLs instead of raising an exception. (:issue:`5881`) - :func:`scrapy.utils.python.get_func_args` now supports more types of callables. (:issue:`5872`, :issue:`5885`) - Fixed an error when processing non-UTF8 values of ``Content-Type`` headers. (:issue:`5914`, :issue:`5917`) - Fixed an error breaking user handling of send failures in :meth:`scrapy.mail.MailSender.send()`. (:issue:`1611`, :issue:`5880`) Documentation ~~~~~~~~~~~~~ - Expanded contributing docs. (:issue:`5109`, :issue:`5851`) - Added blacken-docs_ to pre-commit and reformatted the docs with it. (:issue:`5813`, :issue:`5816`) - Fixed a JS issue. (:issue:`5875`, :issue:`5877`) - Fixed ``make htmlview``. (:issue:`5878`, :issue:`5879`) - Fixed typos and other small errors. (:issue:`5827`, :issue:`5839`, :issue:`5883`, :issue:`5890`, :issue:`5895`, :issue:`5904`) Quality assurance ~~~~~~~~~~~~~~~~~ - Extended typing hints. (:issue:`5805`, :issue:`5889`, :issue:`5896`) - Tests for most of the examples in the docs are now run as a part of CI, found problems were fixed. (:issue:`5816`, :issue:`5826`, :issue:`5919`) - Removed usage of deprecated Python classes. (:issue:`5849`) - Silenced ``include-ignored`` warnings from coverage. (:issue:`5820`) - Fixed a random failure of the ``test_feedexport.test_batch_path_differ`` test. (:issue:`5855`, :issue:`5898`) - Updated docstrings to match output produced by parsel_ 1.8.1 so that they don't cause test failures. (:issue:`5902`, :issue:`5919`) - Other CI and pre-commit improvements. (:issue:`5802`, :issue:`5823`, :issue:`5908`) .. _blacken-docs: https://github.com/adamchainz/blacken-docs .. _release-2.8.0: Scrapy 2.8.0 (2023-02-02) ------------------------- This is a maintenance release, with minor features, bug fixes, and cleanups. Deprecation removals ~~~~~~~~~~~~~~~~~~~~ - The ``scrapy.utils.gz.read1`` function, deprecated in Scrapy 2.0, has now been removed. Use the :meth:`~io.BufferedIOBase.read1` method of :class:`~gzip.GzipFile` instead. (:issue:`5719`) - The ``scrapy.utils.python.to_native_str`` function, deprecated in Scrapy 2.0, has now been removed. Use :func:`scrapy.utils.python.to_unicode` instead. (:issue:`5719`) - The ``scrapy.utils.python.MutableChain.next`` method, deprecated in Scrapy 2.0, has now been removed. Use :meth:`~scrapy.utils.python.MutableChain.__next__` instead. (:issue:`5719`) - The ``scrapy.linkextractors.FilteringLinkExtractor`` class, deprecated in Scrapy 2.0, has now been removed. Use :class:`LinkExtractor ` instead. (:issue:`5720`) - Support for using environment variables prefixed with ``SCRAPY_`` to override settings, deprecated in Scrapy 2.0, has now been removed. (:issue:`5724`) - Support for the ``noconnect`` query string argument in proxy URLs, deprecated in Scrapy 2.0, has now been removed. We expect proxies that used to need it to work fine without it. (:issue:`5731`) - The ``scrapy.utils.python.retry_on_eintr`` function, deprecated in Scrapy 2.3, has now been removed. (:issue:`5719`) - The ``scrapy.utils.python.WeakKeyCache`` class, deprecated in Scrapy 2.4, has now been removed. (:issue:`5719`) - The ``scrapy.utils.boto.is_botocore()`` function, deprecated in Scrapy 2.4, has now been removed. (:issue:`5719`) Deprecations ~~~~~~~~~~~~ - :exc:`scrapy.pipelines.images.NoimagesDrop` is now deprecated. (:issue:`5368`, :issue:`5489`) - :meth:`ImagesPipeline.convert_image ` must now accept a ``response_body`` parameter. (:issue:`3055`, :issue:`3689`, :issue:`4753`) New features ~~~~~~~~~~~~ - Applied black_ coding style to files generated with the :command:`genspider` and :command:`startproject` commands. (:issue:`5809`, :issue:`5814`) .. _black: https://black.readthedocs.io/en/stable/ - :setting:`FEED_EXPORT_ENCODING` is now set to ``"utf-8"`` in the ``settings.py`` file that the :command:`startproject` command generates. With this value, JSON exports won’t force the use of escape sequences for non-ASCII characters. (:issue:`5797`, :issue:`5800`) - The :class:`~scrapy.extensions.memusage.MemoryUsage` extension now logs the peak memory usage during checks, and the binary unit MiB is now used to avoid confusion. (:issue:`5717`, :issue:`5722`, :issue:`5727`) - The ``callback`` parameter of :class:`~scrapy.Request` can now be set to :func:`scrapy.http.request.NO_CALLBACK`, to distinguish it from ``None``, as the latter indicates that the default spider callback (:meth:`~scrapy.Spider.parse`) is to be used. (:issue:`5798`) Bug fixes ~~~~~~~~~ - Enabled unsafe legacy SSL renegotiation to fix access to some outdated websites. (:issue:`5491`, :issue:`5790`) - Fixed STARTTLS-based email delivery not working with Twisted 21.2.0 and better. (:issue:`5386`, :issue:`5406`) - Fixed the :meth:`finish_exporting` method of :ref:`item exporters ` not being called for empty files. (:issue:`5537`, :issue:`5758`) - Fixed HTTP/2 responses getting only the last value for a header when multiple headers with the same name are received. (:issue:`5777`) - Fixed an exception raised by the :command:`shell` command on some cases when :ref:`using asyncio `. (:issue:`5740`, :issue:`5742`, :issue:`5748`, :issue:`5759`, :issue:`5760`, :issue:`5771`) - When using :class:`~scrapy.spiders.CrawlSpider`, callback keyword arguments (``cb_kwargs``) added to a request in the ``process_request`` callback of a :class:`~scrapy.spiders.Rule` will no longer be ignored. (:issue:`5699`) - The :ref:`images pipeline ` no longer re-encodes JPEG files. (:issue:`3055`, :issue:`3689`, :issue:`4753`) - Fixed the handling of transparent WebP images by the :ref:`images pipeline `. (:issue:`3072`, :issue:`5766`, :issue:`5767`) - :func:`scrapy.shell.inspect_response` no longer inhibits ``SIGINT`` (Ctrl+C). (:issue:`2918`) - :class:`LinkExtractor ` with ``unique=False`` no longer filters out links that have identical URL *and* text. (:issue:`3798`, :issue:`3799`, :issue:`4695`, :issue:`5458`) - :class:`~scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware` now ignores URL protocols that do not support ``robots.txt`` (``data://``, ``file://``). (:issue:`5807`) - Silenced the ``filelock`` debug log messages introduced in Scrapy 2.6. (:issue:`5753`, :issue:`5754`) - Fixed the output of ``scrapy -h`` showing an unintended ``**commands**`` line. (:issue:`5709`, :issue:`5711`, :issue:`5712`) - Made the active project indication in the output of :ref:`commands ` more clear. (:issue:`5715`) Documentation ~~~~~~~~~~~~~ - Documented how to :ref:`debug spiders from Visual Studio Code `. (:issue:`5721`) - Documented how :setting:`DOWNLOAD_DELAY` affects per-domain concurrency. (:issue:`5083`, :issue:`5540`) - Improved consistency. (:issue:`5761`) - Fixed typos. (:issue:`5714`, :issue:`5744`, :issue:`5764`) Quality assurance ~~~~~~~~~~~~~~~~~ - Applied :ref:`black coding style `, sorted import statements, and introduced :ref:`pre-commit `. (:issue:`4654`, :issue:`4658`, :issue:`5734`, :issue:`5737`, :issue:`5806`, :issue:`5810`) - Switched from :mod:`os.path` to :mod:`pathlib`. (:issue:`4916`, :issue:`4497`, :issue:`5682`) - Addressed many issues reported by Pylint. (:issue:`5677`) - Improved code readability. (:issue:`5736`) - Improved package metadata. (:issue:`5768`) - Removed direct invocations of ``setup.py``. (:issue:`5774`, :issue:`5776`) - Removed unnecessary :class:`~collections.OrderedDict` usages. (:issue:`5795`) - Removed unnecessary ``__str__`` definitions. (:issue:`5150`) - Removed obsolete code and comments. (:issue:`5725`, :issue:`5729`, :issue:`5730`, :issue:`5732`) - Fixed test and CI issues. (:issue:`5749`, :issue:`5750`, :issue:`5756`, :issue:`5762`, :issue:`5765`, :issue:`5780`, :issue:`5781`, :issue:`5782`, :issue:`5783`, :issue:`5785`, :issue:`5786`) .. _release-2.7.1: Scrapy 2.7.1 (2022-11-02) ------------------------- New features ~~~~~~~~~~~~ - Relaxed the restriction introduced in 2.6.2 so that the ``Proxy-Authorization`` header can again be set explicitly, as long as the proxy URL in the :reqmeta:`proxy` metadata has no other credentials, and for as long as that proxy URL remains the same; this restores compatibility with scrapy-zyte-smartproxy 2.1.0 and older (:issue:`5626`). Bug fixes ~~~~~~~~~ - Using ``-O``/``--overwrite-output`` and ``-t``/``--output-format`` options together now produces an error instead of ignoring the former option (:issue:`5516`, :issue:`5605`). - Replaced deprecated :mod:`asyncio` APIs that implicitly use the current event loop with code that explicitly requests a loop from the event loop policy (:issue:`5685`, :issue:`5689`). - Fixed uses of deprecated Scrapy APIs in Scrapy itself (:issue:`5588`, :issue:`5589`). - Fixed uses of a deprecated Pillow API (:issue:`5684`, :issue:`5692`). - Improved code that checks if generators return values, so that it no longer fails on decorated methods and partial methods (:issue:`5323`, :issue:`5592`, :issue:`5599`, :issue:`5691`). Documentation ~~~~~~~~~~~~~ - Upgraded the Code of Conduct to Contributor Covenant v2.1 (:issue:`5698`). - Fixed typos (:issue:`5681`, :issue:`5694`). Quality assurance ~~~~~~~~~~~~~~~~~ - Re-enabled some erroneously disabled flake8 checks (:issue:`5688`). - Ignored harmless deprecation warnings from :mod:`typing` in tests (:issue:`5686`, :issue:`5697`). - Modernized our CI configuration (:issue:`5695`, :issue:`5696`). .. _release-2.7.0: Scrapy 2.7.0 (2022-10-17) ----------------------------- Highlights: - Added Python 3.11 support, dropped Python 3.6 support - Improved support for :ref:`asynchronous callbacks ` - :ref:`Asyncio support ` is enabled by default on new projects - Output names of item fields can now be arbitrary strings - Centralized :ref:`request fingerprinting ` configuration is now possible Modified requirements ~~~~~~~~~~~~~~~~~~~~~ Python 3.7 or greater is now required; support for Python 3.6 has been dropped. Support for the upcoming Python 3.11 has been added. The minimum required version of some dependencies has changed as well: - lxml_: 3.5.0 → 4.3.0 - Pillow_ (:ref:`images pipeline `): 4.0.0 → 7.1.0 - zope.interface_: 5.0.0 → 5.1.0 (:issue:`5512`, :issue:`5514`, :issue:`5524`, :issue:`5563`, :issue:`5664`, :issue:`5670`, :issue:`5678`) Deprecations ~~~~~~~~~~~~ - :meth:`ImagesPipeline.thumb_path ` must now accept an ``item`` parameter (:issue:`5504`, :issue:`5508`). - The ``scrapy.downloadermiddlewares.decompression`` module is now deprecated (:issue:`5546`, :issue:`5547`). New features ~~~~~~~~~~~~ - The :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` method of :ref:`spider middlewares ` can now be defined as an :term:`asynchronous generator` (:issue:`4978`). - The output of :class:`~scrapy.Request` callbacks defined as :ref:`coroutines ` is now processed asynchronously (:issue:`4978`). - :class:`~scrapy.spiders.crawl.CrawlSpider` now supports :ref:`asynchronous callbacks ` (:issue:`5657`). - New projects created with the :command:`startproject` command have :ref:`asyncio support ` enabled by default (:issue:`5590`, :issue:`5679`). - The :setting:`FEED_EXPORT_FIELDS` setting can now be defined as a dictionary to customize the output name of item fields, lifting the restriction that required output names to be valid Python identifiers, e.g. preventing them to have whitespace (:issue:`1008`, :issue:`3266`, :issue:`3696`). - You can now customize :ref:`request fingerprinting ` through the new :setting:`REQUEST_FINGERPRINTER_CLASS` setting, instead of having to change it on every Scrapy component that relies on request fingerprinting (:issue:`900`, :issue:`3420`, :issue:`4113`, :issue:`4762`, :issue:`4524`). - ``jsonl`` is now supported and encouraged as a file extension for `JSON Lines`_ files (:issue:`4848`). .. _JSON Lines: https://jsonlines.org/ - :meth:`ImagesPipeline.thumb_path ` now receives the source :ref:`item ` (:issue:`5504`, :issue:`5508`). Bug fixes ~~~~~~~~~ - When using Google Cloud Storage with a :ref:`media pipeline `, :setting:`FILES_EXPIRES` now also works when :setting:`FILES_STORE` does not point at the root of your Google Cloud Storage bucket (:issue:`5317`, :issue:`5318`). - The :command:`parse` command now supports :ref:`asynchronous callbacks ` (:issue:`5424`, :issue:`5577`). - When using the :command:`parse` command with a URL for which there is no available spider, an exception is no longer raised (:issue:`3264`, :issue:`3265`, :issue:`5375`, :issue:`5376`, :issue:`5497`). - :class:`~scrapy.http.TextResponse` now gives higher priority to the `byte order mark`_ when determining the text encoding of the response body, following the `HTML living standard`_ (:issue:`5601`, :issue:`5611`). .. _byte order mark: https://en.wikipedia.org/wiki/Byte_order_mark .. _HTML living standard: https://html.spec.whatwg.org/multipage/parsing.html#determining-the-character-encoding - MIME sniffing takes the response body into account in FTP and HTTP/1.0 requests, as well as in cached requests (:issue:`4873`). - MIME sniffing now detects valid HTML 5 documents even if the ``html`` tag is missing (:issue:`4873`). - An exception is now raised if :setting:`ASYNCIO_EVENT_LOOP` has a value that does not match the asyncio event loop actually installed (:issue:`5529`). - Fixed :meth:`Headers.getlist ` returning only the last header (:issue:`5515`, :issue:`5526`). - Fixed :class:`LinkExtractor ` not ignoring the ``tar.gz`` file extension by default (:issue:`1837`, :issue:`2067`, :issue:`4066`) Documentation ~~~~~~~~~~~~~ - Clarified the return type of :meth:`Spider.parse ` (:issue:`5602`, :issue:`5608`). - To enable :class:`~scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware` to do `brotli compression`_, installing brotli_ is now recommended instead of installing brotlipy_, as the former provides a more recent version of brotli. .. _brotli: https://github.com/google/brotli .. _brotli compression: https://www.ietf.org/rfc/rfc7932.txt - :ref:`Signal documentation ` now mentions :ref:`coroutine support ` and uses it in code examples (:issue:`4852`, :issue:`5358`). - :ref:`bans` now recommends `Common Crawl`_ instead of `Google cache`_ (:issue:`3582`, :issue:`5432`). .. _Common Crawl: https://commoncrawl.org/ .. _Google cache: https://www.googleguide.com/cached_pages.html - The new :ref:`topics-components` topic covers enforcing requirements on Scrapy components, like :ref:`downloader middlewares `, :ref:`extensions `, :ref:`item pipelines `, :ref:`spider middlewares `, and more; :ref:`enforce-asyncio-requirement` has also been added (:issue:`4978`). - :ref:`topics-settings` now indicates that setting values must be :ref:`picklable ` (:issue:`5607`, :issue:`5629`). - Removed outdated documentation (:issue:`5446`, :issue:`5373`, :issue:`5369`, :issue:`5370`, :issue:`5554`). - Fixed typos (:issue:`5442`, :issue:`5455`, :issue:`5457`, :issue:`5461`, :issue:`5538`, :issue:`5553`, :issue:`5558`, :issue:`5624`, :issue:`5631`). - Fixed other issues (:issue:`5283`, :issue:`5284`, :issue:`5559`, :issue:`5567`, :issue:`5648`, :issue:`5659`, :issue:`5665`). Quality assurance ~~~~~~~~~~~~~~~~~ - Added a continuous integration job to run `twine check`_ (:issue:`5655`, :issue:`5656`). .. _twine check: https://twine.readthedocs.io/en/stable/#twine-check - Addressed test issues and warnings (:issue:`5560`, :issue:`5561`, :issue:`5612`, :issue:`5617`, :issue:`5639`, :issue:`5645`, :issue:`5662`, :issue:`5671`, :issue:`5675`). - Cleaned up code (:issue:`4991`, :issue:`4995`, :issue:`5451`, :issue:`5487`, :issue:`5542`, :issue:`5667`, :issue:`5668`, :issue:`5672`). - Applied minor code improvements (:issue:`5661`). .. _release-2.6.3: Scrapy 2.6.3 (2022-09-27) ------------------------- - Added support for pyOpenSSL_ 22.1.0, removing support for SSLv3 (:issue:`5634`, :issue:`5635`, :issue:`5636`). - Upgraded the minimum versions of the following dependencies: - cryptography_: 2.0 → 3.3 - pyOpenSSL_: 16.2.0 → 21.0.0 - service_identity_: 16.0.0 → 18.1.0 - Twisted_: 17.9.0 → 18.9.0 - zope.interface_: 4.1.3 → 5.0.0 (:issue:`5621`, :issue:`5632`) - Fixes test and documentation issues (:issue:`5612`, :issue:`5617`, :issue:`5631`). .. _release-2.6.2: Scrapy 2.6.2 (2022-07-25) ------------------------- **Security bug fix:** - When :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` processes a request with :reqmeta:`proxy` metadata, and that :reqmeta:`proxy` metadata includes proxy credentials, :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` sets the ``Proxy-Authorization`` header, but only if that header is not already set. There are third-party proxy-rotation downloader middlewares that set different :reqmeta:`proxy` metadata every time they process a request. Because of request retries and redirects, the same request can be processed by downloader middlewares more than once, including both :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` and any third-party proxy-rotation downloader middleware. These third-party proxy-rotation downloader middlewares could change the :reqmeta:`proxy` metadata of a request to a new value, but fail to remove the ``Proxy-Authorization`` header from the previous value of the :reqmeta:`proxy` metadata, causing the credentials of one proxy to be sent to a different proxy. To prevent the unintended leaking of proxy credentials, the behavior of :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` is now as follows when processing a request: - If the request being processed defines :reqmeta:`proxy` metadata that includes credentials, the ``Proxy-Authorization`` header is always updated to feature those credentials. - If the request being processed defines :reqmeta:`proxy` metadata without credentials, the ``Proxy-Authorization`` header is removed *unless* it was originally defined for the same proxy URL. To remove proxy credentials while keeping the same proxy URL, remove the ``Proxy-Authorization`` header. - If the request has no :reqmeta:`proxy` metadata, or that metadata is a falsy value (e.g. ``None``), the ``Proxy-Authorization`` header is removed. It is no longer possible to set a proxy URL through the :reqmeta:`proxy` metadata but set the credentials through the ``Proxy-Authorization`` header. Set proxy credentials through the :reqmeta:`proxy` metadata instead. Also fixes the following regressions introduced in 2.6.0: - :class:`~scrapy.crawler.CrawlerProcess` supports again crawling multiple spiders (:issue:`5435`, :issue:`5436`) - Installing a Twisted reactor before Scrapy does (e.g. importing :mod:`twisted.internet.reactor` somewhere at the module level) no longer prevents Scrapy from starting, as long as a different reactor is not specified in :setting:`TWISTED_REACTOR` (:issue:`5525`, :issue:`5528`) - Fixed an exception that was being logged after the spider finished under certain conditions (:issue:`5437`, :issue:`5440`) - The ``--output``/``-o`` command-line parameter supports again a value starting with a hyphen (:issue:`5444`, :issue:`5445`) - The ``scrapy parse -h`` command no longer throws an error (:issue:`5481`, :issue:`5482`) .. _release-2.6.1: Scrapy 2.6.1 (2022-03-01) ------------------------- Fixes a regression introduced in 2.6.0 that would unset the request method when following redirects. .. _release-2.6.0: Scrapy 2.6.0 (2022-03-01) ------------------------- Highlights: * :ref:`Security fixes for cookie handling <2.6-security-fixes>` * Python 3.10 support * :ref:`asyncio support ` is no longer considered experimental, and works out-of-the-box on Windows regardless of your Python version * Feed exports now support :class:`pathlib.Path` output paths and per-feed :ref:`item filtering ` and :ref:`post-processing ` .. _2.6-security-fixes: Security bug fixes ~~~~~~~~~~~~~~~~~~ - When a :class:`~scrapy.Request` object with cookies defined gets a redirect response causing a new :class:`~scrapy.Request` object to be scheduled, the cookies defined in the original :class:`~scrapy.Request` object are no longer copied into the new :class:`~scrapy.Request` object. If you manually set the ``Cookie`` header on a :class:`~scrapy.Request` object and the domain name of the redirect URL is not an exact match for the domain of the URL of the original :class:`~scrapy.Request` object, your ``Cookie`` header is now dropped from the new :class:`~scrapy.Request` object. The old behavior could be exploited by an attacker to gain access to your cookies. Please, see the `cjvr-mfj7-j4j8 security advisory`_ for more information. .. _cjvr-mfj7-j4j8 security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-cjvr-mfj7-j4j8 .. note:: It is still possible to enable the sharing of cookies between different domains with a shared domain suffix (e.g. ``example.com`` and any subdomain) by defining the shared domain suffix (e.g. ``example.com``) as the cookie domain when defining your cookies. See the documentation of the :class:`~scrapy.Request` class for more information. - When the domain of a cookie, either received in the ``Set-Cookie`` header of a response or defined in a :class:`~scrapy.Request` object, is set to a `public suffix `_, the cookie is now ignored unless the cookie domain is the same as the request domain. The old behavior could be exploited by an attacker to inject cookies from a controlled domain into your cookiejar that could be sent to other domains not controlled by the attacker. Please, see the `mfjm-vh54-3f96 security advisory`_ for more information. .. _mfjm-vh54-3f96 security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-mfjm-vh54-3f96 Modified requirements ~~~~~~~~~~~~~~~~~~~~~ - The h2_ dependency is now optional, only needed to :ref:`enable HTTP/2 support `. (:issue:`5113`) .. _h2: https://pypi.org/project/h2/ Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - The ``formdata`` parameter of :class:`~scrapy.FormRequest`, if specified for a non-POST request, now overrides the URL query string, instead of being appended to it. (:issue:`2919`, :issue:`3579`) - When a function is assigned to the :setting:`FEED_URI_PARAMS` setting, now the return value of that function, and not the ``params`` input parameter, will determine the feed URI parameters, unless that return value is ``None``. (:issue:`4962`, :issue:`4966`) - In :class:`scrapy.core.engine.ExecutionEngine`, methods :meth:`~scrapy.core.engine.ExecutionEngine.crawl`, :meth:`~scrapy.core.engine.ExecutionEngine.download`, :meth:`~scrapy.core.engine.ExecutionEngine.schedule`, and :meth:`~scrapy.core.engine.ExecutionEngine.spider_is_idle` now raise :exc:`RuntimeError` if called before :meth:`~scrapy.core.engine.ExecutionEngine.open_spider`. (:issue:`5090`) These methods used to assume that :attr:`ExecutionEngine.slot ` had been defined by a prior call to :meth:`~scrapy.core.engine.ExecutionEngine.open_spider`, so they were raising :exc:`AttributeError` instead. - If the API of the configured :ref:`scheduler ` does not meet expectations, :exc:`TypeError` is now raised at startup time. Before, other exceptions would be raised at run time. (:issue:`3559`) - The ``_encoding`` field of serialized :class:`~scrapy.Request` objects is now named ``encoding``, in line with all other fields (:issue:`5130`) Deprecation removals ~~~~~~~~~~~~~~~~~~~~ - ``scrapy.http.TextResponse.body_as_unicode``, deprecated in Scrapy 2.2, has now been removed. (:issue:`5393`) - ``scrapy.item.BaseItem``, deprecated in Scrapy 2.2, has now been removed. (:issue:`5398`) - ``scrapy.item.DictItem``, deprecated in Scrapy 1.8, has now been removed. (:issue:`5398`) - ``scrapy.Spider.make_requests_from_url``, deprecated in Scrapy 1.4, has now been removed. (:issue:`4178`, :issue:`4356`) Deprecations ~~~~~~~~~~~~ - When a function is assigned to the :setting:`FEED_URI_PARAMS` setting, returning ``None`` or modifying the ``params`` input parameter is now deprecated. Return a new dictionary instead. (:issue:`4962`, :issue:`4966`) - :mod:`scrapy.utils.reqser` is deprecated. (:issue:`5130`) - Instead of :func:`~scrapy.utils.reqser.request_to_dict`, use the new :meth:`.Request.to_dict` method. - Instead of :func:`~scrapy.utils.reqser.request_from_dict`, use the new :func:`scrapy.utils.request.request_from_dict` function. - In :mod:`scrapy.squeues`, the following queue classes are deprecated: :class:`~scrapy.squeues.PickleFifoDiskQueueNonRequest`, :class:`~scrapy.squeues.PickleLifoDiskQueueNonRequest`, :class:`~scrapy.squeues.MarshalFifoDiskQueueNonRequest`, and :class:`~scrapy.squeues.MarshalLifoDiskQueueNonRequest`. You should instead use: :class:`~scrapy.squeues.PickleFifoDiskQueue`, :class:`~scrapy.squeues.PickleLifoDiskQueue`, :class:`~scrapy.squeues.MarshalFifoDiskQueue`, and :class:`~scrapy.squeues.MarshalLifoDiskQueue`. (:issue:`5117`) - Many aspects of :class:`scrapy.core.engine.ExecutionEngine` that come from a time when this class could handle multiple :class:`~scrapy.Spider` objects at a time have been deprecated. (:issue:`5090`) - The :meth:`~scrapy.core.engine.ExecutionEngine.has_capacity` method is deprecated. - The :meth:`~scrapy.core.engine.ExecutionEngine.schedule` method is deprecated, use :meth:`~scrapy.core.engine.ExecutionEngine.crawl` or :meth:`~scrapy.core.engine.ExecutionEngine.download` instead. - The :attr:`~scrapy.core.engine.ExecutionEngine.open_spiders` attribute is deprecated, use :attr:`~scrapy.core.engine.ExecutionEngine.spider` instead. - The ``spider`` parameter is deprecated for the following methods: - :meth:`~scrapy.core.engine.ExecutionEngine.spider_is_idle` - :meth:`~scrapy.core.engine.ExecutionEngine.crawl` - :meth:`~scrapy.core.engine.ExecutionEngine.download` Instead, call :meth:`~scrapy.core.engine.ExecutionEngine.open_spider` first to set the :class:`~scrapy.Spider` object. - :func:`scrapy.utils.response.response_httprepr` is now deprecated. (:issue:`4972`) New features ~~~~~~~~~~~~ - You can now use :ref:`item filtering ` to control which items are exported to each output feed. (:issue:`4575`, :issue:`5178`, :issue:`5161`, :issue:`5203`) - You can now apply :ref:`post-processing ` to feeds, and :ref:`built-in post-processing plugins ` are provided for output file compression. (:issue:`2174`, :issue:`5168`, :issue:`5190`) - The :setting:`FEEDS` setting now supports :class:`pathlib.Path` objects as keys. (:issue:`5383`, :issue:`5384`) - Enabling :ref:`asyncio ` while using Windows and Python 3.8 or later will automatically switch the asyncio event loop to one that allows Scrapy to work. See :ref:`asyncio-windows`. (:issue:`4976`, :issue:`5315`) - The :command:`genspider` command now supports a start URL instead of a domain name. (:issue:`4439`) - :mod:`scrapy.utils.defer` gained 2 new functions, :func:`~scrapy.utils.defer.deferred_to_future` and :func:`~scrapy.utils.defer.maybe_deferred_to_future`, to help :ref:`await on Deferreds when using the asyncio reactor `. (:issue:`5288`) - :ref:`Amazon S3 feed export storage ` gained support for `temporary security credentials`_ (:setting:`AWS_SESSION_TOKEN`) and endpoint customization (:setting:`AWS_ENDPOINT_URL`). (:issue:`4998`, :issue:`5210`) .. _temporary security credentials: https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html - New :setting:`LOG_FILE_APPEND` setting to allow truncating the log file. (:issue:`5279`) - :attr:`Request.cookies ` values that are :class:`bool`, :class:`float` or :class:`int` are cast to :class:`str`. (:issue:`5252`, :issue:`5253`) - You may now raise :exc:`~scrapy.exceptions.CloseSpider` from a handler of the :signal:`spider_idle` signal to customize the reason why the spider is stopping. (:issue:`5191`) - When using :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware`, the proxy URL for non-HTTPS HTTP/1.1 requests no longer needs to include a URL scheme. (:issue:`4505`, :issue:`4649`) - All built-in queues now expose a ``peek`` method that returns the next queue object (like ``pop``) but does not remove the returned object from the queue. (:issue:`5112`) If the underlying queue does not support peeking (e.g. because you are not using ``queuelib`` 1.6.1 or later), the ``peek`` method raises :exc:`NotImplementedError`. - :class:`~scrapy.Request` and :class:`~scrapy.http.Response` now have an ``attributes`` attribute that makes subclassing easier. For :class:`~scrapy.Request`, it also allows subclasses to work with :func:`scrapy.utils.request.request_from_dict`. (:issue:`1877`, :issue:`5130`, :issue:`5218`) - The :meth:`~scrapy.core.scheduler.BaseScheduler.open` and :meth:`~scrapy.core.scheduler.BaseScheduler.close` methods of the :ref:`scheduler ` are now optional. (:issue:`3559`) - HTTP/1.1 :exc:`~scrapy.core.downloader.handlers.http11.TunnelError` exceptions now only truncate response bodies longer than 1000 characters, instead of those longer than 32 characters, making it easier to debug such errors. (:issue:`4881`, :issue:`5007`) - :class:`~scrapy.loader.ItemLoader` now supports non-text responses. (:issue:`5145`, :issue:`5269`) Bug fixes ~~~~~~~~~ - The :setting:`TWISTED_REACTOR` and :setting:`ASYNCIO_EVENT_LOOP` settings are no longer ignored if defined in :attr:`~scrapy.Spider.custom_settings`. (:issue:`4485`, :issue:`5352`) - Removed a module-level Twisted reactor import that could prevent :ref:`using the asyncio reactor `. (:issue:`5357`) - The :command:`startproject` command works with existing folders again. (:issue:`4665`, :issue:`4676`) - The :setting:`FEED_URI_PARAMS` setting now behaves as documented. (:issue:`4962`, :issue:`4966`) - :attr:`Request.cb_kwargs ` once again allows the ``callback`` keyword. (:issue:`5237`, :issue:`5251`, :issue:`5264`) - Made :func:`scrapy.utils.response.open_in_browser` support more complex HTML. (:issue:`5319`, :issue:`5320`) - Fixed :attr:`CSVFeedSpider.quotechar ` being interpreted as the CSV file encoding. (:issue:`5391`, :issue:`5394`) - Added missing setuptools_ to the list of dependencies. (:issue:`5122`) .. _setuptools: https://pypi.org/project/setuptools/ - :class:`LinkExtractor ` now also works as expected with links that have comma-separated ``rel`` attribute values including ``nofollow``. (:issue:`5225`) - Fixed a :exc:`TypeError` that could be raised during :ref:`feed export ` parameter parsing. (:issue:`5359`) Documentation ~~~~~~~~~~~~~ - :ref:`asyncio support ` is no longer considered experimental. (:issue:`5332`) - Included :ref:`Windows-specific help for asyncio usage `. (:issue:`4976`, :issue:`5315`) - Rewrote :ref:`topics-headless-browsing` with up-to-date best practices. (:issue:`4484`, :issue:`4613`) - Documented :ref:`local file naming in media pipelines `. (:issue:`5069`, :issue:`5152`) - :ref:`faq` now covers spider file name collision issues. (:issue:`2680`, :issue:`3669`) - Provided better context and instructions to disable the :setting:`URLLENGTH_LIMIT` setting. (:issue:`5135`, :issue:`5250`) - Documented that Reppy parser does not support Python 3.9+. (:issue:`5226`, :issue:`5231`) - Documented :ref:`the scheduler component `. (:issue:`3537`, :issue:`3559`) - Documented the method used by :ref:`media pipelines ` to :ref:`determine if a file has expired `. (:issue:`5120`, :issue:`5254`) - :ref:`run-multiple-spiders` now features :func:`scrapy.utils.project.get_project_settings` usage. (:issue:`5070`) - :ref:`run-multiple-spiders` now covers what happens when you define different per-spider values for some settings that cannot differ at run time. (:issue:`4485`, :issue:`5352`) - Extended the documentation of the :class:`~scrapy.extensions.statsmailer.StatsMailer` extension. (:issue:`5199`, :issue:`5217`) - Added :setting:`JOBDIR` to :ref:`topics-settings`. (:issue:`5173`, :issue:`5224`) - Documented :attr:`Spider.attribute `. (:issue:`5174`, :issue:`5244`) - Documented :attr:`TextResponse.urljoin `. (:issue:`1582`) - Added the ``body_length`` parameter to the documented signature of the :signal:`headers_received` signal. (:issue:`5270`) - Clarified :meth:`SelectorList.get ` usage in the :ref:`tutorial `. (:issue:`5256`) - The documentation now features the shortest import path of classes with multiple import paths. (:issue:`2733`, :issue:`5099`) - ``quotes.toscrape.com`` references now use HTTPS instead of HTTP. (:issue:`5395`, :issue:`5396`) - Added a link to `our Discord server `_ to :ref:`getting-help`. (:issue:`5421`, :issue:`5422`) - The pronunciation of the project name is now :ref:`officially ` /ˈskreɪpaɪ/. (:issue:`5280`, :issue:`5281`) - Added the Scrapy logo to the README. (:issue:`5255`, :issue:`5258`) - Fixed issues and implemented minor improvements. (:issue:`3155`, :issue:`4335`, :issue:`5074`, :issue:`5098`, :issue:`5134`, :issue:`5180`, :issue:`5194`, :issue:`5239`, :issue:`5266`, :issue:`5271`, :issue:`5273`, :issue:`5274`, :issue:`5276`, :issue:`5347`, :issue:`5356`, :issue:`5414`, :issue:`5415`, :issue:`5416`, :issue:`5419`, :issue:`5420`) Quality Assurance ~~~~~~~~~~~~~~~~~ - Added support for Python 3.10. (:issue:`5212`, :issue:`5221`, :issue:`5265`) - Significantly reduced memory usage by :func:`scrapy.utils.response.response_httprepr`, used by the :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats` downloader middleware, which is enabled by default. (:issue:`4964`, :issue:`4972`) - Removed uses of the deprecated :mod:`optparse` module. (:issue:`5366`, :issue:`5374`) - Extended typing hints. (:issue:`5077`, :issue:`5090`, :issue:`5100`, :issue:`5108`, :issue:`5171`, :issue:`5215`, :issue:`5334`) - Improved tests, fixed CI issues, removed unused code. (:issue:`5094`, :issue:`5157`, :issue:`5162`, :issue:`5198`, :issue:`5207`, :issue:`5208`, :issue:`5229`, :issue:`5298`, :issue:`5299`, :issue:`5310`, :issue:`5316`, :issue:`5333`, :issue:`5388`, :issue:`5389`, :issue:`5400`, :issue:`5401`, :issue:`5404`, :issue:`5405`, :issue:`5407`, :issue:`5410`, :issue:`5412`, :issue:`5425`, :issue:`5427`) - Implemented improvements for contributors. (:issue:`5080`, :issue:`5082`, :issue:`5177`, :issue:`5200`) - Implemented cleanups. (:issue:`5095`, :issue:`5106`, :issue:`5209`, :issue:`5228`, :issue:`5235`, :issue:`5245`, :issue:`5246`, :issue:`5292`, :issue:`5314`, :issue:`5322`) .. _release-2.5.1: Scrapy 2.5.1 (2021-10-05) ------------------------- * **Security bug fix:** If you use :class:`~scrapy.downloadermiddlewares.httpauth.HttpAuthMiddleware` (i.e. the ``http_user`` and ``http_pass`` spider attributes) for HTTP authentication, any request exposes your credentials to the request target. To prevent unintended exposure of authentication credentials to unintended domains, you must now additionally set a new, additional spider attribute, ``http_auth_domain``, and point it to the specific domain to which the authentication credentials must be sent. If the ``http_auth_domain`` spider attribute is not set, the domain of the first request will be considered the HTTP authentication target, and authentication credentials will only be sent in requests targeting that domain. If you need to send the same HTTP authentication credentials to multiple domains, you can use :func:`w3lib.http.basic_auth_header` instead to set the value of the ``Authorization`` header of your requests. If you *really* want your spider to send the same HTTP authentication credentials to any domain, set the ``http_auth_domain`` spider attribute to ``None``. Finally, if you are a user of `scrapy-splash`_, know that this version of Scrapy breaks compatibility with scrapy-splash 0.7.2 and earlier. You will need to upgrade scrapy-splash to a greater version for it to continue to work. .. _release-2.5.0: Scrapy 2.5.0 (2021-04-06) ------------------------- Highlights: - Official Python 3.9 support - Experimental :ref:`HTTP/2 support ` - New :func:`~scrapy.downloadermiddlewares.retry.get_retry_request` function to retry requests from spider callbacks - New :class:`~scrapy.signals.headers_received` signal that allows stopping downloads early - New :class:`Response.protocol ` attribute Deprecation removals ~~~~~~~~~~~~~~~~~~~~ - Removed all code that :ref:`was deprecated in 1.7.0 <1.7-deprecations>` and had not :ref:`already been removed in 2.4.0 <2.4-deprecation-removals>`. (:issue:`4901`) - Removed support for the ``SCRAPY_PICKLED_SETTINGS_TO_OVERRIDE`` environment variable, :ref:`deprecated in 1.8.0 <1.8-deprecations>`. (:issue:`4912`) Deprecations ~~~~~~~~~~~~ - The :mod:`scrapy.utils.py36` module is now deprecated in favor of :mod:`scrapy.utils.asyncgen`. (:issue:`4900`) New features ~~~~~~~~~~~~ - Experimental :ref:`HTTP/2 support ` through a new download handler that can be assigned to the ``https`` protocol in the :setting:`DOWNLOAD_HANDLERS` setting. (:issue:`1854`, :issue:`4769`, :issue:`5058`, :issue:`5059`, :issue:`5066`) - The new :func:`scrapy.downloadermiddlewares.retry.get_retry_request` function may be used from spider callbacks or middlewares to handle the retrying of a request beyond the scenarios that :class:`~scrapy.downloadermiddlewares.retry.RetryMiddleware` supports. (:issue:`3590`, :issue:`3685`, :issue:`4902`) - The new :class:`~scrapy.signals.headers_received` signal gives early access to response headers and allows :ref:`stopping downloads `. (:issue:`1772`, :issue:`4897`) - The new :attr:`Response.protocol ` attribute gives access to the string that identifies the protocol used to download a response. (:issue:`4878`) - :ref:`Stats ` now include the following entries that indicate the number of successes and failures in storing :ref:`feeds `:: feedexport/success_count/ feedexport/failed_count/ Where ```` is the feed storage backend class name, such as :class:`~scrapy.extensions.feedexport.FileFeedStorage` or :class:`~scrapy.extensions.feedexport.FTPFeedStorage`. (:issue:`3947`, :issue:`4850`) - The :class:`~scrapy.spidermiddlewares.urllength.UrlLengthMiddleware` spider middleware now logs ignored URLs with ``INFO`` :ref:`logging level ` instead of ``DEBUG``, and it now includes the following entry into :ref:`stats ` to keep track of the number of ignored URLs:: urllength/request_ignored_count (:issue:`5036`) - The :class:`~scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware` downloader middleware now logs the number of decompressed responses and the total count of resulting bytes:: httpcompression/response_bytes httpcompression/response_count (:issue:`4797`, :issue:`4799`) Bug fixes ~~~~~~~~~ - Fixed installation on PyPy installing PyDispatcher in addition to PyPyDispatcher, which could prevent Scrapy from working depending on which package got imported. (:issue:`4710`, :issue:`4814`) - When inspecting a callback to check if it is a generator that also returns a value, an exception is no longer raised if the callback has a docstring with lower indentation than the following code. (:issue:`4477`, :issue:`4935`) - The `Content-Length `_ header is no longer omitted from responses when using the default, HTTP/1.1 download handler (see :setting:`DOWNLOAD_HANDLERS`). (:issue:`5009`, :issue:`5034`, :issue:`5045`, :issue:`5057`, :issue:`5062`) - Setting the :reqmeta:`handle_httpstatus_all` request meta key to ``False`` now has the same effect as not setting it at all, instead of having the same effect as setting it to ``True``. (:issue:`3851`, :issue:`4694`) Documentation ~~~~~~~~~~~~~ - Added instructions to :ref:`install Scrapy in Windows using pip `. (:issue:`4715`, :issue:`4736`) - Logging documentation now includes :ref:`additional ways to filter logs `. (:issue:`4216`, :issue:`4257`, :issue:`4965`) - Covered how to deal with long lists of allowed domains in the :ref:`FAQ `. (:issue:`2263`, :issue:`3667`) - Covered scrapy-bench_ in :ref:`benchmarking`. (:issue:`4996`, :issue:`5016`) - Clarified that one :ref:`extension ` instance is created per crawler. (:issue:`5014`) - Fixed some errors in examples. (:issue:`4829`, :issue:`4830`, :issue:`4907`, :issue:`4909`, :issue:`5008`) - Fixed some external links, typos, and so on. (:issue:`4892`, :issue:`4899`, :issue:`4936`, :issue:`4942`, :issue:`5005`, :issue:`5063`) - The :ref:`list of Request.meta keys ` is now sorted alphabetically. (:issue:`5061`, :issue:`5065`) - Updated references to Scrapinghub, which is now called Zyte. (:issue:`4973`, :issue:`5072`) - Added a mention to contributors in the README. (:issue:`4956`) - Reduced the top margin of lists. (:issue:`4974`) Quality Assurance ~~~~~~~~~~~~~~~~~ - Made Python 3.9 support official (:issue:`4757`, :issue:`4759`) - Extended typing hints (:issue:`4895`) - Fixed deprecated uses of the Twisted API. (:issue:`4940`, :issue:`4950`, :issue:`5073`) - Made our tests run with the new pip resolver. (:issue:`4710`, :issue:`4814`) - Added tests to ensure that :ref:`coroutine support ` is tested. (:issue:`4987`) - Migrated from Travis CI to GitHub Actions. (:issue:`4924`) - Fixed CI issues. (:issue:`4986`, :issue:`5020`, :issue:`5022`, :issue:`5027`, :issue:`5052`, :issue:`5053`) - Implemented code refactorings, style fixes and cleanups. (:issue:`4911`, :issue:`4982`, :issue:`5001`, :issue:`5002`, :issue:`5076`) .. _release-2.4.1: Scrapy 2.4.1 (2020-11-17) ------------------------- - Fixed :ref:`feed exports ` overwrite support (:issue:`4845`, :issue:`4857`, :issue:`4859`) - Fixed the AsyncIO event loop handling, which could make code hang (:issue:`4855`, :issue:`4872`) - Fixed the IPv6-capable DNS resolver :class:`~scrapy.resolver.CachingHostnameResolver` for download handlers that call :meth:`reactor.resolve ` (:issue:`4802`, :issue:`4803`) - Fixed the output of the :command:`genspider` command showing placeholders instead of the import path of the generated spider module (:issue:`4874`) - Migrated Windows CI from Azure Pipelines to GitHub Actions (:issue:`4869`, :issue:`4876`) .. _release-2.4.0: Scrapy 2.4.0 (2020-10-11) ------------------------- Highlights: * Python 3.5 support has been dropped. * The ``file_path`` method of :ref:`media pipelines ` can now access the source :ref:`item `. This allows you to set a download file path based on item data. * The new ``item_export_kwargs`` key of the :setting:`FEEDS` setting allows to define keyword parameters to pass to :ref:`item exporter classes ` * You can now choose whether :ref:`feed exports ` overwrite or append to the output file. For example, when using the :command:`crawl` or :command:`runspider` commands, you can use the ``-O`` option instead of ``-o`` to overwrite the output file. * Zstd-compressed responses are now supported if zstandard_ is installed. * In settings, where the import path of a class is required, it is now possible to pass a class object instead. Modified requirements ~~~~~~~~~~~~~~~~~~~~~ * Python 3.6 or greater is now required; support for Python 3.5 has been dropped As a result: - When using PyPy, PyPy 7.2.0 or greater :ref:`is now required ` - For Amazon S3 storage support in :ref:`feed exports ` or :ref:`media pipelines `, botocore_ 1.4.87 or greater is now required - To use the :ref:`images pipeline `, Pillow_ 4.0.0 or greater is now required (:issue:`4718`, :issue:`4732`, :issue:`4733`, :issue:`4742`, :issue:`4743`, :issue:`4764`) Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * :class:`~scrapy.downloadermiddlewares.cookies.CookiesMiddleware` once again discards cookies defined in :attr:`.Request.headers`. We decided to revert this bug fix, introduced in Scrapy 2.2.0, because it was reported that the current implementation could break existing code. If you need to set cookies for a request, use the :class:`Request.cookies ` parameter. A future version of Scrapy will include a new, better implementation of the reverted bug fix. (:issue:`4717`, :issue:`4823`) .. _2.4-deprecation-removals: Deprecation removals ~~~~~~~~~~~~~~~~~~~~ * :class:`scrapy.extensions.feedexport.S3FeedStorage` no longer reads the values of ``access_key`` and ``secret_key`` from the running project settings when they are not passed to its ``__init__`` method; you must either pass those parameters to its ``__init__`` method or use :class:`S3FeedStorage.from_crawler ` (:issue:`4356`, :issue:`4411`, :issue:`4688`) * :attr:`Rule.process_request ` no longer admits callables which expect a single ``request`` parameter, rather than both ``request`` and ``response`` (:issue:`4818`) Deprecations ~~~~~~~~~~~~ * In custom :ref:`media pipelines `, signatures that do not accept a keyword-only ``item`` parameter in any of the methods that :ref:`now support this parameter ` are now deprecated (:issue:`4628`, :issue:`4686`) * In custom :ref:`feed storage backend classes `, ``__init__`` method signatures that do not accept a keyword-only ``feed_options`` parameter are now deprecated (:issue:`547`, :issue:`716`, :issue:`4512`) * The :class:`scrapy.utils.python.WeakKeyCache` class is now deprecated (:issue:`4684`, :issue:`4701`) * The :func:`scrapy.utils.boto.is_botocore` function is now deprecated, use :func:`scrapy.utils.boto.is_botocore_available` instead (:issue:`4734`, :issue:`4776`) New features ~~~~~~~~~~~~ .. _media-pipeline-item-parameter: * The following methods of :ref:`media pipelines ` now accept an ``item`` keyword-only parameter containing the source :ref:`item `: - In :class:`scrapy.pipelines.files.FilesPipeline`: - :meth:`~scrapy.pipelines.files.FilesPipeline.file_downloaded` - :meth:`~scrapy.pipelines.files.FilesPipeline.file_path` - :meth:`~scrapy.pipelines.files.FilesPipeline.media_downloaded` - :meth:`~scrapy.pipelines.files.FilesPipeline.media_to_download` - In :class:`scrapy.pipelines.images.ImagesPipeline`: - :meth:`~scrapy.pipelines.images.ImagesPipeline.file_downloaded` - :meth:`~scrapy.pipelines.images.ImagesPipeline.file_path` - :meth:`~scrapy.pipelines.images.ImagesPipeline.get_images` - :meth:`~scrapy.pipelines.images.ImagesPipeline.image_downloaded` - :meth:`~scrapy.pipelines.images.ImagesPipeline.media_downloaded` - :meth:`~scrapy.pipelines.images.ImagesPipeline.media_to_download` (:issue:`4628`, :issue:`4686`) * The new ``item_export_kwargs`` key of the :setting:`FEEDS` setting allows to define keyword parameters to pass to :ref:`item exporter classes ` (:issue:`4606`, :issue:`4768`) * :ref:`Feed exports ` gained overwrite support: * When using the :command:`crawl` or :command:`runspider` commands, you can use the ``-O`` option instead of ``-o`` to overwrite the output file * You can use the ``overwrite`` key in the :setting:`FEEDS` setting to configure whether to overwrite the output file (``True``) or append to its content (``False``) * The ``__init__`` and ``from_crawler`` methods of :ref:`feed storage backend classes ` now receive a new keyword-only parameter, ``feed_options``, which is a dictionary of :ref:`feed options ` (:issue:`547`, :issue:`716`, :issue:`4512`) * Zstd-compressed responses are now supported if zstandard_ is installed (:issue:`4831`) * In settings, where the import path of a class is required, it is now possible to pass a class object instead (:issue:`3870`, :issue:`3873`). This includes also settings where only part of its value is made of an import path, such as :setting:`DOWNLOADER_MIDDLEWARES` or :setting:`DOWNLOAD_HANDLERS`. * :ref:`Downloader middlewares ` can now override :class:`response.request `. If a :ref:`downloader middleware ` returns a :class:`~scrapy.http.Response` object from :meth:`~scrapy.downloadermiddlewares.DownloaderMiddleware.process_response` or :meth:`~scrapy.downloadermiddlewares.DownloaderMiddleware.process_exception` with a custom :class:`~scrapy.Request` object assigned to :class:`response.request `: - The response is handled by the callback of that custom :class:`~scrapy.Request` object, instead of being handled by the callback of the original :class:`~scrapy.Request` object - That custom :class:`~scrapy.Request` object is now sent as the ``request`` argument to the :signal:`response_received` signal, instead of the original :class:`~scrapy.Request` object (:issue:`4529`, :issue:`4632`) * When using the :ref:`FTP feed storage backend `: - It is now possible to set the new ``overwrite`` :ref:`feed option ` to ``False`` to append to an existing file instead of overwriting it - The FTP password can now be omitted if it is not necessary (:issue:`547`, :issue:`716`, :issue:`4512`) * The ``__init__`` method of :class:`~scrapy.exporters.CsvItemExporter` now supports an ``errors`` parameter to indicate how to handle encoding errors (:issue:`4755`) * When :ref:`using asyncio `, it is now possible to :ref:`set a custom asyncio loop ` (:issue:`4306`, :issue:`4414`) * Serialized requests (see :ref:`topics-jobs`) now support callbacks that are spider methods that delegate on other callable (:issue:`4756`) * When a response is larger than :setting:`DOWNLOAD_MAXSIZE`, the logged message is now a warning, instead of an error (:issue:`3874`, :issue:`3886`, :issue:`4752`) Bug fixes ~~~~~~~~~ * The :command:`genspider` command no longer overwrites existing files unless the ``--force`` option is used (:issue:`4561`, :issue:`4616`, :issue:`4623`) * Cookies with an empty value are no longer considered invalid cookies (:issue:`4772`) * The :command:`runspider` command now supports files with the ``.pyw`` file extension (:issue:`4643`, :issue:`4646`) * The :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` middleware now simply ignores unsupported proxy values (:issue:`3331`, :issue:`4778`) * Checks for generator callbacks with a ``return`` statement no longer warn about ``return`` statements in nested functions (:issue:`4720`, :issue:`4721`) * The system file mode creation mask no longer affects the permissions of files generated using the :command:`startproject` command (:issue:`4722`) * :func:`scrapy.utils.iterators.xmliter` now supports namespaced node names (:issue:`861`, :issue:`4746`) * :class:`~scrapy.Request` objects can now have ``about:`` URLs, which can work when using a headless browser (:issue:`4835`) Documentation ~~~~~~~~~~~~~ * The :setting:`FEED_URI_PARAMS` setting is now documented (:issue:`4671`, :issue:`4724`) * Improved the documentation of :ref:`link extractors ` with an usage example from a spider callback and reference documentation for the :class:`~scrapy.link.Link` class (:issue:`4751`, :issue:`4775`) * Clarified the impact of :setting:`CONCURRENT_REQUESTS` when using the :class:`~scrapy.extensions.closespider.CloseSpider` extension (:issue:`4836`) * Removed references to Python 2’s ``unicode`` type (:issue:`4547`, :issue:`4703`) * We now have an :ref:`official deprecation policy ` (:issue:`4705`) * Our :ref:`documentation policies ` now cover usage of Sphinx’s :rst:dir:`versionadded` and :rst:dir:`versionchanged` directives, and we have removed usages referencing Scrapy 1.4.0 and earlier versions (:issue:`3971`, :issue:`4310`) * Other documentation cleanups (:issue:`4090`, :issue:`4782`, :issue:`4800`, :issue:`4801`, :issue:`4809`, :issue:`4816`, :issue:`4825`) Quality assurance ~~~~~~~~~~~~~~~~~ * Extended typing hints (:issue:`4243`, :issue:`4691`) * Added tests for the :command:`check` command (:issue:`4663`) * Fixed test failures on Debian (:issue:`4726`, :issue:`4727`, :issue:`4735`) * Improved Windows test coverage (:issue:`4723`) * Switched to :ref:`formatted string literals ` where possible (:issue:`4307`, :issue:`4324`, :issue:`4672`) * Modernized :func:`super` usage (:issue:`4707`) * Other code and test cleanups (:issue:`1790`, :issue:`3288`, :issue:`4165`, :issue:`4564`, :issue:`4651`, :issue:`4714`, :issue:`4738`, :issue:`4745`, :issue:`4747`, :issue:`4761`, :issue:`4765`, :issue:`4804`, :issue:`4817`, :issue:`4820`, :issue:`4822`, :issue:`4839`) .. _release-2.3.0: Scrapy 2.3.0 (2020-08-04) ------------------------- Highlights: * :ref:`Feed exports ` now support :ref:`Google Cloud Storage ` as a storage backend * The new :setting:`FEED_EXPORT_BATCH_ITEM_COUNT` setting allows to deliver output items in batches of up to the specified number of items. It also serves as a workaround for :ref:`delayed file delivery `, which causes Scrapy to only start item delivery after the crawl has finished when using certain storage backends (:ref:`S3 `, :ref:`FTP `, and now :ref:`GCS `). * The base implementation of :ref:`item loaders ` has been moved into a separate library, :doc:`itemloaders `, allowing usage from outside Scrapy and a separate release schedule Deprecation removals ~~~~~~~~~~~~~~~~~~~~ * Removed the following classes and their parent modules from ``scrapy.linkextractors``: * ``htmlparser.HtmlParserLinkExtractor`` * ``regex.RegexLinkExtractor`` * ``sgml.BaseSgmlLinkExtractor`` * ``sgml.SgmlLinkExtractor`` Use :class:`LinkExtractor ` instead (:issue:`4356`, :issue:`4679`) Deprecations ~~~~~~~~~~~~ * The ``scrapy.utils.python.retry_on_eintr`` function is now deprecated (:issue:`4683`) New features ~~~~~~~~~~~~ * :ref:`Feed exports ` support :ref:`Google Cloud Storage ` (:issue:`685`, :issue:`3608`) * New :setting:`FEED_EXPORT_BATCH_ITEM_COUNT` setting for batch deliveries (:issue:`4250`, :issue:`4434`) * The :command:`parse` command now allows specifying an output file (:issue:`4317`, :issue:`4377`) * :meth:`.Request.from_curl` and :func:`~scrapy.utils.curl.curl_to_request_kwargs` now also support ``--data-raw`` (:issue:`4612`) * A ``parse`` callback may now be used in built-in spider subclasses, such as :class:`~scrapy.spiders.CrawlSpider` (:issue:`712`, :issue:`732`, :issue:`781`, :issue:`4254` ) Bug fixes ~~~~~~~~~ * Fixed the :ref:`CSV exporting ` of :ref:`dataclass items ` and :ref:`attr.s items ` (:issue:`4667`, :issue:`4668`) * :meth:`.Request.from_curl` and :func:`~scrapy.utils.curl.curl_to_request_kwargs` now set the request method to ``POST`` when a request body is specified and no request method is specified (:issue:`4612`) * The processing of ANSI escape sequences in enabled in Windows 10.0.14393 and later, where it is required for colored output (:issue:`4393`, :issue:`4403`) Documentation ~~~~~~~~~~~~~ * Updated the `OpenSSL cipher list format`_ link in the documentation about the :setting:`DOWNLOADER_CLIENT_TLS_CIPHERS` setting (:issue:`4653`) * Simplified the code example in :ref:`topics-loaders-dataclass` (:issue:`4652`) .. _OpenSSL cipher list format: https://docs.openssl.org/master/man1/openssl-ciphers/#cipher-list-format Quality assurance ~~~~~~~~~~~~~~~~~ * The base implementation of :ref:`item loaders ` has been moved into :doc:`itemloaders ` (:issue:`4005`, :issue:`4516`) * Fixed a silenced error in some scheduler tests (:issue:`4644`, :issue:`4645`) * Renewed the localhost certificate used for SSL tests (:issue:`4650`) * Removed cookie-handling code specific to Python 2 (:issue:`4682`) * Stopped using Python 2 unicode literal syntax (:issue:`4704`) * Stopped using a backlash for line continuation (:issue:`4673`) * Removed unneeded entries from the MyPy exception list (:issue:`4690`) * Automated tests now pass on Windows as part of our continuous integration system (:issue:`4458`) * Automated tests now pass on the latest PyPy version for supported Python versions in our continuous integration system (:issue:`4504`) .. _release-2.2.1: Scrapy 2.2.1 (2020-07-17) ------------------------- * The :command:`startproject` command no longer makes unintended changes to the permissions of files in the destination folder, such as removing execution permissions (:issue:`4662`, :issue:`4666`) .. _release-2.2.0: Scrapy 2.2.0 (2020-06-24) ------------------------- Highlights: * Python 3.5.2+ is required now * :ref:`dataclass objects ` and :ref:`attrs objects ` are now valid :ref:`item types ` * New :meth:`TextResponse.json ` method * New :signal:`bytes_received` signal that allows canceling response download * :class:`~scrapy.downloadermiddlewares.cookies.CookiesMiddleware` fixes Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Support for Python 3.5.0 and 3.5.1 has been dropped; Scrapy now refuses to run with a Python version lower than 3.5.2, which introduced :class:`typing.Type` (:issue:`4615`) Deprecations ~~~~~~~~~~~~ * ``TextResponse.body_as_unicode()`` is now deprecated, use :attr:`TextResponse.text ` instead (:issue:`4546`, :issue:`4555`, :issue:`4579`) * :class:`scrapy.item.BaseItem` is now deprecated, use :class:`scrapy.item.Item` instead (:issue:`4534`) New features ~~~~~~~~~~~~ * :ref:`dataclass objects ` and :ref:`attrs objects ` are now valid :ref:`item types `, and a new itemadapter_ library makes it easy to write code that :ref:`supports any item type ` (:issue:`2749`, :issue:`2807`, :issue:`3761`, :issue:`3881`, :issue:`4642`) * A new :meth:`TextResponse.json ` method allows to deserialize JSON responses (:issue:`2444`, :issue:`4460`, :issue:`4574`) * A new :signal:`bytes_received` signal allows monitoring response download progress and :ref:`stopping downloads ` (:issue:`4205`, :issue:`4559`) * The dictionaries in the result list of a :ref:`media pipeline ` now include a new key, ``status``, which indicates if the file was downloaded or, if the file was not downloaded, why it was not downloaded; see :meth:`FilesPipeline.get_media_requests ` for more information (:issue:`2893`, :issue:`4486`) * When using :ref:`Google Cloud Storage ` for a :ref:`media pipeline `, a warning is now logged if the configured credentials do not grant the required permissions (:issue:`4346`, :issue:`4508`) * :ref:`Link extractors ` are now serializable, as long as you do not use :ref:`lambdas ` for parameters; for example, you can now pass link extractors in :attr:`.Request.cb_kwargs` or :attr:`.Request.meta` when :ref:`persisting scheduled requests ` (:issue:`4554`) * Upgraded the :ref:`pickle protocol ` that Scrapy uses from protocol 2 to protocol 4, improving serialization capabilities and performance (:issue:`4135`, :issue:`4541`) * :func:`scrapy.utils.misc.create_instance` now raises a :exc:`TypeError` exception if the resulting instance is ``None`` (:issue:`4528`, :issue:`4532`) .. _itemadapter: https://github.com/scrapy/itemadapter Bug fixes ~~~~~~~~~ * :class:`~scrapy.downloadermiddlewares.cookies.CookiesMiddleware` no longer discards cookies defined in :attr:`Request.headers ` (:issue:`1992`, :issue:`2400`) * :class:`~scrapy.downloadermiddlewares.cookies.CookiesMiddleware` no longer re-encodes cookies defined as :class:`bytes` in the ``cookies`` parameter of the ``__init__`` method of :class:`~scrapy.Request` (:issue:`2400`, :issue:`3575`) * When :setting:`FEEDS` defines multiple URIs, :setting:`FEED_STORE_EMPTY` is ``False`` and the crawl yields no items, Scrapy no longer stops feed exports after the first URI (:issue:`4621`, :issue:`4626`) * :class:`~scrapy.spiders.Spider` callbacks defined using :doc:`coroutine syntax ` no longer need to return an iterable, and may instead return a :class:`~scrapy.Request` object, an :ref:`item `, or ``None`` (:issue:`4609`) * The :command:`startproject` command now ensures that the generated project folders and files have the right permissions (:issue:`4604`) * Fix a :exc:`KeyError` exception being sometimes raised from :class:`scrapy.utils.datatypes.LocalWeakReferencedCache` (:issue:`4597`, :issue:`4599`) * When :setting:`FEEDS` defines multiple URIs, log messages about items being stored now contain information from the corresponding feed, instead of always containing information about only one of the feeds (:issue:`4619`, :issue:`4629`) Documentation ~~~~~~~~~~~~~ * Added a new section about :ref:`accessing cb_kwargs from errbacks ` (:issue:`4598`, :issue:`4634`) * Covered chompjs_ in :ref:`topics-parsing-javascript` (:issue:`4556`, :issue:`4562`) * Removed from :doc:`topics/coroutines` the warning about the API being experimental (:issue:`4511`, :issue:`4513`) * Removed references to unsupported versions of :doc:`Twisted ` (:issue:`4533`) * Updated the description of the :ref:`screenshot pipeline example `, which now uses :doc:`coroutine syntax ` instead of returning a :class:`~twisted.internet.defer.Deferred` (:issue:`4514`, :issue:`4593`) * Removed a misleading import line from the :func:`scrapy.utils.log.configure_logging` code example (:issue:`4510`, :issue:`4587`) * The display-on-hover behavior of internal documentation references now also covers links to :ref:`commands `, :attr:`.Request.meta` keys, :ref:`settings ` and :ref:`signals ` (:issue:`4495`, :issue:`4563`) * It is again possible to download the documentation for offline reading (:issue:`4578`, :issue:`4585`) * Removed backslashes preceding ``*args`` and ``**kwargs`` in some function and method signatures (:issue:`4592`, :issue:`4596`) .. _chompjs: https://github.com/Nykakin/chompjs Quality assurance ~~~~~~~~~~~~~~~~~ * Adjusted the code base further to our :ref:`style guidelines ` (:issue:`4237`, :issue:`4525`, :issue:`4538`, :issue:`4539`, :issue:`4540`, :issue:`4542`, :issue:`4543`, :issue:`4544`, :issue:`4545`, :issue:`4557`, :issue:`4558`, :issue:`4566`, :issue:`4568`, :issue:`4572`) * Removed remnants of Python 2 support (:issue:`4550`, :issue:`4553`, :issue:`4568`) * Improved code sharing between the :command:`crawl` and :command:`runspider` commands (:issue:`4548`, :issue:`4552`) * Replaced ``chain(*iterable)`` with ``chain.from_iterable(iterable)`` (:issue:`4635`) * You may now run the :mod:`asyncio` tests with Tox on any Python version (:issue:`4521`) * Updated test requirements to reflect an incompatibility with pytest 5.4 and 5.4.1 (:issue:`4588`) * Improved :class:`~scrapy.spiderloader.SpiderLoader` test coverage for scenarios involving duplicate spider names (:issue:`4549`, :issue:`4560`) * Configured Travis CI to also run the tests with Python 3.5.2 (:issue:`4518`, :issue:`4615`) * Added a `Pylint `_ job to Travis CI (:issue:`3727`) * Added a `Mypy `_ job to Travis CI (:issue:`4637`) * Made use of set literals in tests (:issue:`4573`) * Cleaned up the Travis CI configuration (:issue:`4517`, :issue:`4519`, :issue:`4522`, :issue:`4537`) .. _release-2.1.0: Scrapy 2.1.0 (2020-04-24) ------------------------- Highlights: * New :setting:`FEEDS` setting to export to multiple feeds * New :attr:`Response.ip_address ` attribute Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * :exc:`AssertionError` exceptions triggered by :ref:`assert ` statements have been replaced by new exception types, to support running Python in optimized mode (see :option:`-O`) without changing Scrapy’s behavior in any unexpected ways. If you catch an :exc:`AssertionError` exception from Scrapy, update your code to catch the corresponding new exception. (:issue:`4440`) Deprecation removals ~~~~~~~~~~~~~~~~~~~~ * The ``LOG_UNSERIALIZABLE_REQUESTS`` setting is no longer supported, use :setting:`SCHEDULER_DEBUG` instead (:issue:`4385`) * The ``REDIRECT_MAX_METAREFRESH_DELAY`` setting is no longer supported, use :setting:`METAREFRESH_MAXDELAY` instead (:issue:`4385`) * The :class:`~scrapy.downloadermiddlewares.chunked.ChunkedTransferMiddleware` middleware has been removed, including the entire :class:`scrapy.downloadermiddlewares.chunked` module; chunked transfers work out of the box (:issue:`4431`) * The ``spiders`` property has been removed from :class:`~scrapy.crawler.Crawler`, use :class:`CrawlerRunner.spider_loader ` or instantiate :setting:`SPIDER_LOADER_CLASS` with your settings instead (:issue:`4398`) * The ``MultiValueDict``, ``MultiValueDictKeyError``, and ``SiteNode`` classes have been removed from :mod:`scrapy.utils.datatypes` (:issue:`4400`) Deprecations ~~~~~~~~~~~~ * The ``FEED_FORMAT`` and ``FEED_URI`` settings have been deprecated in favor of the new :setting:`FEEDS` setting (:issue:`1336`, :issue:`3858`, :issue:`4507`) New features ~~~~~~~~~~~~ * A new setting, :setting:`FEEDS`, allows configuring multiple output feeds with different settings each (:issue:`1336`, :issue:`3858`, :issue:`4507`) * The :command:`crawl` and :command:`runspider` commands now support multiple ``-o`` parameters (:issue:`1336`, :issue:`3858`, :issue:`4507`) * The :command:`crawl` and :command:`runspider` commands now support specifying an output format by appending ``:`` to the output file (:issue:`1336`, :issue:`3858`, :issue:`4507`) * The new :attr:`Response.ip_address ` attribute gives access to the IP address that originated a response (:issue:`3903`, :issue:`3940`) * A warning is now issued when a value in :attr:`~scrapy.spiders.Spider.allowed_domains` includes a port (:issue:`50`, :issue:`3198`, :issue:`4413`) * Zsh completion now excludes used option aliases from the completion list (:issue:`4438`) Bug fixes ~~~~~~~~~ * :ref:`Request serialization ` no longer breaks for callbacks that are spider attributes which are assigned a function with a different name (:issue:`4500`) * ``None`` values in :attr:`~scrapy.spiders.Spider.allowed_domains` no longer cause a :exc:`TypeError` exception (:issue:`4410`) * Zsh completion no longer allows options after arguments (:issue:`4438`) * zope.interface 5.0.0 and later versions are now supported (:issue:`4447`, :issue:`4448`) * ``Spider.make_requests_from_url``, deprecated in Scrapy 1.4.0, now issues a warning when used (:issue:`4412`) Documentation ~~~~~~~~~~~~~ * Improved the documentation about signals that allow their handlers to return a :class:`~twisted.internet.defer.Deferred` (:issue:`4295`, :issue:`4390`) * Our PyPI entry now includes links for our documentation, our source code repository and our issue tracker (:issue:`4456`) * Covered the `curl2scrapy `_ service in the documentation (:issue:`4206`, :issue:`4455`) * Removed references to the Guppy library, which only works in Python 2 (:issue:`4285`, :issue:`4343`) * Extended use of InterSphinx to link to Python 3 documentation (:issue:`4444`, :issue:`4445`) * Added support for Sphinx 3.0 and later (:issue:`4475`, :issue:`4480`, :issue:`4496`, :issue:`4503`) Quality assurance ~~~~~~~~~~~~~~~~~ * Removed warnings about using old, removed settings (:issue:`4404`) * Removed a warning about importing :class:`~twisted.internet.testing.StringTransport` from ``twisted.test.proto_helpers`` in Twisted 19.7.0 or newer (:issue:`4409`) * Removed outdated Debian package build files (:issue:`4384`) * Removed :class:`object` usage as a base class (:issue:`4430`) * Removed code that added support for old versions of Twisted that we no longer support (:issue:`4472`) * Fixed code style issues (:issue:`4468`, :issue:`4469`, :issue:`4471`, :issue:`4481`) * Removed :func:`twisted.internet.defer.returnValue` calls (:issue:`4443`, :issue:`4446`, :issue:`4489`) .. _release-2.0.1: Scrapy 2.0.1 (2020-03-18) ------------------------- * :meth:`Response.follow_all ` now supports an empty URL iterable as input (:issue:`4408`, :issue:`4420`) * Removed top-level :mod:`~twisted.internet.reactor` imports to prevent errors about the wrong Twisted reactor being installed when setting a different Twisted reactor using :setting:`TWISTED_REACTOR` (:issue:`4401`, :issue:`4406`) * Fixed tests (:issue:`4422`) .. _release-2.0.0: Scrapy 2.0.0 (2020-03-03) ------------------------- Highlights: * Python 2 support has been removed * :doc:`Partial ` :ref:`coroutine syntax ` support and :doc:`experimental ` :mod:`asyncio` support * New :meth:`Response.follow_all ` method * :ref:`FTP support ` for media pipelines * New :attr:`Response.certificate ` attribute * IPv6 support through :setting:`DNS_RESOLVER` Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Python 2 support has been removed, following `Python 2 end-of-life on January 1, 2020`_ (:issue:`4091`, :issue:`4114`, :issue:`4115`, :issue:`4121`, :issue:`4138`, :issue:`4231`, :issue:`4242`, :issue:`4304`, :issue:`4309`, :issue:`4373`) * Retry gaveups (see :setting:`RETRY_TIMES`) are now logged as errors instead of as debug information (:issue:`3171`, :issue:`3566`) * File extensions that :class:`LinkExtractor ` ignores by default now also include ``7z``, ``7zip``, ``apk``, ``bz2``, ``cdr``, ``dmg``, ``ico``, ``iso``, ``tar``, ``tar.gz``, ``webm``, and ``xz`` (:issue:`1837`, :issue:`2067`, :issue:`4066`) * The :setting:`METAREFRESH_IGNORE_TAGS` setting is now an empty list by default, following web browser behavior (:issue:`3844`, :issue:`4311`) * The :class:`~scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware` now includes spaces after commas in the value of the ``Accept-Encoding`` header that it sets, following web browser behavior (:issue:`4293`) * The ``__init__`` method of custom download handlers (see :setting:`DOWNLOAD_HANDLERS`) or subclasses of the following downloader handlers no longer receives a ``settings`` parameter: * :class:`scrapy.core.downloader.handlers.datauri.DataURIDownloadHandler` * :class:`scrapy.core.downloader.handlers.file.FileDownloadHandler` Use the ``from_settings`` or ``from_crawler`` class methods to expose such a parameter to your custom download handlers. (:issue:`4126`) * We have refactored the :class:`scrapy.core.scheduler.Scheduler` class and related queue classes (see :setting:`SCHEDULER_PRIORITY_QUEUE`, :setting:`SCHEDULER_DISK_QUEUE` and :setting:`SCHEDULER_MEMORY_QUEUE`) to make it easier to implement custom scheduler queue classes. See :ref:`2-0-0-scheduler-queue-changes` below for details. * Overridden settings are now logged in a different format. This is more in line with similar information logged at startup (:issue:`4199`) .. _Python 2 end-of-life on January 1, 2020: https://www.python.org/doc/sunset-python-2/ Deprecation removals ~~~~~~~~~~~~~~~~~~~~ * The :ref:`Scrapy shell ` no longer provides a `sel` proxy object, use :meth:`response.selector ` instead (:issue:`4347`) * LevelDB support has been removed (:issue:`4112`) * The following functions have been removed from :mod:`scrapy.utils.python`: ``isbinarytext``, ``is_writable``, ``setattr_default``, ``stringify_dict`` (:issue:`4362`) Deprecations ~~~~~~~~~~~~ * Using environment variables prefixed with ``SCRAPY_`` to override settings is deprecated (:issue:`4300`, :issue:`4374`, :issue:`4375`) * :class:`scrapy.linkextractors.FilteringLinkExtractor` is deprecated, use :class:`scrapy.linkextractors.LinkExtractor ` instead (:issue:`4045`) * The ``noconnect`` query string argument of proxy URLs is deprecated and should be removed from proxy URLs (:issue:`4198`) * The :meth:`next ` method of :class:`scrapy.utils.python.MutableChain` is deprecated, use the global :func:`next` function or :meth:`MutableChain.__next__ ` instead (:issue:`4153`) New features ~~~~~~~~~~~~ * Added :doc:`partial support ` for Python’s :ref:`coroutine syntax ` and :doc:`experimental support ` for :mod:`asyncio` and :mod:`asyncio`-powered libraries (:issue:`4010`, :issue:`4259`, :issue:`4269`, :issue:`4270`, :issue:`4271`, :issue:`4316`, :issue:`4318`) * The new :meth:`Response.follow_all ` method offers the same functionality as :meth:`Response.follow ` but supports an iterable of URLs as input and returns an iterable of requests (:issue:`2582`, :issue:`4057`, :issue:`4286`) * :ref:`Media pipelines ` now support :ref:`FTP storage ` (:issue:`3928`, :issue:`3961`) * The new :attr:`Response.certificate ` attribute exposes the SSL certificate of the server as a :class:`twisted.internet.ssl.Certificate` object for HTTPS responses (:issue:`2726`, :issue:`4054`) * A new :setting:`DNS_RESOLVER` setting allows enabling IPv6 support (:issue:`1031`, :issue:`4227`) * A new :setting:`SCRAPER_SLOT_MAX_ACTIVE_SIZE` setting allows configuring the existing soft limit that pauses request downloads when the total response data being processed is too high (:issue:`1410`, :issue:`3551`) * A new :setting:`TWISTED_REACTOR` setting allows customizing the :mod:`~twisted.internet.reactor` that Scrapy uses, allowing to :doc:`enable asyncio support ` or deal with a :ref:`common macOS issue ` (:issue:`2905`, :issue:`4294`) * Scheduler disk and memory queues may now use the class methods ``from_crawler`` or ``from_settings`` (:issue:`3884`) * The new :attr:`Response.cb_kwargs ` attribute serves as a shortcut for :attr:`Response.request.cb_kwargs ` (:issue:`4331`) * :meth:`Response.follow ` now supports a ``flags`` parameter, for consistency with :class:`~scrapy.Request` (:issue:`4277`, :issue:`4279`) * :ref:`Item loader processors ` can now be regular functions, they no longer need to be methods (:issue:`3899`) * :class:`~scrapy.spiders.Rule` now accepts an ``errback`` parameter (:issue:`4000`) * :class:`~scrapy.Request` no longer requires a ``callback`` parameter when an ``errback`` parameter is specified (:issue:`3586`, :issue:`4008`) * :class:`~scrapy.logformatter.LogFormatter` now supports some additional methods: * :class:`~scrapy.logformatter.LogFormatter.download_error` for download errors * :class:`~scrapy.logformatter.LogFormatter.item_error` for exceptions raised during item processing by :ref:`item pipelines ` * :class:`~scrapy.logformatter.LogFormatter.spider_error` for exceptions raised from :ref:`spider callbacks ` (:issue:`374`, :issue:`3986`, :issue:`3989`, :issue:`4176`, :issue:`4188`) * The :setting:`FEED_URI` setting now supports :class:`pathlib.Path` values (:issue:`3731`, :issue:`4074`) * A new :signal:`request_left_downloader` signal is sent when a request leaves the downloader (:issue:`4303`) * Scrapy logs a warning when it detects a request callback or errback that uses ``yield`` but also returns a value, since the returned value would be lost (:issue:`3484`, :issue:`3869`) * :class:`~scrapy.spiders.Spider` objects now raise an :exc:`AttributeError` exception if they do not have a :class:`~scrapy.spiders.Spider.start_urls` attribute nor reimplement ``scrapy.spiders.Spider.start_requests()``, but have a ``start_url`` attribute (:issue:`4133`, :issue:`4170`) * :class:`~scrapy.exporters.BaseItemExporter` subclasses may now use ``super().__init__(**kwargs)`` instead of ``self._configure(kwargs)`` in their ``__init__`` method, passing ``dont_fail=True`` to the parent ``__init__`` method if needed, and accessing ``kwargs`` at ``self._kwargs`` after calling their parent ``__init__`` method (:issue:`4193`, :issue:`4370`) * A new ``keep_fragments`` parameter of ``scrapy.utils.request.request_fingerprint`` allows to generate different fingerprints for requests with different fragments in their URL (:issue:`4104`) * Download handlers (see :setting:`DOWNLOAD_HANDLERS`) may now use the ``from_settings`` and ``from_crawler`` class methods that other Scrapy components already supported (:issue:`4126`) * :class:`scrapy.utils.python.MutableChain.__iter__` now returns ``self``, `allowing it to be used as a sequence `_ (:issue:`4153`) Bug fixes ~~~~~~~~~ * The :command:`crawl` command now also exits with exit code 1 when an exception happens before the crawling starts (:issue:`4175`, :issue:`4207`) * :class:`LinkExtractor.extract_links ` no longer re-encodes the query string or URLs from non-UTF-8 responses in UTF-8 (:issue:`998`, :issue:`1403`, :issue:`1949`, :issue:`4321`) * The first spider middleware (see :setting:`SPIDER_MIDDLEWARES`) now also processes exceptions raised from callbacks that are generators (:issue:`4260`, :issue:`4272`) * Redirects to URLs starting with 3 slashes (``///``) are now supported (:issue:`4032`, :issue:`4042`) * :class:`~scrapy.Request` no longer accepts strings as ``url`` simply because they have a colon (:issue:`2552`, :issue:`4094`) * The correct encoding is now used for attach names in :class:`~scrapy.mail.MailSender` (:issue:`4229`, :issue:`4239`) * :class:`~scrapy.dupefilters.RFPDupeFilter`, the default :setting:`DUPEFILTER_CLASS`, no longer writes an extra ``\r`` character on each line in Windows, which made the size of the ``requests.seen`` file unnecessarily large on that platform (:issue:`4283`) * Z shell auto-completion now looks for ``.html`` files, not ``.http`` files, and covers the ``-h`` command-line switch (:issue:`4122`, :issue:`4291`) * Adding items to a :class:`scrapy.utils.datatypes.LocalCache` object without a ``limit`` defined no longer raises a :exc:`TypeError` exception (:issue:`4123`) * Fixed a typo in the message of the :exc:`ValueError` exception raised when :func:`scrapy.utils.misc.create_instance` gets both ``settings`` and ``crawler`` set to ``None`` (:issue:`4128`) Documentation ~~~~~~~~~~~~~ * API documentation now links to an online, syntax-highlighted view of the corresponding source code (:issue:`4148`) * Links to unexisting documentation pages now allow access to the sidebar (:issue:`4152`, :issue:`4169`) * Cross-references within our documentation now display a tooltip when hovered (:issue:`4173`, :issue:`4183`) * Improved the documentation about :meth:`LinkExtractor.extract_links ` and simplified :ref:`topics-link-extractors` (:issue:`4045`) * Clarified how :class:`ItemLoader.item ` works (:issue:`3574`, :issue:`4099`) * Clarified that :func:`logging.basicConfig` should not be used when also using :class:`~scrapy.crawler.CrawlerProcess` (:issue:`2149`, :issue:`2352`, :issue:`3146`, :issue:`3960`) * Clarified the requirements for :class:`~scrapy.Request` objects :ref:`when using persistence ` (:issue:`4124`, :issue:`4139`) * Clarified how to install a :ref:`custom image pipeline ` (:issue:`4034`, :issue:`4252`) * Fixed the signatures of the ``file_path`` method in :ref:`media pipeline ` examples (:issue:`4290`) * Covered a backward-incompatible change in Scrapy 1.7.0 affecting custom :class:`scrapy.core.scheduler.Scheduler` subclasses (:issue:`4274`) * Improved the ``README.rst`` and ``CODE_OF_CONDUCT.md`` files (:issue:`4059`) * Documentation examples are now checked as part of our test suite and we have fixed some of the issues detected (:issue:`4142`, :issue:`4146`, :issue:`4171`, :issue:`4184`, :issue:`4190`) * Fixed logic issues, broken links and typos (:issue:`4247`, :issue:`4258`, :issue:`4282`, :issue:`4288`, :issue:`4305`, :issue:`4308`, :issue:`4323`, :issue:`4338`, :issue:`4359`, :issue:`4361`) * Improved consistency when referring to the ``__init__`` method of an object (:issue:`4086`, :issue:`4088`) * Fixed an inconsistency between code and output in :ref:`intro-overview` (:issue:`4213`) * Extended :mod:`~sphinx.ext.intersphinx` usage (:issue:`4147`, :issue:`4172`, :issue:`4185`, :issue:`4194`, :issue:`4197`) * We now use a recent version of Python to build the documentation (:issue:`4140`, :issue:`4249`) * Cleaned up documentation (:issue:`4143`, :issue:`4275`) Quality assurance ~~~~~~~~~~~~~~~~~ * Re-enabled proxy ``CONNECT`` tests (:issue:`2545`, :issue:`4114`) * Added Bandit_ security checks to our test suite (:issue:`4162`, :issue:`4181`) * Added Flake8_ style checks to our test suite and applied many of the corresponding changes (:issue:`3944`, :issue:`3945`, :issue:`4137`, :issue:`4157`, :issue:`4167`, :issue:`4174`, :issue:`4186`, :issue:`4195`, :issue:`4238`, :issue:`4246`, :issue:`4355`, :issue:`4360`, :issue:`4365`) * Improved test coverage (:issue:`4097`, :issue:`4218`, :issue:`4236`) * Started reporting slowest tests, and improved the performance of some of them (:issue:`4163`, :issue:`4164`) * Fixed broken tests and refactored some tests (:issue:`4014`, :issue:`4095`, :issue:`4244`, :issue:`4268`, :issue:`4372`) * Modified the :doc:`tox ` configuration to allow running tests with any Python version, run Bandit_ and Flake8_ tests by default, and enforce a minimum tox version programmatically (:issue:`4179`) * Cleaned up code (:issue:`3937`, :issue:`4208`, :issue:`4209`, :issue:`4210`, :issue:`4212`, :issue:`4369`, :issue:`4376`, :issue:`4378`) .. _Bandit: https://bandit.readthedocs.io/en/latest/ .. _Flake8: https://flake8.pycqa.org/en/latest/ .. _2-0-0-scheduler-queue-changes: Changes to scheduler queue classes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following changes may impact any custom queue classes of all types: * The ``push`` method no longer receives a second positional parameter containing ``request.priority * -1``. If you need that value, get it from the first positional parameter, ``request``, instead, or use the new :meth:`~scrapy.core.scheduler.ScrapyPriorityQueue.priority` method in :class:`scrapy.core.scheduler.ScrapyPriorityQueue` subclasses. The following changes may impact custom priority queue classes: * In the ``__init__`` method or the ``from_crawler`` or ``from_settings`` class methods: * The parameter that used to contain a factory function, ``qfactory``, is now passed as a keyword parameter named ``downstream_queue_cls``. * A new keyword parameter has been added: ``key``. It is a string that is always an empty string for memory queues and indicates the :setting:`JOB_DIR` value for disk queues. * The parameter for disk queues that contains data from the previous crawl, ``startprios`` or ``slot_startprios``, is now passed as a keyword parameter named ``startprios``. * The ``serialize`` parameter is no longer passed. The disk queue class must take care of request serialization on its own before writing to disk, using the :func:`~scrapy.utils.reqser.request_to_dict` and :func:`~scrapy.utils.reqser.request_from_dict` functions from the :mod:`scrapy.utils.reqser` module. The following changes may impact custom disk and memory queue classes: * The signature of the ``__init__`` method is now ``__init__(self, crawler, key)``. The following changes affect specifically the :class:`~scrapy.core.scheduler.ScrapyPriorityQueue` and :class:`~scrapy.core.scheduler.DownloaderAwarePriorityQueue` classes from :mod:`scrapy.core.scheduler` and may affect subclasses: * In the ``__init__`` method, most of the changes described above apply. ``__init__`` may still receive all parameters as positional parameters, however: * ``downstream_queue_cls``, which replaced ``qfactory``, must be instantiated differently. ``qfactory`` was instantiated with a priority value (integer). Instances of ``downstream_queue_cls`` should be created using the new :meth:`ScrapyPriorityQueue.qfactory ` or :meth:`DownloaderAwarePriorityQueue.pqfactory ` methods. * The new ``key`` parameter displaced the ``startprios`` parameter 1 position to the right. * The following class attributes have been added: * :attr:`~scrapy.core.scheduler.ScrapyPriorityQueue.crawler` * :attr:`~scrapy.core.scheduler.ScrapyPriorityQueue.downstream_queue_cls` (details above) * :attr:`~scrapy.core.scheduler.ScrapyPriorityQueue.key` (details above) * The ``serialize`` attribute has been removed (details above) The following changes affect specifically the :class:`~scrapy.core.scheduler.ScrapyPriorityQueue` class and may affect subclasses: * A new :meth:`~scrapy.core.scheduler.ScrapyPriorityQueue.priority` method has been added which, given a request, returns ``request.priority * -1``. It is used in :meth:`~scrapy.core.scheduler.ScrapyPriorityQueue.push` to make up for the removal of its ``priority`` parameter. * The ``spider`` attribute has been removed. Use :attr:`crawler.spider ` instead. The following changes affect specifically the :class:`~scrapy.core.scheduler.DownloaderAwarePriorityQueue` class and may affect subclasses: * A new :attr:`~scrapy.core.scheduler.DownloaderAwarePriorityQueue.pqueues` attribute offers a mapping of downloader slot names to the corresponding instances of :attr:`~scrapy.core.scheduler.DownloaderAwarePriorityQueue.downstream_queue_cls`. (:issue:`3884`) .. _release-1.8.4: Scrapy 1.8.4 (2024-02-14) ------------------------- **Security bug fixes:** - Due to its `ReDoS vulnerabilities`_, ``scrapy.utils.iterators.xmliter`` is now deprecated in favor of :func:`~scrapy.utils.iterators.xmliter_lxml`, which :class:`~scrapy.spiders.XMLFeedSpider` now uses. To minimize the impact of this change on existing code, :func:`~scrapy.utils.iterators.xmliter_lxml` now supports indicating the node namespace as a prefix in the node name, and big files with highly nested trees when using libxml2 2.7+. Please, see the `cc65-xxvf-f7r9 security advisory`_ for more information. - :setting:`DOWNLOAD_MAXSIZE` and :setting:`DOWNLOAD_WARNSIZE` now also apply to the decompressed response body. Please, see the `7j7m-v7m3-jqm7 security advisory`_ for more information. - Also in relation with the `7j7m-v7m3-jqm7 security advisory`_, use of the ``scrapy.downloadermiddlewares.decompression`` module is discouraged and will trigger a warning. - The ``Authorization`` header is now dropped on redirects to a different domain. Please, see the `cw9j-q3vf-hrrv security advisory`_ for more information. .. _cw9j-q3vf-hrrv security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-cw9j-q3vf-hrrv .. _release-1.8.3: Scrapy 1.8.3 (2022-07-25) ------------------------- **Security bug fix:** - When :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` processes a request with :reqmeta:`proxy` metadata, and that :reqmeta:`proxy` metadata includes proxy credentials, :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` sets the ``Proxy-Authorization`` header, but only if that header is not already set. There are third-party proxy-rotation downloader middlewares that set different :reqmeta:`proxy` metadata every time they process a request. Because of request retries and redirects, the same request can be processed by downloader middlewares more than once, including both :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` and any third-party proxy-rotation downloader middleware. These third-party proxy-rotation downloader middlewares could change the :reqmeta:`proxy` metadata of a request to a new value, but fail to remove the ``Proxy-Authorization`` header from the previous value of the :reqmeta:`proxy` metadata, causing the credentials of one proxy to be sent to a different proxy. To prevent the unintended leaking of proxy credentials, the behavior of :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` is now as follows when processing a request: - If the request being processed defines :reqmeta:`proxy` metadata that includes credentials, the ``Proxy-Authorization`` header is always updated to feature those credentials. - If the request being processed defines :reqmeta:`proxy` metadata without credentials, the ``Proxy-Authorization`` header is removed *unless* it was originally defined for the same proxy URL. To remove proxy credentials while keeping the same proxy URL, remove the ``Proxy-Authorization`` header. - If the request has no :reqmeta:`proxy` metadata, or that metadata is a falsy value (e.g. ``None``), the ``Proxy-Authorization`` header is removed. It is no longer possible to set a proxy URL through the :reqmeta:`proxy` metadata but set the credentials through the ``Proxy-Authorization`` header. Set proxy credentials through the :reqmeta:`proxy` metadata instead. .. _release-1.8.2: Scrapy 1.8.2 (2022-03-01) ------------------------- **Security bug fixes:** - When a :class:`~scrapy.Request` object with cookies defined gets a redirect response causing a new :class:`~scrapy.Request` object to be scheduled, the cookies defined in the original :class:`~scrapy.Request` object are no longer copied into the new :class:`~scrapy.Request` object. If you manually set the ``Cookie`` header on a :class:`~scrapy.Request` object and the domain name of the redirect URL is not an exact match for the domain of the URL of the original :class:`~scrapy.Request` object, your ``Cookie`` header is now dropped from the new :class:`~scrapy.Request` object. The old behavior could be exploited by an attacker to gain access to your cookies. Please, see the `cjvr-mfj7-j4j8 security advisory`_ for more information. .. _cjvr-mfj7-j4j8 security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-cjvr-mfj7-j4j8 .. note:: It is still possible to enable the sharing of cookies between different domains with a shared domain suffix (e.g. ``example.com`` and any subdomain) by defining the shared domain suffix (e.g. ``example.com``) as the cookie domain when defining your cookies. See the documentation of the :class:`~scrapy.Request` class for more information. - When the domain of a cookie, either received in the ``Set-Cookie`` header of a response or defined in a :class:`~scrapy.Request` object, is set to a `public suffix `_, the cookie is now ignored unless the cookie domain is the same as the request domain. The old behavior could be exploited by an attacker to inject cookies into your requests to some other domains. Please, see the `mfjm-vh54-3f96 security advisory`_ for more information. .. _mfjm-vh54-3f96 security advisory: https://github.com/scrapy/scrapy/security/advisories/GHSA-mfjm-vh54-3f96 .. _release-1.8.1: Scrapy 1.8.1 (2021-10-05) ------------------------- * **Security bug fix:** If you use :class:`~scrapy.downloadermiddlewares.httpauth.HttpAuthMiddleware` (i.e. the ``http_user`` and ``http_pass`` spider attributes) for HTTP authentication, any request exposes your credentials to the request target. To prevent unintended exposure of authentication credentials to unintended domains, you must now additionally set a new, additional spider attribute, ``http_auth_domain``, and point it to the specific domain to which the authentication credentials must be sent. If the ``http_auth_domain`` spider attribute is not set, the domain of the first request will be considered the HTTP authentication target, and authentication credentials will only be sent in requests targeting that domain. If you need to send the same HTTP authentication credentials to multiple domains, you can use :func:`w3lib.http.basic_auth_header` instead to set the value of the ``Authorization`` header of your requests. If you *really* want your spider to send the same HTTP authentication credentials to any domain, set the ``http_auth_domain`` spider attribute to ``None``. Finally, if you are a user of `scrapy-splash`_, know that this version of Scrapy breaks compatibility with scrapy-splash 0.7.2 and earlier. You will need to upgrade scrapy-splash to a greater version for it to continue to work. .. _scrapy-splash: https://github.com/scrapy-plugins/scrapy-splash .. _release-1.8.0: Scrapy 1.8.0 (2019-10-28) ------------------------- Highlights: * Dropped Python 3.4 support and updated minimum requirements; made Python 3.8 support official * New :meth:`.Request.from_curl` class method * New :setting:`ROBOTSTXT_PARSER` and :setting:`ROBOTSTXT_USER_AGENT` settings * New :setting:`DOWNLOADER_CLIENT_TLS_CIPHERS` and :setting:`DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING` settings Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Python 3.4 is no longer supported, and some of the minimum requirements of Scrapy have also changed: * :doc:`cssselect ` 0.9.1 * cryptography_ 2.0 * lxml_ 3.5.0 * pyOpenSSL_ 16.2.0 * queuelib_ 1.4.2 * service_identity_ 16.0.0 * six_ 1.10.0 * Twisted_ 17.9.0 (16.0.0 with Python 2) * zope.interface_ 4.1.3 (:issue:`3892`) * ``JSONRequest`` is now called :class:`~scrapy.http.JsonRequest` for consistency with similar classes (:issue:`3929`, :issue:`3982`) * If you are using a custom context factory (:setting:`DOWNLOADER_CLIENTCONTEXTFACTORY`), its ``__init__`` method must accept two new parameters: ``tls_verbose_logging`` and ``tls_ciphers`` (:issue:`2111`, :issue:`3392`, :issue:`3442`, :issue:`3450`) * :class:`~scrapy.loader.ItemLoader` now turns the values of its input item into lists: .. code-block:: pycon >>> item = MyItem() >>> item["field"] = "value1" >>> loader = ItemLoader(item=item) >>> item["field"] ['value1'] This is needed to allow adding values to existing fields (``loader.add_value('field', 'value2')``). (:issue:`3804`, :issue:`3819`, :issue:`3897`, :issue:`3976`, :issue:`3998`, :issue:`4036`) See also :ref:`1.8-deprecation-removals` below. New features ~~~~~~~~~~~~ * A new :meth:`Request.from_curl ` class method allows :ref:`creating a request from a cURL command ` (:issue:`2985`, :issue:`3862`) * A new :setting:`ROBOTSTXT_PARSER` setting allows choosing which robots.txt_ parser to use. It includes built-in support for :ref:`RobotFileParser `, :ref:`Protego ` (default), Reppy, and :ref:`Robotexclusionrulesparser `, and allows you to :ref:`implement support for additional parsers ` (:issue:`754`, :issue:`2669`, :issue:`3796`, :issue:`3935`, :issue:`3969`, :issue:`4006`) * A new :setting:`ROBOTSTXT_USER_AGENT` setting allows defining a separate user agent string to use for robots.txt_ parsing (:issue:`3931`, :issue:`3966`) * :class:`~scrapy.spiders.Rule` no longer requires a :class:`LinkExtractor ` parameter (:issue:`781`, :issue:`4016`) * Use the new :setting:`DOWNLOADER_CLIENT_TLS_CIPHERS` setting to customize the TLS/SSL ciphers used by the default HTTP/1.1 downloader (:issue:`3392`, :issue:`3442`) * Set the new :setting:`DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING` setting to ``True`` to enable debug-level messages about TLS connection parameters after establishing HTTPS connections (:issue:`2111`, :issue:`3450`) * Callbacks that receive keyword arguments (see :attr:`.Request.cb_kwargs`) can now be tested using the new :class:`@cb_kwargs ` :ref:`spider contract ` (:issue:`3985`, :issue:`3988`) * When a :class:`@scrapes ` spider contract fails, all missing fields are now reported (:issue:`766`, :issue:`3939`) * :ref:`Custom log formats ` can now drop messages by having the corresponding methods of the configured :setting:`LOG_FORMATTER` return ``None`` (:issue:`3984`, :issue:`3987`) * A much improved completion definition is now available for Zsh_ (:issue:`4069`) Bug fixes ~~~~~~~~~ * :meth:`ItemLoader.load_item() ` no longer makes later calls to :meth:`ItemLoader.get_output_value() ` or :meth:`ItemLoader.load_item() ` return empty data (:issue:`3804`, :issue:`3819`, :issue:`3897`, :issue:`3976`, :issue:`3998`, :issue:`4036`) * Fixed :class:`~scrapy.statscollectors.DummyStatsCollector` raising a :exc:`TypeError` exception (:issue:`4007`, :issue:`4052`) * :meth:`FilesPipeline.file_path ` and :meth:`ImagesPipeline.file_path ` no longer choose file extensions that are not `registered with IANA`_ (:issue:`1287`, :issue:`3953`, :issue:`3954`) * When using botocore_ to persist files in S3, all botocore-supported headers are properly mapped now (:issue:`3904`, :issue:`3905`) * FTP passwords in :setting:`FEED_URI` containing percent-escaped characters are now properly decoded (:issue:`3941`) * A memory-handling and error-handling issue in :func:`scrapy.utils.ssl.get_temp_key_info` has been fixed (:issue:`3920`) Documentation ~~~~~~~~~~~~~ * The documentation now covers how to define and configure a :ref:`custom log format ` (:issue:`3616`, :issue:`3660`) * API documentation added for :class:`~scrapy.exporters.MarshalItemExporter` and :class:`~scrapy.exporters.PythonItemExporter` (:issue:`3973`) * API documentation added for :class:`~scrapy.item.BaseItem` and :class:`~scrapy.item.ItemMeta` (:issue:`3999`) * Minor documentation fixes (:issue:`2998`, :issue:`3398`, :issue:`3597`, :issue:`3894`, :issue:`3934`, :issue:`3978`, :issue:`3993`, :issue:`4022`, :issue:`4028`, :issue:`4033`, :issue:`4046`, :issue:`4050`, :issue:`4055`, :issue:`4056`, :issue:`4061`, :issue:`4072`, :issue:`4071`, :issue:`4079`, :issue:`4081`, :issue:`4089`, :issue:`4093`) .. _1.8-deprecation-removals: Deprecation removals ~~~~~~~~~~~~~~~~~~~~ * ``scrapy.xlib`` has been removed (:issue:`4015`) .. _1.8-deprecations: Deprecations ~~~~~~~~~~~~ * The LevelDB_ storage backend (``scrapy.extensions.httpcache.LeveldbCacheStorage``) of :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware` is deprecated (:issue:`4085`, :issue:`4092`) * Use of the undocumented ``SCRAPY_PICKLED_SETTINGS_TO_OVERRIDE`` environment variable is deprecated (:issue:`3910`) * ``scrapy.item.DictItem`` is deprecated, use :class:`~scrapy.item.Item` instead (:issue:`3999`) Other changes ~~~~~~~~~~~~~ * Minimum versions of optional Scrapy requirements that are covered by continuous integration tests have been updated: * botocore_ 1.3.23 * Pillow_ 3.4.2 Lower versions of these optional requirements may work, but it is not guaranteed (:issue:`3892`) * GitHub templates for bug reports and feature requests (:issue:`3126`, :issue:`3471`, :issue:`3749`, :issue:`3754`) * Continuous integration fixes (:issue:`3923`) * Code cleanup (:issue:`3391`, :issue:`3907`, :issue:`3946`, :issue:`3950`, :issue:`4023`, :issue:`4031`) .. _release-1.7.4: Scrapy 1.7.4 (2019-10-21) ------------------------- Revert the fix for :issue:`3804` (:issue:`3819`), which has a few undesired side effects (:issue:`3897`, :issue:`3976`). As a result, when an item loader is initialized with an item, :meth:`ItemLoader.load_item() ` once again makes later calls to :meth:`ItemLoader.get_output_value() ` or :meth:`ItemLoader.load_item() ` return empty data. .. _release-1.7.3: Scrapy 1.7.3 (2019-08-01) ------------------------- Enforce lxml 4.3.5 or lower for Python 3.4 (:issue:`3912`, :issue:`3918`). .. _release-1.7.2: Scrapy 1.7.2 (2019-07-23) ------------------------- Fix Python 2 support (:issue:`3889`, :issue:`3893`, :issue:`3896`). .. _release-1.7.1: Scrapy 1.7.1 (2019-07-18) ------------------------- Re-packaging of Scrapy 1.7.0, which was missing some changes in PyPI. .. _release-1.7.0: Scrapy 1.7.0 (2019-07-18) ------------------------- .. note:: Make sure you install Scrapy 1.7.1. The Scrapy 1.7.0 package in PyPI is the result of an erroneous commit tagging and does not include all the changes described below. Highlights: * Improvements for crawls targeting multiple domains * A cleaner way to pass arguments to callbacks * A new class for JSON requests * Improvements for rule-based spiders * New features for feed exports Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ``429`` is now part of the :setting:`RETRY_HTTP_CODES` setting by default This change is **backward incompatible**. If you don’t want to retry ``429``, you must override :setting:`RETRY_HTTP_CODES` accordingly. * :class:`~scrapy.crawler.Crawler`, :class:`CrawlerRunner.crawl ` and :class:`CrawlerRunner.create_crawler ` no longer accept a :class:`~scrapy.spiders.Spider` subclass instance, they only accept a :class:`~scrapy.spiders.Spider` subclass now. :class:`~scrapy.spiders.Spider` subclass instances were never meant to work, and they were not working as one would expect: instead of using the passed :class:`~scrapy.spiders.Spider` subclass instance, their :class:`~scrapy.spiders.Spider.from_crawler` method was called to generate a new instance. * Non-default values for the :setting:`SCHEDULER_PRIORITY_QUEUE` setting may stop working. Scheduler priority queue classes now need to handle :class:`~scrapy.Request` objects instead of arbitrary Python data structures. * An additional ``crawler`` parameter has been added to the ``__init__`` method of the :class:`~scrapy.core.scheduler.Scheduler` class. Custom scheduler subclasses which don't accept arbitrary parameters in their ``__init__`` method might break because of this change. For more information, see :setting:`SCHEDULER`. See also :ref:`1.7-deprecation-removals` below. New features ~~~~~~~~~~~~ * A new scheduler priority queue, ``scrapy.pqueues.DownloaderAwarePriorityQueue``, may be :ref:`enabled ` for a significant scheduling improvement on crawls targeting multiple web domains, at the cost of no :setting:`CONCURRENT_REQUESTS_PER_IP` support (:issue:`3520`) * A new :attr:`.Request.cb_kwargs` attribute provides a cleaner way to pass keyword arguments to callback methods (:issue:`1138`, :issue:`3563`) * A new :class:`JSONRequest ` class offers a more convenient way to build JSON requests (:issue:`3504`, :issue:`3505`) * A ``process_request`` callback passed to the :class:`~scrapy.spiders.Rule` ``__init__`` method now receives the :class:`~scrapy.http.Response` object that originated the request as its second argument (:issue:`3682`) * A new ``restrict_text`` parameter for the :attr:`LinkExtractor ` ``__init__`` method allows filtering links by linking text (:issue:`3622`, :issue:`3635`) * A new :setting:`FEED_STORAGE_S3_ACL` setting allows defining a custom ACL for feeds exported to Amazon S3 (:issue:`3607`) * A new :setting:`FEED_STORAGE_FTP_ACTIVE` setting allows using FTP’s active connection mode for feeds exported to FTP servers (:issue:`3829`) * A new :setting:`METAREFRESH_IGNORE_TAGS` setting allows overriding which HTML tags are ignored when searching a response for HTML meta tags that trigger a redirect (:issue:`1422`, :issue:`3768`) * A new :reqmeta:`redirect_reasons` request meta key exposes the reason (status code, meta refresh) behind every followed redirect (:issue:`3581`, :issue:`3687`) * The ``SCRAPY_CHECK`` variable is now set to the ``true`` string during runs of the :command:`check` command, which allows :ref:`detecting contract check runs from code ` (:issue:`3704`, :issue:`3739`) * A new :meth:`Item.deepcopy() ` method makes it easier to :ref:`deep-copy items ` (:issue:`1493`, :issue:`3671`) * :class:`~scrapy.extensions.corestats.CoreStats` also logs ``elapsed_time_seconds`` now (:issue:`3638`) * Exceptions from :class:`~scrapy.loader.ItemLoader` :ref:`input and output processors ` are now more verbose (:issue:`3836`, :issue:`3840`) * :class:`~scrapy.crawler.Crawler`, :class:`CrawlerRunner.crawl ` and :class:`CrawlerRunner.create_crawler ` now fail gracefully if they receive a :class:`~scrapy.spiders.Spider` subclass instance instead of the subclass itself (:issue:`2283`, :issue:`3610`, :issue:`3872`) Bug fixes ~~~~~~~~~ * :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_exception` is now also invoked for generators (:issue:`220`, :issue:`2061`) * System exceptions like KeyboardInterrupt_ are no longer caught (:issue:`3726`) * :meth:`ItemLoader.load_item() ` no longer makes later calls to :meth:`ItemLoader.get_output_value() ` or :meth:`ItemLoader.load_item() ` return empty data (:issue:`3804`, :issue:`3819`) * The images pipeline (:class:`~scrapy.pipelines.images.ImagesPipeline`) no longer ignores these Amazon S3 settings: :setting:`AWS_ENDPOINT_URL`, :setting:`AWS_REGION_NAME`, :setting:`AWS_USE_SSL`, :setting:`AWS_VERIFY` (:issue:`3625`) * Fixed a memory leak in ``scrapy.pipelines.media.MediaPipeline`` affecting, for example, non-200 responses and exceptions from custom middlewares (:issue:`3813`) * Requests with private callbacks are now correctly unserialized from disk (:issue:`3790`) * :meth:`.FormRequest.from_response` now handles invalid methods like major web browsers (:issue:`3777`, :issue:`3794`) Documentation ~~~~~~~~~~~~~ * A new topic, :ref:`topics-dynamic-content`, covers recommended approaches to read dynamically-loaded data (:issue:`3703`) * :ref:`topics-broad-crawls` now features information about memory usage (:issue:`1264`, :issue:`3866`) * The documentation of :class:`~scrapy.spiders.Rule` now covers how to access the text of a link when using :class:`~scrapy.spiders.CrawlSpider` (:issue:`3711`, :issue:`3712`) * A new section, :ref:`httpcache-storage-custom`, covers writing a custom cache storage backend for :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware` (:issue:`3683`, :issue:`3692`) * A new :ref:`FAQ ` entry, :ref:`faq-split-item`, explains what to do when you want to split an item into multiple items from an item pipeline (:issue:`2240`, :issue:`3672`) * Updated the :ref:`FAQ entry about crawl order ` to explain why the first few requests rarely follow the desired order (:issue:`1739`, :issue:`3621`) * The :setting:`LOGSTATS_INTERVAL` setting (:issue:`3730`), the :meth:`FilesPipeline.file_path ` and :meth:`ImagesPipeline.file_path ` methods (:issue:`2253`, :issue:`3609`) and the :meth:`Crawler.stop() ` method (:issue:`3842`) are now documented * Some parts of the documentation that were confusing or misleading are now clearer (:issue:`1347`, :issue:`1789`, :issue:`2289`, :issue:`3069`, :issue:`3615`, :issue:`3626`, :issue:`3668`, :issue:`3670`, :issue:`3673`, :issue:`3728`, :issue:`3762`, :issue:`3861`, :issue:`3882`) * Minor documentation fixes (:issue:`3648`, :issue:`3649`, :issue:`3662`, :issue:`3674`, :issue:`3676`, :issue:`3694`, :issue:`3724`, :issue:`3764`, :issue:`3767`, :issue:`3791`, :issue:`3797`, :issue:`3806`, :issue:`3812`) .. _1.7-deprecation-removals: Deprecation removals ~~~~~~~~~~~~~~~~~~~~ The following deprecated APIs have been removed (:issue:`3578`): * ``scrapy.conf`` (use :attr:`Crawler.settings `) * From ``scrapy.core.downloader.handlers``: * ``http.HttpDownloadHandler`` (use ``http10.HTTP10DownloadHandler``) * ``scrapy.loader.ItemLoader._get_values`` (use ``_get_xpathvalues``) * ``scrapy.loader.XPathItemLoader`` (use :class:`~scrapy.loader.ItemLoader`) * ``scrapy.log`` (see :ref:`topics-logging`) * From ``scrapy.pipelines``: * ``files.FilesPipeline.file_key`` (use ``file_path``) * ``images.ImagesPipeline.file_key`` (use ``file_path``) * ``images.ImagesPipeline.image_key`` (use ``file_path``) * ``images.ImagesPipeline.thumb_key`` (use ``thumb_path``) * From both ``scrapy.selector`` and ``scrapy.selector.lxmlsel``: * ``HtmlXPathSelector`` (use :class:`~scrapy.Selector`) * ``XmlXPathSelector`` (use :class:`~scrapy.Selector`) * ``XPathSelector`` (use :class:`~scrapy.Selector`) * ``XPathSelectorList`` (use :class:`~scrapy.Selector`) * From ``scrapy.selector.csstranslator``: * ``ScrapyGenericTranslator`` (use parsel.csstranslator.GenericTranslator_) * ``ScrapyHTMLTranslator`` (use parsel.csstranslator.HTMLTranslator_) * ``ScrapyXPathExpr`` (use parsel.csstranslator.XPathExpr_) * From :class:`~scrapy.Selector`: * ``_root`` (both the ``__init__`` method argument and the object property, use ``root``) * ``extract_unquoted`` (use ``getall``) * ``select`` (use ``xpath``) * From :class:`~scrapy.selector.SelectorList`: * ``extract_unquoted`` (use ``getall``) * ``select`` (use ``xpath``) * ``x`` (use ``xpath``) * ``scrapy.spiders.BaseSpider`` (use :class:`~scrapy.spiders.Spider`) * From :class:`~scrapy.spiders.Spider` (and subclasses): * ``DOWNLOAD_DELAY`` (use :ref:`download_delay `) * ``set_crawler`` (use :meth:`~scrapy.spiders.Spider.from_crawler`) * ``scrapy.spiders.spiders`` (use :class:`~scrapy.spiderloader.SpiderLoader`) * ``scrapy.telnet`` (use :mod:`scrapy.extensions.telnet`) * From ``scrapy.utils.python``: * ``str_to_unicode`` (use ``to_unicode``) * ``unicode_to_str`` (use ``to_bytes``) * ``scrapy.utils.response.body_or_str`` The following deprecated settings have also been removed (:issue:`3578`): * ``SPIDER_MANAGER_CLASS`` (use :setting:`SPIDER_LOADER_CLASS`) .. _1.7-deprecations: Deprecations ~~~~~~~~~~~~ * The ``queuelib.PriorityQueue`` value for the :setting:`SCHEDULER_PRIORITY_QUEUE` setting is deprecated. Use ``scrapy.pqueues.ScrapyPriorityQueue`` instead. * ``process_request`` callbacks passed to :class:`~scrapy.spiders.Rule` that do not accept two arguments are deprecated. * The following modules are deprecated: * ``scrapy.utils.http`` (use `w3lib.http`_) * ``scrapy.utils.markup`` (use `w3lib.html`_) * ``scrapy.utils.multipart`` (use `urllib3`_) * The ``scrapy.utils.datatypes.MergeDict`` class is deprecated for Python 3 code bases. Use :class:`~collections.ChainMap` instead. (:issue:`3878`) * The ``scrapy.utils.gz.is_gzipped`` function is deprecated. Use ``scrapy.utils.gz.gzip_magic_number`` instead. .. _urllib3: https://urllib3.readthedocs.io/en/latest/index.html .. _w3lib.html: https://w3lib.readthedocs.io/en/latest/w3lib.html#module-w3lib.html .. _w3lib.http: https://w3lib.readthedocs.io/en/latest/w3lib.html#module-w3lib.http Other changes ~~~~~~~~~~~~~ * It is now possible to run all tests from the same tox_ environment in parallel; the documentation now covers :ref:`this and other ways to run tests ` (:issue:`3707`) * It is now possible to generate an API documentation coverage report (:issue:`3806`, :issue:`3810`, :issue:`3860`) * The :ref:`documentation policies ` now require docstrings_ (:issue:`3701`) that follow `PEP 257`_ (:issue:`3748`) * Internal fixes and cleanup (:issue:`3629`, :issue:`3643`, :issue:`3684`, :issue:`3698`, :issue:`3734`, :issue:`3735`, :issue:`3736`, :issue:`3737`, :issue:`3809`, :issue:`3821`, :issue:`3825`, :issue:`3827`, :issue:`3833`, :issue:`3857`, :issue:`3877`) .. _release-1.6.0: Scrapy 1.6.0 (2019-01-30) ------------------------- Highlights: * better Windows support; * Python 3.7 compatibility; * big documentation improvements, including a switch from ``.extract_first()`` + ``.extract()`` API to ``.get()`` + ``.getall()`` API; * feed exports, FilePipeline and MediaPipeline improvements; * better extensibility: :signal:`item_error` and :signal:`request_reached_downloader` signals; ``from_crawler`` support for feed exporters, feed storages and dupefilters. * ``scrapy.contracts`` fixes and new features; * telnet console security improvements, first released as a backport in :ref:`release-1.5.2`; * clean-up of the deprecated code; * various bug fixes, small new features and usability improvements across the codebase. Selector API changes ~~~~~~~~~~~~~~~~~~~~ While these are not changes in Scrapy itself, but rather in the parsel_ library which Scrapy uses for xpath/css selectors, these changes are worth mentioning here. Scrapy now depends on parsel >= 1.5, and Scrapy documentation is updated to follow recent ``parsel`` API conventions. Most visible change is that ``.get()`` and ``.getall()`` selector methods are now preferred over ``.extract_first()`` and ``.extract()``. We feel that these new methods result in a more concise and readable code. See :ref:`old-extraction-api` for more details. .. note:: There are currently **no plans** to deprecate ``.extract()`` and ``.extract_first()`` methods. Another useful new feature is the introduction of ``Selector.attrib`` and ``SelectorList.attrib`` properties, which make it easier to get attributes of HTML elements. See :ref:`selecting-attributes`. CSS selectors are cached in parsel >= 1.5, which makes them faster when the same CSS path is used many times. This is very common in case of Scrapy spiders: callbacks are usually called several times, on different pages. If you're using custom ``Selector`` or ``SelectorList`` subclasses, a **backward incompatible** change in parsel may affect your code. See `parsel changelog`_ for a detailed description, as well as for the full list of improvements. .. _parsel changelog: https://parsel.readthedocs.io/en/latest/history.html Telnet console ~~~~~~~~~~~~~~ **Backward incompatible**: Scrapy's telnet console now requires username and password. See :ref:`topics-telnetconsole` for more details. This change fixes a **security issue**; see :ref:`release-1.5.2` release notes for details. New extensibility features ~~~~~~~~~~~~~~~~~~~~~~~~~~ * ``from_crawler`` support is added to feed exporters and feed storages. This, among other things, allows to access Scrapy settings from custom feed storages and exporters (:issue:`1605`, :issue:`3348`). * ``from_crawler`` support is added to dupefilters (:issue:`2956`); this allows to access e.g. settings or a spider from a dupefilter. * :signal:`item_error` is fired when an error happens in a pipeline (:issue:`3256`); * :signal:`request_reached_downloader` is fired when Downloader gets a new Request; this signal can be useful e.g. for custom Schedulers (:issue:`3393`). * new SitemapSpider :meth:`~.SitemapSpider.sitemap_filter` method which allows to select sitemap entries based on their attributes in SitemapSpider subclasses (:issue:`3512`). * Lazy loading of Downloader Handlers is now optional; this enables better initialization error handling in custom Downloader Handlers (:issue:`3394`). New FilePipeline and MediaPipeline features ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Expose more options for S3FilesStore: :setting:`AWS_ENDPOINT_URL`, :setting:`AWS_USE_SSL`, :setting:`AWS_VERIFY`, :setting:`AWS_REGION_NAME`. For example, this allows to use alternative or self-hosted AWS-compatible providers (:issue:`2609`, :issue:`3548`). * ACL support for Google Cloud Storage: :setting:`FILES_STORE_GCS_ACL` and :setting:`IMAGES_STORE_GCS_ACL` (:issue:`3199`). ``scrapy.contracts`` improvements ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Exceptions in contracts code are handled better (:issue:`3377`); * ``dont_filter=True`` is used for contract requests, which allows to test different callbacks with the same URL (:issue:`3381`); * ``request_cls`` attribute in Contract subclasses allow to use different Request classes in contracts, for example FormRequest (:issue:`3383`). * Fixed errback handling in contracts, e.g. for cases where a contract is executed for URL which returns non-200 response (:issue:`3371`). Usability improvements ~~~~~~~~~~~~~~~~~~~~~~ * more stats for RobotsTxtMiddleware (:issue:`3100`) * INFO log level is used to show telnet host/port (:issue:`3115`) * a message is added to IgnoreRequest in RobotsTxtMiddleware (:issue:`3113`) * better validation of ``url`` argument in ``Response.follow`` (:issue:`3131`) * non-zero exit code is returned from Scrapy commands when error happens on spider initialization (:issue:`3226`) * Link extraction improvements: "ftp" is added to scheme list (:issue:`3152`); "flv" is added to common video extensions (:issue:`3165`) * better error message when an exporter is disabled (:issue:`3358`); * ``scrapy shell --help`` mentions syntax required for local files (``./file.html``) - :issue:`3496`. * Referer header value is added to RFPDupeFilter log messages (:issue:`3588`) Bug fixes ~~~~~~~~~ * fixed issue with extra blank lines in .csv exports under Windows (:issue:`3039`); * proper handling of pickling errors in Python 3 when serializing objects for disk queues (:issue:`3082`) * flags are now preserved when copying Requests (:issue:`3342`); * FormRequest.from_response clickdata shouldn't ignore elements with ``input[type=image]`` (:issue:`3153`). * FormRequest.from_response should preserve duplicate keys (:issue:`3247`) Documentation improvements ~~~~~~~~~~~~~~~~~~~~~~~~~~ * Docs are re-written to suggest .get/.getall API instead of .extract/.extract_first. Also, :ref:`topics-selectors` docs are updated and re-structured to match latest parsel docs; they now contain more topics, such as :ref:`selecting-attributes` or :ref:`topics-selectors-css-extensions` (:issue:`3390`). * :ref:`topics-developer-tools` is a new tutorial which replaces old Firefox and Firebug tutorials (:issue:`3400`). * SCRAPY_PROJECT environment variable is documented (:issue:`3518`); * troubleshooting section is added to install instructions (:issue:`3517`); * improved links to beginner resources in the tutorial (:issue:`3367`, :issue:`3468`); * fixed :setting:`RETRY_HTTP_CODES` default values in docs (:issue:`3335`); * remove unused ``DEPTH_STATS`` option from docs (:issue:`3245`); * other cleanups (:issue:`3347`, :issue:`3350`, :issue:`3445`, :issue:`3544`, :issue:`3605`). Deprecation removals ~~~~~~~~~~~~~~~~~~~~ Compatibility shims for pre-1.0 Scrapy module names are removed (:issue:`3318`): * ``scrapy.command`` * ``scrapy.contrib`` (with all submodules) * ``scrapy.contrib_exp`` (with all submodules) * ``scrapy.dupefilter`` * ``scrapy.linkextractor`` * ``scrapy.project`` * ``scrapy.spider`` * ``scrapy.spidermanager`` * ``scrapy.squeue`` * ``scrapy.stats`` * ``scrapy.statscol`` * ``scrapy.utils.decorator`` See :ref:`module-relocations` for more information, or use suggestions from Scrapy 1.5.x deprecation warnings to update your code. Other deprecation removals: * Deprecated scrapy.interfaces.ISpiderManager is removed; please use scrapy.interfaces.ISpiderLoader. * Deprecated ``CrawlerSettings`` class is removed (:issue:`3327`). * Deprecated ``Settings.overrides`` and ``Settings.defaults`` attributes are removed (:issue:`3327`, :issue:`3359`). Other improvements, cleanups ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * All Scrapy tests now pass on Windows; Scrapy testing suite is executed in a Windows environment on CI (:issue:`3315`). * Python 3.7 support (:issue:`3326`, :issue:`3150`, :issue:`3547`). * Testing and CI fixes (:issue:`3526`, :issue:`3538`, :issue:`3308`, :issue:`3311`, :issue:`3309`, :issue:`3305`, :issue:`3210`, :issue:`3299`) * ``scrapy.http.cookies.CookieJar.clear`` accepts "domain", "path" and "name" optional arguments (:issue:`3231`). * additional files are included to sdist (:issue:`3495`); * code style fixes (:issue:`3405`, :issue:`3304`); * unneeded .strip() call is removed (:issue:`3519`); * collections.deque is used to store MiddlewareManager methods instead of a list (:issue:`3476`) .. _release-1.5.2: Scrapy 1.5.2 (2019-01-22) ------------------------- * *Security bugfix*: Telnet console extension can be easily exploited by rogue websites POSTing content to http://localhost:6023, we haven't found a way to exploit it from Scrapy, but it is very easy to trick a browser to do so and elevates the risk for local development environment. *The fix is backward incompatible*, it enables telnet user-password authentication by default with a random generated password. If you can't upgrade right away, please consider setting :setting:`TELNETCONSOLE_PORT` out of its default value. See :ref:`telnet console ` documentation for more info * Backport CI build failure under GCE environment due to boto import error. .. _release-1.5.1: Scrapy 1.5.1 (2018-07-12) ------------------------- This is a maintenance release with important bug fixes, but no new features: * ``O(N^2)`` gzip decompression issue which affected Python 3 and PyPy is fixed (:issue:`3281`); * skipping of TLS validation errors is improved (:issue:`3166`); * Ctrl-C handling is fixed in Python 3.5+ (:issue:`3096`); * testing fixes (:issue:`3092`, :issue:`3263`); * documentation improvements (:issue:`3058`, :issue:`3059`, :issue:`3089`, :issue:`3123`, :issue:`3127`, :issue:`3189`, :issue:`3224`, :issue:`3280`, :issue:`3279`, :issue:`3201`, :issue:`3260`, :issue:`3284`, :issue:`3298`, :issue:`3294`). .. _release-1.5.0: Scrapy 1.5.0 (2017-12-29) ------------------------- This release brings small new features and improvements across the codebase. Some highlights: * Google Cloud Storage is supported in FilesPipeline and ImagesPipeline. * Crawling with proxy servers becomes more efficient, as connections to proxies can be reused now. * Warnings, exception and logging messages are improved to make debugging easier. * ``scrapy parse`` command now allows to set custom request meta via ``--meta`` argument. * Compatibility with Python 3.6, PyPy and PyPy3 is improved; PyPy and PyPy3 are now supported officially, by running tests on CI. * Better default handling of HTTP 308, 522 and 524 status codes. * Documentation is improved, as usual. Backward Incompatible Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * Scrapy 1.5 drops support for Python 3.3. * Default Scrapy User-Agent now uses https link to scrapy.org (:issue:`2983`). **This is technically backward-incompatible**; override :setting:`USER_AGENT` if you relied on old value. * Logging of settings overridden by ``custom_settings`` is fixed; **this is technically backward-incompatible** because the logger changes from ``[scrapy.utils.log]`` to ``[scrapy.crawler]``. If you're parsing Scrapy logs, please update your log parsers (:issue:`1343`). * LinkExtractor now ignores ``m4v`` extension by default, this is change in behavior. * 522 and 524 status codes are added to ``RETRY_HTTP_CODES`` (:issue:`2851`) New features ~~~~~~~~~~~~ - Support ```` tags in ``Response.follow`` (:issue:`2785`) - Support for ``ptpython`` REPL (:issue:`2654`) - Google Cloud Storage support for FilesPipeline and ImagesPipeline (:issue:`2923`). - New ``--meta`` option of the "scrapy parse" command allows to pass additional request.meta (:issue:`2883`) - Populate spider variable when using ``shell.inspect_response`` (:issue:`2812`) - Handle HTTP 308 Permanent Redirect (:issue:`2844`) - Add 522 and 524 to ``RETRY_HTTP_CODES`` (:issue:`2851`) - Log versions information at startup (:issue:`2857`) - ``scrapy.mail.MailSender`` now works in Python 3 (it requires Twisted 17.9.0) - Connections to proxy servers are reused (:issue:`2743`) - Add template for a downloader middleware (:issue:`2755`) - Explicit message for NotImplementedError when parse callback not defined (:issue:`2831`) - CrawlerProcess got an option to disable installation of root log handler (:issue:`2921`) - LinkExtractor now ignores ``m4v`` extension by default - Better log messages for responses over :setting:`DOWNLOAD_WARNSIZE` and :setting:`DOWNLOAD_MAXSIZE` limits (:issue:`2927`) - Show warning when a URL is put to ``Spider.allowed_domains`` instead of a domain (:issue:`2250`). Bug fixes ~~~~~~~~~ - Fix logging of settings overridden by ``custom_settings``; **this is technically backward-incompatible** because the logger changes from ``[scrapy.utils.log]`` to ``[scrapy.crawler]``, so please update your log parsers if needed (:issue:`1343`) - Default Scrapy User-Agent now uses https link to scrapy.org (:issue:`2983`). **This is technically backward-incompatible**; override :setting:`USER_AGENT` if you relied on old value. - Fix PyPy and PyPy3 test failures, support them officially (:issue:`2793`, :issue:`2935`, :issue:`2990`, :issue:`3050`, :issue:`2213`, :issue:`3048`) - Fix DNS resolver when ``DNSCACHE_ENABLED=False`` (:issue:`2811`) - Add ``cryptography`` for Debian Jessie tox test env (:issue:`2848`) - Add verification to check if Request callback is callable (:issue:`2766`) - Port ``extras/qpsclient.py`` to Python 3 (:issue:`2849`) - Use getfullargspec under the scenes for Python 3 to stop DeprecationWarning (:issue:`2862`) - Update deprecated test aliases (:issue:`2876`) - Fix ``SitemapSpider`` support for alternate links (:issue:`2853`) Docs ~~~~ - Added missing bullet point for the ``AUTOTHROTTLE_TARGET_CONCURRENCY`` setting. (:issue:`2756`) - Update Contributing docs, document new support channels (:issue:`2762`, issue:`3038`) - Include references to Scrapy subreddit in the docs - Fix broken links; use ``https://`` for external links (:issue:`2978`, :issue:`2982`, :issue:`2958`) - Document CloseSpider extension better (:issue:`2759`) - Use ``pymongo.collection.Collection.insert_one()`` in MongoDB example (:issue:`2781`) - Spelling mistake and typos (:issue:`2828`, :issue:`2837`, :issue:`2884`, :issue:`2924`) - Clarify ``CSVFeedSpider.headers`` documentation (:issue:`2826`) - Document ``DontCloseSpider`` exception and clarify ``spider_idle`` (:issue:`2791`) - Update "Releases" section in README (:issue:`2764`) - Fix rst syntax in ``DOWNLOAD_FAIL_ON_DATALOSS`` docs (:issue:`2763`) - Small fix in description of startproject arguments (:issue:`2866`) - Clarify data types in Response.body docs (:issue:`2922`) - Add a note about ``request.meta['depth']`` to DepthMiddleware docs (:issue:`2374`) - Add a note about ``request.meta['dont_merge_cookies']`` to CookiesMiddleware docs (:issue:`2999`) - Up-to-date example of project structure (:issue:`2964`, :issue:`2976`) - A better example of ItemExporters usage (:issue:`2989`) - Document ``from_crawler`` methods for spider and downloader middlewares (:issue:`3019`) .. _release-1.4.0: Scrapy 1.4.0 (2017-05-18) ------------------------- Scrapy 1.4 does not bring that many breathtaking new features but quite a few handy improvements nonetheless. Scrapy now supports anonymous FTP sessions with customizable user and password via the new :setting:`FTP_USER` and :setting:`FTP_PASSWORD` settings. And if you're using Twisted version 17.1.0 or above, FTP is now available with Python 3. There's a new :meth:`response.follow ` method for creating requests; **it is now a recommended way to create Requests in Scrapy spiders**. This method makes it easier to write correct spiders; ``response.follow`` has several advantages over creating ``scrapy.Request`` objects directly: * it handles relative URLs; * it works properly with non-ascii URLs on non-UTF8 pages; * in addition to absolute and relative URLs it supports Selectors; for ```` elements it can also extract their href values. For example, instead of this:: for href in response.css('li.page a::attr(href)').extract(): url = response.urljoin(href) yield scrapy.Request(url, self.parse, encoding=response.encoding) One can now write this:: for a in response.css('li.page a'): yield response.follow(a, self.parse) Link extractors are also improved. They work similarly to what a regular modern browser would do: leading and trailing whitespace are removed from attributes (think ``href=" http://example.com"``) when building ``Link`` objects. This whitespace-stripping also happens for ``action`` attributes with ``FormRequest``. **Please also note that link extractors do not canonicalize URLs by default anymore.** This was puzzling users every now and then, and it's not what browsers do in fact, so we removed that extra transformation on extracted links. For those of you wanting more control on the ``Referer:`` header that Scrapy sends when following links, you can set your own ``Referrer Policy``. Prior to Scrapy 1.4, the default ``RefererMiddleware`` would simply and blindly set it to the URL of the response that generated the HTTP request (which could leak information on your URL seeds). By default, Scrapy now behaves much like your regular browser does. And this policy is fully customizable with W3C standard values (or with something really custom of your own if you wish). See :setting:`REFERRER_POLICY` for details. To make Scrapy spiders easier to debug, Scrapy logs more stats by default in 1.4: memory usage stats, detailed retry stats, detailed HTTP error code stats. A similar change is that HTTP cache path is also visible in logs now. Last but not least, Scrapy now has the option to make JSON and XML items more human-readable, with newlines between items and even custom indenting offset, using the new :setting:`FEED_EXPORT_INDENT` setting. Enjoy! (Or read on for the rest of changes in this release.) Deprecations and Backward Incompatible Changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Default to ``canonicalize=False`` in :class:`scrapy.linkextractors.LinkExtractor ` (:issue:`2537`, fixes :issue:`1941` and :issue:`1982`): **warning, this is technically backward-incompatible** - Enable memusage extension by default (:issue:`2539`, fixes :issue:`2187`); **this is technically backward-incompatible** so please check if you have any non-default ``MEMUSAGE_***`` options set. - ``EDITOR`` environment variable now takes precedence over ``EDITOR`` option defined in settings.py (:issue:`1829`); Scrapy default settings no longer depend on environment variables. **This is technically a backward incompatible change**. - ``Spider.make_requests_from_url`` is deprecated (:issue:`1728`, fixes :issue:`1495`). New Features ~~~~~~~~~~~~ - Accept proxy credentials in :reqmeta:`proxy` request meta key (:issue:`2526`) - Support `brotli-compressed`_ content; requires optional `brotlipy`_ (:issue:`2535`) - New :ref:`response.follow ` shortcut for creating requests (:issue:`1940`) - Added ``flags`` argument and attribute to :class:`~scrapy.Request` objects (:issue:`2047`) - Support Anonymous FTP (:issue:`2342`) - Added ``retry/count``, ``retry/max_reached`` and ``retry/reason_count/`` stats to :class:`RetryMiddleware ` (:issue:`2543`) - Added ``httperror/response_ignored_count`` and ``httperror/response_ignored_status_count/`` stats to :class:`HttpErrorMiddleware ` (:issue:`2566`) - Customizable :setting:`Referrer policy ` in :class:`RefererMiddleware ` (:issue:`2306`) - New ``data:`` URI download handler (:issue:`2334`, fixes :issue:`2156`) - Log cache directory when HTTP Cache is used (:issue:`2611`, fixes :issue:`2604`) - Warn users when project contains duplicate spider names (fixes :issue:`2181`) - ``scrapy.utils.datatypes.CaselessDict`` now accepts ``Mapping`` instances and not only dicts (:issue:`2646`) - :ref:`Media downloads `, with :class:`~scrapy.pipelines.files.FilesPipeline` or :class:`~scrapy.pipelines.images.ImagesPipeline`, can now optionally handle HTTP redirects using the new :setting:`MEDIA_ALLOW_REDIRECTS` setting (:issue:`2616`, fixes :issue:`2004`) - Accept non-complete responses from websites using a new :setting:`DOWNLOAD_FAIL_ON_DATALOSS` setting (:issue:`2590`, fixes :issue:`2586`) - Optional pretty-printing of JSON and XML items via :setting:`FEED_EXPORT_INDENT` setting (:issue:`2456`, fixes :issue:`1327`) - Allow dropping fields in ``FormRequest.from_response`` formdata when ``None`` value is passed (:issue:`667`) - Per-request retry times with the new :reqmeta:`max_retry_times` meta key (:issue:`2642`) - ``python -m scrapy`` as a more explicit alternative to ``scrapy`` command (:issue:`2740`) .. _brotli-compressed: https://www.ietf.org/rfc/rfc7932.txt .. _brotlipy: https://github.com/python-hyper/brotlipy/ Bug fixes ~~~~~~~~~ - LinkExtractor now strips leading and trailing whitespaces from attributes (:issue:`2547`, fixes :issue:`1614`) - Properly handle whitespaces in action attribute in :class:`~scrapy.FormRequest` (:issue:`2548`) - Buffer CONNECT response bytes from proxy until all HTTP headers are received (:issue:`2495`, fixes :issue:`2491`) - FTP downloader now works on Python 3, provided you use Twisted>=17.1 (:issue:`2599`) - Use body to choose response type after decompressing content (:issue:`2393`, fixes :issue:`2145`) - Always decompress ``Content-Encoding: gzip`` at :class:`HttpCompressionMiddleware ` stage (:issue:`2391`) - Respect custom log level in ``Spider.custom_settings`` (:issue:`2581`, fixes :issue:`1612`) - 'make htmlview' fix for macOS (:issue:`2661`) - Remove "commands" from the command list (:issue:`2695`) - Fix duplicate Content-Length header for POST requests with empty body (:issue:`2677`) - Properly cancel large downloads, i.e. above :setting:`DOWNLOAD_MAXSIZE` (:issue:`1616`) - ImagesPipeline: fixed processing of transparent PNG images with palette (:issue:`2675`) Cleanups & Refactoring ~~~~~~~~~~~~~~~~~~~~~~ - Tests: remove temp files and folders (:issue:`2570`), fixed ProjectUtilsTest on macOS (:issue:`2569`), use portable pypy for Linux on Travis CI (:issue:`2710`) - Separate building request from ``_requests_to_follow`` in CrawlSpider (:issue:`2562`) - Remove “Python 3 progress” badge (:issue:`2567`) - Add a couple more lines to ``.gitignore`` (:issue:`2557`) - Remove bumpversion prerelease configuration (:issue:`2159`) - Add codecov.yml file (:issue:`2750`) - Set context factory implementation based on Twisted version (:issue:`2577`, fixes :issue:`2560`) - Add omitted ``self`` arguments in default project middleware template (:issue:`2595`) - Remove redundant ``slot.add_request()`` call in ExecutionEngine (:issue:`2617`) - Catch more specific ``os.error`` exception in ``scrapy.pipelines.files.FSFilesStore`` (:issue:`2644`) - Change "localhost" test server certificate (:issue:`2720`) - Remove unused ``MEMUSAGE_REPORT`` setting (:issue:`2576`) Documentation ~~~~~~~~~~~~~ - Binary mode is required for exporters (:issue:`2564`, fixes :issue:`2553`) - Mention issue with :meth:`.FormRequest.from_response` due to bug in lxml (:issue:`2572`) - Use single quotes uniformly in templates (:issue:`2596`) - Document :reqmeta:`ftp_user` and :reqmeta:`ftp_password` meta keys (:issue:`2587`) - Removed section on deprecated ``contrib/`` (:issue:`2636`) - Recommend Anaconda when installing Scrapy on Windows (:issue:`2477`, fixes :issue:`2475`) - FAQ: rewrite note on Python 3 support on Windows (:issue:`2690`) - Rearrange selector sections (:issue:`2705`) - Remove ``__nonzero__`` from :class:`~scrapy.selector.SelectorList` docs (:issue:`2683`) - Mention how to disable request filtering in documentation of :setting:`DUPEFILTER_CLASS` setting (:issue:`2714`) - Add sphinx_rtd_theme to docs setup readme (:issue:`2668`) - Open file in text mode in JSON item writer example (:issue:`2729`) - Clarify ``allowed_domains`` example (:issue:`2670`) .. _release-1.3.3: Scrapy 1.3.3 (2017-03-10) ------------------------- Bug fixes ~~~~~~~~~ - Make ``SpiderLoader`` raise ``ImportError`` again by default for missing dependencies and wrong :setting:`SPIDER_MODULES`. These exceptions were silenced as warnings since 1.3.0. A new setting is introduced to toggle between warning or exception if needed ; see :setting:`SPIDER_LOADER_WARN_ONLY` for details. .. _release-1.3.2: Scrapy 1.3.2 (2017-02-13) ------------------------- Bug fixes ~~~~~~~~~ - Preserve request class when converting to/from dicts (utils.reqser) (:issue:`2510`). - Use consistent selectors for author field in tutorial (:issue:`2551`). - Fix TLS compatibility in Twisted 17+ (:issue:`2558`) .. _release-1.3.1: Scrapy 1.3.1 (2017-02-08) ------------------------- New features ~~~~~~~~~~~~ - Support ``'True'`` and ``'False'`` string values for boolean settings (:issue:`2519`); you can now do something like ``scrapy crawl myspider -s REDIRECT_ENABLED=False``. - Support kwargs with ``response.xpath()`` to use :ref:`XPath variables ` and ad-hoc namespaces declarations ; this requires at least Parsel v1.1 (:issue:`2457`). - Add support for Python 3.6 (:issue:`2485`). - Run tests on PyPy (warning: some tests still fail, so PyPy is not supported yet). Bug fixes ~~~~~~~~~ - Enforce ``DNS_TIMEOUT`` setting (:issue:`2496`). - Fix :command:`view` command ; it was a regression in v1.3.0 (:issue:`2503`). - Fix tests regarding ``*_EXPIRES settings`` with Files/Images pipelines (:issue:`2460`). - Fix name of generated pipeline class when using basic project template (:issue:`2466`). - Fix compatibility with Twisted 17+ (:issue:`2496`, :issue:`2528`). - Fix ``scrapy.Item`` inheritance on Python 3.6 (:issue:`2511`). - Enforce numeric values for components order in ``SPIDER_MIDDLEWARES``, ``DOWNLOADER_MIDDLEWARES``, ``EXTENSIONS`` and ``SPIDER_CONTRACTS`` (:issue:`2420`). Documentation ~~~~~~~~~~~~~ - Reword Code of Conduct section and upgrade to Contributor Covenant v1.4 (:issue:`2469`). - Clarify that passing spider arguments converts them to spider attributes (:issue:`2483`). - Document ``formid`` argument on ``FormRequest.from_response()`` (:issue:`2497`). - Add .rst extension to README files (:issue:`2507`). - Mention LevelDB cache storage backend (:issue:`2525`). - Use ``yield`` in sample callback code (:issue:`2533`). - Add note about HTML entities decoding with ``.re()/.re_first()`` (:issue:`1704`). - Typos (:issue:`2512`, :issue:`2534`, :issue:`2531`). Cleanups ~~~~~~~~ - Remove redundant check in ``MetaRefreshMiddleware`` (:issue:`2542`). - Faster checks in ``LinkExtractor`` for allow/deny patterns (:issue:`2538`). - Remove dead code supporting old Twisted versions (:issue:`2544`). .. _release-1.3.0: Scrapy 1.3.0 (2016-12-21) ------------------------- This release comes rather soon after 1.2.2 for one main reason: it was found out that releases since 0.18 up to 1.2.2 (included) use some backported code from Twisted (``scrapy.xlib.tx.*``), even if newer Twisted modules are available. Scrapy now uses ``twisted.web.client`` and ``twisted.internet.endpoints`` directly. (See also cleanups below.) As it is a major change, we wanted to get the bug fix out quickly while not breaking any projects using the 1.2 series. New Features ~~~~~~~~~~~~ - ``MailSender`` now accepts single strings as values for ``to`` and ``cc`` arguments (:issue:`2272`) - ``scrapy fetch url``, ``scrapy shell url`` and ``fetch(url)`` inside Scrapy shell now follow HTTP redirections by default (:issue:`2290`); See :command:`fetch` and :command:`shell` for details. - ``HttpErrorMiddleware`` now logs errors with ``INFO`` level instead of ``DEBUG``; this is technically **backward incompatible** so please check your log parsers. - By default, logger names now use a long-form path, e.g. ``[scrapy.extensions.logstats]``, instead of the shorter "top-level" variant of prior releases (e.g. ``[scrapy]``); this is **backward incompatible** if you have log parsers expecting the short logger name part. You can switch back to short logger names using :setting:`LOG_SHORT_NAMES` set to ``True``. Dependencies & Cleanups ~~~~~~~~~~~~~~~~~~~~~~~ - Scrapy now requires Twisted >= 13.1 which is the case for many Linux distributions already. - As a consequence, we got rid of ``scrapy.xlib.tx.*`` modules, which copied some of Twisted code for users stuck with an "old" Twisted version - ``ChunkedTransferMiddleware`` is deprecated and removed from the default downloader middlewares. .. _release-1.2.3: Scrapy 1.2.3 (2017-03-03) ------------------------- - Packaging fix: disallow unsupported Twisted versions in setup.py .. _release-1.2.2: Scrapy 1.2.2 (2016-12-06) ------------------------- Bug fixes ~~~~~~~~~ - Fix a cryptic traceback when a pipeline fails on ``open_spider()`` (:issue:`2011`) - Fix embedded IPython shell variables (fixing :issue:`396` that re-appeared in 1.2.0, fixed in :issue:`2418`) - A couple of patches when dealing with robots.txt: - handle (non-standard) relative sitemap URLs (:issue:`2390`) - handle non-ASCII URLs and User-Agents in Python 2 (:issue:`2373`) Documentation ~~~~~~~~~~~~~ - Document ``"download_latency"`` key in ``Request``'s ``meta`` dict (:issue:`2033`) - Remove page on (deprecated & unsupported) Ubuntu packages from ToC (:issue:`2335`) - A few fixed typos (:issue:`2346`, :issue:`2369`, :issue:`2369`, :issue:`2380`) and clarifications (:issue:`2354`, :issue:`2325`, :issue:`2414`) Other changes ~~~~~~~~~~~~~ - Advertize `conda-forge`_ as Scrapy's official conda channel (:issue:`2387`) - More helpful error messages when trying to use ``.css()`` or ``.xpath()`` on non-Text Responses (:issue:`2264`) - ``startproject`` command now generates a sample ``middlewares.py`` file (:issue:`2335`) - Add more dependencies' version info in ``scrapy version`` verbose output (:issue:`2404`) - Remove all ``*.pyc`` files from source distribution (:issue:`2386`) .. _conda-forge: https://anaconda.org/conda-forge/scrapy .. _release-1.2.1: Scrapy 1.2.1 (2016-10-21) ------------------------- Bug fixes ~~~~~~~~~ - Include OpenSSL's more permissive default ciphers when establishing TLS/SSL connections (:issue:`2314`). - Fix "Location" HTTP header decoding on non-ASCII URL redirects (:issue:`2321`). Documentation ~~~~~~~~~~~~~ - Fix JsonWriterPipeline example (:issue:`2302`). - Various notes: :issue:`2330` on spider names, :issue:`2329` on middleware methods processing order, :issue:`2327` on getting multi-valued HTTP headers as lists. Other changes ~~~~~~~~~~~~~ - Removed ``www.`` from ``start_urls`` in built-in spider templates (:issue:`2299`). .. _release-1.2.0: Scrapy 1.2.0 (2016-10-03) ------------------------- New Features ~~~~~~~~~~~~ - New :setting:`FEED_EXPORT_ENCODING` setting to customize the encoding used when writing items to a file. This can be used to turn off ``\uXXXX`` escapes in JSON output. This is also useful for those wanting something else than UTF-8 for XML or CSV output (:issue:`2034`). - ``startproject`` command now supports an optional destination directory to override the default one based on the project name (:issue:`2005`). - New :setting:`SCHEDULER_DEBUG` setting to log requests serialization failures (:issue:`1610`). - JSON encoder now supports serialization of ``set`` instances (:issue:`2058`). - Interpret ``application/json-amazonui-streaming`` as ``TextResponse`` (:issue:`1503`). - ``scrapy`` is imported by default when using shell tools (:command:`shell`, :ref:`inspect_response `) (:issue:`2248`). Bug fixes ~~~~~~~~~ - DefaultRequestHeaders middleware now runs before UserAgent middleware (:issue:`2088`). **Warning: this is technically backward incompatible**, though we consider this a bug fix. - HTTP cache extension and plugins that use the ``.scrapy`` data directory now work outside projects (:issue:`1581`). **Warning: this is technically backward incompatible**, though we consider this a bug fix. - ``Selector`` does not allow passing both ``response`` and ``text`` anymore (:issue:`2153`). - Fixed logging of wrong callback name with ``scrapy parse`` (:issue:`2169`). - Fix for an odd gzip decompression bug (:issue:`1606`). - Fix for selected callbacks when using ``CrawlSpider`` with :command:`scrapy parse ` (:issue:`2225`). - Fix for invalid JSON and XML files when spider yields no items (:issue:`872`). - Implement ``flush()`` for ``StreamLogger`` avoiding a warning in logs (:issue:`2125`). Refactoring ~~~~~~~~~~~ - ``canonicalize_url`` has been moved to `w3lib.url`_ (:issue:`2168`). .. _w3lib.url: https://w3lib.readthedocs.io/en/latest/w3lib.html#w3lib.url.canonicalize_url Tests & Requirements ~~~~~~~~~~~~~~~~~~~~ Scrapy's new requirements baseline is Debian 8 "Jessie". It was previously Ubuntu 12.04 Precise. What this means in practice is that we run continuous integration tests with these (main) packages versions at a minimum: Twisted 14.0, pyOpenSSL 0.14, lxml 3.4. Scrapy may very well work with older versions of these packages (the code base still has switches for older Twisted versions for example) but it is not guaranteed (because it's not tested anymore). Documentation ~~~~~~~~~~~~~ - Grammar fixes: :issue:`2128`, :issue:`1566`. - Download stats badge removed from README (:issue:`2160`). - New Scrapy :ref:`architecture diagram ` (:issue:`2165`). - Updated ``Response`` parameters documentation (:issue:`2197`). - Reworded misleading :setting:`RANDOMIZE_DOWNLOAD_DELAY` description (:issue:`2190`). - Add StackOverflow as a support channel (:issue:`2257`). .. _release-1.1.4: Scrapy 1.1.4 (2017-03-03) ------------------------- - Packaging fix: disallow unsupported Twisted versions in setup.py .. _release-1.1.3: Scrapy 1.1.3 (2016-09-22) ------------------------- Bug fixes ~~~~~~~~~ - Class attributes for subclasses of ``ImagesPipeline`` and ``FilesPipeline`` work as they did before 1.1.1 (:issue:`2243`, fixes :issue:`2198`) Documentation ~~~~~~~~~~~~~ - :ref:`Overview ` and :ref:`tutorial ` rewritten to use http://toscrape.com websites (:issue:`2236`, :issue:`2249`, :issue:`2252`). .. _release-1.1.2: Scrapy 1.1.2 (2016-08-18) ------------------------- Bug fixes ~~~~~~~~~ - Introduce a missing :setting:`IMAGES_STORE_S3_ACL` setting to override the default ACL policy in ``ImagesPipeline`` when uploading images to S3 (note that default ACL policy is "private" -- instead of "public-read" -- since Scrapy 1.1.0) - :setting:`IMAGES_EXPIRES` default value set back to 90 (the regression was introduced in 1.1.1) .. _release-1.1.1: Scrapy 1.1.1 (2016-07-13) ------------------------- Bug fixes ~~~~~~~~~ - Add "Host" header in CONNECT requests to HTTPS proxies (:issue:`2069`) - Use response ``body`` when choosing response class (:issue:`2001`, fixes :issue:`2000`) - Do not fail on canonicalizing URLs with wrong netlocs (:issue:`2038`, fixes :issue:`2010`) - a few fixes for ``HttpCompressionMiddleware`` (and ``SitemapSpider``): - Do not decode HEAD responses (:issue:`2008`, fixes :issue:`1899`) - Handle charset parameter in gzip Content-Type header (:issue:`2050`, fixes :issue:`2049`) - Do not decompress gzip octet-stream responses (:issue:`2065`, fixes :issue:`2063`) - Catch (and ignore with a warning) exception when verifying certificate against IP-address hosts (:issue:`2094`, fixes :issue:`2092`) - Make ``FilesPipeline`` and ``ImagesPipeline`` backward compatible again regarding the use of legacy class attributes for customization (:issue:`1989`, fixes :issue:`1985`) New features ~~~~~~~~~~~~ - Enable genspider command outside project folder (:issue:`2052`) - Retry HTTPS CONNECT ``TunnelError`` by default (:issue:`1974`) Documentation ~~~~~~~~~~~~~ - ``FEED_TEMPDIR`` setting at lexicographical position (:commit:`9b3c72c`) - Use idiomatic ``.extract_first()`` in overview (:issue:`1994`) - Update years in copyright notice (:commit:`c2c8036`) - Add information and example on errbacks (:issue:`1995`) - Use "url" variable in downloader middleware example (:issue:`2015`) - Grammar fixes (:issue:`2054`, :issue:`2120`) - New FAQ entry on using BeautifulSoup in spider callbacks (:issue:`2048`) - Add notes about Scrapy not working on Windows with Python 3 (:issue:`2060`) - Encourage complete titles in pull requests (:issue:`2026`) Tests ~~~~~ - Upgrade py.test requirement on Travis CI and Pin pytest-cov to 2.2.1 (:issue:`2095`) .. _release-1.1.0: Scrapy 1.1.0 (2016-05-11) ------------------------- This 1.1 release brings a lot of interesting features and bug fixes: - Scrapy 1.1 has beta Python 3 support (requires Twisted >= 15.5). See :ref:`news_betapy3` for more details and some limitations. - Hot new features: - Item loaders now support nested loaders (:issue:`1467`). - ``FormRequest.from_response`` improvements (:issue:`1382`, :issue:`1137`). - Added setting :setting:`AUTOTHROTTLE_TARGET_CONCURRENCY` and improved AutoThrottle docs (:issue:`1324`). - Added ``response.text`` to get body as unicode (:issue:`1730`). - Anonymous S3 connections (:issue:`1358`). - Deferreds in downloader middlewares (:issue:`1473`). This enables better robots.txt handling (:issue:`1471`). - HTTP caching now follows RFC2616 more closely, added settings :setting:`HTTPCACHE_ALWAYS_STORE` and :setting:`HTTPCACHE_IGNORE_RESPONSE_CACHE_CONTROLS` (:issue:`1151`). - Selectors were extracted to the parsel_ library (:issue:`1409`). This means you can use Scrapy Selectors without Scrapy and also upgrade the selectors engine without needing to upgrade Scrapy. - HTTPS downloader now does TLS protocol negotiation by default, instead of forcing TLS 1.0. You can also set the SSL/TLS method using the new :setting:`DOWNLOADER_CLIENT_TLS_METHOD`. - These bug fixes may require your attention: - Don't retry bad requests (HTTP 400) by default (:issue:`1289`). If you need the old behavior, add ``400`` to :setting:`RETRY_HTTP_CODES`. - Fix shell files argument handling (:issue:`1710`, :issue:`1550`). If you try ``scrapy shell index.html`` it will try to load the URL ``http://index.html``, use ``scrapy shell ./index.html`` to load a local file. - Robots.txt compliance is now enabled by default for newly-created projects (:issue:`1724`). Scrapy will also wait for robots.txt to be downloaded before proceeding with the crawl (:issue:`1735`). If you want to disable this behavior, update :setting:`ROBOTSTXT_OBEY` in ``settings.py`` file after creating a new project. - Exporters now work on unicode, instead of bytes by default (:issue:`1080`). If you use :class:`~scrapy.exporters.PythonItemExporter`, you may want to update your code to disable binary mode which is now deprecated. - Accept XML node names containing dots as valid (:issue:`1533`). - When uploading files or images to S3 (with ``FilesPipeline`` or ``ImagesPipeline``), the default ACL policy is now "private" instead of "public" **Warning: backward incompatible!**. You can use :setting:`FILES_STORE_S3_ACL` to change it. - We've reimplemented ``canonicalize_url()`` for more correct output, especially for URLs with non-ASCII characters (:issue:`1947`). This could change link extractors output compared to previous Scrapy versions. This may also invalidate some cache entries you could still have from pre-1.1 runs. **Warning: backward incompatible!**. Keep reading for more details on other improvements and bug fixes. .. _news_betapy3: Beta Python 3 Support ~~~~~~~~~~~~~~~~~~~~~ We have been `hard at work to make Scrapy run on Python 3 `_. As a result, now you can run spiders on Python 3.3, 3.4 and 3.5 (Twisted >= 15.5 required). Some features are still missing (and some may never be ported). Almost all builtin extensions/middlewares are expected to work. However, we are aware of some limitations in Python 3: - Scrapy does not work on Windows with Python 3 - Sending emails is not supported - FTP download handler is not supported - Telnet console is not supported Additional New Features and Enhancements ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - Scrapy now has a `Code of Conduct`_ (:issue:`1681`). - Command line tool now has completion for zsh (:issue:`934`). - Improvements to ``scrapy shell``: - Support for bpython and configure preferred Python shell via ``SCRAPY_PYTHON_SHELL`` (:issue:`1100`, :issue:`1444`). - Support URLs without scheme (:issue:`1498`) **Warning: backward incompatible!** - Bring back support for relative file path (:issue:`1710`, :issue:`1550`). - Added :setting:`MEMUSAGE_CHECK_INTERVAL_SECONDS` setting to change default check interval (:issue:`1282`). - Download handlers are now lazy-loaded on first request using their scheme (:issue:`1390`, :issue:`1421`). - HTTPS download handlers do not force TLS 1.0 anymore; instead, OpenSSL's ``SSLv23_method()/TLS_method()`` is used allowing to try negotiating with the remote hosts the highest TLS protocol version it can (:issue:`1794`, :issue:`1629`). - ``RedirectMiddleware`` now skips the status codes from ``handle_httpstatus_list`` on spider attribute or in ``Request``'s ``meta`` key (:issue:`1334`, :issue:`1364`, :issue:`1447`). - Form submission: - now works with ``