Merge remote-tracking branch 'origin/master' into fix_log_flags

.bandit.yml

@@ -1,18 +0,0 @@
-skips:
-- B101
-- B105
-- B301
-- B303
-- B306
-- B307
-- B311
-- B320
-- B321
-- B402  # https://github.com/scrapy/scrapy/issues/4180
-- B403
-- B404
-- B406
-- B410
-- B503
-- B603
-- B605

.bumpversion.cfg

@@ -1,7 +0,0 @@
-[bumpversion]
-current_version = 2.5.0
-commit = True
-tag = True
-tag_name = {new_version}
-
-[bumpversion:file:scrapy/VERSION]

.coveragerc

@@ -1,5 +0,0 @@
-[run]
-branch = true
-include = scrapy/*
-omit =
-  tests/*

.flake8

@@ -1,19 +0,0 @@
-[flake8]
-
-max-line-length = 119
-ignore = W503
-
-exclude =
-# Exclude files that are meant to provide top-level imports
-# E402: Module level import not at top of file
-# F401: Module imported but unused
-    scrapy/__init__.py E402
-    scrapy/core/downloader/handlers/http.py F401
-    scrapy/http/__init__.py F401
-    scrapy/linkextractors/__init__.py E402 F401
-    scrapy/selector/__init__.py F401
-    scrapy/spiders/__init__.py E402 F401
-
-    # Issues pending a review:
-    scrapy/utils/url.py F403 F405
-    tests/test_loader.py E741

.git-blame-ignore-revs

@@ -0,0 +1,7 @@
+# .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
+c5cdd0d30ceb68ccba04af0e71d1b8e6678e2962

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,13 @@
+---
+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.

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: monthly
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+    cooldown:
+      default-days: 7

.github/workflows/checks.yml

@@ -1,45 +1,76 @@
 name: Checks
-on: [push, pull_request]
+
+permissions:
+  contents: read
+
+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-18.04
+    runs-on: ubuntu-latest
+    env:
+      # Make uv use the interpreter that actions/setup-python installed instead
+      # of downloading one of its own.
+      UV_PYTHON_PREFERENCE: only-system
     strategy:
       fail-fast: false
       matrix:
         include:
-        - python-version: "3.10"
-          env:
-            TOXENV: security
-        - python-version: "3.10"
-          env:
-            TOXENV: flake8
-        # Pylint requires installing reppy, which does not support Python 3.9
-        # https://github.com/seomoz/reppy/issues/122
-        - python-version: 3.8
+        - python-version: "3.14"
           env:
             TOXENV: pylint
-            TOX_PIP_VERSION: 20.3.3
-        - python-version: 3.6
+        - python-version: "3.10"
           env:
-            TOXENV: typing
-        - python-version: "3.10"  # Keep in sync with .readthedocs.yml
+            TOXENV: mypy
+        - python-version: "3.10"
+          env:
+            TOXENV: mypy-tests
+        # Keep in sync with pyproject.toml tool.sphinx-scrapy.python-version.
+        - python-version: "3.14"
           env:
             TOXENV: docs
+        - python-version: "3.13"
+          env:
+            TOXENV: docs-tests
+        - python-version: "3.14"
+          env:
+            TOXENV: twinecheck
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      with:
+        persist-credentials: false
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
       with:
         python-version: ${{ matrix.python-version }}
 
+    - name: Set up uv
+      uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      with:
+        cache-dependency-glob: |
+          docs/requirements.txt
+          pyproject.toml
+          tox.ini
+
     - name: Run check
       env: ${{ matrix.env }}
-      run: |
-        if [[ ! -z "$TOX_PIP_VERSION" ]]; then
-            pip install tox-pip-version
-        fi
-        pip install -U tox
-        tox
+      run: uvx --with tox-uv tox
+
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      with:
+        persist-credentials: false
+    - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1

.github/workflows/codspeed.yml

@@ -0,0 +1,59 @@
+---
+name: codspeed
+
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+        paths:
+            - scrapy/**
+            - tests/benchmarks/**
+            - .github/workflows/codspeed.yml
+            - tox.ini
+    workflow_dispatch:
+
+concurrency:
+    group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+    cancel-in-progress: true
+
+permissions: {}
+
+jobs:
+    benchmark:
+        runs-on: ubuntu-latest
+        env:
+            # Make uv use the interpreter that actions/setup-python installed
+            # instead of downloading one of its own.
+            UV_PYTHON_PREFERENCE: only-system
+        permissions:
+            contents: read
+            id-token: write  # OIDC authentication with CodSpeed
+
+        steps:
+            - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+              with:
+                persist-credentials: false
+
+            - name: Set up Python 3.14
+              uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+              with:
+                  python-version: '3.14'
+
+            - name: Set up uv
+              uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+              with:
+                  cache-dependency-glob: |
+                      pyproject.toml
+                      tox.ini
+
+            - name: Install dependencies
+              # tox must stay on PATH for the CodSpeed action to invoke it.
+              run: |
+                  uv tool install --with tox-uv tox
+                  tox -n -e benchmark
+            - name: Run benchmarks
+              uses: CodSpeedHQ/action@0ca9cbbf4623b599a6c3ed4fc8a922942705d9f1 # v5.0.2
+              with:
+                  mode: simulation
+                  run: tox -e benchmark

.github/workflows/flag-prs-for-triage.yml

@@ -0,0 +1,255 @@
+name: Flag PRs for triage
+# Labels pull requests whose author's public activity suggests that an LLM is
+# writing them without supervision, and records the evidence in the workflow
+# run summary so that triaging one does not require reading a user profile.
+#
+# Four independent signals, any of which is enough to label. Each one abstains
+# when the data it needs is unavailable, so a missing signal never counts
+# against an author:
+#
+# - Rejection burst: pull requests of theirs closed unmerged elsewhere within
+#   the last month. Volume of rejections in absolute terms separates spraying
+#   from ordinary contribution far better than a merge ratio does, since
+#   ratios reward authors who accumulate merges in trivial repositories.
+# - Spray breadth: unrelated repositories they open pull requests against
+#   within one week. Breadth catches an agent on its first day, before any of
+#   its pull requests have been closed, and it comes from the event feed, so it
+#   also covers authors that the search API refuses to return.
+# - Assistant voice: their recent comments across GitHub read as assistant
+#   output rather than as a developer talking, by section headings, bullet
+#   lists, em dash density or stock acknowledgement phrases.
+# - Agent branch: the branch name carries an agent prefix.
+#
+# Authors that the organisations behind this repository already trust are left
+# alone before any of that runs: public members of those organisations, and
+# authors with a track record of pull requests merged into their repositories.
+# Trust from a merge record rather than from a list of names keeps the exemption
+# in step with who is actually contributing.
+#
+# Deliberately not used: account age, fork age, follower count, total pull
+# request count and cross-repository merge ratio. All of them were measured
+# against hand-labelled pull requests and either failed to separate or, in the
+# case of the merge ratio, inverted on held-out data.
+#
+# The label is advisory, and it says the author's history is worth a look
+# before reviewing in depth; it does not say the pull request is bad.
+#
+# The workflow only reads pull request and public activity metadata through the
+# API, it never checks out or runs pull request code, so pull_request_target is
+# safe here.
+on:  # zizmor: ignore[dangerous-triggers]
+  pull_request_target:
+    types: [opened]
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  flag-pr-for-triage:
+    name: Label PR if the author's activity suggests unsupervised LLM use
+    runs-on: ubuntu-latest
+    steps:
+      - name: Score the author and label the PR
+        uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const LABEL = 'needs triage';
+            const RETRIES = 5;
+            const RETRY_WAIT_MS = 60000;
+            const REJECTION_WINDOW_DAYS = 30;
+            const MIN_REJECTIONS = 1;
+            const MIN_COMMENTS = 2;
+            const MAX_REPOS_PER_WEEK = 2;
+            const VOICE = { structure: 0.10, emDashPerKChar: 0.30, acknowledgement: 0.40 };
+            const EVENT_PAGES = 3;
+            const TRUSTED_ORGS = ['scrapy', 'scrapy-plugins', 'scrapinghub', 'zytedata'];
+            const MIN_TRUSTED_MERGES = 10;
+            const AGENT_BRANCH = /^(agent|codex|claude|cursor|devin|copilot|jules|bot)[\/_-]/i;
+
+            const { owner, repo } = context.repo;
+            const pr = context.payload.pull_request;
+            const author = pr.user.login;
+
+            if (pr.user.type === 'Bot'
+                || ['MEMBER', 'OWNER', 'COLLABORATOR'].includes(pr.author_association)) {
+              core.info(`Skipping PR #${pr.number} by ${author} (${pr.user.type}, ${pr.author_association}).`);
+              return;
+            }
+
+            // Rate and abuse limits reset on the order of a minute, so waiting
+            // is enough; other errors are not worth retrying.
+            const retriable = new Set([403, 429, 500, 502, 503, 504]);
+            const sleep = ms => new Promise(resolve => setTimeout(resolve, ms));
+            async function withRetries(description, call) {
+              for (let attempt = 1; ; attempt++) {
+                try {
+                  return await call();
+                } catch (error) {
+                  if (!retriable.has(error.status) || attempt > RETRIES) throw error;
+                  const reset = Number(error.response?.headers?.['x-ratelimit-reset']) * 1000 - Date.now();
+                  const after = Number(error.response?.headers?.['retry-after']) * 1000;
+                  const wait = Math.min(Math.max(after || reset || RETRY_WAIT_MS, RETRY_WAIT_MS), 15 * RETRY_WAIT_MS);
+                  core.info(`${description} failed with ${error.status}, retrying in ${Math.round(wait / 1000)}s (attempt ${attempt}/${RETRIES}).`);
+                  await sleep(wait);
+                }
+              }
+            }
+            // Accounts excluded from search, deleted users and the like leave a
+            // signal unmeasurable rather than negative.
+            const orNull = promise => promise.catch(error => {
+              if ([404, 410, 422].includes(error.status)) return null;
+              throw error;
+            });
+
+            // author_association only reports membership of the organisation
+            // that owns this repository, and only when it is public, so trust
+            // in the author is established here instead.
+            const trustedOrg = (await Promise.all(TRUSTED_ORGS.map(org =>
+              orNull(withRetries(`Checking public membership of ${org}`, () =>
+                github.rest.orgs.checkPublicMembershipForUser({ org, username: author }),
+              )).then(response => response && org),
+            ))).find(Boolean);
+            if (trustedOrg) {
+              core.info(`Skipping PR #${pr.number} by ${author} (public member of ${trustedOrg}).`);
+              return;
+            }
+            // Repeating a qualifier narrows the search instead of widening it,
+            // hence the explicit disjunction.
+            const trustedMerges = await orNull(withRetries('Counting merged PRs in trusted organisations', () =>
+              github.rest.search.issuesAndPullRequests({
+                q: `author:${author} type:pr is:merged`
+                  + ` (${TRUSTED_ORGS.map(org => `org:${org}`).join(' OR ')})`,
+                advanced_search: 'true', per_page: 1,
+              }).then(response => response.data.total_count),
+            ));
+            if (trustedMerges >= MIN_TRUSTED_MERGES) {
+              core.info(`Skipping PR #${pr.number} by ${author}`
+                + ` (${trustedMerges} PR(s) merged into ${TRUSTED_ORGS.join(', ')}).`);
+              return;
+            }
+
+            const opened = new Date(pr.created_at);
+            const daysBefore = date => (opened - new Date(date)) / 86400000;
+
+            // Signal 1: pull requests closed unmerged elsewhere, recently.
+            const search = await orNull(withRetries('Searching for PRs by the author', () =>
+              github.rest.search.issuesAndPullRequests({
+                q: `author:${author} type:pr`, advanced_search: 'true',
+                sort: 'created', order: 'desc', per_page: 100,
+              }).then(response => response.data),
+            ));
+            let rejections = null;
+            if (search) {
+              rejections = search.items.filter(item => {
+                const itemOwner = item.repository_url.split('/repos/')[1].split('/')[0].toLowerCase();
+                return itemOwner !== author.toLowerCase()
+                  && item.state === 'closed' && !item.pull_request?.merged_at
+                  && daysBefore(item.created_at) >= 0
+                  && daysBefore(item.created_at) <= REJECTION_WINDOW_DAYS;
+              }).map(item => item.html_url);
+            }
+
+            // Signal 2: how their recent comments across GitHub read.
+            const events = [];
+            for (let page = 1; page <= EVENT_PAGES; page++) {
+              const batch = await orNull(withRetries(`Reading public events page ${page}`, () =>
+                github.rest.activity.listPublicEventsForUser({
+                  username: author, per_page: 100, page,
+                }).then(response => response.data),
+              ));
+              if (!batch?.length) break;
+              events.push(...batch);
+              if (batch.length < 100) break;
+            }
+            const comments = events
+              .filter(event => ['IssueCommentEvent', 'PullRequestReviewCommentEvent'].includes(event.type))
+              .map(event => event.payload?.comment?.body)
+              .filter(Boolean);
+
+            // Signal 3: how many unrelated projects they open pull requests
+            // against in a single week. Breadth rather than volume: a focused
+            // contributor sends many pull requests to few repositories, while
+            // an unattended agent sprays a few across many. Taken from the
+            // event feed, which unlike search covers authors that search
+            // refuses to return.
+            const weeks = {};
+            for (const event of events) {
+              if (event.type !== 'PullRequestEvent' || event.payload?.action !== 'opened') continue;
+              const name = event.repo?.name;
+              if (!name || name.toLowerCase().startsWith(`${author.toLowerCase()}/`)) continue;
+              const week = Math.floor(new Date(event.created_at) / (7 * 86400000));
+              (weeks[week] ??= new Set()).add(name);
+            }
+            const breadth = events.length
+              ? Math.max(0, ...Object.values(weeks).map(repos => repos.size))
+              : null;
+            const STRUCTURE = [/^\s*#{2,3}\s/m, /^\s*[-*]\s.+\n\s*[-*]\s/m, /\*\*[^*]+\*\*/, /```/];
+            const ACKNOWLEDGEMENT = [
+              /thanks for (the )?(review|feedback|pointing|catching|flagging|clarif)/i,
+              /you'?re (absolutely )?right/i, /great catch/i, /that makes sense/i,
+              /i'?ll (continue|investigate|update|submit|look into|make sure)/i,
+              /let me know (if|whether)/i, /happy to (update|adjust|revise|change)/i,
+              /i understand that/i, /thanks for your time/i, /just following up/i,
+              /hope (this|that) helps/i, /please let me know/i, /i'?ve (updated|addressed|fixed)/i,
+            ];
+            let voice = null;
+            if (comments.length >= MIN_COMMENTS) {
+              const chars = comments.reduce((total, body) => total + body.length, 0);
+              const rate = patterns => comments.filter(body => patterns.some(re => re.test(body))).length / comments.length;
+              voice = {
+                comments: comments.length,
+                structure: rate(STRUCTURE),
+                acknowledgement: rate(ACKNOWLEDGEMENT),
+                emDashPerKChar: 1000 * comments.reduce((total, body) => total + (body.match(/—/g) || []).length, 0) / chars,
+              };
+            }
+
+            const reasons = [];
+            if (rejections && rejections.length >= MIN_REJECTIONS) {
+              reasons.push(`${rejections.length} PR(s) of theirs closed unmerged elsewhere in the last`
+                + ` ${REJECTION_WINDOW_DAYS} days: ${rejections.slice(0, 10).join(' ')}`);
+            }
+            if (voice && (voice.structure > VOICE.structure
+                          || voice.emDashPerKChar > VOICE.emDashPerKChar
+                          || voice.acknowledgement > VOICE.acknowledgement)) {
+              reasons.push(`comment style over ${voice.comments} recent comments:`
+                + ` ${(100 * voice.structure).toFixed(0)}% structured,`
+                + ` ${(100 * voice.acknowledgement).toFixed(0)}% stock acknowledgements,`
+                + ` ${voice.emDashPerKChar.toFixed(2)} em dashes per 1000 characters`);
+            }
+            if (breadth !== null && breadth > MAX_REPOS_PER_WEEK) {
+              reasons.push(`opened pull requests against ${breadth} unrelated repositories within a week`);
+            }
+            if (AGENT_BRANCH.test(pr.head?.ref || '')) {
+              reasons.push(`branch name carries an agent prefix: ${pr.head.ref}`);
+            }
+
+            await core.summary
+              .addHeading(`PR #${pr.number} by ${author}`, 3)
+              .addList([
+                rejections === null
+                  ? 'recent rejections elsewhere: unmeasurable, the author cannot be searched'
+                  : `recent rejections elsewhere: ${rejections.length}`,
+                voice === null
+                  ? `comment style: unmeasurable, fewer than ${MIN_COMMENTS} recent comments found`
+                  : `comment style: ${(100 * voice.structure).toFixed(0)}% structured,`
+                    + ` ${(100 * voice.acknowledgement).toFixed(0)}% stock acknowledgements,`
+                    + ` ${voice.emDashPerKChar.toFixed(2)} em dashes per 1000 characters`
+                    + ` over ${voice.comments} comments`,
+                breadth === null
+                  ? 'repositories per week: unmeasurable, no public events found'
+                  : `repositories per week, at most: ${breadth}`,
+                `branch: ${pr.head?.ref ?? 'unknown'}`,
+                `verdict: ${reasons.length ? `labelled "${LABEL}"` : 'not labelled'}`,
+              ])
+              .addRaw(reasons.length ? `\n${reasons.map(reason => `- ${reason}`).join('\n')}\n` : '')
+              .write();
+
+            if (!reasons.length) {
+              core.info(`Not labelling PR #${pr.number}.`);
+              return;
+            }
+            await withRetries('Adding the label', () =>
+              github.rest.issues.addLabels({ owner, repo, issue_number: pr.number, labels: [LABEL] }),
+            );
+            core.info(`Labelled PR #${pr.number}: ${reasons.join(' | ')}`);

.github/workflows/publish.yml

@@ -1,31 +1,50 @@
 name: Publish
-on: [push]
+
+permissions:
+  contents: read
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+
+concurrency:
+  group: ${{github.workflow}}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
-  publish:
-    runs-on: ubuntu-18.04
-    if: startsWith(github.event.ref, 'refs/tags/')
-
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+        with:
+          python-version: "3.14"
+      - run: |
+          python -m pip install --upgrade build
+          python -m build
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: python-package-distributions
+          path: dist/
 
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: "3.10"
-
-    - name: Check Tag
-      id: check-release-tag
-      run: |
-        if [[ ${{ github.event.ref }} =~ ^refs/tags/[0-9]+[.][0-9]+[.][0-9]+(rc[0-9]+|[.]dev[0-9]+)?$ ]]; then
-          echo ::set-output name=release_tag::true
-        fi
-
-    - name: Publish to PyPI
-      if: steps.check-release-tag.outputs.release_tag == 'true'
-      run: |
-        pip install --upgrade setuptools wheel twine
-        python setup.py sdist bdist_wheel
-        export TWINE_USERNAME=__token__
-        export TWINE_PASSWORD=${{ secrets.PYPI_TOKEN }}
-        twine upload dist/*
+  publish:
+    name: Upload release to PyPI
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/Scrapy
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33 # v1.14.2

.github/workflows/tests-macos.yml

@@ -1,26 +1,77 @@
 name: macOS
-on: [push, pull_request]
+
+permissions:
+  contents: read
+
+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-10.15
+    name: tests (${{ matrix.python-version }}, ${{ matrix.env.TOXENV }})
+    runs-on: macos-latest
+    env:
+      PYTEST_ADDOPTS: ${{ matrix.coverage && '-n auto' || '-n auto --no-cov' }}
+      # Make uv use the interpreter that actions/setup-python installed instead
+      # of downloading one of its own.
+      UV_PYTHON_PREFERENCE: only-system
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+        include:
+        - python-version: "3.10"
+          env:
+            TOXENV: py
+        - python-version: "3.14"
+          env:
+            TOXENV: py
+          coverage: true
+        - python-version: "3.14"
+          env:
+            TOXENV: no-reactor
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      with:
+        persist-credentials: false
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
       with:
         python-version: ${{ matrix.python-version }}
 
+    - name: Set up uv
+      uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      with:
+        cache-dependency-glob: |
+          pyproject.toml
+          tox.ini
+
+    - name: Install mitmproxy
+      env:
+        # mitmproxy needs a newer Python than the oldest matrix entries, so let
+        # uv download one where no system interpreter is new enough.
+        UV_PYTHON_PREFERENCE: system
+      run: uv tool install mitmproxy
+
     - name: Run tests
-      run: |
-        pip install -U tox
-        tox -e py
+      env: ${{ matrix.env }}
+      run: uvx --with tox-uv tox
 
     - name: Upload coverage report
-      run: bash <(curl -s https://codecov.io/bash)
+      if: ${{ matrix.coverage }}
+      uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
+
+    - name: Upload test results
+      if: ${{ !cancelled() }}
+      uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
+      with:
+        report_type: test_results

.github/workflows/tests-ubuntu.yml

@@ -1,83 +1,138 @@
 name: Ubuntu
-on: [push, pull_request]
+
+permissions:
+  contents: read
+
+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-18.04
+    name: tests (${{ matrix.python-version }}, ${{ matrix.env.TOXENV }})
+    runs-on: ubuntu-latest
+    env:
+      PYTEST_ADDOPTS: ${{ matrix.coverage && '-n auto' || '-n auto --no-cov' }}
+      # Make uv use the interpreter that actions/setup-python installed instead
+      # of downloading one of its own.
+      UV_PYTHON_PREFERENCE: only-system
     strategy:
       fail-fast: false
       matrix:
         include:
-        - python-version: 3.7
-          env:
-            TOXENV: py
-        - python-version: 3.8
-          env:
-            TOXENV: py
-        - python-version: 3.9
-          env:
-            TOXENV: py
         - python-version: "3.10"
           env:
             TOXENV: py
-        - python-version: "3.10"
+        - python-version: "3.11"
           env:
-            TOXENV: asyncio
-        - python-version: pypy3
+            TOXENV: py
+        - python-version: "3.12"
           env:
-            TOXENV: pypy3
-            PYPY_VERSION: 3.6-v7.3.3
+            TOXENV: py
+        - python-version: "3.13"
+          env:
+            TOXENV: py
+        - python-version: "3.14"
+          env:
+            TOXENV: py
+          coverage: true
+        - python-version: "3.14"
+          env:
+            TOXENV: default-reactor
+          coverage: true
+        - python-version: "3.14"
+          env:
+            TOXENV: no-reactor
+          coverage: true
 
-        # pinned deps
-        - python-version: 3.6.12
+        # min deps
+        - python-version: "3.10.19"
           env:
-            TOXENV: pinned
-        - python-version: 3.6.12
+            TOXENV: min
+          coverage: true
+        - python-version: "3.10.19"
           env:
-            TOXENV: asyncio-pinned
-        - python-version: pypy3
+            TOXENV: min-default-reactor
+          coverage: true
+        # pinned due to https://github.com/pypy/pypy/issues/5388
+        - python-version: pypy3.11-7.3.20
           env:
-            TOXENV: pypy3-pinned
-            PYPY_VERSION: 3.6-v7.2.0
+            TOXENV: min-pypy3
+        - python-version: "3.10.19"
+          env:
+            TOXENV: min-extra-deps
+          coverage: true
+        - python-version: "3.10.19"
+          env:
+            TOXENV: min-botocore
+          coverage: true
 
-        # extras
-        # extra-deps includes reppy, which does not support Python 3.9
-        # https://github.com/seomoz/reppy/issues/122
-        - python-version: 3.8
+        - python-version: "3.14"
           env:
             TOXENV: extra-deps
-            TOX_PIP_VERSION: 20.3.3
+          coverage: true
+        - python-version: "3.14"
+          env:
+            TOXENV: no-reactor-extra-deps
+          coverage: true
+        # pinned due to https://github.com/pypy/pypy/issues/5388
+        - python-version: pypy3.11-7.3.20
+          env:
+            TOXENV: pypy3-extra-deps
+        - python-version: "3.14"
+          env:
+            TOXENV: botocore
+          coverage: true
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      with:
+        persist-credentials: false
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
       with:
         python-version: ${{ matrix.python-version }}
 
     - name: Install system libraries
-      if: matrix.python-version == 'pypy3' || contains(matrix.env.TOXENV, 'pinned') || matrix.python-version == '3.10.0-beta.4'
+      if: contains(matrix.python-version, 'pypy') || contains(matrix.env.TOXENV, 'min')
       run: |
         sudo apt-get update
-        # libxml2 2.9.12 from ondrej/php PPA breaks lxml so we pin it to the bionic-updates repo version
-        sudo apt-get install libxml2-dev/bionic-updates libxslt-dev
+        sudo apt-get install libxml2-dev libxslt-dev
+
+    - name: Set up uv
+      uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      with:
+        cache-dependency-glob: |
+          pyproject.toml
+          tox.ini
+
+    - name: Install mitmproxy
+      env:
+        # mitmproxy needs a newer Python than the oldest matrix entries, so let
+        # uv download one where no system interpreter is new enough.
+        UV_PYTHON_PREFERENCE: system
+      # mitmproxy has no PyPy wheels, so run it on CPython regardless of the
+      # interpreter under test.
+      run: uv tool install --python cpython mitmproxy
 
     - name: Run tests
       env: ${{ matrix.env }}
-      run: |
-        if [[ ! -z "$PYPY_VERSION" ]]; then
-          export PYPY_VERSION="pypy$PYPY_VERSION-linux64"
-          wget "https://downloads.python.org/pypy/${PYPY_VERSION}.tar.bz2"
-          tar -jxf ${PYPY_VERSION}.tar.bz2
-          $PYPY_VERSION/bin/pypy3 -m venv "$HOME/virtualenvs/$PYPY_VERSION"
-          source "$HOME/virtualenvs/$PYPY_VERSION/bin/activate"
-        fi
-        if [[ ! -z "$TOX_PIP_VERSION" ]]; then
-            pip install tox-pip-version
-        fi
-        pip install -U tox
-        tox
+      run: uvx --with tox-uv tox
 
     - name: Upload coverage report
-      run: bash <(curl -s https://codecov.io/bash)
+      if: ${{ matrix.coverage }}
+      uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
+
+    - name: Upload test results
+      if: ${{ !cancelled() }}
+      uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
+      with:
+        report_type: test_results

.github/workflows/tests-windows.yml

@@ -1,39 +1,89 @@
 name: Windows
-on: [push, pull_request]
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+    - master
+    - '[0-9]+.[0-9]+'
+  pull_request:
+
+concurrency:
+  group: ${{github.workflow}}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
   tests:
+    name: tests (${{ matrix.python-version }}, ${{ matrix.env.TOXENV }})
     runs-on: windows-latest
+    env:
+      PYTEST_ADDOPTS: ${{ matrix.coverage && '-n auto' || '-n auto --no-cov' }}
+      # Make uv use the interpreter that actions/setup-python installed instead
+      # of downloading one of its own.
+      UV_PYTHON_PREFERENCE: only-system
     strategy:
       fail-fast: false
       matrix:
         include:
-        - python-version: 3.6
-          env:
-            TOXENV: windows-pinned
-        - python-version: 3.7
-          env:
-            TOXENV: py
-        - python-version: 3.8
-          env:
-            TOXENV: py
-        - python-version: 3.9
-          env:
-            TOXENV: py
         - python-version: "3.10"
           env:
             TOXENV: py
+        - python-version: "3.14"
+          env:
+            TOXENV: py
+          coverage: true
+        - python-version: "3.14"
+          env:
+            TOXENV: no-reactor
+
+        # min deps
+        - python-version: "3.10.11"
+          env:
+            TOXENV: min
+        - python-version: "3.10.11"
+          env:
+            TOXENV: min-extra-deps
+
+        - python-version: "3.14"
+          env:
+            TOXENV: extra-deps
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      with:
+        persist-credentials: false
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
       with:
         python-version: ${{ matrix.python-version }}
 
+    - name: Set up uv
+      uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      with:
+        cache-dependency-glob: |
+          pyproject.toml
+          tox.ini
+
+    - name: Install mitmproxy
+      env:
+        # mitmproxy needs a newer Python than the oldest matrix entries, so let
+        # uv download one where no system interpreter is new enough.
+        UV_PYTHON_PREFERENCE: system
+      run: uv tool install mitmproxy
+
     - name: Run tests
       env: ${{ matrix.env }}
-      run: |
-        pip install -U tox
-        tox
+      run: uvx --with tox-uv tox
+
+    - name: Upload coverage report
+      if: ${{ matrix.coverage }}
+      uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
+
+    - name: Upload test results
+      if: ${{ !cancelled() }}
+      uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
+      with:
+        report_type: test_results

.gitignore

@@ -3,18 +3,21 @@
 *.pyc
 _trial_temp*
 dropin.cache
-docs/build
+docs/_build
 *egg-info
-.tox
-venv
-build
-dist
-.idea
+.tox/
+venv/
+.venv/
+build/
+dist/
+.idea/
+.vscode/
 htmlcov/
-.coverage
 .pytest_cache/
+.coverage
 .coverage.*
 coverage.*
+*.junit.xml
 test-output.*
 .cache/
 .mypy_cache/
@@ -23,3 +26,6 @@ test-output.*
 
 # Windows
 Thumbs.db
+
+# OSX miscellaneous
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+exclude: |
+  (?x)(
+      ^docs/_static|
+      ^docs/_tests|
+      ^tests/sample_data
+  )
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.15.20
+  hooks:
+    - id: ruff-check
+      args: [ --fix ]
+    - id: ruff-format
+- repo: https://github.com/adamchainz/blacken-docs
+  rev: 1.20.0
+  hooks:
+  - id: blacken-docs
+    additional_dependencies:
+    - black==26.5.1
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v6.0.0
+  hooks:
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/sphinx-contrib/sphinx-lint
+  rev: v1.0.2
+  hooks:
+    - id: sphinx-lint
+- repo: https://github.com/scrapy/sphinx-scrapy
+  rev: 0.8.10
+  hooks:
+    - id: sphinx-scrapy
+- repo: https://github.com/zizmorcore/zizmor-pre-commit
+  rev: v1.28.0
+  hooks:
+    - id: zizmor
+      args: [--no-progress, --fix]

.readthedocs.yml

@@ -1,17 +1,10 @@
 version: 2
-formats: all
-sphinx:
-  configuration: docs/conf.py
-  fail_on_warning: true
-
 build:
-  os: ubuntu-20.04
+  os: ubuntu-24.04
   tools:
-    # For available versions, see:
-    # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools-python
-    python: "3.10"  # Keep in sync with .github/workflows/checks.yml
-
-python:
-  install:
-    - requirements: docs/requirements.txt
-    - path: .
+    python: "3.14"
+  commands:
+    - pip install tox
+    - tox -e docs
+    - mkdir -p $READTHEDOCS_OUTPUT/html
+    - cp -a docs/_build/all/. $READTHEDOCS_OUTPUT/html/

CITATION.cff

@@ -0,0 +1,6 @@
+cff-version: 1.2.0
+message: If you use Scrapy in published research, please cite it as below.
+title: Scrapy
+authors:
+  - name: Scrapy contributors
+url: https://scrapy.org

CODE_OF_CONDUCT.md

@@ -1,77 +1,133 @@
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to make participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+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 creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+* 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 by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* 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 electronic
-  address, without explicit permission
+* 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
 
-## Our Responsibilities
+## Enforcement Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+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.
 
-Project maintainers 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, or to ban temporarily or
-permanently any contributor for other behaviors 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 both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
+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 by contacting the project team at opensource@zyte.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+reported to the community leaders responsible for enforcement at
+opensource@zyte.com.
+All complaints will be reviewed and investigated promptly and fairly.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
+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 1.4,
-available at [http://contributor-covenant.org/version/1/4][version].
+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].
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+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
-https://www.contributor-covenant.org/faq
+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

INSTALL

@@ -1,4 +0,0 @@
-For information about installing Scrapy see:
-
-* docs/intro/install.rst (local file)
-* https://docs.scrapy.org/en/latest/intro/install.html (online version)

INSTALL.md

@@ -0,0 +1,4 @@
+For information about installing Scrapy see:
+
+* [Local docs](docs/intro/install.rst)
+* [Online docs](https://docs.scrapy.org/en/latest/intro/install.html)

MANIFEST.in

@@ -1,26 +0,0 @@
-include README.rst
-include AUTHORS
-include INSTALL
-include LICENSE
-include MANIFEST.in
-include NEWS
-
-include scrapy/VERSION
-include scrapy/mime.types
-
-include codecov.yml
-include conftest.py
-include pytest.ini
-include requirements-*.txt
-include tox.ini
-
-recursive-include scrapy/templates *
-recursive-include scrapy license.txt
-recursive-include docs *
-prune docs/build
-
-recursive-include extras *
-recursive-include bin *
-recursive-include tests *
-
-global-exclude __pycache__ *.py[cod]

README.rst

@@ -1,112 +1,54 @@
-.. image:: /artwork/scrapy-logo.jpg
-   :width: 400px
-   
-======
-Scrapy
-======
+|logo|
 
-.. image:: https://img.shields.io/pypi/v/Scrapy.svg
-   :target: https://pypi.python.org/pypi/Scrapy
+.. |logo| image:: https://raw.githubusercontent.com/scrapy/scrapy/master/docs/_static/logo.svg
+   :target: https://scrapy.org
+   :alt: Scrapy
+   :width: 480px
+
+|version| |python_version| |tests| |coverage| |conda| |deepwiki|
+
+.. |version| image:: https://img.shields.io/pypi/v/Scrapy.svg
+   :target: https://pypi.org/pypi/Scrapy
    :alt: PyPI Version
 
-.. image:: https://img.shields.io/pypi/pyversions/Scrapy.svg
-   :target: https://pypi.python.org/pypi/Scrapy
+.. |python_version| image:: https://img.shields.io/pypi/pyversions/Scrapy.svg
+   :target: https://pypi.org/pypi/Scrapy
    :alt: Supported Python Versions
 
-.. image:: https://github.com/scrapy/scrapy/workflows/Ubuntu/badge.svg
-   :target: https://github.com/scrapy/scrapy/actions?query=workflow%3AUbuntu
-   :alt: Ubuntu
+.. |tests| image:: https://img.shields.io/github/check-runs/scrapy/scrapy/master?label=tests
+   :target: https://github.com/scrapy/scrapy/actions?query=branch%3Amaster
+   :alt: Tests
 
-.. image:: https://github.com/scrapy/scrapy/workflows/macOS/badge.svg
-   :target: https://github.com/scrapy/scrapy/actions?query=workflow%3AmacOS
-   :alt: macOS
-
-.. image:: https://github.com/scrapy/scrapy/workflows/Windows/badge.svg
-   :target: https://github.com/scrapy/scrapy/actions?query=workflow%3AWindows
-   :alt: Windows
-
-.. image:: https://img.shields.io/badge/wheel-yes-brightgreen.svg
-   :target: https://pypi.python.org/pypi/Scrapy
-   :alt: Wheel Status
-
-.. image:: https://img.shields.io/codecov/c/github/scrapy/scrapy/master.svg
+.. |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
 
-.. image:: https://anaconda.org/conda-forge/scrapy/badges/version.svg
+.. |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
 
-Overview
-========
-
-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.
-
-Scrapy is maintained by Zyte_ (formerly Scrapinghub) and `many other
-contributors`_.
+Scrapy_ is a web scraping framework to extract structured data from websites.
+It is cross-platform, and requires Python 3.10+. 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/
 
-Check the Scrapy homepage at https://scrapy.org for more information,
-including a list of features.
+Install with:
 
-
-Requirements
-============
-
-* Python 3.6+
-* Works on Linux, Windows, macOS, BSD
-
-Install
-=======
-
-The quick way::
+.. code:: bash
 
     pip install scrapy
 
-See the install section in the documentation at
-https://docs.scrapy.org/en/latest/intro/install.html for more details.
+And follow the documentation_ to learn how to use it.
 
-Documentation
-=============
+.. _documentation: https://docs.scrapy.org/en/latest/
 
-Documentation is available online at https://docs.scrapy.org/ and in the ``docs``
-directory.
+If you wish to contribute, see Contributing_.
 
-Releases
-========
-
-You can check https://docs.scrapy.org/en/latest/news.html for the release notes.
-
-Community (blog, twitter, mail list, IRC)
-=========================================
-
-See https://scrapy.org/community/ for details.
-
-Contributing
-============
-
-See https://docs.scrapy.org/en/master/contributing.html for details.
-
-Code of Conduct
----------------
-
-Please note that this project is released with a Contributor Code of Conduct
-(see https://github.com/scrapy/scrapy/blob/master/CODE_OF_CONDUCT.md).
-
-By participating in this project you agree to abide by its terms.
-Please report unacceptable behavior to opensource@zyte.com.
-
-Companies using Scrapy
-======================
-
-See https://scrapy.org/companies/ for a list.
-
-Commercial Support
-==================
-
-See https://scrapy.org/support/ for details.
+.. _Contributing: https://docs.scrapy.org/en/master/contributing.html

SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 2.17.x     | :white_check_mark: |
+| < 2.17.x   | :x:                |
+
+## Reporting a Vulnerability
+
+Please report the vulnerability using https://github.com/scrapy/scrapy/security/advisories/new.

artwork/README.rst

@@ -1,20 +0,0 @@
-==============
-Scrapy artwork
-==============
-
-This folder contains Scrapy artwork resources such as logos and fonts.
-
-scrapy-logo.jpg
----------------
-
-Main Scrapy logo, in JPEG format.
-
-qlassik.zip
------------
-
-Font used for Scrapy logo. Homepage: https://www.dafont.com/qlassik.font
-
-scrapy-blog.logo.xcf
---------------------
-
-The logo used in Scrapy blog, in Gimp format.

conftest.py

@@ -1,90 +1,144 @@
+from __future__ import annotations
+
+import os
+from importlib.util import find_spec
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 import pytest
 from twisted.web.http import H2_ENABLED
 
-from scrapy.utils.reactor import install_reactor
-
+from scrapy.utils.reactor import set_asyncio_event_loop_policy
+from scrapy.utils.reactorless import install_reactor_import_hook
 from tests.keys import generate_keys
+from tests.mockserver.http import MockServer
+from tests.mockserver.mitm_proxy import MitmProxy, mitmdump_cmd
+
+if TYPE_CHECKING:
+    from collections.abc import Generator
 
 
 def _py_files(folder):
-    return (str(p) for p in Path(folder).rglob('*.py'))
+    return (str(p) for p in Path(folder).rglob("*.py"))
 
 
 collect_ignore = [
-    # not a test, but looks like a test
-    "scrapy/utils/testsite.py",
-    # contains scripts to be run by tests/test_crawler.py::CrawlerProcessSubprocess
+    # may need extra deps
+    "docs/_ext",
+    # contains scripts to be run by tests/test_crawler_subprocess.py::AsyncCrawlerProcessSubprocess
+    *_py_files("tests/AsyncCrawlerProcess"),
+    # contains scripts to be run by tests/test_crawler_subprocess.py::AsyncCrawlerRunnerSubprocess
+    *_py_files("tests/AsyncCrawlerRunner"),
+    # contains scripts to be run by tests/test_crawler_subprocess.py::CrawlerProcessSubprocess
     *_py_files("tests/CrawlerProcess"),
-    # contains scripts to be run by tests/test_crawler.py::CrawlerRunnerSubprocess
+    # contains scripts to be run by tests/test_crawler_subprocess.py::CrawlerRunnerSubprocess
     *_py_files("tests/CrawlerRunner"),
 ]
 
-with open('tests/ignores.txt') as reader:
+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] != '#':
+        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',
+            "scrapy/core/downloader/handlers/http2.py",
             *_py_files("scrapy/core/http2"),
         )
     )
 
+if find_spec("httpx2") is None and find_spec("httpx") is None:
+    collect_ignore.append("scrapy/core/downloader/handlers/_httpx.py")
 
-@pytest.fixture()
-def chdir(tmpdir):
-    """Change to pytest-provided temporary directory"""
-    tmpdir.chdir()
+if find_spec("pytest_codspeed") is None:
+    collect_ignore.append("tests/benchmarks")
 
 
-def pytest_collection_modifyitems(session, config, items):
-    # Avoid executing tests when executing `--flake8` flag (pytest-flake8)
-    try:
-        from pytest_flake8 import Flake8Item
-        if config.getoption('--flake8'):
-            items[:] = [item for item in items if isinstance(item, Flake8Item)]
-    except ImportError:
-        pass
-
-
-def pytest_addoption(parser):
+def pytest_addoption(parser, pluginmanager):
+    if pluginmanager.hasplugin("twisted"):
+        return
+    # add the full choice set so that pytest doesn't complain about invalid choices in some cases
     parser.addoption(
         "--reactor",
-        default="default",
-        choices=["default", "asyncio"],
+        default="none",
+        choices=["asyncio", "default", "none"],
     )
 
 
-@pytest.fixture(scope='class')
-def reactor_pytest(request):
-    if not request.cls:
-        # doctests
-        return
-    request.cls.reactor_pytest = request.config.getoption("--reactor")
-    return request.cls.reactor_pytest
+@pytest.fixture(scope="session")
+def mockserver() -> Generator[MockServer]:
+    with MockServer() as mockserver:
+        yield mockserver
 
 
-@pytest.fixture(autouse=True)
-def only_asyncio(request, reactor_pytest):
-    if request.node.get_closest_marker('only_asyncio') and reactor_pytest != 'asyncio':
-        pytest.skip('This test is only run with --reactor=asyncio')
+@pytest.fixture  # function scope because it modifies os.environ
+def proxy_server(
+    request: pytest.FixtureRequest, monkeypatch: pytest.MonkeyPatch
+) -> Generator[str]:
+    kind = request.param
+    proxy = MitmProxy(mode="socks5" if kind == "socks5" else None)
+    url = proxy.start()
+    if kind == "https":
+        url = url.replace("http://", "https://")
+    monkeypatch.setenv("http_proxy", url)
+    monkeypatch.setenv("https_proxy", url)
+
+    try:
+        yield kind
+    finally:
+        proxy.stop()
 
 
-@pytest.fixture(autouse=True)
-def only_not_asyncio(request, reactor_pytest):
-    if request.node.get_closest_marker('only_not_asyncio') and reactor_pytest == 'asyncio':
-        pytest.skip('This test is only run without --reactor=asyncio')
+@pytest.fixture(scope="session")
+def reactor_pytest(request) -> str:
+    return request.config.getoption("--reactor")
 
 
 def pytest_configure(config):
     if config.getoption("--reactor") == "asyncio":
-        install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor")
+        # Needed on Windows to switch from proactor to selector for Twisted reactor compatibility.
+        # If we decide to run tests with both, we will need to add a new option and check it here.
+        set_asyncio_event_loop_policy()
+    elif config.getoption("--reactor") == "none":
+        install_reactor_import_hook()
 
 
-# Generate localhost certificate files, needed by some tests
-generate_keys()
+def pytest_runtest_setup(item):
+    # Skip tests based on reactor markers
+    reactor = item.config.getoption("--reactor")
+
+    if item.get_closest_marker("requires_reactor") and reactor == "none":
+        pytest.skip('This test is only run when the --reactor value is not "none"')
+
+    if item.get_closest_marker("only_asyncio") and reactor not in {"asyncio", "none"}:
+        pytest.skip(
+            'This test is only run when the --reactor value is "asyncio" (default) or "none"'
+        )
+
+    if item.get_closest_marker("only_not_asyncio") and reactor in {"asyncio", "none"}:
+        pytest.skip(
+            'This test is only run when the --reactor value is not "asyncio" (default) or "none"'
+        )
+
+    # Skip tests requiring optional dependencies
+    optional_deps = [
+        "uvloop",
+        "botocore",
+        "boto3",
+    ]
+
+    for module in optional_deps:
+        if item.get_closest_marker(f"requires_{module}") and find_spec(module) is None:
+            pytest.skip(f"{module} is not installed")
+
+    if item.get_closest_marker("requires_mitmproxy") and mitmdump_cmd() is None:
+        pytest.skip("mitmdump is not available")
+
+
+# Generate localhost certificate files, needed by some tests (but only once if xdist is used)
+if "PYTEST_XDIST_WORKER" not in os.environ:
+    generate_keys()

docs/Makefile

@@ -1,96 +1,20 @@
-#
-# Makefile for Scrapy documentation [based on Python documentation Makefile]
-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Minimal makefile for Sphinx documentation
 #
 
-# You can set these variables from the command line.
-PYTHON       = python
-SPHINXOPTS   =
-PAPER        =
-SOURCES      =
-SHELL        = /usr/bin/env bash
-
-ALLSPHINXOPTS = -b $(BUILDER) -d build/doctrees \
-                -D latex_elements.papersize=$(PAPER) \
-                $(SPHINXOPTS) . build/$(BUILDER) $(SOURCES)
-
-.PHONY: help update build html htmlhelp clean
+# 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:
-	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  html      to make standalone HTML files"
-	@echo "  htmlhelp  to make HTML files and a HTML help project"
-	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  text      to make plain text files"
-	@echo "  changes   to make an overview over all changed/added/deprecated items"
-	@echo "  linkcheck to check all external links for integrity"
-	@echo "  watch     build HTML docs, open in browser and watch for changes"
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-build-dirs:
-	mkdir -p build/$(BUILDER) build/doctrees
+.PHONY: help Makefile
 
-build: build-dirs
-	sphinx-build $(ALLSPHINXOPTS)
-	@echo
-
-build-ignore-errors: build-dirs
-	-sphinx-build $(ALLSPHINXOPTS)
-	@echo
-
-
-html: BUILDER = html
-html: build
-	@echo "Build finished. The HTML pages are in build/html."
-
-htmlhelp: BUILDER = htmlhelp
-htmlhelp: build
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      "build/htmlhelp/pydoc.hhp project file."
-
-latex: BUILDER = latex
-latex: build
-	@echo "Build finished; the LaTeX files are in build/latex."
-	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
-	      "run these through (pdf)latex."
-
-text: BUILDER = text
-text: build
-	@echo "Build finished; the text files are in build/text."
-
-changes: BUILDER = changes
-changes: build
-	@echo "The overview file is in build/changes."
-
-linkcheck: BUILDER = linkcheck
-linkcheck: build
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in build/$(BUILDER)/output.txt"
-
-linkfix: BUILDER = linkcheck
-linkfix: build-ignore-errors
-	$(PYTHON) utils/linkfix.py
-	@echo "Fixing redirecting links in docs has finished; check all " \
-	      "replacements before committing them"
-
-doctest: BUILDER = doctest
-doctest: build
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in build/doctest/output.txt"
-
-pydoc-topics: BUILDER = pydoc-topics
-pydoc-topics: build
-	@echo "Building finished; now copy build/pydoc-topics/pydoc_topics.py " \
-	      "into the Lib/ directory"
-
-coverage: BUILDER = coverage
-coverage: build
-
-htmlview: html
-	 $(PYTHON) -c "import webbrowser, os; webbrowser.open('file://' + \
-	 os.path.realpath('build/html/index.html'))"
-
-clean:
-	-rm -rf build/*
-
-watch: htmlview
-	watchmedo shell-command -p '*.rst' -c 'make html' -R -D
+# 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)

docs/README.rst

@@ -1,68 +0,0 @@
-: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 cleanup 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.

docs/_ext/scrapydocs.py

@@ -1,63 +1,74 @@
-from docutils.parsers.rst.roles import set_classes
-from docutils import nodes
-from docutils.parsers.rst import Directive
-from sphinx.util.nodes import make_refnode
+# 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 settingslist_node(nodes.General, nodes.Element):
+class SettingData(TypedDict):
+    docname: str
+    setting_name: str
+    refid: str
+
+
+class SettingslistNode(General, Element):
     pass
 
 
 class SettingsListDirective(Directive):
-    def run(self):
-        return [settingslist_node('')]
+    def run(self) -> Sequence[Node]:
+        return [SettingslistNode()]
 
 
-def is_setting_index(node):
-    if node.tagname == 'index':
+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]
-        return entry_type == 'pair' and info.endswith('; setting')
+        entry_type, info, _ = node["entries"][0][:3]  # type: ignore[index]
+        return entry_type == "pair" and info.endswith("; setting")
     return False
 
 
-def get_setting_target(node):
-    # target nodes are placed next to the node in the doc tree
-    return node.parent[node.parent.index(node) + 1]
-
-
-def get_setting_name_and_refid(node):
+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]
-    return info.replace('; setting', ''), refid
+    _, info, refid = node["entries"][0][:3]  # type: ignore[index]
+    return info.replace("; setting", ""), refid
 
 
-def collect_scrapy_settings_refs(app, doctree):
+def collect_scrapy_settings_refs(app: Sphinx, doctree: document) -> None:
     env = app.builder.env
 
-    if not hasattr(env, 'scrapy_all_settings'):
-        env.scrapy_all_settings = []
-
-    for node in doctree.traverse(is_setting_index):
-        targetnode = get_setting_target(node)
-        assert isinstance(targetnode, nodes.target), "Next node is not a target"
+    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({
-            'docname': env.docname,
-            'setting_name': setting_name,
-            'refid': refid,
-        })
+        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, app, fromdocname):
-    refnode = make_refnode(app.builder, fromdocname,
-                           todocname=setting_data['docname'],
-                           targetid=setting_data['refid'],
-                           child=nodes.Text(setting_data['setting_name']))
+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
 
@@ -66,74 +77,106 @@ def make_setting_element(setting_data, app, fromdocname):
     return item
 
 
-def replace_settingslist_nodes(app, doctree, fromdocname):
+def make_setting_markdown_item(
+    setting_data: SettingData, app: Sphinx, fromdocname: str
+) -> str:
+    uri = app.builder.get_relative_uri(fromdocname, setting_data["docname"])
+    if uri.startswith("#"):
+        target = f"#{setting_data['refid']}"
+    else:
+        target = f"{uri}#{setting_data['refid']}"
+    return f"* [{setting_data['setting_name']}]({target})"
+
+
+def _iter_sorted_settings(env: Any, fromdocname: str) -> list[SettingData]:
+    return [
+        d
+        for d in sorted(env.scrapy_all_settings, key=itemgetter("setting_name"))  # type: ignore[attr-defined]
+        if fromdocname != d["docname"]
+    ]
+
+
+def replace_settingslist_nodes(
+    app: Sphinx, doctree: document, fromdocname: str
+) -> None:
     env = app.builder.env
 
-    for node in doctree.traverse(settingslist_node):
+    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'))
-                              if fromdocname != d['docname']])
+        settings_list.extend(
+            [
+                make_setting_element(d, app, fromdocname)
+                for d in _iter_sorted_settings(env, fromdocname)
+            ]
+        )
         node.replace_self(settings_list)
 
 
-def setup(app):
-    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(settingslist_node)
-    app.add_directive('settingslist', SettingsListDirective)
-
-    app.connect('doctree-read', collect_scrapy_settings_refs)
-    app.connect('doctree-resolved', replace_settingslist_nodes)
+def visit_settingslist_node_markdown(translator: Any, _node: Node) -> None:
+    builder = translator.builder
+    env = builder.env
+    fromdocname = getattr(builder, "current_doc_name", env.docname)
+    lines = [
+        make_setting_markdown_item(setting_data, builder.app, fromdocname)
+        for setting_data in _iter_sorted_settings(env, fromdocname)
+    ]
+    if lines:
+        translator.add("\n".join(lines), prefix_eol=2, suffix_eol=2)
+    raise nodes.SkipNode
 
 
-def source_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
-    ref = 'https://github.com/scrapy/scrapy/blob/master/' + text
-    set_classes(options)
+def depart_settingslist_node_markdown(_translator: Any, _node: Node) -> None:
+    return None
+
+
+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, lineno, inliner, options={}, content=[]):
-    ref = 'https://github.com/scrapy/scrapy/issues/' + text
-    set_classes(options)
-    node = nodes.reference(rawtext, 'issue ' + text, refuri=ref, **options)
+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, lineno, inliner, options={}, content=[]):
-    ref = 'https://github.com/scrapy/scrapy/commit/' + text
-    set_classes(options)
-    node = nodes.reference(rawtext, 'commit ' + text, refuri=ref, **options)
+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, lineno, inliner, options={}, content=[]):
-    ref = 'http://hg.scrapy.org/scrapy/changeset/' + text
-    set_classes(options)
-    node = nodes.reference(rawtext, 'r' + text, refuri=ref, **options)
+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) -> dict[str, Any]:
+    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,
+        markdown=(visit_settingslist_node_markdown, depart_settingslist_node_markdown),
+        singlemarkdown=(
+            visit_settingslist_node_markdown,
+            depart_settingslist_node_markdown,
+        ),
+    )
+    app.add_directive("settingslist", SettingsListDirective)
+
+    app.connect("doctree-read", collect_scrapy_settings_refs)
+    app.connect("doctree-resolved", replace_settingslist_nodes)
+    return {"parallel_read_safe": True}

docs/_ext/scrapyfixautodoc.py

@@ -0,0 +1,21 @@
+"""
+Must be included after 'sphinx.ext.autodoc'. Fixes unwanted 'alias of' behavior.
+https://github.com/sphinx-doc/sphinx/issues/4422
+"""
+
+from typing import Any
+
+# 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:
+        # autodoc was generating the text "alias of" for the following members
+        return name in {"default_item_class", "default_selector_class"}
+    return skip
+
+
+def setup(app: Sphinx) -> dict[str, Any]:
+    app.connect("autodoc-skip-member", maybe_skip_member)
+    return {"parallel_read_safe": True}

docs/_static/custom.css

@@ -7,4 +7,50 @@
 }
 .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
+}

docs/_static/selectors-sample1.html

@@ -1,16 +1,17 @@
-<html>
- <head>
-  <base href='http://example.com/' />
-  <title>Example website</title>
- </head>
- <body>
-  <div id='images'>
-   <a href='image1.html'>Name: My image 1 <br /><img src='image1_thumb.jpg' /></a>
-   <a href='image2.html'>Name: My image 2 <br /><img src='image2_thumb.jpg' /></a>
-   <a href='image3.html'>Name: My image 3 <br /><img src='image3_thumb.jpg' /></a>
-   <a href='image4.html'>Name: My image 4 <br /><img src='image4_thumb.jpg' /></a>
-   <a href='image5.html'>Name: My image 5 <br /><img src='image5_thumb.jpg' /></a>
-  </div>
- </body>
-</html>
+<!DOCTYPE html>
 
+<html>
+  <head>
+    <base href='http://example.com/' />
+    <title>Example website</title>
+  </head>
+  <body>
+    <div id='images'>
+      <a href='image1.html'>Name: My image 1 <br /><img src='image1_thumb.jpg' alt='image1'/></a>
+      <a href='image2.html'>Name: My image 2 <br /><img src='image2_thumb.jpg' alt='image2'/></a>
+      <a href='image3.html'>Name: My image 3 <br /><img src='image3_thumb.jpg' alt='image3'/></a>
+      <a href='image4.html'>Name: My image 4 <br /><img src='image4_thumb.jpg' alt='image4'/></a>
+      <a href='image5.html'>Name: My image 5 <br /><img src='image5_thumb.jpg' alt='image5'/></a>
+    </div>
+  </body>
+</html>

docs/_templates/layout.html

@@ -1,11 +1,23 @@
 {% extends "!layout.html" %}
 
-{% block footer %}
-{{ super() }}
-<script type="text/javascript">
-analytics.ready(function () {
-    ga('require', 'linker');
-    ga('linker:autoLink', ['zyte.com']);
-});
-</script>
-{% endblock %}
+{# Overridden 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) %}
+<a href="https://scrapy.org">scrapy.org</a> / <a href="{{ pathto(_root_doc) }}">docs</a>
+
+{%- if READTHEDOCS or DEBUG %}
+  {%- if theme_version_selector or theme_language_selector %}
+    <div class="switch-menus">
+      <div class="version-switch"></div>
+      <div class="language-switch"></div>
+    </div>
+  {%- endif %}
+{%- endif %}
+
+{%- include "searchbox.html" %}
+
+{%- endblock %}

docs/_tests/quotes.html

@@ -16,13 +16,13 @@
             </div>
             <div class="col-md-4">
                 <p>
-                
+
                     <a href="/login">Login</a>
-                
+
                 </p>
             </div>
         </div>
-    
+
 
 <div class="row">
     <div class="col-md-8">
@@ -34,16 +34,16 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="change,deep-thoughts,thinking,world" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="change,deep-thoughts,thinking,world" /    >
+
             <a class="tag" href="/tag/change/page/1/">change</a>
-            
+
             <a class="tag" href="/tag/deep-thoughts/page/1/">deep-thoughts</a>
-            
+
             <a class="tag" href="/tag/thinking/page/1/">thinking</a>
-            
+
             <a class="tag" href="/tag/world/page/1/">world</a>
-            
+
         </div>
     </div>
 
@@ -54,12 +54,12 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="abilities,choices" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="abilities,choices" /    >
+
             <a class="tag" href="/tag/abilities/page/1/">abilities</a>
-            
+
             <a class="tag" href="/tag/choices/page/1/">choices</a>
-            
+
         </div>
     </div>
 
@@ -70,18 +70,18 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="inspirational,life,live,miracle,miracles" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="inspirational,life,live,miracle,miracles" /    >
+
             <a class="tag" href="/tag/inspirational/page/1/">inspirational</a>
-            
+
             <a class="tag" href="/tag/life/page/1/">life</a>
-            
+
             <a class="tag" href="/tag/live/page/1/">live</a>
-            
+
             <a class="tag" href="/tag/miracle/page/1/">miracle</a>
-            
+
             <a class="tag" href="/tag/miracles/page/1/">miracles</a>
-            
+
         </div>
     </div>
 
@@ -92,16 +92,16 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="aliteracy,books,classic,humor" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="aliteracy,books,classic,humor" /    >
+
             <a class="tag" href="/tag/aliteracy/page/1/">aliteracy</a>
-            
+
             <a class="tag" href="/tag/books/page/1/">books</a>
-            
+
             <a class="tag" href="/tag/classic/page/1/">classic</a>
-            
+
             <a class="tag" href="/tag/humor/page/1/">humor</a>
-            
+
         </div>
     </div>
 
@@ -112,12 +112,12 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="be-yourself,inspirational" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="be-yourself,inspirational" /    >
+
             <a class="tag" href="/tag/be-yourself/page/1/">be-yourself</a>
-            
+
             <a class="tag" href="/tag/inspirational/page/1/">inspirational</a>
-            
+
         </div>
     </div>
 
@@ -128,14 +128,14 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="adulthood,success,value" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="adulthood,success,value" /    >
+
             <a class="tag" href="/tag/adulthood/page/1/">adulthood</a>
-            
+
             <a class="tag" href="/tag/success/page/1/">success</a>
-            
+
             <a class="tag" href="/tag/value/page/1/">value</a>
-            
+
         </div>
     </div>
 
@@ -146,12 +146,12 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="life,love" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="life,love" /    >
+
             <a class="tag" href="/tag/life/page/1/">life</a>
-            
+
             <a class="tag" href="/tag/love/page/1/">love</a>
-            
+
         </div>
     </div>
 
@@ -162,16 +162,16 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="edison,failure,inspirational,paraphrased" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="edison,failure,inspirational,paraphrased" /    >
+
             <a class="tag" href="/tag/edison/page/1/">edison</a>
-            
+
             <a class="tag" href="/tag/failure/page/1/">failure</a>
-            
+
             <a class="tag" href="/tag/inspirational/page/1/">inspirational</a>
-            
+
             <a class="tag" href="/tag/paraphrased/page/1/">paraphrased</a>
-            
+
         </div>
     </div>
 
@@ -182,10 +182,10 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="misattributed-eleanor-roosevelt" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="misattributed-eleanor-roosevelt" /    >
+
             <a class="tag" href="/tag/misattributed-eleanor-roosevelt/page/1/">misattributed-eleanor-roosevelt</a>
-            
+
         </div>
     </div>
 
@@ -196,73 +196,73 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="humor,obvious,simile" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="humor,obvious,simile" /    >
+
             <a class="tag" href="/tag/humor/page/1/">humor</a>
-            
+
             <a class="tag" href="/tag/obvious/page/1/">obvious</a>
-            
+
             <a class="tag" href="/tag/simile/page/1/">simile</a>
-            
+
         </div>
     </div>
 
     <nav>
         <ul class="pager">
-            
-            
+
+
             <li class="next">
                 <a href="/page/2/">Next <span aria-hidden="true">&rarr;</span></a>
             </li>
-            
+
         </ul>
     </nav>
     </div>
     <div class="col-md-4 tags-box">
-        
+
             <h2>Top Ten tags</h2>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 28px" href="/tag/love/">love</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 26px" href="/tag/inspirational/">inspirational</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 26px" href="/tag/life/">life</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 24px" href="/tag/humor/">humor</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 22px" href="/tag/books/">books</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 14px" href="/tag/reading/">reading</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 10px" href="/tag/friendship/">friendship</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 8px" href="/tag/friends/">friends</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 8px" href="/tag/truth/">truth</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 6px" href="/tag/simile/">simile</a>
             </span>
-            
-        
+
+
     </div>
 </div>
 
@@ -273,7 +273,7 @@
                 Quotes by: <a href="https://www.goodreads.com/quotes">GoodReads.com</a>
             </p>
             <p class="copyright">
-                Made with <span class='sh-red'>❤</span> by <a href="https://scrapinghub.com">Scrapinghub</a>
+                Made with <span class='sh-red'>❤</span> by <a href="https://www.zyte.com">Zyte</a>
             </p>
         </div>
     </footer>

docs/_tests/quotes1.html

@@ -16,13 +16,13 @@
             </div>
             <div class="col-md-4">
                 <p>
-                
+
                     <a href="/login">Login</a>
-                
+
                 </p>
             </div>
         </div>
-    
+
 
 <div class="row">
     <div class="col-md-8">
@@ -34,16 +34,16 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="change,deep-thoughts,thinking,world" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="change,deep-thoughts,thinking,world" /    >
+
             <a class="tag" href="/tag/change/page/1/">change</a>
-            
+
             <a class="tag" href="/tag/deep-thoughts/page/1/">deep-thoughts</a>
-            
+
             <a class="tag" href="/tag/thinking/page/1/">thinking</a>
-            
+
             <a class="tag" href="/tag/world/page/1/">world</a>
-            
+
         </div>
     </div>
 
@@ -54,12 +54,12 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="abilities,choices" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="abilities,choices" /    >
+
             <a class="tag" href="/tag/abilities/page/1/">abilities</a>
-            
+
             <a class="tag" href="/tag/choices/page/1/">choices</a>
-            
+
         </div>
     </div>
 
@@ -70,18 +70,18 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="inspirational,life,live,miracle,miracles" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="inspirational,life,live,miracle,miracles" /    >
+
             <a class="tag" href="/tag/inspirational/page/1/">inspirational</a>
-            
+
             <a class="tag" href="/tag/life/page/1/">life</a>
-            
+
             <a class="tag" href="/tag/live/page/1/">live</a>
-            
+
             <a class="tag" href="/tag/miracle/page/1/">miracle</a>
-            
+
             <a class="tag" href="/tag/miracles/page/1/">miracles</a>
-            
+
         </div>
     </div>
 
@@ -92,16 +92,16 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="aliteracy,books,classic,humor" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="aliteracy,books,classic,humor" /    >
+
             <a class="tag" href="/tag/aliteracy/page/1/">aliteracy</a>
-            
+
             <a class="tag" href="/tag/books/page/1/">books</a>
-            
+
             <a class="tag" href="/tag/classic/page/1/">classic</a>
-            
+
             <a class="tag" href="/tag/humor/page/1/">humor</a>
-            
+
         </div>
     </div>
 
@@ -112,12 +112,12 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="be-yourself,inspirational" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="be-yourself,inspirational" /    >
+
             <a class="tag" href="/tag/be-yourself/page/1/">be-yourself</a>
-            
+
             <a class="tag" href="/tag/inspirational/page/1/">inspirational</a>
-            
+
         </div>
     </div>
 
@@ -128,14 +128,14 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="adulthood,success,value" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="adulthood,success,value" /    >
+
             <a class="tag" href="/tag/adulthood/page/1/">adulthood</a>
-            
+
             <a class="tag" href="/tag/success/page/1/">success</a>
-            
+
             <a class="tag" href="/tag/value/page/1/">value</a>
-            
+
         </div>
     </div>
 
@@ -146,12 +146,12 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="life,love" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="life,love" /    >
+
             <a class="tag" href="/tag/life/page/1/">life</a>
-            
+
             <a class="tag" href="/tag/love/page/1/">love</a>
-            
+
         </div>
     </div>
 
@@ -162,16 +162,16 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="edison,failure,inspirational,paraphrased" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="edison,failure,inspirational,paraphrased" /    >
+
             <a class="tag" href="/tag/edison/page/1/">edison</a>
-            
+
             <a class="tag" href="/tag/failure/page/1/">failure</a>
-            
+
             <a class="tag" href="/tag/inspirational/page/1/">inspirational</a>
-            
+
             <a class="tag" href="/tag/paraphrased/page/1/">paraphrased</a>
-            
+
         </div>
     </div>
 
@@ -182,10 +182,10 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="misattributed-eleanor-roosevelt" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="misattributed-eleanor-roosevelt" /    >
+
             <a class="tag" href="/tag/misattributed-eleanor-roosevelt/page/1/">misattributed-eleanor-roosevelt</a>
-            
+
         </div>
     </div>
 
@@ -196,73 +196,73 @@
         </span>
         <div class="tags">
             Tags:
-            <meta class="keywords" itemprop="keywords" content="humor,obvious,simile" /    > 
-            
+            <meta class="keywords" itemprop="keywords" content="humor,obvious,simile" /    >
+
             <a class="tag" href="/tag/humor/page/1/">humor</a>
-            
+
             <a class="tag" href="/tag/obvious/page/1/">obvious</a>
-            
+
             <a class="tag" href="/tag/simile/page/1/">simile</a>
-            
+
         </div>
     </div>
 
     <nav>
         <ul class="pager">
-            
-            
+
+
             <li class="next">
                 <a href="/page/2/">Next <span aria-hidden="true">&rarr;</span></a>
             </li>
-            
+
         </ul>
     </nav>
     </div>
     <div class="col-md-4 tags-box">
-        
+
             <h2>Top Ten tags</h2>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 28px" href="/tag/love/">love</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 26px" href="/tag/inspirational/">inspirational</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 26px" href="/tag/life/">life</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 24px" href="/tag/humor/">humor</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 22px" href="/tag/books/">books</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 14px" href="/tag/reading/">reading</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 10px" href="/tag/friendship/">friendship</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 8px" href="/tag/friends/">friends</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 8px" href="/tag/truth/">truth</a>
             </span>
-            
+
             <span class="tag-item">
             <a class="tag" style="font-size: 6px" href="/tag/simile/">simile</a>
             </span>
-            
-        
+
+
     </div>
 </div>
 
@@ -273,7 +273,7 @@
                 Quotes by: <a href="https://www.goodreads.com/quotes">GoodReads.com</a>
             </p>
             <p class="copyright">
-                Made with <span class='sh-red'>❤</span> by <a href="https://scrapinghub.com">Scrapinghub</a>
+                Made with <span class='sh-red'>❤</span> by <a href="https://www.zyte.com">Zyte</a>
             </p>
         </div>
     </footer>

docs/conf.py

@@ -1,55 +1,41 @@
-# Scrapy documentation build configuration file, created by
-# sphinx-quickstart on Mon Nov 24 12:02:52 2008.
+# Configuration file for the Sphinx documentation builder.
 #
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# The contents of this file are pickled, so don't put values in the namespace
-# that aren't pickleable (module imports are okay, they're removed automatically).
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import os
 import sys
-from datetime import datetime
-from os import path
+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 os.path.abspath to make it
-# absolute, like shown here.
-sys.path.append(path.join(path.dirname(__file__), "_ext"))
-sys.path.insert(0, path.dirname(path.dirname(__file__)))
+# 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))
 
 
-# General configuration
-# ---------------------
+# -- 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
 
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    'hoverxref.extension',
-    'notfound.extension',
-    'scrapydocs',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.coverage',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.viewcode',
+    "notfound.extension",
+    "scrapydocs",
+    "sphinx_scrapy",
+    "scrapyfixautodoc",  # Must be after "sphinx.ext.autodoc"
+    "sphinx.ext.coverage",
+    "sphinx_rtd_dark_mode",
 ]
 
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-#source_encoding = 'utf-8'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = 'Scrapy'
-copyright = f'2008–{datetime.now().year}, Scrapy developers'
+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
@@ -58,267 +44,130 @@ copyright = f'2008–{datetime.now().year}, Scrapy developers'
 # The short X.Y version.
 try:
     import scrapy
-    version = '.'.join(map(str, scrapy.version_info[:2]))
+
+    version = ".".join(map(str, scrapy.version_info[:2]))
     release = scrapy.__version__
 except ImportError:
-    version = ''
-    release = ''
+    version = ""
+    release = ""
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-language = 'en'
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-exclude_patterns = ['build']
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = ['.build']
-
-# The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# List of Sphinx warnings that will not be raised
-suppress_warnings = ['epub.unknown_project_files']
+suppress_warnings = ["epub.unknown_project_files"]
 
 
-# Options for HTML output
-# -----------------------
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-# Add path to the RTD explicitly to robustify builds (otherwise might
-# fail in a clean Debian build env)
-import sphinx_rtd_theme
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-# The style sheet to use for HTML and HTML Help pages. A file of that name
-# must exist either in Sphinx' static/ path, or in one of the custom paths
-# given in html_static_path.
-# html_style = 'scrapydoc.css'
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_use_modindex = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, the reST sources are included in the HTML build as _sources/<name>.
-html_copy_source = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'Scrapydoc'
+html_last_updated_fmt = "%b %d, %Y"
 
 html_css_files = [
-    'custom.css',
+    "custom.css",
 ]
 
+html_context = {
+    "display_github": True,
+    "github_user": "scrapy",
+    "github_repo": "scrapy",
+    "github_version": "master",
+    "conf_py_path": "/docs/",
+}
 
-# Options for LaTeX output
-# ------------------------
+# Set canonical URL from the Read the Docs Domain
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
 
-# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
-
-# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# -- 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'),
+    ("index", "Scrapy.tex", "Scrapy Documentation", "Scrapy developers", "manual"),
 ]
 
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
 
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
+# -- Options for the linkcheck builder ---------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
 
-# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_use_modindex = True
-
-
-# Options for the linkcheck builder
-# ---------------------------------
-
-# A list of regular expressions that match URIs that should not be checked when
-# doing a linkcheck build.
 linkcheck_ignore = [
-    'http://localhost:\d+', 'http://hg.scrapy.org',
-    'http://directory.google.com/'
+    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
 
-# Options for the Coverage extension
-# ----------------------------------
 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$',
-
+    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$',
-
+    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)$',
-
+    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)\.',
-
+    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',
-
+    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_crawler|request_seen|open|close|log)$",
     # Private exception used by the command-line interface implementation.
-    r'^scrapy\.exceptions\.UsageError',
-
+    r"^scrapy\.exceptions\.UsageError",
     # Methods of BaseItemExporter subclasses are only documented in
     # BaseItemExporter.
-    r'^scrapy\.exporters\.(?!BaseItemExporter\b)\w*?\.',
-
+    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
-
+    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\.item\.DictItem$',
-    r'^scrapy\.linkextractors\.FilteringLinkExtractor$',
-
+    r"^scrapy\.linkextractors\.FilteringLinkExtractor$",
     # Implementation detail of LxmlLinkExtractor
-    r'^scrapy\.linkextractors\.lxmlhtml\.LxmlParserLinkExtractor',
+    r"^scrapy\.linkextractors\.lxmlhtml\.LxmlParserLinkExtractor",
 ]
 
+# -- Options for the autodoc extension ----------------------------------------
+autodoc_member_order = "bysource"
 
-# Options for the InterSphinx extension
-# -------------------------------------
+# -- 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/stable', None),
-    'cryptography' : ('https://cryptography.io/en/latest/', None),
-    'cssselect': ('https://cssselect.readthedocs.io/en/latest', None),
-    'itemloaders': ('https://itemloaders.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.readthedocs.io/en/latest', None),
-    'twisted': ('https://twistedmatrix.com/documents/current', None),
-    'twistedapi': ('https://twistedmatrix.com/documents/current/api', None),
-}
+intersphinx_disabled_reftypes: Sequence[str] = []
 
+# sphinx-scrapy ---------------------------------------------------------------
 
-# Options for sphinx-hoverxref options
-# ------------------------------------
+scrapy_intersphinx_enable = [
+    "attrs",
+    "coverage",
+    "cryptography",
+    "cssselect",
+    "form2request",
+    "itemloaders",
+    "parsel",
+    "pytest",
+    "pypug",
+    "scrapy-lint",
+    "sphinx",
+    "tox",
+    "twisted",
+    "twistedapi",
+    "w3lib",
+]
 
-hoverxref_auto_ref = True
-hoverxref_role_types = {
-    "class": "tooltip",
-    "confval": "tooltip",
-    "hoverxref": "tooltip",
-    "mod": "tooltip",
-    "ref": "tooltip",
-}
-hoverxref_roles = ['command', 'reqmeta', 'setting', 'signal']
-
-
-def setup(app):
-    app.connect('autodoc-skip-member', maybe_skip_member)
-
-
-def maybe_skip_member(app, what, name, obj, skip, options):
-    if not skip:
-        # autodocs was generating a text "alias of" for the following members
-        # https://github.com/sphinx-doc/sphinx/issues/4422
-        return name in {'default_item_class', 'default_selector_class'}
-    return skip
+# -- Other options ------------------------------------------------------------
+default_dark_mode = False

docs/conftest.py

@@ -1,33 +1,34 @@
-import os
 from doctest import ELLIPSIS, NORMALIZE_WHITESPACE
+from pathlib import Path
 
-from scrapy.http.response.html import HtmlResponse
 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 sybil.parsers.doctest import DocTestParser
-from sybil.parsers.skip import skip
+
+from scrapy.http.response.html import HtmlResponse
 
 
-def load_response(url, filename):
-    input_path = os.path.join(os.path.dirname(__file__), '_tests', filename)
-    with open(input_path, 'rb') as input_file:
-        return HtmlResponse(url, body=input_file.read())
+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
+    namespace["load_response"] = load_response
 
 
 pytest_collect_file = Sybil(
     parsers=[
         DocTestParser(optionflags=ELLIPSIS | NORMALIZE_WHITESPACE),
-        PythonCodeBlockParser(future_imports=['print_function']),
+        PythonCodeBlockParser(future_imports=["print_function"]),
         skip,
     ],
-    pattern='*.rst',
+    pattern="*.rst",
     setup=setup,
 ).pytest()

docs/contributing.rst

@@ -6,15 +6,16 @@ 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
+    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
+    <https://github.com/scrapy/scrapy/blob/master/CODE_OF_CONDUCT.md>`_. Please
+    report unacceptable behavior to opensource@zyte.com.
 
 There are many ways to contribute to Scrapy. Here are some of them:
 
-* 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.
-
 * Report bugs and request features in the `issue tracker`_, trying to follow
   the guidelines detailed in `Reporting bugs`_ below.
 
@@ -22,13 +23,16 @@ There are many ways to contribute to Scrapy. Here are some of them:
   :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 <https://stackoverflow.com/questions/tagged/scrapy>`__.
 
-
 Reporting bugs
 ==============
 
@@ -49,7 +53,7 @@ guidelines when you're going to report a new bug.
   (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 
+  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 <writing-patches>` with a fix.
 
@@ -75,6 +79,76 @@ guidelines when you're going to report a new bug.
 
 .. _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 <write-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 <writing-patches>`.
+
+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
@@ -125,6 +199,14 @@ 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
+<https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword>`__,
+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
@@ -148,7 +230,7 @@ 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://help.github.com/en/github/collaborating-with-issues-and-pull-requests/checking-out-pull-requests-locally#modifying-an-inactive-pull-request-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"
@@ -169,15 +251,42 @@ Coding style
 Please follow these coding conventions when writing code for inclusion in
 Scrapy:
 
-* Unless otherwise specified, follow :pep:`8`.
-
-* It's OK to use lines longer than 79 chars if it improves the code
-  readability.
+* We use `Ruff <https://docs.astral.sh/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://help.github.com/en/github/using-git/setting-your-username-in-git for
-  setup instructions.
+  See https://docs.github.com/en/get-started/git-basics/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 <https://pre-commit.com/#installation>`_.
+
+#.  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:
 
@@ -209,13 +318,15 @@ 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 <news>`.
 
+.. _write-tests:
 
 Tests
 =====
 
-Tests are implemented using the :doc:`Twisted unit-testing framework
-<twisted:core/development/policy/test-standard>`. Running tests requires
-:doc:`tox <tox:index>`.
+Tests are implemented using pytest_. Running tests requires :doc:`tox
+<tox:index>`.
+
+.. _pytest: https://pytest.org
 
 .. _running-tests:
 
@@ -232,15 +343,15 @@ To run a specific test (say ``tests/test_loader.py``) use:
 
 To run the tests on a specific :doc:`tox <tox:index>` environment, use
 ``-e <name>`` with an environment name from ``tox.ini``. For example, to run
-the tests with Python 3.6 use::
+the tests with Python 3.10 use::
 
-    tox -e py36
+    tox -e py310
 
 You can also specify a comma-separated list of environments, and use :ref:`tox’s
 parallel mode <tox:parallel_mode>` to run the tests on multiple environments in
 parallel::
 
-    tox -e py36,py38 -p auto
+    tox -e py39,py310 -p auto
 
 To pass command-line options to :doc:`pytest <pytest:index>`, add them after
 ``--`` in your call to :doc:`tox <tox:index>`. Using ``--`` overrides the
@@ -250,9 +361,9 @@ 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.6 :doc:`tox <tox:index>` environment using all your CPU cores::
+the Python 3.10 :doc:`tox <tox:index>` environment using all your CPU cores::
 
-    tox -e py36 -- scrapy tests -n auto
+    tox -e py310 -- scrapy tests -n auto
 
 To see coverage report install :doc:`coverage <coverage:index>`
 (``pip install coverage``) and run:
@@ -261,6 +372,21 @@ To see coverage report install :doc:`coverage <coverage:index>`
 
 see output of ``coverage --help`` for more options like html or xml report.
 
+Some tests need a ``mitmdump`` executable (from mitmproxy_) to test against a
+fully featured proxy server; they are skipped when one cannot be found
+(``mitmproxy`` is intentionally not a test dependency that would be installed
+into test venvs, as that sometimes leads to various dependency conflicts).
+To run these tests, make ``mitmdump`` available in one of these ways:
+
+* install ``mitmproxy`` so that ``mitmdump`` is on your ``PATH``, e.g. with
+  pipx_ (``pipx install mitmproxy``) or uv_ (``uv tool install mitmproxy``);
+
+* have uv_ installed, in which case the tests will run
+  ``uvx --from mitmproxy mitmdump``;
+
+* set the ``MITMDUMP`` environment variable to the path of a ``mitmdump``
+  executable.
+
 Writing tests
 -------------
 
@@ -280,10 +406,14 @@ And their unit-tests are in::
 
 .. _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
+.. _Scrapy subreddit: https://www.reddit.com/r/scrapy/
 .. _tests/: https://github.com/scrapy/scrapy/tree/master/tests
 .. _open issues: https://github.com/scrapy/scrapy/issues
-.. _PEP 257: https://www.python.org/dev/peps/pep-0257/
-.. _pull request: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request
+.. _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
+.. _mitmproxy: https://mitmproxy.org/
+.. _pipx: https://pipx.pypa.io/
+.. _uv: https://docs.astral.sh/uv/

docs/faq.rst

@@ -23,7 +23,7 @@ comparing `jinja2`_ to `Django`_.
 
 .. _BeautifulSoup: https://www.crummy.com/software/BeautifulSoup/
 .. _lxml: https://lxml.de/
-.. _jinja2: https://palletsprojects.com/p/jinja/
+.. _jinja2: https://palletsprojects.com/projects/jinja/
 .. _Django: https://www.djangoproject.com/
 
 Can I use Scrapy with BeautifulSoup?
@@ -35,8 +35,10 @@ 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::
+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
@@ -45,17 +47,12 @@ Here's an example spider using BeautifulSoup API, with ``lxml`` as the HTML pars
     class ExampleSpider(scrapy.Spider):
         name = "example"
         allowed_domains = ["example.com"]
-        start_urls = (
-            'http://www.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
-            }
+            soup = BeautifulSoup(response.text, "lxml")
+            yield {"url": response.url, "title": soup.h1.string}
 
 .. note::
 
@@ -85,51 +82,35 @@ 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
+Yes. Support for HTTP proxies is provided through the HTTP Proxy downloader
+middleware. See
 :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware`.
 
+Does Scrapy work with SOCKS proxies?
+------------------------------------
+
+Yes, when using
+:class:`~scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler`. See
+:class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` and the
+handler documentation.
+
 How can I scrape an item with attributes in different pages?
 ------------------------------------------------------------
 
-See :ref:`topics-request-response-ref-request-callback-arguments`.
-
-
-Scrapy crashes with: ImportError: No module named win32api
-----------------------------------------------------------
-
-You need to install `pywin32`_ because of `this Twisted bug`_.
-
-.. _pywin32: https://sourceforge.net/projects/pywin32/
-.. _this Twisted bug: https://twistedmatrix.com/trac/ticket/3707
+See :ref:`callback-data`.
 
 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?
 --------------------------------------------------------
 
-By default, Scrapy uses a `LIFO`_ queue for storing pending requests, which
-basically means that it crawls in `DFO order`_. This order is more convenient
-in most cases.
-
-If you do want to crawl in true `BFO order`_, you can do it by
-setting the following settings::
-
-    DEPTH_PRIORITY = 1
-    SCHEDULER_DISK_QUEUE = 'scrapy.squeues.PickleFifoDiskQueue'
-    SCHEDULER_MEMORY_QUEUE = 'scrapy.squeues.FifoMemoryQueue'
-
-While pending requests are below the configured values of
-:setting:`CONCURRENT_REQUESTS`, :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` or
-:setting:`CONCURRENT_REQUESTS_PER_IP`, those requests are sent
-concurrently. As a result, the first few requests of a crawl rarely follow the
-desired order. Lowering those settings to ``1`` enforces the desired order, but
-it significantly slows down the crawl as a whole.
+:ref:`DFO by default, but other orders are possible <request-order>`.
 
 
 My Scrapy crawler has memory leaks. What can I do?
@@ -148,37 +129,36 @@ 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.spidermiddlewares.offsite.OffsiteMiddleware` spider middleware
-with a :ref:`custom spider middleware <custom-spider-middleware>` that requires
-less memory. For example:
+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
+<topics-downloader-middleware-custom>` 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.
+    instead of 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
+-   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`_.
+See also `other suggestions at StackOverflow
+<https://stackoverflow.com/q/36440681>`__.
 
 .. note:: Remember to disable
-   :class:`scrapy.spidermiddlewares.offsite.OffsiteMiddleware` when you enable
-   your custom implementation::
+   :class:`scrapy.downloadermiddlewares.offsite.OffsiteMiddleware` when you
+   enable your custom implementation:
 
-       SPIDER_MIDDLEWARES = {
-           'scrapy.spidermiddlewares.offsite.OffsiteMiddleware': None,
-           'myproject.middlewares.CustomOffsiteMiddleware': 500,
+   .. code-block:: python
+
+       DOWNLOADER_MIDDLEWARES = {
+           "scrapy.downloadermiddlewares.offsite.OffsiteMiddleware": None,
+           "myproject.middlewares.CustomOffsiteMiddleware": 50,
        }
 
-.. _meet the installation requirements: https://github.com/andreasvc/pyre2#installation
 .. _pyre2: https://github.com/andreasvc/pyre2
-.. _re: https://docs.python.org/library/re.html
-.. _StackOverflow: https://stackoverflow.com/q/36440681/939364
+.. _re: https://docs.python.org/3/library/re.html
 
 Can I use Basic HTTP Authentication in my spiders?
 --------------------------------------------------
@@ -214,12 +194,10 @@ 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 the Offsite Spider Middleware, which is a spider
-middleware (enabled by default) whose purpose is to filter out requests to
-domains outside the ones covered by the spider.
-
-For more info see:
-:class:`~scrapy.spidermiddlewares.offsite.OffsiteMiddleware`.
+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?
 ---------------------------------------------------------------------
@@ -239,20 +217,18 @@ 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 means?
----------------------------------------------
+What does the response status code 999 mean?
+--------------------------------------------
 
-999 is a custom response status code used by Yahoo sites to throttle requests.
+999 is a custom response status code used by some sites to throttle requests.
 Try slowing down the crawling speed by using a download delay of ``2`` (or
-higher) in your spider::
+higher) for the affected domains, with the :setting:`DOWNLOAD_SLOTS` setting:
 
-    class MySpider(CrawlSpider):
+.. code-block:: python
 
-        name = 'myspider'
-
-        download_delay = 2
-
-        # [ ... rest of the spider code ... ]
+    DOWNLOAD_SLOTS = {
+        "example.com": {"delay": 2},
+    }
 
 Or by setting a global download delay in your project with the
 :setting:`DOWNLOAD_DELAY` setting.
@@ -277,7 +253,7 @@ To dump into a CSV file::
 
     scrapy crawl myspider -O items.csv
 
-To dump into a XML file::
+To dump into an XML file::
 
     scrapy crawl myspider -O items.xml
 
@@ -290,7 +266,7 @@ 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/pod/release/ECARROLL/HTML-TreeBuilderX-ASP_NET-0.09/lib/HTML/TreeBuilderX/ASP_NET.pm
+.. _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?
@@ -301,9 +277,14 @@ 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 functions ``xmliter`` and ``csviter`` from ``scrapy.utils.iterators``
-module. In fact, this is what the feed spiders (see :ref:`topics-spiders`) use
-under the cover.
+the :func:`~scrapy.utils.iterators.xmliter_lxml` and
+:func:`~scrapy.utils.iterators.csviter` functions. In fact, this is what
+:class:`~scrapy.spiders.XMLFeedSpider` and
+:class:`~scrapy.spiders.CSVFeedSpider` use.
+
+.. autofunction:: scrapy.utils.iterators.xmliter_lxml
+
+.. autofunction:: scrapy.utils.iterators.csviter
 
 Does Scrapy manage cookies automatically?
 -----------------------------------------
@@ -345,8 +326,8 @@ 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
---------------------------------------------------------------------------
+I'm scraping an XML document and my XPath selector doesn't return any items
+---------------------------------------------------------------------------
 
 You may need to remove namespaces. See :ref:`removing-namespaces`.
 
@@ -360,25 +341,33 @@ How to split an item into multiple items in an item pipeline?
 input item. :ref:`Create a spider middleware <custom-spider-middleware>`
 instead, and use its
 :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output`
-method for this purpose. For example::
+method for this purpose. For example:
+
+.. code-block:: python
 
     from copy import deepcopy
 
-    from itemadapter import is_item, ItemAdapter
+    from itemadapter import ItemAdapter
+    from scrapy import Request
+
 
     class MultiplyItemsMiddleware:
-
-        def process_spider_output(self, response, result, spider):
-            for item in result:
-                if is_item(item):
-                    adapter = ItemAdapter(item)
-                    for _ in range(adapter['multiply_by']):
-                        yield deepcopy(item)
+        def process_spider_output(self, response, result):
+            for item_or_request in result:
+                if isinstance(item_or_request, Request):
+                    yield item_or_request
+                    continue
+                adapter = ItemAdapter(item_or_request)
+                for _ in range(adapter["multiply_by"]):
+                    yield deepcopy(item_or_request)
 
 Does Scrapy support IPv6 addresses?
 -----------------------------------
 
-Yes, by setting :setting:`DNS_RESOLVER` to ``scrapy.resolver.CachingHostnameResolver``.
+Yes, but when using
+:class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler` or
+:class:`~scrapy.core.downloader.handlers.http2.H2DownloadHandler` you need to
+set :setting:`TWISTED_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).
 
@@ -389,8 +378,9 @@ How to deal with ``<class 'ValueError'>: filedescriptor out of range in select()
 ----------------------------------------------------------------------------------------------
 
 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.
+Twisted reactor was :class:`twisted.internet.selectreactor.SelectReactor` at that time.
+If you have switched to this reactor using the :setting:`TWISTED_REACTOR` setting you can switch
+to a different one in the same way.
 
 
 .. _faq-stop-response-download:
@@ -407,6 +397,22 @@ or :class:`~scrapy.signals.headers_received` signals and raising a
 :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: <filename>``
 --------------------------------------------------------------------------
 
@@ -417,9 +423,5 @@ See :issue:`2680`.
 
 
 .. _has been reported: https://github.com/scrapy/scrapy/issues/2905
-.. _Python standard library modules: https://docs.python.org/py-modindex.html
+.. _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
-.. _LIFO: https://en.wikipedia.org/wiki/Stack_(abstract_data_type)
-.. _DFO order: https://en.wikipedia.org/wiki/Depth-first_search
-.. _BFO order: https://en.wikipedia.org/wiki/Breadth-first_search

docs/index.rst

@@ -12,6 +12,8 @@ testing.
 .. _web crawling: https://en.wikipedia.org/wiki/Web_crawler
 .. _web scraping: https://en.wikipedia.org/wiki/Web_scraping
 
+.. _getting-help:
+
 Getting help
 ============
 
@@ -22,14 +24,16 @@ Having trouble? We'd like to help!
 * 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`_,
+* 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
@@ -87,15 +91,15 @@ Basic concepts
 :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/shell`
+    Test your extraction code in an interactive environment.
+
 :doc:`topics/item-pipeline`
     Post-process and store your scraped data.
 
@@ -124,25 +128,17 @@ Built-in services
 
    topics/logging
    topics/stats
-   topics/email
    topics/telnetconsole
-   topics/webservice
 
 :doc:`topics/logging`
-    Learn how to use Python's builtin logging on Scrapy.
+    Learn how to use Python's built-in 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.
 
-:doc:`topics/webservice`
-    Monitor and control a crawler using a web service.
-
 
 Solving specific problems
 =========================
@@ -155,6 +151,7 @@ Solving specific problems
    topics/debug
    topics/contracts
    topics/practices
+   topics/security
    topics/broad-crawls
    topics/developer-tools
    topics/dynamic-content
@@ -179,6 +176,10 @@ Solving specific problems
 :doc:`topics/practices`
     Get familiar with some Scrapy common practices.
 
+:doc:`topics/security`
+    Understand the security implications of Scrapy defaults and how to harden
+    them.
+
 :doc:`topics/broad-crawls`
     Tune Scrapy for crawling a lot domains in parallel.
 
@@ -222,18 +223,24 @@ Extending Scrapy
    :hidden:
 
    topics/architecture
+   topics/addons
    topics/downloader-middleware
    topics/spider-middleware
    topics/extensions
-   topics/api
    topics/signals
    topics/scheduler
    topics/exporters
+   topics/download-handlers
+   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.
 
@@ -243,9 +250,6 @@ Extending Scrapy
 :doc:`topics/extensions`
     Extend Scrapy with your custom functionality
 
-:doc:`topics/api`
-    Use it on extensions and middlewares to extend Scrapy functionality
-
 :doc:`topics/signals`
     See all available signals and how to work with them.
 
@@ -255,6 +259,16 @@ Extending Scrapy
 :doc:`topics/exporters`
     Quickly export your scraped items to a file (XML, CSV, etc).
 
+:doc:`topics/download-handlers`
+    Customize how requests are downloaded or add support for new URL schemes.
+
+: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
 ============

docs/intro/examples.rst

@@ -7,7 +7,7 @@ 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
-http://quotes.toscrape.com, one using CSS selectors and another one using XPath
+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.

docs/intro/install.rst

@@ -9,8 +9,8 @@ Installation guide
 Supported Python versions
 =========================
 
-Scrapy requires Python 3.6+, either the CPython implementation (default) or
-the PyPy 7.2.0+ implementation (see :ref:`python:implementations`).
+Scrapy requires Python 3.10+, either the CPython implementation (default) or
+the PyPy implementation (see :ref:`python:implementations`).
 
 .. _intro-install-scrapy:
 
@@ -37,7 +37,7 @@ 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 specifics instructions, as well as
+For more detailed and platform-specific instructions, as well as
 troubleshooting information, read on.
 
 
@@ -52,17 +52,7 @@ Scrapy is written in pure Python and depends on a few key Python packages (among
 * `twisted`_, an asynchronous networking framework
 * `cryptography`_ and `pyOpenSSL`_, to deal with various network-level security needs
 
-The minimal versions which Scrapy is tested against are:
-
-* Twisted 14.0
-* lxml 3.4
-* pyOpenSSL 0.14
-
-Scrapy may work with older versions of these packages
-but it is not guaranteed it will continue working
-because it’s not being tested against them.
-
-Some of these packages themselves depends on non-Python packages
+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 <intro-install-platform-notes>`.
 
@@ -99,6 +89,56 @@ just like any other Python package.
 (See :ref:`platform-specific guides <intro-install-platform-notes>`
 below for non-Python dependencies that you may need to install beforehand).
 
+.. _extras:
+
+Optional extras
+===============
+
+Scrapy provides optional :ref:`extras <pypug:dependency-specifiers-extras>`
+that install additional dependencies to enable specific features. To install
+Scrapy with one or more extras, list them in square brackets:
+
+.. code-block:: console
+
+    pip install scrapy[s3,images]
+
+The following extras are available:
+
+.. list-table::
+   :header-rows: 1
+
+   * - Extra
+     - Provides
+   * - ``bpython``
+     - :ref:`bpython shell <shell-config>`
+   * - ``brotli``
+     - :ref:`Brotli response decompression <http-compression>`
+   * - ``gcs``
+     - :ref:`Google Cloud Storage <topics-feed-storage-gcs>` for
+       :ref:`feed exports <topics-feed-exports>` and
+       :ref:`media pipelines <media-pipeline-gcs>`
+   * - ``httpx``
+     - :ref:`httpx-handler`, including its HTTP/2 and SOCKS proxy support
+   * - ``images``
+     - :ref:`Images pipeline <images-pipeline>`
+   * - ``ipython``
+     - :ref:`IPython shell <shell-config>`
+   * - ``ptpython``
+     - :ref:`ptpython shell <shell-config>`
+   * - ``robotparser``
+     - :ref:`Robotexclusionrulesparser robots.txt parsing <rerp-parser>`
+   * - ``s3``
+     - :ref:`Amazon S3 <topics-feed-storage-s3>` storage for
+       :ref:`feed exports <topics-feed-exports>`,
+       :ref:`media pipelines <media-pipelines-s3>`, and
+       :ref:`S3 downloads <s3-handler>`
+   * - ``twisted-http2``
+     - :ref:`twisted-http2-handler`
+   * - ``uvloop``
+     - `uvloop <https://github.com/MagicStack/uvloop>`_ event loop
+   * - ``zstd``
+     - :ref:`Zstandard response decompression <http-compression>`
+
 
 .. _intro-install-platform-notes:
 
@@ -111,7 +151,7 @@ Windows
 -------
 
 Though it's possible to install Scrapy on Windows using pip, we recommend you
-to install `Anaconda`_ or `Miniconda`_ and use the package from the
+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::
@@ -121,7 +161,7 @@ Once you've installed `Anaconda`_ or `Miniconda`_, install Scrapy with::
 To install Scrapy on Windows using ``pip``:
 
 .. warning::
-    This installation method requires “Microsoft Visual C++” for installing some 
+    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.
@@ -133,7 +173,7 @@ To install Scrapy on Windows using ``pip``:
 #. 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.
@@ -151,7 +191,7 @@ 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 latest Scrapy.
+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
@@ -180,7 +220,7 @@ 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
+development tools. To install the Xcode command-line tools, open a terminal
 window and run::
 
     xcode-select --install
@@ -190,14 +230,14 @@ 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
+* *(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`` accordantly
+    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
@@ -210,11 +250,6 @@ solutions:
 
       brew install python
 
-  * Latest versions of python have ``pip`` bundled with them so you won't need
-    to install it separately. If this is not the case, upgrade python::
-
-      brew update; brew upgrade python
-
 *   *(Optional)* :ref:`Install Scrapy inside a Python virtual environment
     <intro-using-virtualenv>`.
 
@@ -229,13 +264,13 @@ After any of these workarounds you should be able to install Scrapy::
 PyPy
 ----
 
-We recommend using the latest PyPy version. The version tested is 5.9.0.
+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 Cryptography dependency,
-solution to this problem is described
+On macOS, you are likely to face an issue with building the Cryptography
+dependency. The solution to this problem is described
 `here <https://github.com/pyca/cryptography/issues/2692#issuecomment-272773481>`_,
 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
@@ -245,8 +280,8 @@ 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'``.
+that the ``PyPyDispatcher`` dependency wasn't installed. To fix this issue, run
+``pip install 'PyPyDispatcher>=2.1.0'``.
 
 
 .. _intro-install-troubleshooting:
@@ -278,18 +313,16 @@ reinstall Twisted with the :code:`tls` extra option::
 For details, see `Issue #2473 <https://github.com/scrapy/scrapy/issues/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://twistedmatrix.com/trac/
+.. _twisted: https://twisted.org/
 .. _cryptography: https://cryptography.io/en/latest/
 .. _pyOpenSSL: https://pypi.org/project/pyOpenSSL/
-.. _setuptools: https://pypi.python.org/pypi/setuptools
+.. _setuptools: https://pypi.org/pypi/setuptools
 .. _homebrew: https://brew.sh/
 .. _zsh: https://www.zsh.org/
-.. _Anaconda: https://docs.anaconda.com/anaconda/
+.. _Anaconda: https://www.anaconda.com/docs/main
 .. _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/

docs/intro/overview.rst

@@ -20,35 +20,37 @@ In order to show you what Scrapy brings to the table, we'll walk you through an
 example of a Scrapy Spider using the simplest way to run a spider.
 
 Here's the code for a spider that scrapes famous quotes from website
-http://quotes.toscrape.com, following the pagination::
+https://quotes.toscrape.com, following the pagination:
+
+.. code-block:: python
 
     import scrapy
 
 
     class QuotesSpider(scrapy.Spider):
-        name = 'quotes'
+        name = "quotes"
         start_urls = [
-            'http://quotes.toscrape.com/tag/humor/',
+            "https://quotes.toscrape.com/tag/humor/",
         ]
 
         def parse(self, response):
-            for quote in response.css('div.quote'):
+            for quote in response.css("div.quote"):
                 yield {
-                    'author': quote.xpath('span/small/text()').get(),
-                    'text': quote.css('span.text::text').get(),
+                    "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 to something like ``quotes_spider.py``
+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.jl
+    scrapy runspider quotes_spider.py -o quotes.jsonl
 
-When this finishes you will have in the ``quotes.jl`` file a list of the
-quotes in JSON Lines format, containing text and author, looking like this::
+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"}
@@ -63,34 +65,35 @@ When you ran the command ``scrapy runspider quotes_spider.py``, Scrapy looked fo
 Spider definition inside it and ran it through its crawler engine.
 
 The crawl started by making requests to the URLs defined in the ``start_urls``
-attribute (in this case, only the URL for quotes in *humor* category)
+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 notice one of the main advantages about Scrapy: requests are
+Here you will notice one of the main advantages of Scrapy: requests are
 :ref:`scheduled and processed asynchronously <topics-architecture>`.  This
 means that Scrapy doesn't need to wait for a request to be finished and
 processed, it can send another request or do other things in the meantime. This
-also means that other requests can keep going even if some request fails or an
+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
 <topics-settings-ref>`. You can do things like setting a download delay between
-each request, limiting amount of concurrent requests per domain or per IP, and
+each request, limiting the amount of concurrent requests per domain, and
 even :ref:`using an auto-throttling extension <topics-autothrottle>` that tries
-to figure out these automatically.
+to figure these settings out automatically.
 
 .. note::
 
     This is using :ref:`feed exports <topics-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 <topics-item-pipeline>` to store the items in a database.
+    JSON Lines 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 <topics-item-pipeline>` to store the
+    items in a database.
 
 
 .. _topics-whatelse:
@@ -104,10 +107,10 @@ scraping easy and efficient, such as:
 
 * Built-in support for :ref:`selecting and extracting <topics-selectors>` data
   from HTML/XML sources using extended CSS selectors and XPath expressions,
-  with helper methods to extract using regular expressions.
+  with helper methods for extraction using regular expressions.
 
 * An :ref:`interactive shell console <topics-shell>` (IPython aware) for trying
-  out the CSS and XPath expressions to scrape data, very useful when writing or
+  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 <topics-feed-exports>` in
@@ -122,7 +125,7 @@ scraping easy and efficient, such as:
   well-defined API (middlewares, :ref:`extensions <topics-extensions>`, and
   :ref:`pipelines <topics-item-pipeline>`).
 
-* Wide range of built-in extensions and middlewares for handling:
+* A wide range of built-in extensions and middlewares for handling:
 
   - cookies and session handling
   - HTTP features like compression, authentication, caching
@@ -148,8 +151,8 @@ The next steps for you are to :ref:`install Scrapy <intro-install>`,
 a full-blown Scrapy project and `join the community`_. Thanks for your
 interest!
 
-.. _join the community: https://scrapy.org/community/
+.. _join the community: https://www.scrapy.org/community
 .. _web scraping: https://en.wikipedia.org/wiki/Web_scraping
-.. _Amazon Associates Web Services: https://affiliate-program.amazon.com/gp/advertising/api/detail/main.html
+.. _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

docs/intro/tutorial.rst

@@ -7,7 +7,7 @@ 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 <http://quotes.toscrape.com/>`_, a website
+We are going to scrape `quotes.toscrape.com <https://quotes.toscrape.com/>`_, a website
 that lists quotes from famous authors.
 
 This tutorial will walk you through these tasks:
@@ -18,11 +18,11 @@ This tutorial will walk you through these tasks:
 4. Changing spider to recursively follow links
 5. Using spider arguments
 
-Scrapy is written in Python_. If you're new to the language you might want to
-start by getting an idea of what the language is like, to get the most out of
-Scrapy.
+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 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:
@@ -76,14 +76,17 @@ This will create a ``tutorial`` directory with the following contents::
 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 make,
-optionally how to follow links in the pages, and how to parse the downloaded
+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::
+``quotes_spider.py`` under the ``tutorial/spiders`` directory in your project:
+
+.. code-block:: python
+
+    from pathlib import Path
 
     import scrapy
 
@@ -91,20 +94,19 @@ This is the code for our first Spider. Save it in a file named
     class QuotesSpider(scrapy.Spider):
         name = "quotes"
 
-        def start_requests(self):
+        async def start(self):
             urls = [
-                'http://quotes.toscrape.com/page/1/',
-                'http://quotes.toscrape.com/page/2/',
+                "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'
-            with open(filename, 'wb') as f:
-                f.write(response.body)
-            self.log(f'Saved file {filename}')
+            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 <scrapy.Spider>`
@@ -114,10 +116,10 @@ and defines some attributes and methods:
   unique within a project, that is, you can't set the same name for different
   Spiders.
 
-* :meth:`~scrapy.Spider.start_requests`: must return an iterable of
-  Requests (you can return a list of requests or write a generator function)
-  which the Spider will begin to crawl from. Subsequent requests will be
-  generated successively from these initial requests.
+* :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
@@ -135,7 +137,7 @@ To put our spider to work, go to the project's top level directory and run::
 
    scrapy crawl quotes
 
-This command runs the spider with name ``quotes`` that we've just added, that
+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::
 
@@ -143,9 +145,9 @@ similar to this::
     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) <GET http://quotes.toscrape.com/robots.txt> (referer: None)
-    2016-12-16 21:24:05 [scrapy.core.engine] DEBUG: Crawled (200) <GET http://quotes.toscrape.com/page/1/> (referer: None)
-    2016-12-16 21:24:05 [scrapy.core.engine] DEBUG: Crawled (200) <GET http://quotes.toscrape.com/page/2/> (referer: None)
+    2016-12-16 21:24:05 [scrapy.core.engine] DEBUG: Crawled (404) <GET https://quotes.toscrape.com/robots.txt> (referer: None)
+    2016-12-16 21:24:05 [scrapy.core.engine] DEBUG: Crawled (200) <GET https://quotes.toscrape.com/page/1/> (referer: None)
+    2016-12-16 21:24:05 [scrapy.core.engine] DEBUG: Crawled (200) <GET https://quotes.toscrape.com/page/2/> (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)
@@ -162,21 +164,26 @@ for the respective URLs, as our ``parse`` method instructs.
 What just happened under the hood?
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Scrapy schedules the :class:`scrapy.Request <scrapy.Request>` objects
-returned by the ``start_requests`` method of the Spider. Upon receiving a
-response for each one, it instantiates :class:`~scrapy.http.Response` objects
-and calls the callback method associated with the request (in this case, the
-``parse`` method) passing the response as argument.
+Scrapy sends the first :class:`scrapy.Request <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_requests method
----------------------------------------
-Instead of implementing a :meth:`~scrapy.Spider.start_requests` method
-that generates :class:`scrapy.Request <scrapy.Request>` objects from URLs,
-you can just 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_requests` to create the initial requests
-for your spider::
+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
 
@@ -184,15 +191,14 @@ for your spider::
     class QuotesSpider(scrapy.Spider):
         name = "quotes"
         start_urls = [
-            'http://quotes.toscrape.com/page/1/',
-            'http://quotes.toscrape.com/page/2/',
+            "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'
-            with open(filename, 'wb') as f:
-                f.write(response.body)
+            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
@@ -207,28 +213,28 @@ Extracting data
 The best way to learn how to extract data with Scrapy is trying selectors
 using the :ref:`Scrapy shell <topics-shell>`. Run::
 
-    scrapy shell 'http://quotes.toscrape.com/page/1/'
+    scrapy shell 'https://quotes.toscrape.com/page/1/'
 
 .. note::
 
-   Remember to always enclose urls in quotes when running Scrapy shell from
-   command-line, otherwise urls containing arguments (i.e. ``&`` character)
+   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 "http://quotes.toscrape.com/page/1/"
+       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) <GET http://quotes.toscrape.com/page/1/> (referer: None)
+    2016-09-19 12:09:27 [scrapy.core.engine] DEBUG: Crawled (200) <GET https://quotes.toscrape.com/page/1/> (referer: None)
     [s] Available Scrapy objects:
     [s]   scrapy     scrapy module (contains scrapy.Request, scrapy.Selector, etc)
     [s]   crawler    <scrapy.crawler.Crawler object at 0x7fa91d888c90>
     [s]   item       {}
-    [s]   request    <GET http://quotes.toscrape.com/page/1/>
-    [s]   response   <200 http://quotes.toscrape.com/page/1/>
+    [s]   request    <GET https://quotes.toscrape.com/page/1/>
+    [s]   response   <200 https://quotes.toscrape.com/page/1/>
     [s]   settings   <scrapy.settings.Settings object at 0x7fa91d888c10>
     [s]   spider     <DefaultSpider 'default' at 0x7fa91c8af990>
     [s] Useful shortcuts:
@@ -241,55 +247,69 @@ object:
 
 .. invisible-code-block: python
 
-    response = load_response('http://quotes.toscrape.com/page/1/', 'quotes1.html')
+    response = load_response('https://quotes.toscrape.com/page/1/', 'quotes1.html')
 
->>> response.css('title')
-[<Selector xpath='descendant-or-self::title' data='<title>Quotes to Scrape</title>'>]
+.. code-block:: pycon
+
+    >>> response.css("title")
+    [<Selector query='descendant-or-self::title' data='<title>Quotes to Scrape</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 fine-grain the selection or extract the
+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:
 
->>> response.css('title::text').getall()
-['Quotes to Scrape']
+.. 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
 ``<title>`` element.  If we don't specify ``::text``, we'd get the full title
 element, including its tags:
 
->>> response.css('title').getall()
-['<title>Quotes to Scrape</title>']
+.. code-block:: pycon
+
+    >>> response.css("title").getall()
+    ['<title>Quotes to Scrape</title>']
 
 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:
 
->>> response.css('title::text').get()
-'Quotes to Scrape'
+.. code-block:: pycon
+
+    >>> response.css("title::text").get()
+    'Quotes to Scrape'
 
 As an alternative, you could've written:
 
->>> response.css('title::text')[0].get()
-'Quotes to Scrape'
+.. code-block:: pycon
 
-Accessing an index on a :class:`~scrapy.selector.SelectorList` instance will 
-raise an :exc:`IndexError` exception if there are no results::
+    >>> response.css("title::text")[0].get()
+    'Quotes to Scrape'
 
-    >>> response.css('noelement')[0].get()
+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::
+You might want to use ``.get()`` directly on the
+:class:`~scrapy.selector.SelectorList` instance instead, which returns ``None``
+if there are no results:
 
->>> response.css("noelement").get()
+.. 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
@@ -300,14 +320,16 @@ Besides the :meth:`~scrapy.selector.SelectorList.getall` and
 the :meth:`~scrapy.selector.SelectorList.re` method to extract using
 :doc:`regular expressions <library/re>`:
 
->>> 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']
+.. code-block:: pycon
 
-In order to find the proper CSS selectors to use, you might find useful opening
+    >>> 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`).
@@ -323,19 +345,21 @@ XPath: a brief intro
 
 Besides `CSS`_, Scrapy selectors also support using `XPath`_ expressions:
 
->>> response.xpath('//title')
-[<Selector xpath='//title' data='<title>Quotes to Scrape</title>'>]
->>> response.xpath('//title/text()').get()
-'Quotes to Scrape'
+.. code-block:: pycon
+
+    >>> response.xpath("//title")
+    [<Selector query='//title' data='<title>Quotes to Scrape</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 closely the text representation of the selector
-objects in the shell.
+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: *select the link
+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.
@@ -346,7 +370,7 @@ recommend `this tutorial to learn XPath through examples
 <http://zvon.org/comp/r/tut-XPath_1.html>`_, and `this tutorial to learn "how
 to think in XPath" <http://plasmasturm.org/log/xpath101/>`_.
 
-.. _XPath: https://www.w3.org/TR/xpath/all/
+.. _XPath: https://www.w3.org/TR/xpath-10/
 .. _CSS: https://www.w3.org/TR/selectors
 
 Extracting quotes and authors
@@ -355,7 +379,7 @@ 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 http://quotes.toscrape.com is represented by HTML elements that look
+Each quote in https://quotes.toscrape.com is represented by HTML elements that look
 like this:
 
 .. code-block:: html
@@ -379,64 +403,77 @@ like this:
 Let's open up scrapy shell and play a bit to find out how to extract the data
 we want::
 
-    $ scrapy shell 'http://quotes.toscrape.com'
+    scrapy shell 'https://quotes.toscrape.com'
 
 We get a list of selectors for the quote HTML elements with:
 
->>> response.css("div.quote")
-[<Selector xpath="descendant-or-self::div[@class and contains(concat(' ', normalize-space(@class), ' '), ' quote ')]" data='<div class="quote" itemscope itemtype...'>,
- <Selector xpath="descendant-or-self::div[@class and contains(concat(' ', normalize-space(@class), ' '), ' quote ')]" data='<div class="quote" itemscope itemtype...'>,
- ...]
+.. code-block:: pycon
+
+    >>> response.css("div.quote")
+    [<Selector query="descendant-or-self::div[@class and contains(concat(' ', normalize-space(@class), ' '), ' quote ')]" data='<div class="quote" itemscope itemtype...'>,
+    <Selector query="descendant-or-self::div[@class and contains(concat(' ', normalize-space(@class), ' '), ' quote ')]" data='<div class="quote" itemscope itemtype...'>,
+    ...]
 
 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:
 
->>> quote = response.css("div.quote")[0]
+.. code-block:: pycon
 
-Now, let's extract ``text``, ``author`` and the ``tags`` from that quote
+    >>> 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:
 
->>> 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'
+.. 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:
 
->>> tags = quote.css("div.tags a.tag::text").getall()
->>> tags
-['change', 'deep-thoughts', 'thinking', 'world']
+.. 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
-quotes elements and put them together into a Python dictionary:
+quote elements and put them together into a Python dictionary:
 
->>> 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']}
-...
+.. 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 doesn't extract any data in
-particular, just saves the whole HTML page to a local file. Let's integrate the
+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::
+in the callback, as you can see below:
+
+.. code-block:: python
 
     import scrapy
 
@@ -444,23 +481,31 @@ in the callback, as you can see below::
     class QuotesSpider(scrapy.Spider):
         name = "quotes"
         start_urls = [
-            'http://quotes.toscrape.com/page/1/',
-            'http://quotes.toscrape.com/page/2/',
+            "https://quotes.toscrape.com/page/1/",
+            "https://quotes.toscrape.com/page/2/",
         ]
 
         def parse(self, response):
-            for quote in response.css('div.quote'):
+            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(),
+                    "text": quote.css("span.text::text").get(),
+                    "author": quote.css("small.author::text").get(),
+                    "tags": quote.css("div.tags a.tag::text").getall(),
                 }
 
-If you run this spider, it will output the extracted data with the log::
+To run this spider, exit the scrapy shell by entering::
 
-    2016-09-19 18:57:19 [scrapy.core.scraper] DEBUG: Scraped from <200 http://quotes.toscrape.com/page/1/>
+    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 http://quotes.toscrape.com/page/1/>
+    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.”"}
 
 
@@ -482,13 +527,13 @@ 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.jl
+    scrapy crawl quotes -o quotes.jsonl
 
-The `JSON Lines`_ format is useful because it's stream-like, you can easily
-append new records to it. It doesn't have the same problem of JSON when you run
+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
-doing that at the command-line.
+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
@@ -497,7 +542,7 @@ 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: http://jsonlines.org
+.. _JSON Lines: https://jsonlines.org
 .. _JQ: https://stedolan.github.io/jq
 
 
@@ -505,12 +550,12 @@ Following links
 ===============
 
 Let's say, instead of just scraping the stuff from the first two pages
-from http://quotes.toscrape.com, you want quotes from all the pages in the website.
+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.
 
-First thing is to extract the link to the page we want to follow.  Examining
+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:
 
@@ -531,17 +576,23 @@ 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:
 
->>> response.css('li.next a::attr(href)').get()
-'/page/2/'
+.. 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):
 
->>> response.css('li.next a').attrib['href']
-'/page/2/'
+.. code-block:: pycon
 
-Let's see now our spider modified to recursively follow the link to the next
-page, extracting data from it::
+    >>> 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
 
@@ -549,18 +600,18 @@ page, extracting data from it::
     class QuotesSpider(scrapy.Spider):
         name = "quotes"
         start_urls = [
-            'http://quotes.toscrape.com/page/1/',
+            "https://quotes.toscrape.com/page/1/",
         ]
 
         def parse(self, response):
-            for quote in response.css('div.quote'):
+            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(),
+                    "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()
+            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)
@@ -592,7 +643,9 @@ A shortcut for creating Requests
 --------------------------------
 
 As a shortcut for creating Request objects you can use
-:meth:`response.follow <scrapy.http.TextResponse.follow>`::
+:meth:`response.follow <scrapy.http.TextResponse.follow>`:
+
+.. code-block:: python
 
     import scrapy
 
@@ -600,18 +653,18 @@ As a shortcut for creating Request objects you can use
     class QuotesSpider(scrapy.Spider):
         name = "quotes"
         start_urls = [
-            'http://quotes.toscrape.com/page/1/',
+            "https://quotes.toscrape.com/page/1/",
         ]
 
         def parse(self, response):
-            for quote in response.css('div.quote'):
+            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(),
+                    "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()
+            next_page = response.css("li.next a::attr(href)").get()
             if next_page is not None:
                 yield response.follow(next_page, callback=self.parse)
 
@@ -619,58 +672,72 @@ 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.
 
-You can also pass a selector to ``response.follow`` instead of a string;
-this selector should extract necessary attributes::
+.. skip: start
 
-    for href in response.css('ul.pager a::attr(href)'):
+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 ``<a>`` elements there is a shortcut: ``response.follow`` uses their href
-attribute automatically. So the code can be shortened further::
+attribute automatically. So the code can be shortened further:
 
-    for a in response.css('ul.pager a'):
+.. 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 <scrapy.http.TextResponse.follow_all>` instead::
+:meth:`response.follow_all <scrapy.http.TextResponse.follow_all>` instead:
 
-    anchors = response.css('ul.pager a')
+.. code-block:: python
+
+    anchors = response.css("ul.pager a")
     yield from response.follow_all(anchors, callback=self.parse)
 
-or, shortening it further::
+or, shortening it further:
 
-    yield from response.follow_all(css='ul.pager a', callback=self.parse)
+.. 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::
+this time for scraping author information:
+
+.. code-block:: python
 
     import scrapy
 
 
     class AuthorSpider(scrapy.Spider):
-        name = 'author'
+        name = "author"
 
-        start_urls = ['http://quotes.toscrape.com/']
+        start_urls = ["https://quotes.toscrape.com/"]
 
         def parse(self, response):
-            author_page_links = response.css('.author + a')
+            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')
+            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()
+                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'),
+                "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
@@ -689,8 +756,8 @@ 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 by the setting
-:setting:`DUPEFILTER_CLASS`.
+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.
@@ -702,7 +769,7 @@ 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
-<topics-request-response-ref-request-callback-arguments>`.
+<callback-data>`.
 
 
 Using spider arguments
@@ -718,7 +785,9 @@ 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::
+with a specific tag, building the URL based on the argument:
+
+.. code-block:: python
 
     import scrapy
 
@@ -726,28 +795,28 @@ with a specific tag, building the URL based on the argument::
     class QuotesSpider(scrapy.Spider):
         name = "quotes"
 
-        def start_requests(self):
-            url = 'http://quotes.toscrape.com/'
-            tag = getattr(self, 'tag', None)
+        async def start(self):
+            url = "https://quotes.toscrape.com/"
+            tag = getattr(self, "tag", None)
             if tag is not None:
-                url = url + 'tag/' + tag
+                url = url + "tag/" + tag
             yield scrapy.Request(url, self.parse)
 
         def parse(self, response):
-            for quote in response.css('div.quote'):
+            for quote in response.css("div.quote"):
                 yield {
-                    'text': quote.css('span.text::text').get(),
-                    'author': quote.css('small.author::text').get(),
+                    "text": quote.css("span.text::text").get(),
+                    "author": quote.css("small.author::text").get(),
                 }
 
-            next_page = response.css('li.next a::attr(href)').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
-``http://quotes.toscrape.com/tag/humor``.
+``https://quotes.toscrape.com/tag/humor``.
 
 You can :ref:`learn more about handling spider arguments here <spiderargs>`.
 
@@ -755,12 +824,12 @@ 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
+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 prefer to play with an example project, check
+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

docs/requirements.in

@@ -0,0 +1,8 @@
+h2
+pydantic
+scrapy-spider-metadata
+sphinx
+sphinx-notfound-page
+sphinx-rtd-theme
+sphinx-rtd-dark-mode
+sphinx-scrapy @ git+https://github.com/scrapy/sphinx-scrapy.git@0.8.10

docs/requirements.txt

@@ -1,4 +1,197 @@
-Sphinx>=3.0
-sphinx-hoverxref>=0.2b1
-sphinx-notfound-page>=0.4
-sphinx-rtd-theme>=0.5.2
+# This file was autogenerated by uv via the following command:
+#    uv pip compile -p 3.13 docs/requirements.in -o docs/requirements.txt
+alabaster==1.0.0
+    # via sphinx
+annotated-types==0.7.0
+    # via pydantic
+attrs==26.1.0
+    # via
+    #   service-identity
+    #   twisted
+automat==25.4.16
+    # via twisted
+babel==2.18.0
+    # via sphinx
+certifi==2026.2.25
+    # via requests
+cffi==2.0.0
+    # via cryptography
+charset-normalizer==3.4.6
+    # via requests
+constantly==23.10.4
+    # via twisted
+cryptography==46.0.6
+    # via
+    #   pyopenssl
+    #   scrapy
+    #   service-identity
+cssselect==1.4.0
+    # via
+    #   parsel
+    #   scrapy
+defusedxml==0.7.1
+    # via scrapy
+docutils==0.22.4
+    # via
+    #   sphinx
+    #   sphinx-markdown-builder
+    #   sphinx-rtd-theme
+filelock==3.25.2
+    # via tldextract
+h2==4.3.0
+    # via -r docs/requirements.in
+hpack==4.1.0
+    # via h2
+hyperframe==6.1.0
+    # via h2
+hyperlink==21.0.0
+    # via twisted
+idna==3.11
+    # via
+    #   hyperlink
+    #   requests
+    #   tldextract
+imagesize==2.0.0
+    # via sphinx
+incremental==24.11.0
+    # via twisted
+itemadapter==0.13.1
+    # via
+    #   itemloaders
+    #   scrapy
+itemloaders==1.4.0
+    # via scrapy
+jinja2==3.1.6
+    # via sphinx
+jmespath==1.1.0
+    # via
+    #   itemloaders
+    #   parsel
+lxml==6.0.2
+    # via
+    #   parsel
+    #   scrapy
+markupsafe==3.0.3
+    # via jinja2
+packaging==26.0
+    # via
+    #   incremental
+    #   parsel
+    #   scrapy
+    #   scrapy-spider-metadata
+    #   sphinx
+    #   sphinx-scrapy
+parsel==1.11.0
+    # via
+    #   itemloaders
+    #   scrapy
+protego==0.6.0
+    # via scrapy
+pyasn1==0.6.3
+    # via
+    #   pyasn1-modules
+    #   service-identity
+pyasn1-modules==0.4.2
+    # via service-identity
+pycparser==3.0
+    # via cffi
+pydantic==2.12.5
+    # via
+    #   -r docs/requirements.in
+    #   scrapy-spider-metadata
+pydantic-core==2.41.5
+    # via pydantic
+pydispatcher==2.0.7
+    # via scrapy
+pygments==2.19.2
+    # via sphinx
+pyopenssl==26.0.0
+    # via scrapy
+queuelib==1.9.0
+    # via scrapy
+requests==2.33.0
+    # via
+    #   requests-file
+    #   sphinx
+    #   tldextract
+requests-file==3.0.1
+    # via tldextract
+roman-numerals==4.1.0
+    # via sphinx
+scrapy==2.14.2
+    # via scrapy-spider-metadata
+scrapy-spider-metadata==0.2.0
+    # via -r docs/requirements.in
+service-identity==24.2.0
+    # via scrapy
+snowballstemmer==3.0.1
+    # via sphinx
+sphinx==9.1.0
+    # via
+    #   -r docs/requirements.in
+    #   sphinx-copybutton
+    #   sphinx-last-updated-by-git
+    #   sphinx-llms-txt
+    #   sphinx-markdown-builder
+    #   sphinx-notfound-page
+    #   sphinx-rtd-theme
+    #   sphinx-scrapy
+    #   sphinxcontrib-jquery
+sphinx-copybutton==0.5.2
+    # via sphinx-scrapy
+sphinx-last-updated-by-git==0.3.8
+    # via sphinx-sitemap
+sphinx-llms-txt @ git+https://github.com/zytedata/sphinx-llms-txt.git@5e8866cb0cc249aa2017ad9050b3b83a7ca16f69
+    # via sphinx-scrapy
+sphinx-markdown-builder @ git+https://github.com/zytedata/sphinx-markdown-builder.git@cfe4c0bfd7b4542f7e6b65a58cdf9ec765829940
+    # via sphinx-scrapy
+sphinx-notfound-page==1.1.0
+    # via -r docs/requirements.in
+sphinx-rtd-dark-mode==1.3.0
+    # via -r docs/requirements.in
+sphinx-rtd-theme==3.1.0
+    # via
+    #   -r docs/requirements.in
+    #   sphinx-rtd-dark-mode
+sphinx-scrapy @ git+https://github.com/scrapy/sphinx-scrapy.git@fe176adc1a8577601bc3fa39b590ebed71a7e9b8
+    # via -r docs/requirements.in
+sphinx-sitemap==2.9.0
+    # via sphinx-scrapy
+sphinxcontrib-applehelp==2.0.0
+    # via sphinx
+sphinxcontrib-devhelp==2.0.0
+    # via sphinx
+sphinxcontrib-htmlhelp==2.1.0
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==2.0.0
+    # via sphinx
+sphinxcontrib-serializinghtml==2.0.0
+    # via sphinx
+tabulate==0.10.0
+    # via sphinx-markdown-builder
+tldextract==5.3.1
+    # via scrapy
+twisted==25.5.0
+    # via scrapy
+typing-extensions==4.15.0
+    # via
+    #   pydantic
+    #   pydantic-core
+    #   twisted
+    #   typing-inspection
+typing-inspection==0.4.2
+    # via pydantic
+urllib3==2.6.3
+    # via requests
+w3lib==2.4.1
+    # via
+    #   parsel
+    #   scrapy
+zope-interface==8.2
+    # via
+    #   scrapy
+    #   twisted

docs/topics/addons.rst

@@ -0,0 +1,206 @@
+.. _topics-addons:
+
+=======
+Add-ons
+=======
+
+Scrapy's add-on system is a framework which unifies managing and configuring
+components that extend Scrapy's core functionality, such as middlewares,
+extensions, or pipelines. It provides users with a plug-and-play experience in
+Scrapy extension management, and grants extensive configuration control to
+developers.
+
+
+Activating and configuring add-ons
+==================================
+
+During :class:`~scrapy.crawler.Crawler` initialization, the list of enabled
+add-ons is read from your ``ADDONS`` setting.
+
+The ``ADDONS`` setting is a dict in which every key is an add-on class or its
+import path and the value is its priority.
+
+This is an example where two add-ons are enabled in a project's
+``settings.py``:
+
+.. skip: next
+
+.. code-block:: python
+
+    ADDONS = {
+        "path.to.someaddon": 0,
+        SomeAddonClass: 1,
+    }
+
+
+Writing your own add-ons
+========================
+
+Add-ons are :ref:`components <topics-components>` that include one or both of
+the following methods:
+
+.. method:: update_settings(settings)
+
+    This method is called during the initialization of the
+    :class:`~scrapy.crawler.Crawler`. Here, you should perform dependency checks
+    (e.g. for external Python libraries) and update the
+    :class:`~scrapy.settings.Settings` object as wished, e.g. enable components
+    for this add-on or set required configuration of other extensions.
+
+    :param settings: The settings object storing Scrapy/component configuration
+    :type settings: :class:`~scrapy.settings.Settings`
+
+.. classmethod:: update_pre_crawler_settings(cls, settings)
+
+    Use this class method instead of the :meth:`update_settings` method to
+    update :ref:`pre-crawler settings <pre-crawler-settings>` whose value is
+    used before the :class:`~scrapy.crawler.Crawler` object is created.
+
+    :param settings: The settings object storing Scrapy/component configuration
+    :type settings: :class:`~scrapy.settings.BaseSettings`
+
+The settings set by the add-on should use the ``addon`` priority (see
+:ref:`populating-settings` and :func:`scrapy.settings.BaseSettings.set`):
+
+.. code-block:: python
+
+    class MyAddon:
+        def update_settings(self, settings):
+            settings.set("DNSCACHE_ENABLED", True, "addon")
+
+This allows users to override these settings in the project or spider
+configuration.
+
+When editing the value of a setting instead of overriding it entirely, it is
+usually best to leave its priority unchanged. For example, when editing a
+:ref:`component priority dictionary <component-priority-dictionaries>`.
+
+If the ``update_settings`` method raises
+:exc:`scrapy.exceptions.NotConfigured`, the add-on will be skipped. This makes
+it easy to enable an add-on only when some conditions are met.
+
+Fallbacks
+---------
+
+Some components provided by add-ons need to fall back to "default"
+implementations, e.g. a custom download handler needs to send the request that
+it doesn't handle via the default download handler, or a stats collector that
+includes some additional processing but otherwise uses the default stats
+collector. And it's possible that a project needs to use several custom
+components of the same type, e.g. two custom download handlers that support
+different kinds of custom requests and still need to use the default download
+handler for other requests. To make such use cases easier to configure, we
+recommend that such custom components should be written in the following way:
+
+1. The custom component (e.g. ``MyDownloadHandler``) shouldn't inherit from the
+   default Scrapy one (e.g.
+   ``scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler``), but instead
+   be able to load the class of the fallback component from a special setting
+   (e.g. ``MY_FALLBACK_DOWNLOAD_HANDLER``), create an instance of it and use
+   it.
+2. The add-ons that include these components should read the current value of
+   the default setting (e.g. ``DOWNLOAD_HANDLERS``) in their
+   ``update_settings()`` methods, save that value into the fallback setting
+   (``MY_FALLBACK_DOWNLOAD_HANDLER`` mentioned earlier) and set the default
+   setting to the component provided by the add-on (e.g.
+   ``MyDownloadHandler``). If the fallback setting is already set by the user,
+   it should not be changed.
+3. This way, if there are several add-ons that want to modify the same setting,
+   all of them will fall back to the component from the previous one and then to
+   the Scrapy default. The order of that depends on the priority order in the
+   ``ADDONS`` setting.
+
+
+Add-on examples
+===============
+
+Set some basic configuration:
+
+.. skip: next
+.. code-block:: python
+
+    from myproject.pipelines import MyPipeline
+
+
+    class MyAddon:
+        def update_settings(self, settings):
+            settings.set("DNSCACHE_ENABLED", True, "addon")
+            settings.remove_from_list("METAREFRESH_IGNORE_TAGS", "noscript")
+            settings.setdefault_in_component_priority_dict(
+                "ITEM_PIPELINES", MyPipeline, 200
+            )
+
+.. _priority-dict-helpers:
+
+.. tip:: When editing a :ref:`component priority dictionary
+    <component-priority-dictionaries>` setting, like :setting:`ITEM_PIPELINES`,
+    consider using setting methods like
+    :meth:`~scrapy.settings.BaseSettings.replace_in_component_priority_dict`,
+    :meth:`~scrapy.settings.BaseSettings.set_in_component_priority_dict`
+    and
+    :meth:`~scrapy.settings.BaseSettings.setdefault_in_component_priority_dict`
+    to avoid mistakes.
+
+Check dependencies:
+
+.. code-block:: python
+
+    class MyAddon:
+        def update_settings(self, settings):
+            try:
+                import boto
+            except ImportError:
+                raise NotConfigured("MyAddon requires the boto library")
+            ...
+
+Access the crawler instance:
+
+.. code-block:: python
+
+    class MyAddon:
+        def __init__(self, crawler) -> None:
+            super().__init__()
+            self.crawler = crawler
+
+        @classmethod
+        def from_crawler(cls, crawler):
+            return cls(crawler)
+
+        def update_settings(self, settings): ...
+
+Use a fallback component:
+
+.. code-block:: python
+
+    from scrapy.utils.misc import build_from_crawler, load_object
+
+    FALLBACK_SETTING = "MY_FALLBACK_DOWNLOAD_HANDLER"
+
+
+    class MyHandler:
+        lazy = False
+
+        def __init__(self, crawler):
+            dhcls = load_object(crawler.settings.get(FALLBACK_SETTING))
+            self._fallback_handler = build_from_crawler(dhcls, crawler)
+
+        async def download_request(self, request):
+            if request.meta.get("my_params"):
+                # handle the request
+                ...
+            else:
+                return await self._fallback_handler.download_request(request)
+
+        async def close(self):
+            pass
+
+
+    class MyAddon:
+        def update_settings(self, settings):
+            if not settings.get(FALLBACK_SETTING):
+                settings.set(
+                    FALLBACK_SETTING,
+                    settings.getwithbase("DOWNLOAD_HANDLERS")["https"],
+                    "addon",
+                )
+            settings["DOWNLOAD_HANDLERS"]["https"] = MyHandler

docs/topics/api.rst

@@ -12,10 +12,11 @@ extensions and middlewares.
 Crawler API
 ===========
 
-The main entry point to Scrapy API is the :class:`~scrapy.crawler.Crawler`
-object, passed to extensions through the ``from_crawler`` class method. This
-object provides access to all Scrapy core components, and it's the only way for
-extensions to access them and hook their functionality into Scrapy.
+The main entry point to the Scrapy API is the :class:`~scrapy.crawler.Crawler`
+object, which :ref:`components <topics-components>` can :ref:`get for
+initialization <from-crawler>`. It provides access to all Scrapy core
+components, and it is the only way for components to access them and hook their
+functionality into Scrapy.
 
 .. module:: scrapy.crawler
    :synopsis: The Scrapy crawler
@@ -26,12 +27,21 @@ contains a dictionary of all available extensions and their order similar to
 how you :ref:`configure the downloader middlewares
 <topics-downloader-middleware-setting>`.
 
-.. class:: Crawler(spidercls, settings)
+.. autoclass:: Crawler
+    :members: get_addon, get_downloader_middleware, get_extension,
+        get_item_pipeline, get_spider_middleware
 
     The Crawler object must be instantiated with a
     :class:`scrapy.Spider` subclass and a
     :class:`scrapy.settings.Settings` object.
 
+    .. attribute:: request_fingerprinter
+
+        The request fingerprint builder of this crawler.
+
+        This is used from extensions and middlewares to build short, unique
+        identifiers for requests. See :ref:`request-fingerprints`.
+
     .. attribute:: settings
 
         The settings manager of this crawler.
@@ -79,7 +89,7 @@ how you :ref:`configure the downloader middlewares
         The execution engine, which coordinates the core crawling logic
         between the scheduler, downloader and spiders.
 
-        Some extension may want to access the Scrapy engine, to inspect  or 
+        Some extension may want to access the Scrapy engine, to inspect  or
         modify the downloader and scheduler behaviour, although this is an
         advanced use and this API is not yet stable.
 
@@ -89,19 +99,25 @@ how you :ref:`configure the downloader middlewares
         provided while constructing the crawler, and it is created after the
         arguments given in the :meth:`crawl` method.
 
-    .. method:: crawl(*args, **kwargs)
+    .. automethod:: crawl_async
 
-        Starts the crawler by instantiating its spider class with the given
-        ``args`` and ``kwargs`` arguments, while setting the execution engine in
-        motion.
+    .. automethod:: crawl
 
-        Returns a deferred that is fired when the crawl is finished.
+    .. automethod:: stop_async
 
     .. automethod:: stop
 
+.. autoclass:: AsyncCrawlerRunner
+   :members:
+
 .. autoclass:: CrawlerRunner
    :members:
 
+.. autoclass:: AsyncCrawlerProcess
+   :show-inheritance:
+   :members:
+   :inherited-members:
+
 .. autoclass:: CrawlerProcess
    :show-inheritance:
    :members:
@@ -125,16 +141,15 @@ Settings API
     precedence over lesser ones when setting and retrieving values in the
     :class:`~scrapy.settings.Settings` class.
 
-    .. highlight:: python
-
-    ::
+    .. code-block:: python
 
         SETTINGS_PRIORITIES = {
-            'default': 0,
-            'command': 10,
-            'project': 20,
-            'spider': 30,
-            'cmdline': 40,
+            "default": 0,
+            "command": 10,
+            "addon": 15,
+            "project": 20,
+            "spider": 30,
+            "cmdline": 40,
         }
 
     For a detailed explanation on each settings sources, see:
@@ -157,46 +172,17 @@ SpiderLoader API
 .. module:: scrapy.spiderloader
    :synopsis: The spider loader
 
-.. class:: SpiderLoader
+Custom spider loaders can be employed by specifying their path in the
+:setting:`SPIDER_LOADER_CLASS` project setting. They must implement
+:class:`SpiderLoaderProtocol`.
 
-    This class is in charge of retrieving and handling the spider classes
-    defined across the project.
+.. autoclass:: SpiderLoaderProtocol
+    :members:
 
-    Custom spider loaders can be employed by specifying their path in the
-    :setting:`SPIDER_LOADER_CLASS` project setting. They must fully implement
-    the :class:`scrapy.interfaces.ISpiderLoader` interface to guarantee an
-    errorless execution.
+.. autoclass:: SpiderLoader
+    :members:
 
-    .. method:: from_settings(settings)
-
-       This class method is used by Scrapy to create an instance of the class.
-       It's called with the current project settings, and it loads the spiders
-       found recursively in the modules of the :setting:`SPIDER_MODULES`
-       setting.
-
-       :param settings: project settings
-       :type settings: :class:`~scrapy.settings.Settings` instance
-
-    .. method:: load(spider_name)
-
-       Get the Spider class with the given name. It'll look into the previously
-       loaded spiders for a spider class with name ``spider_name`` and will raise
-       a KeyError if not found.
-
-       :param spider_name: spider class name
-       :type spider_name: str
-
-    .. method:: list()
-
-       Get the names of the available spiders in the project.
-
-    .. method:: find_by_request(request)
-
-       List the spiders' names that can handle the given request. Will try to
-       match the request's url against the domains of the spiders.
-
-       :param request: queried request
-       :type request: :class:`~scrapy.Request` instance
+.. autoclass:: DummySpiderLoader
 
 .. _topics-api-signals:
 
@@ -263,11 +249,17 @@ class (which they all inherit from).
     The following methods are not part of the stats collection api but instead
     used when implementing custom stats collectors:
 
-    .. method:: open_spider(spider)
+    .. method:: open_spider()
 
-        Open the given spider for stats collection.
+        Open the spider for stats collection.
 
-    .. method:: close_spider(spider)
+    .. method:: close_spider()
 
-        Close the given spider. After this is called, no more specific stats
+        Close the spider. After this is called, no more specific stats
         can be accessed or collected.
+
+Engine API
+==========
+
+.. autoclass:: scrapy.core.engine.ExecutionEngine()
+   :members: needs_backout

docs/topics/architecture.rst

@@ -63,11 +63,11 @@ this:
    :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output`).
 
 8. The :ref:`Engine <component-engine>` sends processed items to
-   :ref:`Item Pipelines <component-pipelines>`, then send processed Requests to
+   :ref:`Item Pipelines <component-pipelines>`, then sends processed Requests to
    the :ref:`Scheduler <component-scheduler>` and asks for possible next Requests
    to crawl.
 
-9. The process repeats (from step 1) until there are no more requests from the
+9. The process repeats (from step 3) until there are no more requests from the
    :ref:`Scheduler <component-scheduler>`.
 
 Components
@@ -87,8 +87,8 @@ of the system, and triggering events when certain actions occur. See the
 Scheduler
 ---------
 
-The :ref:`scheduler <topics-scheduler>` receives requests from the engine and 
-enqueues them for feeding them later (also to the engine) when the engine 
+The :ref:`scheduler <topics-scheduler>` receives requests from the engine and
+enqueues them for feeding them later (also to the engine) when the engine
 requests them.
 
 .. _component-downloader:
@@ -150,7 +150,7 @@ requests).
 Use a Spider middleware if you need to
 
 * post-process output of spider callbacks - change/add/remove requests or items;
-* post-process start_requests;
+* post-process start requests or items;
 * handle spider exceptions;
 * call errback instead of callback for some of the requests based on response
   content.
@@ -168,9 +168,7 @@ For more information about asynchronous programming and Twisted see these
 links:
 
 * :doc:`twisted:core/howto/defer-intro`
-* `Twisted - hello, asynchronous programming`_
 * `Twisted Introduction - Krondo`_
 
-.. _Twisted: https://twistedmatrix.com/trac/
-.. _Twisted - hello, asynchronous programming: http://jessenoller.com/blog/2009/02/11/twisted-hello-asynchronous-programming/
-.. _Twisted Introduction - Krondo: http://krondo.com/an-introduction-to-asynchronous-programming-and-twisted/
+.. _Twisted: https://twisted.org/
+.. _Twisted Introduction - Krondo: https://krondo.com/an-introduction-to-asynchronous-programming-and-twisted/

docs/topics/asyncio.rst

@@ -4,57 +4,362 @@
 asyncio
 =======
 
-.. versionadded:: 2.0
+Scrapy supports :mod:`asyncio` natively. New projects created with
+:command:`startproject` have asyncio enabled by default, and you can use
+:mod:`asyncio` and :mod:`asyncio`-powered libraries in any :doc:`coroutine
+<coroutines>`.
 
-Scrapy has partial support for :mod:`asyncio`. After you :ref:`install the
-asyncio reactor <install-asyncio>`, you may use :mod:`asyncio` and
-:mod:`asyncio`-powered libraries in any :doc:`coroutine <coroutines>`.
+The rest of this page covers advanced topics. If you are starting a new project,
+no additional setup is needed.
 
-.. warning:: :mod:`asyncio` support in Scrapy is experimental, and not yet
-             recommended for production environments. Future Scrapy versions
-             may introduce related changes without a deprecation period or
-             warning.
 
 .. _install-asyncio:
 
-Installing the asyncio reactor
-==============================
+Configuring the asyncio reactor
+===============================
 
-To enable :mod:`asyncio` support, set the :setting:`TWISTED_REACTOR` setting to
-``'twisted.internet.asyncioreactor.AsyncioSelectorReactor'``.
+New projects generated with :command:`startproject` have the asyncio
+reactor configured by default. No manual setup is needed.
 
-If you are using :class:`~scrapy.crawler.CrawlerRunner`, you also need to
+The :setting:`TWISTED_REACTOR` setting controls which Twisted reactor Scrapy
+uses. Its default value is
+``'twisted.internet.asyncioreactor.AsyncioSelectorReactor'``, which enables
+:mod:`asyncio` support.
+
+If you are using :class:`~scrapy.crawler.AsyncCrawlerRunner` or
+:class:`~scrapy.crawler.CrawlerRunner`, you also need to
 install the :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor`
 reactor manually. You can do that using
-:func:`~scrapy.utils.reactor.install_reactor`::
+:func:`~scrapy.utils.reactor.install_reactor`:
 
-    install_reactor('twisted.internet.asyncioreactor.AsyncioSelectorReactor')
+.. skip: next
+.. code-block:: python
 
-.. _using-custom-loops:
+    install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor")
 
-Using custom asyncio loops
-==========================    
 
-You can also use custom asyncio event loops with the asyncio reactor. Set the
-:setting:`ASYNCIO_EVENT_LOOP` setting to the import path of the desired event loop class to
-use it instead of the default asyncio event loop.
+.. _asyncio-preinstalled-reactor:
+
+Handling a pre-installed reactor
+================================
+
+``twisted.internet.reactor`` and some other Twisted imports install the default
+Twisted reactor as a side effect. Once a Twisted reactor is installed, it is
+not possible to switch to a different reactor at run time.
+
+If you :ref:`configure the asyncio Twisted reactor <install-asyncio>` and, at
+run time, Scrapy complains that a different reactor is already installed,
+chances are you have some such imports in your code.
+
+You can usually fix the issue by moving those offending module-level Twisted
+imports to the method or function definitions where they are used. For example,
+if you have something like:
+
+.. skip: next
+.. code-block:: python
+
+    from twisted.internet import reactor
+
+
+    def my_function():
+        reactor.callLater(...)
+
+Switch to something like:
+
+.. code-block:: python
+
+    def my_function():
+        from twisted.internet import reactor
+
+        reactor.callLater(...)
+
+Alternatively, you can try to :ref:`manually install the asyncio reactor
+<install-asyncio>`, with :func:`~scrapy.utils.reactor.install_reactor`, before
+those imports happen.
+
 
 .. _asyncio-await-dfd:
 
-Awaiting on Deferreds
-=====================
+Integrating Deferred code and asyncio code
+==========================================
 
-When the asyncio reactor isn't installed, you can await on Deferreds in the
-coroutines directly. When it is installed, this is not possible anymore, due to
-specifics of the Scrapy coroutine integration (the coroutines are wrapped into
-:class:`asyncio.Future` objects, not into
-:class:`~twisted.internet.defer.Deferred` directly), and you need to wrap them into
-Futures. Scrapy provides two helpers for this:
+Coroutine functions can await on Deferreds by wrapping them into
+:class:`asyncio.Future` objects. Scrapy provides two helpers for this:
 
 .. autofunction:: scrapy.utils.defer.deferred_to_future
 .. autofunction:: scrapy.utils.defer.maybe_deferred_to_future
+
+.. tip:: If you don't need to support reactors other than the default
+         :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor`, you
+         can use :func:`~scrapy.utils.defer.deferred_to_future`, otherwise you
+         should use :func:`~scrapy.utils.defer.maybe_deferred_to_future`.
+
 .. tip:: If you need to use these functions in code that aims to be compatible
          with lower versions of Scrapy that do not provide these functions,
          down to Scrapy 2.0 (earlier versions do not support
          :mod:`asyncio`), you can copy the implementation of these functions
          into your own code.
+
+Coroutines and futures can be wrapped into Deferreds (for example, when a
+Scrapy API requires passing a Deferred to it) using the following helpers:
+
+.. autofunction:: scrapy.utils.defer.deferred_from_coro
+.. autofunction:: scrapy.utils.defer.deferred_f_from_coro_f
+
+The following function helps with a reverse wrapping:
+
+.. autofunction:: scrapy.utils.defer.ensure_awaitable
+
+
+.. _enforce-asyncio-requirement:
+
+Enforcing asyncio as a requirement
+==================================
+
+If you are writing a :ref:`component <topics-components>` that requires asyncio
+to work, use :func:`scrapy.utils.asyncio.is_asyncio_available` to
+:ref:`enforce it as a requirement <enforce-component-requirements>`. For
+example:
+
+.. code-block:: python
+
+    from scrapy.utils.asyncio import is_asyncio_available
+
+
+    class MyComponent:
+        def __init__(self):
+            if not is_asyncio_available():
+                raise ValueError(
+                    f"{MyComponent.__qualname__} requires the asyncio support. "
+                    f"Make sure you have configured the asyncio reactor in the "
+                    f"TWISTED_REACTOR setting. See the asyncio documentation "
+                    f"of Scrapy for more information."
+                )
+
+.. autofunction:: scrapy.utils.asyncio.is_asyncio_available
+.. autofunction:: scrapy.utils.reactor.is_asyncio_reactor_installed
+
+
+.. _asyncio-without-reactor:
+
+Using Scrapy without a Twisted reactor
+======================================
+
+.. versionadded:: 2.15.0
+
+.. warning::
+    This is currently experimental and may not be suitable for production use.
+
+.. note:: As the Twisted download handlers cannot be used without a reactor,
+    the default download handler in this mode is
+    :class:`~scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler`. You
+    will need to additionally install the :ref:`httpx <extras>` extra to use
+    it, unless you switch to some different handler.
+
+It's possible to use Scrapy without installing a Twisted reactor at all, by
+setting the :setting:`TWISTED_REACTOR_ENABLED` setting to ``False``. In this
+mode Scrapy will use the asyncio event loop directly, and most of the Scrapy
+functionality will work in the same way.
+
+Doing this provides several benefits in certain use cases:
+
+* A Twisted reactor, once stopped, cannot be started again. This prevents, for
+  example, using several instances of
+  :class:`~scrapy.crawler.AsyncCrawlerProcess` in the same process when they
+  use a reactor, but with ``TWISTED_REACTOR_ENABLED=False`` it becomes
+  possible.
+* There may be limitations imposed by
+  :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` and related
+  Twisted code, such as the requirement of using
+  :class:`~asyncio.SelectorEventLoop` on Windows (see :ref:`asyncio-windows`),
+  that do not apply if the reactor is not used.
+* :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` manages the
+  underlying event loop, and while :class:`~scrapy.crawler.AsyncCrawlerRunner`
+  can use a pre-existing reactor which, in turn, can use a pre-existing event
+  loop, it's easier to use :class:`~scrapy.crawler.AsyncCrawlerRunner` with a
+  pre-existing loop directly.
+* Omitting the reactor machinery may improve performance and reliability.
+
+Limitations
+-----------
+
+As some Scrapy features and components require a reactor, they don't work and
+are disabled without it. Replacements that don't require a reactor may be added
+in future Scrapy versions. The following features are not available:
+
+* The default HTTP(S) download handler,
+  :class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler` (this
+  is likely the biggest difference; Scrapy provides an HTTP(S) download handler
+  that doesn't require a reactor and will be used instead of it:
+  :class:`~scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler`)
+* :class:`~scrapy.core.downloader.handlers.ftp.FTPDownloadHandler`
+* :class:`~scrapy.core.downloader.handlers.http2.H2DownloadHandler`
+* :ref:`topics-telnetconsole`
+* :class:`~scrapy.crawler.CrawlerRunner` and
+  :class:`~scrapy.crawler.CrawlerProcess`
+  (:class:`~scrapy.crawler.AsyncCrawlerProcess` and
+  :class:`~scrapy.crawler.AsyncCrawlerRunner` are available)
+* Twisted-specific DNS resolvers (the :setting:`TWISTED_DNS_RESOLVER` setting)
+* User and 3rd-party code that requires a reactor (see :ref:`below
+  <asyncio-without-reactor-migrate>` for examples)
+
+Note that importing Twisted modules and, among other things, creating and using
+:class:`~twisted.internet.defer.Deferred` objects doesn't require a reactor, so
+code that uses :class:`~twisted.internet.defer.Deferred`,
+:class:`~twisted.python.failure.Failure` and some other Twisted APIs will not
+necessarily stop working.
+
+Other differences
+-----------------
+
+When :setting:`TWISTED_REACTOR_ENABLED` is set to ``False``, Scrapy will change
+the defaults of some other settings:
+
+* :setting:`TELNETCONSOLE_ENABLED` is set to ``False``.
+* The ``"http"`` and ``"https"`` keys in :setting:`DOWNLOAD_HANDLERS_BASE` are
+  set to ``"scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler"``.
+* The ``"ftp"`` key in :setting:`DOWNLOAD_HANDLERS_BASE` is set to ``None``.
+
+Thus, :class:`~scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler` is
+used by default for making HTTP(S) requests. Please refer to its documentation
+for its differences and limitations compared to
+:class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler`.
+
+Additionally, :class:`~scrapy.crawler.AsyncCrawlerProcess` will install a
+:term:`meta path finder` that prevents :mod:`twisted.internet.reactor` from
+being imported. It will be uninstalled when :meth:`AsyncCrawlerProcess.start()
+<scrapy.crawler.AsyncCrawlerProcess.start>` exits.
+
+.. _asyncio-without-reactor-migrate:
+
+Adding support to existing code
+-------------------------------
+
+Code that doesn't directly use Twisted APIs or APIs that depend on Twisted ones
+doesn't need special support for running without a reactor.
+
+Here are some examples of APIs and patterns that need a replacement:
+
+* Using :meth:`reactor.callLater()
+  <twisted.internet.base.ReactorBase.callLater>` for sleeping or delayed calls.
+  You can use :meth:`asyncio.loop.call_later` instead.
+* Using :func:`twisted.internet.threads.deferToThread`,
+  :meth:`reactor.callFromThread()
+  <twisted.internet.base.ReactorBase.callFromThread>` and related APIs to
+  execute code in other threads. You can use :func:`asyncio.to_thread`,
+  :meth:`asyncio.loop.call_soon_threadsafe` and related APIs instead.
+* Using :class:`twisted.internet.task.LoopingCall` for scheduling repeated
+  tasks. As there is no direct replacement in the standard library, you may
+  need to write your own one using :func:`asyncio.sleep` in a task.
+* Using Twisted network client and server APIs (:meth:`reactor.connectTCP()
+  <twisted.internet.interfaces.IReactorTCP.connectTCP>`,
+  :meth:`reactor.listenTCP()
+  <twisted.internet.interfaces.IReactorTCP.listenTCP>`,
+  :mod:`twisted.web.client`, :mod:`twisted.mail.smtp` etc.). You can use other
+  built-in or 3rd-party libraries for this.
+* Using :class:`~scrapy.crawler.CrawlerProcess` or
+  :class:`~scrapy.crawler.CrawlerRunner`. You should use
+  :class:`~scrapy.crawler.AsyncCrawlerProcess` or
+  :class:`~scrapy.crawler.AsyncCrawlerRunner` respectively instead.
+* Checking whether ``asyncio`` support is available with
+  :func:`scrapy.utils.reactor.is_asyncio_reactor_installed`. You should use
+  :func:`scrapy.utils.asyncio.is_asyncio_available` instead.
+
+Scrapy provides unified helpers for some of these examples:
+
+.. autofunction:: scrapy.utils.asyncio.sleep
+.. autofunction:: scrapy.utils.asyncio.call_later
+.. autofunction:: scrapy.utils.asyncio.create_looping_call
+.. autoclass:: scrapy.utils.asyncio.AsyncioLoopingCall
+.. autofunction:: scrapy.utils.asyncio.run_in_thread
+
+If your code needs to know whether the reactor is available, you can either
+check for the value of the :setting:`TWISTED_REACTOR_ENABLED` setting (you need
+access to the :class:`~scrapy.crawler.Crawler` instance to do this) or use the
+following function:
+
+.. autofunction:: scrapy.utils.reactorless.is_reactorless
+
+In general, code that doesn't use the reactor (directly or indirectly) can be
+used unmodified both with the asyncio reactor and without a reactor. This
+includes code that converts Deferreds to futures and vice versa as described in
+:ref:`asyncio-await-dfd`.
+
+Troubleshooting
+---------------
+
+**ImportError: Import of twisted.internet.reactor is forbidden when running
+without a Twisted reactor [...]:** Scrapy is configured to run without a
+reactor, but some code imported :mod:`twisted.internet.reactor`, most likely
+because that code needs a reactor to be used. You need to stop using this code
+or set :setting:`TWISTED_REACTOR_ENABLED` back to ``True``. It's also possible
+that the reactor isn't really needed but was installed due to the problem
+described in :ref:`asyncio-preinstalled-reactor`, in which case it should be
+enough to fix the problematic imports.
+
+**RuntimeError: TWISTED_REACTOR_ENABLED is False but a Twisted reactor is
+installed:** Scrapy is configured to run without a reactor, but a reactor is
+already installed before the Scrapy code is executed. If you are trying to set
+:setting:`TWISTED_REACTOR_ENABLED` via :ref:`per-spider settings
+<spider-settings>`, it's currently unsupported.
+
+**RuntimeError: We expected a Twisted reactor to be installed but it isn't:**
+Scrapy is configured to run with a reactor and not to install one, but a
+reactor wasn't installed before the Scrapy code is executed. If you are trying
+to set :setting:`TWISTED_REACTOR_ENABLED` via :ref:`per-spider settings
+<spider-settings>`, it's currently unsupported.
+
+**RuntimeError: <class> doesn't support TWISTED_REACTOR_ENABLED=False:** The
+listed class cannot be used with :setting:`TWISTED_REACTOR_ENABLED` set to
+``False``. There may be a replacement in the :ref:`documentation above
+<asyncio-without-reactor>` or the documentation of the affected class.
+
+
+.. _asyncio-windows:
+
+Windows-specific notes
+======================
+
+The Windows implementation of :mod:`asyncio` can use two event loop
+implementations, :class:`~asyncio.ProactorEventLoop` (default) and
+:class:`~asyncio.SelectorEventLoop`. However, only
+:class:`~asyncio.SelectorEventLoop` works with Twisted.
+
+Scrapy changes the event loop class to :class:`~asyncio.SelectorEventLoop`
+automatically when installing the asyncio reactor.
+
+.. note:: Other libraries you use may require
+          :class:`~asyncio.ProactorEventLoop`, e.g. because it supports
+          subprocesses (this is the case with `playwright`_), so you cannot use
+          them together with Scrapy on Windows (but you should be able to use
+          them on WSL or native Linux).
+
+.. note:: This problem doesn't apply when not using the reactor, see
+    :ref:`asyncio-without-reactor`.
+
+.. _playwright: https://github.com/microsoft/playwright-python
+
+
+.. _using-custom-loops:
+
+Using custom asyncio loops
+==========================
+
+You can also use custom asyncio event loops with the asyncio reactor. Set the
+:setting:`ASYNCIO_EVENT_LOOP` setting to the import path of the desired event
+loop class to use it instead of the default asyncio event loop.
+
+
+.. _disable-asyncio:
+
+Switching to a non-asyncio reactor
+==================================
+
+If for some reason your code doesn't work with the asyncio reactor, you can use
+a different reactor by setting the :setting:`TWISTED_REACTOR` setting to its
+import path (e.g. ``'twisted.internet.epollreactor.EPollReactor'``) or to
+``None``, which will use the default reactor for your platform. If you are
+using :class:`~scrapy.crawler.AsyncCrawlerRunner` or
+:class:`~scrapy.crawler.AsyncCrawlerProcess` you also need to switch to their
+Deferred-based counterparts: :class:`~scrapy.crawler.CrawlerRunner` or
+:class:`~scrapy.crawler.CrawlerProcess` respectively.

docs/topics/autothrottle.rst

@@ -21,9 +21,14 @@ Design goals
 How it works
 ============
 
-AutoThrottle extension adjusts download delays dynamically to make spider send
-:setting:`AUTOTHROTTLE_TARGET_CONCURRENCY` concurrent requests on average
-to each remote website.
+Scrapy allows defining the concurrency and delay of different download slots,
+e.g. through the :setting:`DOWNLOAD_SLOTS` setting. By default requests are
+assigned to slots based on their URL domain, although it is possible to
+customize the download slot of any request.
+
+The AutoThrottle extension adjusts the delay of each download slot dynamically,
+to make your spider send :setting:`AUTOTHROTTLE_TARGET_CONCURRENCY` concurrent
+requests on average to each remote website.
 
 It uses download latency to compute the delays. The main idea is the
 following: if a server needs ``latency`` seconds to respond, a client
@@ -32,8 +37,7 @@ processed in parallel.
 
 Instead of adjusting the delays one can just set a small fixed
 download delay and impose hard limits on concurrency using
-:setting:`CONCURRENT_REQUESTS_PER_DOMAIN` or
-:setting:`CONCURRENT_REQUESTS_PER_IP` options. It will provide a similar
+:setting:`CONCURRENT_REQUESTS_PER_DOMAIN`. It will provide a similar
 effect, but there are some important differences:
 
 * because the download delay is small there will be occasional bursts
@@ -66,13 +70,12 @@ AutoThrottle algorithm adjusts download delays based on the following rules:
 .. note:: The AutoThrottle extension honours the standard Scrapy settings for
    concurrency and delay. This means that it will respect
    :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` and
-   :setting:`CONCURRENT_REQUESTS_PER_IP` options and
    never set a download delay lower than :setting:`DOWNLOAD_DELAY`.
 
 .. _download-latency:
 
 In Scrapy, the download latency is measured as the time elapsed between
-establishing the TCP connection and receiving the HTTP headers.
+sending the request and receiving the HTTP headers.
 
 Note that these latencies are very hard to measure accurately in a cooperative
 multitasking environment because Scrapy may be busy processing a spider
@@ -80,6 +83,34 @@ callback, for example, and unable to attend downloads. However, these latencies
 should still give a reasonable estimate of how busy Scrapy (and ultimately, the
 server) is, and this extension builds on that premise.
 
+.. reqmeta:: autothrottle_dont_adjust_delay
+
+Prevent specific requests from triggering slot delay adjustments
+================================================================
+
+.. versionadded:: 2.12.0
+
+AutoThrottle adjusts the delay of download slots based on the latencies of
+responses that belong to that download slot. The only exceptions are non-200
+responses, which are only taken into account to increase that delay, but
+ignored if they would decrease that delay.
+
+You can also set the ``autothrottle_dont_adjust_delay`` request metadata key to
+``True`` in any request to prevent its response latency from impacting the
+delay of its download slot:
+
+.. code-block:: python
+
+    from scrapy import Request
+
+    Request("https://example.com", meta={"autothrottle_dont_adjust_delay": True})
+
+Note, however, that AutoThrottle still determines the starting delay of every
+download slot. If you want AutoThrottle not to impact a download slot at all,
+in addition to setting this meta key in all requests that use that download
+slot, you might want to set a custom value for the ``delay`` attribute of that
+download slot, e.g. using :setting:`DOWNLOAD_SLOTS`.
+
 Settings
 ========
 
@@ -91,7 +122,6 @@ The settings used to control the AutoThrottle extension are:
 * :setting:`AUTOTHROTTLE_TARGET_CONCURRENCY`
 * :setting:`AUTOTHROTTLE_DEBUG`
 * :setting:`CONCURRENT_REQUESTS_PER_DOMAIN`
-* :setting:`CONCURRENT_REQUESTS_PER_IP`
 * :setting:`DOWNLOAD_DELAY`
 
 For more information see :ref:`autothrottle-algorithm`.
@@ -131,7 +161,7 @@ AUTOTHROTTLE_TARGET_CONCURRENCY
 Default: ``1.0``
 
 Average number of requests Scrapy should be sending in parallel to remote
-websites.
+websites. It must be higher than ``0.0``.
 
 By default, AutoThrottle adjusts the delay to send a single
 concurrent request to each of the remote websites. Set this option to
@@ -139,12 +169,10 @@ a higher value (e.g. ``2.0``) to increase the throughput and the load on remote
 servers. A lower ``AUTOTHROTTLE_TARGET_CONCURRENCY`` value
 (e.g. ``0.5``) makes the crawler more conservative and polite.
 
-Note that :setting:`CONCURRENT_REQUESTS_PER_DOMAIN`
-and :setting:`CONCURRENT_REQUESTS_PER_IP` options are still respected
+Note that :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` is still respected
 when AutoThrottle extension is enabled. This means that if
 ``AUTOTHROTTLE_TARGET_CONCURRENCY`` is set to a value higher than
-:setting:`CONCURRENT_REQUESTS_PER_DOMAIN` or
-:setting:`CONCURRENT_REQUESTS_PER_IP`, the crawler won't reach this number
+:setting:`CONCURRENT_REQUESTS_PER_DOMAIN`, the crawler won't reach this number
 of concurrent requests.
 
 At every given time point Scrapy can be sending more or less concurrent

docs/topics/benchmarking.rst

@@ -24,7 +24,8 @@ You should see an output like this::
      'scrapy.extensions.telnet.TelnetConsole',
      'scrapy.extensions.corestats.CoreStats']
     2016-12-16 21:18:49 [scrapy.middleware] INFO: Enabled downloader middlewares:
-    ['scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware',
+    ['scrapy.downloadermiddlewares.offsite.OffsiteMiddleware',
+     'scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware',
      'scrapy.downloadermiddlewares.httpauth.HttpAuthMiddleware',
      'scrapy.downloadermiddlewares.downloadtimeout.DownloadTimeoutMiddleware',
      'scrapy.downloadermiddlewares.defaultheaders.DefaultHeadersMiddleware',
@@ -37,7 +38,6 @@ You should see an output like this::
      'scrapy.downloadermiddlewares.stats.DownloaderStats']
     2016-12-16 21:18:49 [scrapy.middleware] INFO: Enabled spider middlewares:
     ['scrapy.spidermiddlewares.httperror.HttpErrorMiddleware',
-     'scrapy.spidermiddlewares.offsite.OffsiteMiddleware',
      'scrapy.spidermiddlewares.referer.RefererMiddleware',
      'scrapy.spidermiddlewares.urllength.UrlLengthMiddleware',
      'scrapy.spidermiddlewares.depth.DepthMiddleware']
@@ -83,4 +83,4 @@ and how well it's written.
 
 Use scrapy-bench_ for more complex benchmarking.
 
-.. _scrapy-bench: https://github.com/scrapy/scrapy-bench
+.. _scrapy-bench: https://github.com/scrapy/scrapy-bench

docs/topics/broad-crawls.rst

@@ -41,17 +41,6 @@ efficient broad crawl.
 
 .. _broad-crawls-scheduler-priority-queue:
 
-Use the right :setting:`SCHEDULER_PRIORITY_QUEUE`
-=================================================
-
-Scrapy’s default scheduler priority queue is ``'scrapy.pqueues.ScrapyPriorityQueue'``.
-It works best during single-domain crawl. It does not work well with crawling
-many different domains in parallel
-
-To apply the recommended priority queue use::
-
-    SCHEDULER_PRIORITY_QUEUE = 'scrapy.pqueues.DownloaderAwarePriorityQueue'
-
 .. _broad-crawls-concurrency:
 
 Increase concurrency
@@ -59,19 +48,16 @@ Increase concurrency
 
 Concurrency is the number of requests that are processed in parallel. There is
 a global limit (:setting:`CONCURRENT_REQUESTS`) and an additional limit that
-can be set either per domain (:setting:`CONCURRENT_REQUESTS_PER_DOMAIN`) or per
-IP (:setting:`CONCURRENT_REQUESTS_PER_IP`).
-
-.. note:: The scheduler priority queue :ref:`recommended for broad crawls
-          <broad-crawls-scheduler-priority-queue>` does not support
-          :setting:`CONCURRENT_REQUESTS_PER_IP`.
+can be set per domain (:setting:`CONCURRENT_REQUESTS_PER_DOMAIN`).
 
 The default global concurrency limit in Scrapy is not suitable for crawling
 many different domains in parallel, so you will want to increase it. How much
-to increase it will depend on how much CPU and memory you crawler will have
+to increase it will depend on how much CPU and memory your crawler will have
 available.
 
-A good starting point is ``100``::
+A good starting point is ``100``:
+
+.. code-block:: python
 
     CONCURRENT_REQUESTS = 100
 
@@ -92,7 +78,9 @@ hitting DNS resolver timeouts. Possible solution to increase the number of
 threads handling DNS queries. The DNS queue will be processed faster speeding
 up establishing of connection and crawling overall.
 
-To increase maximum thread pool size use::
+To increase maximum thread pool size use:
+
+.. code-block:: python
 
     REACTOR_THREADPOOL_MAXSIZE = 20
 
@@ -110,13 +98,15 @@ Reduce log level
 When doing broad crawls you are often only interested in the crawl rates you
 get and any errors found. These stats are reported by Scrapy when using the
 ``INFO`` log level. In order to save CPU (and log storage requirements) you
-should not use ``DEBUG`` log level when preforming large broad crawls in
+should not use ``DEBUG`` log level when performing large broad crawls in
 production. Using ``DEBUG`` level when developing your (broad) crawler may be
 fine though.
 
-To set the log level use::
+To set the log level use:
 
-    LOG_LEVEL = 'INFO'
+.. code-block:: python
+
+    LOG_LEVEL = "INFO"
 
 Disable cookies
 ===============
@@ -126,19 +116,23 @@ doing broad crawls (search engine crawlers ignore them), and they improve
 performance by saving some CPU cycles and reducing the memory footprint of your
 Scrapy crawler.
 
-To disable cookies use::
+To disable cookies use:
+
+.. code-block:: python
 
     COOKIES_ENABLED = False
 
 Disable retries
 ===============
 
-Retrying failed HTTP requests can slow down the crawls substantially, specially
+Retrying failed HTTP requests can slow down the crawls substantially, especially
 when sites causes are very slow (or fail) to respond, thus causing a timeout
 error which gets retried many times, unnecessarily, preventing crawler capacity
 to be reused for other domains.
 
-To disable retries use::
+To disable retries use:
+
+.. code-block:: python
 
     RETRY_ENABLED = False
 
@@ -149,7 +143,9 @@ Unless you are crawling from a very slow connection (which shouldn't be the
 case for broad crawls) reduce the download timeout so that stuck requests are
 discarded quickly and free up capacity to process the next ones.
 
-To reduce the download timeout use::
+To reduce the download timeout use:
+
+.. code-block:: python
 
     DOWNLOAD_TIMEOUT = 15
 
@@ -162,34 +158,12 @@ revisiting the site at a later crawl. This also help to keep the number of
 request constant per crawl batch, otherwise redirect loops may cause the
 crawler to dedicate too many resources on any specific domain.
 
-To disable redirects use::
+To disable redirects use:
+
+.. code-block:: python
 
     REDIRECT_ENABLED = False
 
-Enable crawling of "Ajax Crawlable Pages"
-=========================================
-
-Some pages (up to 1%, based on empirical data from year 2013) declare
-themselves as `ajax crawlable`_. This means they provide plain HTML
-version of content that is usually available only via AJAX.
-Pages can indicate it in two ways:
-
-1) by using ``#!`` in URL - this is the default way;
-2) by using a special meta tag - this way is used on
-   "main", "index" website pages.
-
-Scrapy handles (1) automatically; to handle (2) enable
-:ref:`AjaxCrawlMiddleware <ajaxcrawl-middleware>`::
-
-    AJAXCRAWL_ENABLED = True
-
-When doing broad crawls it's common to crawl a lot of "index" web pages;
-AjaxCrawlMiddleware helps to crawl them correctly.
-It is turned OFF by default because it has some performance overhead,
-and enabling it for focused crawls doesn't make much sense.
-
-.. _ajax crawlable: https://developers.google.com/search/docs/ajax-crawling/docs/getting-started
-
 .. _broad-crawls-bfo:
 
 Crawl in BFO order

docs/topics/commands.rst

@@ -6,7 +6,7 @@
 Command line tool
 =================
 
-Scrapy is controlled through the ``scrapy`` command-line tool, to be referred
+Scrapy is controlled through the ``scrapy`` command-line tool, to be referred to
 here as the "Scrapy tool" to differentiate it from the sub-commands, which we
 just call "commands" or "Scrapy commands".
 
@@ -114,8 +114,8 @@ some usage help and the available commands::
       scrapy <command> [options] [args]
 
     Available commands:
-      crawl         Run a spider
       fetch         Fetch a URL using the Scrapy downloader
+      runspider     Run a spider from a Python file, no project required
     [...]
 
 The first line will print the currently active project if you're inside a
@@ -163,8 +163,8 @@ information on which commands must be run from inside projects, and which not.
 
 Also keep in mind that some commands may have slightly different behaviours
 when running them from inside projects. For example, the fetch command will use
-spider-overridden behaviours (such as the ``user_agent`` attribute to override
-the user-agent) if the url being fetched is associated with some specific
+spider-overridden behaviours (such as the ``custom_settings`` attribute to
+override settings) if the url being fetched is associated with some specific
 spider. This is intentional, as the ``fetch`` command is meant to be used to
 check how spiders are downloading pages.
 
@@ -185,8 +185,8 @@ And you can see all available commands with::
 
 There are two kinds of commands, those that only work from inside a Scrapy
 project (Project-specific commands) and those that also work without an active
-Scrapy project (Global commands), though they may behave slightly different
-when running from inside a project (as they would use the project overridden
+Scrapy project (Global commands), though they may behave slightly differently
+when run from inside a project (as they would use the project overridden
 settings).
 
 Global commands:
@@ -199,6 +199,7 @@ Global commands:
 * :command:`fetch`
 * :command:`view`
 * :command:`version`
+* :command:`bench`
 
 Project-only commands:
 
@@ -207,7 +208,6 @@ Project-only commands:
 * :command:`list`
 * :command:`edit`
 * :command:`parse`
-* :command:`bench`
 
 .. command:: startproject
 
@@ -230,10 +230,10 @@ Usage example::
 genspider
 ---------
 
-* Syntax: ``scrapy genspider [-t template] <name> <domain>``
+* Syntax: ``scrapy genspider [-t template] <name> <domain or URL>``
 * Requires project: *no*
 
-Create a new spider in the current folder or in the current project's ``spiders`` folder, if called from inside a project. The ``<name>`` parameter is set as the spider's ``name``, while ``<domain>`` is used to generate the ``allowed_domains`` and ``start_urls`` spider's attributes.
+Creates a new spider in the current folder or in the current project's ``spiders`` folder, if called from inside a project. The ``<name>`` parameter is set as the spider's ``name``, while ``<domain or URL>`` is used to generate the ``allowed_domains`` and ``start_urls`` spider's attributes.
 
 Usage example::
 
@@ -250,7 +250,7 @@ Usage example::
     $ scrapy genspider -t crawl scrapyorg scrapy.org
     Created spider 'scrapyorg' using template 'crawl'
 
-This is just a convenience shortcut command for creating spiders based on
+This is just a convenient shortcut command for creating spiders based on
 pre-defined templates, but certainly not the only way to create spiders. You
 can just create the spider source code files yourself, instead of using this
 command.
@@ -263,13 +263,30 @@ crawl
 * Syntax: ``scrapy crawl <spider>``
 * Requires project: *yes*
 
-Start crawling using a spider.
+Start crawling using the spider with the given :attr:`~scrapy.Spider.name`,
+which must be one of those that :command:`list` reports. To run a spider from a
+file instead, use :command:`runspider`.
+
+Supported options:
+
+* ``-h, --help``: show a help message and exit
+
+* ``-a NAME=VALUE``: set a spider argument (may be repeated)
+
+* ``--output FILE`` or ``-o FILE``: append scraped items to the end of FILE (use - for stdout). To define the output format, set a colon at the end of the output URI (i.e. ``-o FILE:FORMAT``)
+
+* ``--overwrite-output FILE`` or ``-O FILE``: dump scraped items into FILE, overwriting any existing file. To define the output format, set a colon at the end of the output URI (i.e. ``-O FILE:FORMAT``)
 
 Usage examples::
 
     $ scrapy crawl myspider
     [ ... myspider starts crawling ... ]
 
+    $ scrapy crawl -o myfile:csv myspider
+    [ ... myspider starts crawling and appends the result to the file myfile in csv format ... ]
+
+    $ scrapy crawl -O myfile:json myspider
+    [ ... myspider starts crawling and saves the result in myfile in json format overwriting the original content... ]
 
 .. command:: check
 
@@ -294,11 +311,25 @@ Usage examples::
       * parse_item
 
     $ scrapy check
-    [FAILED] first_spider:parse_item
-    >>> 'RetailPricex' field is missing
+    F.F.
+    ======================================================================
+    FAIL: [first_spider] parse (@returns post-hook)
+    ----------------------------------------------------------------------
+    Traceback (most recent call last):
+      ...
+    scrapy.exceptions.ContractFail: Returned 92 requests, expected 0..4
 
-    [FAILED] first_spider:parse
-    >>> Returned 92 requests, expected 0..4
+    ======================================================================
+    FAIL: [first_spider] parse_item (@scrapes post-hook)
+    ----------------------------------------------------------------------
+    Traceback (most recent call last):
+      ...
+    scrapy.exceptions.ContractFail: Missing fields: RetailPricex
+
+    ----------------------------------------------------------------------
+    Ran 4 contracts in 0.174s
+
+    FAILED (failures=2)
 
 .. skip: end
 
@@ -330,7 +361,7 @@ edit
 Edit the given spider using the editor defined in the ``EDITOR`` environment
 variable or (if unset) the :setting:`EDITOR` setting.
 
-This command is provided only as a convenience shortcut for the most common
+This command is provided only as a convenient shortcut for the most common
 case, the developer is of course free to choose any tool or IDE to write and
 debug spiders.
 
@@ -349,7 +380,7 @@ fetch
 Downloads the given URL using the Scrapy downloader and writes the contents to
 standard output.
 
-The interesting thing about this command is that it fetches the page how the
+The interesting thing about this command is that it fetches the page the way the
 spider would download it. For example, if the spider has a ``USER_AGENT``
 attribute which overrides the User Agent, it will use that one.
 
@@ -362,7 +393,7 @@ Supported options:
 
 * ``--spider=SPIDER``: bypass spider autodetection and force use of specific spider
 
-* ``--headers``: print the response's HTTP headers instead of the response's body
+* ``--headers``: print the request's and response's HTTP headers instead of the response's body
 
 * ``--no-redirect``: do not follow HTTP 3xx redirects (default is to follow them)
 
@@ -372,15 +403,19 @@ Usage examples::
     [ ... html content here ... ]
 
     $ scrapy fetch --nolog --headers http://www.example.com/
-    {'Accept-Ranges': ['bytes'],
-     'Age': ['1263   '],
-     'Connection': ['close     '],
-     'Content-Length': ['596'],
-     'Content-Type': ['text/html; charset=UTF-8'],
-     'Date': ['Wed, 18 Aug 2010 23:59:46 GMT'],
-     'Etag': ['"573c1-254-48c9c87349680"'],
-     'Last-Modified': ['Fri, 30 Jul 2010 15:30:18 GMT'],
-     'Server': ['Apache/2.2.3 (CentOS)']}
+    > Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
+    > Accept-Language: en
+    > User-Agent: Scrapy/2.16.0 (+https://scrapy.org)
+    > Accept-Encoding: gzip, deflate, br
+    >
+    < Date: Wed, 08 Jul 2026 06:15:01 GMT
+    < Content-Type: text/html
+    < Server: cloudflare
+    < Last-Modified: Wed, 01 Jul 2026 17:50:18 GMT
+    < Allow: GET, HEAD
+    < Cf-Cache-Status: HIT
+    < Age: 8184
+    < Cf-Ray: a17cf3b80eddf141-DME
 
 .. command:: view
 
@@ -461,7 +496,7 @@ Supported options:
 
 * ``--spider=SPIDER``: bypass spider autodetection and force use of specific spider
 
-* ``--a NAME=VALUE``: set spider argument (may be repeated)
+* ``-a NAME=VALUE``: set spider argument (may be repeated)
 
 * ``--callback`` or ``-c``: spider method to use as callback for parsing the
   response
@@ -472,7 +507,7 @@ Supported options:
 * ``--cbkwargs``: additional keyword arguments that will be passed to the callback.
   This must be a valid json string. Example: --cbkwargs='{"foo" : "bar"}'
 
-* ``--pipelines``: process items through pipelines
+* ``--pipelines``: :ref:`process items through pipelines <test-item-pipeline>`
 
 * ``--rules`` or ``-r``: use :class:`~scrapy.spiders.CrawlSpider`
   rules to discover the callback (i.e. spider method) to use for parsing the
@@ -491,8 +526,6 @@ Supported options:
 
 * ``--output`` or ``-o``: dump scraped items to a file
 
-  .. versionadded:: 2.3
-
 .. skip: start
 
 Usage example::
@@ -540,8 +573,9 @@ runspider
 * Syntax: ``scrapy runspider <spider_file.py>``
 * Requires project: *no*
 
-Run a spider self-contained in a Python file, without having to create a
-project.
+Run the spider defined in the given Python file, without requiring a project.
+
+Supported options: the same as :command:`crawl`.
 
 Example usage::
 
@@ -569,6 +603,47 @@ bench
 
 Run a quick benchmark test. :ref:`benchmarking`.
 
+.. _topics-commands-crawlerprocess:
+
+Commands that run a crawl
+=========================
+
+Many commands need to run a crawl of some kind, running either a user-provided
+spider or a special internal one:
+
+* :command:`bench`
+* :command:`check`
+* :command:`crawl`
+* :command:`fetch`
+* :command:`parse`
+* :command:`runspider`
+* :command:`shell`
+* :command:`view`
+
+They use an internal instance of :class:`scrapy.crawler.AsyncCrawlerProcess` or
+:class:`scrapy.crawler.CrawlerProcess` for this. In most cases this detail
+shouldn't matter to the user running the command, but when the user :ref:`needs
+a non-default Twisted reactor <disable-asyncio>`, it may be important.
+
+Scrapy decides which of these two classes to use based on the value of the
+:setting:`TWISTED_REACTOR` and :setting:`TWISTED_REACTOR_ENABLED` settings.
+With :setting:`TWISTED_REACTOR_ENABLED` set to ``False`` it will use
+:class:`~scrapy.crawler.AsyncCrawlerProcess`. Otherwise, if the
+:setting:`TWISTED_REACTOR` value is the default one
+(``'twisted.internet.asyncioreactor.AsyncioSelectorReactor'``),
+:class:`~scrapy.crawler.AsyncCrawlerProcess` will be used, otherwise
+:class:`~scrapy.crawler.CrawlerProcess` will be used. The :ref:`spider settings
+<spider-settings>` are not taken into account when doing this, as they are
+loaded after this decision is made. This may cause an error if the
+project-level setting is set to :ref:`the asyncio reactor <install-asyncio>`
+(:ref:`explicitly <project-settings>` or :ref:`by using the Scrapy default
+<default-settings>`) and :ref:`the setting of the spider being run
+<spider-settings>` is set to :ref:`a different one <disable-asyncio>`, because
+:class:`~scrapy.crawler.AsyncCrawlerProcess` only supports the asyncio reactor.
+In this case you should set the :setting:`FORCE_CRAWLER_PROCESS` setting to
+``True`` (at the project level or via the command line) so that Scrapy uses
+:class:`~scrapy.crawler.CrawlerProcess` which supports all reactors.
+
 Custom project commands
 =======================
 
@@ -591,7 +666,9 @@ Example:
 
 .. code-block:: python
 
-    COMMANDS_MODULE = 'mybot.commands'
+    COMMANDS_MODULE = "mybot.commands"
+
+.. note:: This is a :ref:`pre-crawler setting <pre-crawler-settings>`.
 
 .. _Deploying your project: https://scrapyd.readthedocs.io/en/latest/deploy.html
 
@@ -610,10 +687,11 @@ The following example adds ``my_command`` command:
 
   from setuptools import setup, find_packages
 
-  setup(name='scrapy-mymodule',
-    entry_points={
-      'scrapy.commands': [
-        'my_command=my_scrapy_module.commands:MyCommand',
-      ],
-    },
-   )
+  setup(
+      name="scrapy-mymodule",
+      entry_points={
+          "scrapy.commands": [
+              "my_command=my_scrapy_module.commands:MyCommand",
+          ],
+      },
+  )

docs/topics/components.rst

@@ -0,0 +1,157 @@
+.. _topics-components:
+
+==========
+Components
+==========
+
+A Scrapy component is any class whose objects are built using
+:func:`~scrapy.utils.misc.build_from_crawler`.
+
+That includes the classes that you may assign to the following settings:
+
+- :setting:`ADDONS`
+- :setting:`DOWNLOAD_HANDLERS`
+- :setting:`DOWNLOADER_MIDDLEWARES`
+- :setting:`DUPEFILTER_CLASS`
+- :setting:`EXTENSIONS`
+- :setting:`FEED_EXPORTERS`
+- :setting:`FEED_STORAGES`
+- :setting:`ITEM_PIPELINES`
+- :setting:`SCHEDULER`
+- :setting:`SCHEDULER_DISK_QUEUE`
+- :setting:`SCHEDULER_MEMORY_QUEUE`
+- :setting:`SCHEDULER_PRIORITY_QUEUE`
+- :setting:`SCHEDULER_START_DISK_QUEUE`
+- :setting:`SCHEDULER_START_MEMORY_QUEUE`
+- :setting:`SPIDER_MIDDLEWARES`
+- :setting:`TWISTED_DNS_RESOLVER`
+
+Third-party Scrapy components may also let you define additional Scrapy
+components, usually configurable through :ref:`settings <topics-settings>`, to
+modify their behavior.
+
+.. _from-crawler:
+
+Initializing from the crawler
+=============================
+
+Any Scrapy component may optionally define the following class method:
+
+.. classmethod:: from_crawler(cls, crawler: scrapy.crawler.Crawler, *args, **kwargs)
+
+    Return an instance of the component based on *crawler*.
+
+    *args* and *kwargs* are component-specific arguments that some components
+    receive. However, most components do not get any arguments, and instead
+    :ref:`use settings <component-settings>`.
+
+    If a component class defines this method, this class method is called to
+    create any instance of the component.
+
+    The *crawler* object provides access to all Scrapy core components like
+    :ref:`settings <topics-settings>` and :ref:`signals <topics-signals>`,
+    allowing the component to access them and hook its functionality into
+    Scrapy.
+
+.. _component-settings:
+
+Settings
+========
+
+Components can be configured through :ref:`settings <topics-settings>`.
+
+Components can read any setting from the
+:attr:`~scrapy.crawler.Crawler.settings` attribute of the
+:class:`~scrapy.crawler.Crawler` object they can :ref:`get for initialization
+<from-crawler>`. That includes both built-in and custom settings.
+
+For example:
+
+.. code-block:: python
+
+    class MyExtension:
+        @classmethod
+        def from_crawler(cls, crawler):
+            settings = crawler.settings
+            return cls(settings.getbool("LOG_ENABLED"))
+
+        def __init__(self, log_is_enabled=False):
+            if log_is_enabled:
+                print("log is enabled!")
+
+Components do not need to declare their custom settings programmatically.
+However, they should document them, so that users know they exist and how to
+use them.
+
+It is a good practice to prefix custom settings with the name of the component,
+to avoid collisions with custom settings of other existing (or future)
+components. For example, an extension called ``WarcCaching`` could prefix its
+custom settings with ``WARC_CACHING_``.
+
+Another good practice, mainly for components meant for :ref:`component priority
+dictionaries <component-priority-dictionaries>`, is to provide a boolean setting
+called ``<PREFIX>_ENABLED`` (e.g. ``WARC_CACHING_ENABLED``) to allow toggling
+that component on and off without changing the component priority dictionary
+setting. You can usually check the value of such a setting during
+initialization, and if ``False``, raise
+:exc:`~scrapy.exceptions.NotConfigured`.
+
+When choosing a name for a custom setting, it is also a good idea to have a
+look at the names of :ref:`built-in settings <topics-settings-ref>`, to try to
+maintain consistency with them.
+
+.. _enforce-component-requirements:
+
+Enforcing requirements
+======================
+
+Sometimes, your components may only be intended to work under certain
+conditions. For example, they may require a minimum version of Scrapy to work as
+intended, or they may require certain settings to have specific values.
+
+In addition to describing those conditions in the documentation of your
+component, it is a good practice to raise an exception from the ``__init__``
+method of your component if those conditions are not met at run time.
+
+In the case of :ref:`downloader middlewares <topics-downloader-middleware>`,
+:ref:`extensions <topics-extensions>`, :ref:`item pipelines
+<topics-item-pipeline>`, and :ref:`spider middlewares
+<topics-spider-middleware>`, you should raise
+:exc:`~scrapy.exceptions.NotConfigured`, passing a description of the issue as
+a parameter to the exception so that it is printed in the logs, for the user to
+see. For other components, feel free to raise whatever other exception feels
+right to you; for example, :exc:`RuntimeError` would make sense for a Scrapy
+version mismatch, while :exc:`ValueError` may be better if the issue is the
+value of a setting.
+
+If your requirement is a minimum Scrapy version, you may use
+:attr:`scrapy.__version__` to enforce your requirement. For example:
+
+.. code-block:: python
+
+    from packaging.version import parse as parse_version
+
+    import scrapy
+
+
+    class MyComponent:
+        def __init__(self):
+            if parse_version(scrapy.__version__) < parse_version("2.7"):
+                raise RuntimeError(
+                    f"{MyComponent.__qualname__} requires Scrapy 2.7 or "
+                    f"later, which allow defining the process_spider_output "
+                    f"method of spider middlewares as an asynchronous "
+                    f"generator."
+                )
+
+API reference
+=============
+
+The following function can be used to create an instance of a component class:
+
+.. autofunction:: scrapy.utils.misc.build_from_crawler
+
+The following function can also be useful when implementing a component, to
+report the import path of the component class, e.g. when reporting problems:
+
+.. autofunction:: scrapy.utils.python.global_object_name

docs/topics/contracts.rst

@@ -11,51 +11,34 @@ integrated way of testing your spiders by the means of contracts.
 This allows you to test each callback of your spider by hardcoding a sample url
 and check various constraints for how the callback processes the response. Each
 contract is prefixed with an ``@`` and included in the docstring. See the
-following example::
+following example:
+
+.. code-block:: python
 
     def parse(self, response):
-        """ This function parses a sample response. Some contracts are mingled
+        """
+        This function parses a sample response. Some contracts are mingled
         with this docstring.
 
-        @url http://www.amazon.com/s?field-keywords=selfish+gene
+        @url http://www.example.com/s?field-keywords=selfish+gene
         @returns items 1 16
         @returns requests 0 0
         @scrapes Title Author Year Price
         """
 
-This callback is tested using three built-in contracts:
+You can use the following contracts:
 
 .. module:: scrapy.contracts.default
 
-.. class:: UrlContract
+.. autoclass:: UrlContract
 
-    This contract (``@url``) sets the sample URL used when checking other
-    contract conditions for this spider. This contract is mandatory. All
-    callbacks lacking this contract are ignored when running the checks::
+.. autoclass:: CallbackKeywordArgumentsContract
 
-    @url url
+.. autoclass:: MetadataContract
 
-.. class:: CallbackKeywordArgumentsContract
+.. autoclass:: ReturnsContract
 
-    This contract (``@cb_kwargs``) sets the :attr:`cb_kwargs <scrapy.Request.cb_kwargs>`
-    attribute for the sample request. It must be a valid JSON dictionary.
-    ::
-
-    @cb_kwargs {"arg1": "value1", "arg2": "value2", ...}
-
-.. class:: ReturnsContract
-
-    This contract (``@returns``) sets lower and upper bounds for the items and
-    requests returned by the spider. The upper bound is optional::
-
-    @returns item(s)|request(s) [min [max]]
-
-.. class:: ScrapesContract
-
-    This contract (``@scrapes``) checks that all the items returned by the
-    callback have the specified fields::
-
-    @scrapes field_1 field_2 ...
+.. autoclass:: ScrapesContract
 
 Use the :command:`check` command to run the contract checks.
 
@@ -64,11 +47,13 @@ Custom Contracts
 
 If you find you need more power than the built-in Scrapy contracts you can
 create and load your own contracts in the project by using the
-:setting:`SPIDER_CONTRACTS` setting::
+:setting:`SPIDER_CONTRACTS` setting:
+
+.. code-block:: python
 
     SPIDER_CONTRACTS = {
-        'myproject.contracts.ResponseCheck': 10,
-        'myproject.contracts.ItemValidate': 10,
+        "myproject.contracts.ResponseCheck": 10,
+        "myproject.contracts.ItemValidate": 10,
     }
 
 Each contract must inherit from :class:`~scrapy.contracts.Contract` and can
@@ -76,33 +61,19 @@ override three methods:
 
 .. module:: scrapy.contracts
 
-.. class:: Contract(method, *args)
+.. autoclass:: Contract
 
-    :param method: callback function to which the contract is associated
-    :type method: collections.abc.Callable
+    .. automethod:: adjust_request_args
 
-    :param args: list of arguments passed into the docstring (whitespace
-        separated)
-    :type args: list
-
-    .. method:: Contract.adjust_request_args(args)
-
-        This receives a ``dict`` as an argument containing default arguments
-        for request object. :class:`~scrapy.Request` is used by default,
-        but this can be changed with the ``request_cls`` attribute.
-        If multiple contracts in chain have this attribute defined, the last one is used.
-
-        Must return the same or a modified version of it.
-
-    .. method:: Contract.pre_process(response)
+    .. method:: pre_process(response)
 
         This allows hooking in various checks on the response received from the
         sample request, before it's being passed to the callback.
 
-    .. method:: Contract.post_process(output)
+    .. method:: post_process(output)
 
         This allows processing the output of the callback. Iterators are
-        converted listified before being passed to this hook.
+        converted to lists before being passed to this hook.
 
 Raise :class:`~scrapy.exceptions.ContractFail` from
 :class:`~scrapy.contracts.Contract.pre_process` or
@@ -111,22 +82,27 @@ Raise :class:`~scrapy.exceptions.ContractFail` from
 .. autoclass:: scrapy.exceptions.ContractFail
 
 Here is a demo contract which checks the presence of a custom header in the
-response received::
+response received:
+
+.. skip: next
+.. code-block:: python
 
     from scrapy.contracts import Contract
     from scrapy.exceptions import ContractFail
 
+
     class HasHeaderContract(Contract):
-        """ Demo contract which checks the presence of a custom header
-            @has_header X-CustomHeader
+        """
+        Demo contract which checks the presence of a custom header
+        @has_header X-CustomHeader
         """
 
-        name = 'has_header'
+        name = "has_header"
 
         def pre_process(self, response):
             for header in self.args:
                 if header not in response.headers:
-                    raise ContractFail('X-CustomHeader not present')
+                    raise ContractFail("X-CustomHeader not present")
 
 .. _detecting-contract-check-runs:
 
@@ -135,14 +111,17 @@ Detecting check runs
 
 When ``scrapy check`` is running, the ``SCRAPY_CHECK`` environment variable is
 set to the ``true`` string. You can use :data:`os.environ` to perform any change to
-your spiders or your settings when ``scrapy check`` is used::
+your spiders or your settings when ``scrapy check`` is used:
+
+.. code-block:: python
 
     import os
     import scrapy
 
+
     class ExampleSpider(scrapy.Spider):
-        name = 'example'
+        name = "example"
 
         def __init__(self):
-            if os.environ.get('SCRAPY_CHECK'):
+            if os.environ.get("SCRAPY_CHECK"):
                 pass  # Do some scraper adjustments when a check is running

docs/topics/coroutines.rst

@@ -1,11 +1,12 @@
+.. _topics-coroutines:
+
 ==========
 Coroutines
 ==========
 
-.. versionadded:: 2.0
+Scrapy :ref:`supports <coroutine-support>` the :ref:`coroutine syntax <async>`
+(i.e. ``async def``).
 
-Scrapy has :ref:`partial support <coroutine-support>` for the
-:ref:`coroutine syntax <async>`.
 
 .. _coroutine-support:
 
@@ -15,16 +16,14 @@ Supported callables
 The following callables may be defined as coroutines using ``async def``, and
 hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``):
 
--   :class:`~scrapy.Request` callbacks.
+-   The :meth:`~scrapy.Spider.start` spider method, which *must* be
+    defined as an :term:`asynchronous generator`.
 
-    .. note:: The callback output is not processed until the whole callback
-        finishes.
+    .. versionadded:: 2.13
 
-        As a side effect, if the callback raises an exception, none of its
-        output is processed.
-
-        This is a known caveat of the current implementation that we aim to
-        address in a future version of Scrapy.
+-   :class:`~scrapy.Request` :ref:`callbacks <callbacks>`, which may
+    also be defined as :term:`asynchronous generators <asynchronous
+    generator>`.
 
 -   The :meth:`process_item` method of
     :ref:`item pipelines <topics-item-pipeline>`.
@@ -37,56 +36,163 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``):
     methods of
     :ref:`downloader middlewares <topics-downloader-middleware-custom>`.
 
+-   The
+    :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output`
+    method of :ref:`spider middlewares <topics-spider-middleware>`, which
+    *must* be defined as an :term:`asynchronous generator` except in
+    :ref:`universal spider middlewares <universal-spider-middleware>`.
+
+-   The :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_start` method
+    of :ref:`spider middlewares <custom-spider-middleware>`, which *must* be
+    defined as an :term:`asynchronous generator`.
+
+    .. versionadded:: 2.13
+
 -   :ref:`Signal handlers that support deferreds <signal-deferred>`.
 
-Usage
-=====
+-   Methods of :ref:`download handlers <topics-download-handlers>`.
 
-There are several use cases for coroutines in Scrapy. Code that would
-return Deferreds when written for previous Scrapy versions, such as downloader
-middlewares and signal handlers, can be rewritten to be shorter and cleaner::
+    .. versionadded:: 2.14
+
+
+.. _coroutine-deferred-apis:
+
+Using Deferred-based APIs
+=========================
+
+In addition to native coroutine APIs Scrapy has some APIs that return a
+:class:`~twisted.internet.defer.Deferred` object or take a user-supplied
+function that returns a :class:`~twisted.internet.defer.Deferred` object. These
+APIs are also asynchronous but don't yet support native ``async def`` syntax.
+In the future we plan to add support for the ``async def`` syntax to these APIs
+or replace them with other APIs where changing the existing ones isn't
+possible.
+
+These APIs have a coroutine-based implementation and a Deferred-based one:
+
+-   :class:`scrapy.crawler.Crawler`:
+
+    - :meth:`~scrapy.crawler.Crawler.crawl_async` (coroutine-based) and
+      :meth:`~scrapy.crawler.Crawler.crawl` (Deferred-based): the former
+      may be inconvenient to use in Deferred-based code so both are available,
+      this may change in a future Scrapy version.
+
+-   :class:`scrapy.crawler.AsyncCrawlerRunner` and its subclass
+    :class:`scrapy.crawler.AsyncCrawlerProcess` (coroutine-based) and
+    :class:`scrapy.crawler.CrawlerRunner` and its subclass
+    :class:`scrapy.crawler.CrawlerProcess` (Deferred-based): the former
+    doesn't support non-default reactors and so the latter should be used
+    with those.
+
+The following user-supplied methods can return
+:class:`~twisted.internet.defer.Deferred` objects (the methods that can also
+return coroutines are listed in :ref:`coroutine-support`):
+
+-   Custom downloader implementations (see :setting:`DOWNLOADER`):
+
+    - ``fetch()``
+
+-   Custom scheduler implementations (see :setting:`SCHEDULER`):
+
+    - :meth:`~scrapy.core.scheduler.BaseScheduler.open`
+
+    - :meth:`~scrapy.core.scheduler.BaseScheduler.close`
+
+-   Custom dupefilters (see :setting:`DUPEFILTER_CLASS`):
+
+    - ``open()``
+
+    - ``close()``
+
+-   Custom feed storages (see :setting:`FEED_STORAGES`):
+
+    - ``store()``
+
+-   Subclasses of :class:`scrapy.pipelines.media.MediaPipeline`:
+
+    - ``media_to_download()``
+
+    - ``item_completed()``
+
+-   Custom storages used by subclasses of
+    :class:`scrapy.pipelines.files.FilesPipeline`:
+
+    - ``persist_file()``
+
+    - ``stat_file()``
+
+In most cases you can use these APIs in code that otherwise uses coroutines, by
+wrapping a :class:`~twisted.internet.defer.Deferred` object into a
+:class:`~asyncio.Future` object or vice versa. See :ref:`asyncio-await-dfd` for
+more information about this.
+
+For example: a custom scheduler needs to define an ``open()`` method that can
+return a :class:`~twisted.internet.defer.Deferred` object. You can write a
+method that works with Deferreds and returns one directly, or you can write a
+coroutine and convert it into a function that returns a Deferred with
+:func:`~scrapy.utils.defer.deferred_f_from_coro_f`.
+
+
+General usage
+=============
+
+There are several use cases for coroutines in Scrapy.
+
+Code that would return Deferreds when written for previous Scrapy versions,
+such as downloader middlewares and signal handlers, can be rewritten to be
+shorter and cleaner:
+
+.. code-block:: python
 
     from itemadapter import ItemAdapter
 
+
     class DbPipeline:
         def _update_item(self, data, item):
             adapter = ItemAdapter(item)
-            adapter['field'] = data
+            adapter["field"] = data
             return item
 
-        def process_item(self, item, spider):
+        def process_item(self, item):
             adapter = ItemAdapter(item)
-            dfd = db.get_some_data(adapter['id'])
+            dfd = db.get_some_data(adapter["id"])
             dfd.addCallback(self._update_item, item)
             return dfd
 
-becomes::
+becomes:
+
+.. code-block:: python
 
     from itemadapter import ItemAdapter
 
+
     class DbPipeline:
-        async def process_item(self, item, spider):
+        async def process_item(self, item):
             adapter = ItemAdapter(item)
-            adapter['field'] = await db.get_some_data(adapter['id'])
+            adapter["field"] = await db.get_some_data(adapter["id"])
             return item
 
 Coroutines may be used to call asynchronous code. This includes other
 coroutines, functions that return Deferreds and functions that return
 :term:`awaitable objects <awaitable>` such as :class:`~asyncio.Future`.
-This means you can use many useful Python libraries providing such code::
+This means you can use many useful Python libraries providing such code:
+
+.. skip: next
+.. code-block:: python
 
     class MySpiderDeferred(Spider):
         # ...
         async def parse(self, response):
-            additional_response = await treq.get('https://additional.url')
+            additional_response = await treq.get("https://additional.url")
             additional_data = await treq.content(additional_response)
             # ... use response and additional_data to yield items and requests
 
+
     class MySpiderAsyncio(Spider):
         # ...
         async def parse(self, response):
             async with aiohttp.ClientSession() as session:
-                async with session.get('https://additional.url') as additional_response:
+                async with session.get("https://additional.url") as additional_response:
                     additional_data = await additional_response.text()
             # ... use response and additional_data to yield items and requests
 
@@ -99,12 +205,72 @@ This means you can use many useful Python libraries providing such code::
 
 Common use cases for asynchronous code include:
 
-* requesting data from websites, databases and other services (in callbacks,
-  pipelines and middlewares);
+* requesting data from websites, databases and other services (in
+  :meth:`~scrapy.Spider.start`, callbacks, pipelines and
+  middlewares);
 * storing data in databases (in pipelines and middlewares);
 * delaying the spider initialization until some external event (in the
   :signal:`spider_opened` handler);
-* calling asynchronous Scrapy methods like ``ExecutionEngine.download`` (see
-  :ref:`the screenshot pipeline example<ScreenshotPipeline>`).
+* calling asynchronous Scrapy methods like
+  :meth:`ExecutionEngine.download_async()
+  <scrapy.core.engine.ExecutionEngine.download_async>` (see :ref:`the
+  screenshot pipeline example <ScreenshotPipeline>`).
 
 .. _aio-libs: https://github.com/aio-libs
+
+
+.. _inline-requests:
+
+Inline requests
+===============
+
+The spider below shows how to send a request and await its response all from
+within a spider callback:
+
+.. code-block:: python
+
+    from scrapy import Spider, Request
+
+
+    class SingleRequestSpider(Spider):
+        name = "single"
+        start_urls = ["https://example.org/product"]
+
+        async def parse(self, response, **kwargs):
+            additional_request = Request("https://example.org/price")
+            additional_response = await self.crawler.engine.download_async(
+                additional_request
+            )
+            yield {
+                "h1": response.css("h1").get(),
+                "price": additional_response.css("#price").get(),
+            }
+
+You can also send multiple requests in parallel:
+
+.. code-block:: python
+
+    import asyncio
+
+    from scrapy import Spider, Request
+
+
+    class MultipleRequestsSpider(Spider):
+        name = "multiple"
+        start_urls = ["https://example.com/product"]
+
+        async def parse(self, response, **kwargs):
+            additional_requests = [
+                Request("https://example.com/price"),
+                Request("https://example.com/color"),
+            ]
+            tasks = []
+            for r in additional_requests:
+                task = self.crawler.engine.download_async(r)
+                tasks.append(task)
+            responses = await asyncio.gather(*tasks)
+            yield {
+                "h1": response.css("h1::text").get(),
+                "price": responses[0].css(".price::text").get(),
+                "color": responses[1].css(".color::text").get(),
+            }

docs/topics/debug.rst

@@ -5,21 +5,25 @@ Debugging Spiders
 =================
 
 This document explains the most common techniques for debugging spiders.
-Consider the following Scrapy spider below::
+Consider the following Scrapy spider below:
+
+.. skip: next
+.. code-block:: python
 
     import scrapy
     from myproject.items import MyItem
 
+
     class MySpider(scrapy.Spider):
-        name = 'myspider'
+        name = "myspider"
         start_urls = (
-            'http://example.com/page1',
-            'http://example.com/page2',
-            )
+            "http://example.com/page1",
+            "http://example.com/page2",
+        )
 
         def parse(self, response):
             # <processing code not shown>
-            # collect `item_urls` 
+            # collect `item_urls`
             for item_url in item_urls:
                 yield scrapy.Request(item_url, self.parse_item)
 
@@ -28,7 +32,9 @@ Consider the following Scrapy spider below::
             item = MyItem()
             # populate `item` fields
             # and extract item_details_url
-            yield scrapy.Request(item_details_url, self.parse_details, cb_kwargs={'item': item})
+            yield scrapy.Request(
+                item_details_url, self.parse_details, cb_kwargs={"item": item}
+            )
 
         def parse_details(self, response, item):
             # populate more `item` fields
@@ -103,10 +109,13 @@ showing the response received and the output. How to debug the situation when
 .. highlight:: python
 
 Fortunately, the :command:`shell` is your bread and butter in this case (see
-:ref:`topics-shell-inspect-response`)::
+:ref:`topics-shell-inspect-response`):
+
+.. code-block:: python
 
     from scrapy.shell import inspect_response
 
+
     def parse_details(self, response, item=None):
         if item:
             # populate more `item` fields
@@ -116,37 +125,60 @@ Fortunately, the :command:`shell` is your bread and butter in this case (see
 
 See also: :ref:`topics-shell-inspect-response`.
 
+
 Open in browser
 ===============
 
 Sometimes you just want to see how a certain response looks in a browser, you
-can use the ``open_in_browser`` function for that. Here is an example of how
-you would use it::
+can use the :func:`~scrapy.utils.response.open_in_browser` function for that:
 
-    from scrapy.utils.response import open_in_browser
+.. autofunction:: scrapy.utils.response.open_in_browser
 
-    def parse_details(self, response):
-        if "item name" not in response.body:
-            open_in_browser(response)
-
-``open_in_browser`` will open a browser with the response received by Scrapy at
-that point, adjusting the `base tag`_ so that images and styles are displayed
-properly.
 
 Logging
 =======
 
 Logging is another useful option for getting information about your spider run.
 Although not as convenient, it comes with the advantage that the logs will be
-available in all future runs should they be necessary again::
+available in all future runs should they be necessary again:
+
+.. code-block:: python
 
     def parse_details(self, response, item=None):
         if item:
             # populate more `item` fields
             return item
         else:
-            self.logger.warning('No item received for %s', response.url)
+            self.logger.warning("No item received for %s", response.url)
 
 For more information, check the :ref:`topics-logging` section.
 
-.. _base tag: https://www.w3schools.com/tags/tag_base.asp
+.. _debug-vscode:
+
+Visual Studio Code
+==================
+
+.. highlight:: json
+
+To debug spiders with Visual Studio Code you can use the following ``launch.json``::
+
+    {
+        "version": "0.1.0",
+        "configurations": [
+            {
+                "name": "Python: Launch Scrapy Spider",
+                "type": "python",
+                "request": "launch",
+                "module": "scrapy",
+                "args": [
+                    "runspider",
+                    "${file}"
+                ],
+                "console": "integratedTerminal"
+            }
+        ]
+    }
+
+
+Also, make sure you enable "User Uncaught Exceptions", to catch exceptions in
+your Scrapy spider.

docs/topics/deploy.rst

@@ -54,6 +54,6 @@ just like ``scrapyd-deploy``.
 .. _scrapyd-client: https://github.com/scrapy/scrapyd-client
 .. _scrapyd-deploy documentation: https://scrapyd.readthedocs.io/en/latest/deploy.html
 .. _shub: https://shub.readthedocs.io/en/latest/
-.. _Zyte: https://zyte.com/
+.. _Zyte: https://www.zyte.com/
 .. _Zyte Scrapy Cloud: https://www.zyte.com/scrapy-cloud/
 .. _Zyte Scrapy Cloud documentation: https://docs.zyte.com/scrapy-cloud.html

docs/topics/developer-tools.rst

@@ -19,14 +19,14 @@ Caveats with inspecting the live browser DOM
 
 Since Developer Tools operate on a live browser DOM, what you'll actually see
 when inspecting the page source is not the original HTML, but a modified one
-after applying some browser clean up and executing Javascript code.  Firefox,
+after applying some browser clean up and executing JavaScript code.  Firefox,
 in particular, is known for adding ``<tbody>`` elements to tables.  Scrapy, on
 the other hand, does not modify the original page HTML, so you won't be able to
 extract any data if you use ``<tbody>`` in your XPath expressions.
 
 Therefore, you should keep in mind the following things:
 
-* Disable Javascript while inspecting the DOM looking for XPaths to be
+* Disable JavaScript while inspecting the DOM looking for XPaths to be
   used in Scrapy (in the Developer Tools settings click `Disable JavaScript`)
 
 * Never use full XPath paths, use relative and clever ones based on attributes
@@ -81,21 +81,23 @@ clicking directly on the tag. If we expand the ``span`` tag with the ``class=
 "text"`` we will see the quote-text we clicked on. The `Inspector` lets you
 copy XPaths to selected elements. Let's try it out.
 
-First open the Scrapy shell at http://quotes.toscrape.com/ in a terminal:
+First open the Scrapy shell at https://quotes.toscrape.com/ in a terminal:
 
 .. code-block:: none
 
-    $ scrapy shell "http://quotes.toscrape.com/"
+    $ scrapy shell "https://quotes.toscrape.com/"
 
 Then, back to your web browser, right-click on the ``span`` tag, select
 ``Copy > XPath`` and paste it in the Scrapy shell like so:
 
 .. invisible-code-block: python
 
-    response = load_response('http://quotes.toscrape.com/', 'quotes.html')
+    response = load_response('https://quotes.toscrape.com/', 'quotes.html')
 
->>> response.xpath('/html/body/div/div[2]/div[1]/div[1]/span[1]/text()').getall()
-['“The world as we have created it is a process of our thinking. It cannot be changed without changing our thinking.”']
+.. code-block:: pycon
+
+  >>> response.xpath("/html/body/div/div[2]/div[1]/div[1]/span[1]/text()").getall()
+  ['“The world as we have created it is a process of our thinking. It cannot be changed without changing our thinking.”']
 
 Adding ``text()`` at the end we are able to extract the first quote with this
 basic selector. But this XPath is not really that clever. All it does is
@@ -124,11 +126,13 @@ With this knowledge we can refine our XPath: Instead of a path to follow,
 we'll simply select all ``span`` tags with the ``class="text"`` by using
 the `has-class-extension`_:
 
->>> response.xpath('//span[has-class("text")]/text()').getall()
-['“The world as we have created it is a process of our thinking. It cannot be changed without changing our thinking.”',
-'“It is our choices, Harry, that show what we truly are, far more than our abilities.”',
-'“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.”',
-...]
+.. code-block:: pycon
+
+    >>> response.xpath('//span[has-class("text")]/text()').getall()
+    ['“The world as we have created it is a process of our thinking. It cannot be changed without changing our thinking.”',
+    '“It is our choices, Harry, that show what we truly are, far more than our abilities.”',
+    '“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.”',
+    ...]
 
 And with one simple, cleverer XPath we are able to extract all quotes from
 the page. We could have constructed a loop over our first XPath to increase
@@ -227,7 +231,7 @@ interests us is the one request called ``quotes?page=1`` with the
 type ``json``.
 
 If we click on this request, we see that the request URL is
-``http://quotes.toscrape.com/api/quotes?page=1`` and the response
+``https://quotes.toscrape.com/api/quotes?page=1`` and the response
 is a JSON-object that contains our quotes. We can also right-click
 on the request and open ``Open in new tab`` to get a better overview.
 
@@ -237,25 +241,26 @@ on the request and open ``Open in new tab`` to get a better overview.
    :alt: JSON-object returned from the quotes.toscrape API
 
 With this response we can now easily parse the JSON-object and
-also request each page to get every quote on the site::
+also request each page to get every quote on the site:
+
+.. code-block:: python
 
     import scrapy
-    import json
 
 
     class QuoteSpider(scrapy.Spider):
-        name = 'quote'
-        allowed_domains = ['quotes.toscrape.com']
+        name = "quote"
+        allowed_domains = ["quotes.toscrape.com"]
         page = 1
-        start_urls = ['http://quotes.toscrape.com/api/quotes?page=1']
+        start_urls = ["https://quotes.toscrape.com/api/quotes?page=1"]
 
         def parse(self, response):
-            data = json.loads(response.text)
+            data = response.json()
             for quote in data["quotes"]:
                 yield {"quote": quote["text"]}
             if data["has_next"]:
                 self.page += 1
-                url = f"http://quotes.toscrape.com/api/quotes?page={self.page}"
+                url = f"https://quotes.toscrape.com/api/quotes?page={self.page}"
                 yield scrapy.Request(url=url, callback=self.parse)
 
 This spider starts at the first page of the quotes-API. With each
@@ -272,21 +277,24 @@ into our ``url``.
 
 In more complex websites, it could be difficult to easily reproduce the
 requests, as we could need to add ``headers`` or ``cookies`` to make it work.
-In those cases you can export the requests in `cURL <https://curl.haxx.se/>`_
+In those cases you can export the requests in `cURL <https://curl.se/>`_
 format, by right-clicking on each of them in the network tool and using the
-:meth:`~scrapy.Request.from_curl()` method to generate an equivalent
-request::
+:meth:`~scrapy.Request.from_curl` method to generate an equivalent
+request:
+
+.. code-block:: python
 
     from scrapy import Request
 
     request = Request.from_curl(
-        "curl 'http://quotes.toscrape.com/api/quotes?page=1' -H 'User-Agent: Mozil"
+        "curl 'https://quotes.toscrape.com/api/quotes?page=1' -H 'User-Agent: Mozil"
         "la/5.0 (X11; Linux x86_64; rv:67.0) Gecko/20100101 Firefox/67.0' -H 'Acce"
         "pt: */*' -H 'Accept-Language: ca,en-US;q=0.7,en;q=0.3' --compressed -H 'X"
         "-Requested-With: XMLHttpRequest' -H 'Proxy-Authorization: Basic QFRLLTAzM"
         "zEwZTAxLTk5MWUtNDFiNC1iZWRmLTJjNGI4M2ZiNDBmNDpAVEstMDMzMTBlMDEtOTkxZS00MW"
         "I0LWJlZGYtMmM0YjgzZmI0MGY0' -H 'Connection: keep-alive' -H 'Referer: http"
-        "://quotes.toscrape.com/scroll' -H 'Cache-Control: max-age=0'")
+        "://quotes.toscrape.com/scroll' -H 'Cache-Control: max-age=0'"
+    )
 
 Alternatively, if you want to know the arguments needed to recreate that
 request you can use the :func:`~scrapy.utils.curl.curl_to_request_kwargs`
@@ -304,8 +312,7 @@ daunting and pages can be very complex, but it (mostly) boils down
 to identifying the correct request and replicating it in your spider.
 
 .. _Developer Tools: https://en.wikipedia.org/wiki/Web_development_tools
-.. _quotes.toscrape.com: http://quotes.toscrape.com
-.. _quotes.toscrape.com/scroll: http://quotes.toscrape.com/scroll
-.. _quotes.toscrape.com/api/quotes?page=10: http://quotes.toscrape.com/api/quotes?page=10
+.. _quotes.toscrape.com: https://quotes.toscrape.com
+.. _quotes.toscrape.com/scroll: https://quotes.toscrape.com/scroll
+.. _quotes.toscrape.com/api/quotes?page=10: https://quotes.toscrape.com/api/quotes?page=10
 .. _has-class-extension: https://parsel.readthedocs.io/en/latest/usage.html#other-xpath-extensions
-

docs/topics/download-handlers.rst

@@ -0,0 +1,385 @@
+.. _topics-download-handlers:
+
+=================
+Download handlers
+=================
+
+Download handlers are Scrapy :ref:`components <topics-components>` used to
+download :ref:`requests <topics-request-response>` and produce responses from
+them.
+
+Using download handlers
+=======================
+
+The :setting:`DOWNLOAD_HANDLERS_BASE` and :setting:`DOWNLOAD_HANDLERS` settings
+tell Scrapy which handler is responsible for a given URL scheme. Their values
+are merged into a mapping from scheme names to handler classes. When Scrapy
+initializes it creates instances of all configured download handlers (except
+for :ref:`lazy ones <lazy-download-handlers>`) and stores them in a similar
+mapping. When Scrapy needs to download a request it extracts the scheme from
+its URL, finds the handler for this scheme, passes the request to it and gets a
+response from it.  If there is no handler for the scheme, the request is not
+downloaded and a :exc:`~scrapy.exceptions.NotSupported` exception is raised.
+
+The :setting:`DOWNLOAD_HANDLERS_BASE` setting contains the default mapping of
+handlers. You can use the :setting:`DOWNLOAD_HANDLERS` setting to add handlers
+for additional schemes and to replace or disable default ones:
+
+.. code-block:: python
+
+    DOWNLOAD_HANDLERS = {
+        # disable support for ftp:// requests
+        "ftp": None,
+        # replace the default one for http://
+        "http": "my.download_handlers.HttpHandler",
+        # http:// and https:// are different schemes,
+        # even though they may use the same handler
+        "https": "my.download_handlers.HttpHandler",
+        # support for any custom scheme can be added
+        "sftp": "my.download_handlers.SftpHandler",
+    }
+
+.. seealso:: :ref:`security-unencrypted-protocols` and
+    :ref:`security-local-resources`, for the security implications of the
+    default ``http``, ``ftp``, ``file`` and ``data`` handlers.
+
+Replacing HTTP(S) download handlers
+-----------------------------------
+
+While Scrapy provides a default handler for ``http`` and ``https`` schemes,
+users may want to use a different handler, provided by Scrapy or by some
+3rd-party package. There are several considerations to keep in mind related to
+this.
+
+First of all, as ``http`` and ``https`` are separate schemes, they need
+separate entries in the :setting:`DOWNLOAD_HANDLERS` setting, even though it's
+likely that the same handler class will be used for both schemes.
+
+Additionally, some of the Scrapy settings, like :setting:`DOWNLOAD_MAXSIZE`,
+are honored by the default HTTP(S) handler but not necessarily by alternative
+ones. The same may apply to other Scrapy features, e.g. the
+:signal:`bytes_received` and :signal:`headers_received` signals.
+
+.. _lazy-download-handlers:
+
+Lazy instantiation of download handlers
+---------------------------------------
+
+A download handler can be marked as "lazy" by setting its ``lazy`` class
+attribute to ``True``. Such handlers are only instantiated when they need to
+download their first request. This may be useful when the instantiation is slow
+or requires dependencies that are not always available, and the handler is not
+needed on every spider run. For example, :class:`the built-in S3 handler
+<.S3DownloadHandler>` is lazy.
+
+Writing your own download handler
+=================================
+
+A download handler is a :ref:`component <topics-components>` that defines
+the following API:
+
+.. autoclass:: scrapy.core.downloader.handlers.DownloadHandlerProtocol
+    :members:
+
+An optional base class for custom handlers is provided:
+
+.. autoclass:: scrapy.core.downloader.handlers.base.BaseDownloadHandler
+    :members:
+    :undoc-members:
+    :exclude-members: close, download_request, lazy
+
+.. _download-handlers-exceptions:
+
+Exceptions raised by download handlers
+======================================
+
+.. versionadded:: 2.15.0
+
+The built-in download handlers raise Scrapy-specific exceptions instead of
+implementation-specific ones, so that code that handles these exceptions can be
+written in a generic way. We recommend custom download handlers to also use
+these exceptions.
+
+.. autoexception:: scrapy.exceptions.CannotResolveHostError
+
+.. autoexception:: scrapy.exceptions.DownloadCancelledError
+
+.. autoexception:: scrapy.exceptions.DownloadConnectionRefusedError
+
+.. autoexception:: scrapy.exceptions.DownloadFailedError
+
+.. autoexception:: scrapy.exceptions.DownloadTimeoutError
+
+.. autoexception:: scrapy.exceptions.ResponseDataLossError
+
+.. autoexception:: scrapy.exceptions.UnsupportedURLSchemeError
+
+.. _download-handlers-ref:
+
+Built-in HTTP download handlers reference
+=========================================
+
+Scrapy ships several handlers for HTTP and HTTPS requests. While all of them
+support basic features, they may differ in support of specific Scrapy features
+and settings and HTTP protocol features. See the documentation of specific
+handlers and specific settings for more information. Additionally, as the
+underlying HTTP client implementations differ between handlers, the behavior of
+specific websites may be different when doing the same Scrapy requests but
+using different handlers.
+
+Here is a comparison of some features of the built-in HTTP handlers, see the
+individual handler docs for more differences:
+
+================== ================= ===================== ====================
+Feature            H2DownloadHandler HTTP11DownloadHandler HttpxDownloadHandler
+================== ================= ===================== ====================
+Requires asyncio   No                No                    Yes
+Requires a reactor Yes               Yes                   No
+HTTP/1.1           No                Yes                   Yes
+HTTP/2             Yes               No                    Yes
+TLS implementation ``cryptography``  ``cryptography``      Stdlib ``ssl``
+HTTP proxies       No                Yes                   Yes
+SOCKS proxies      No                No                    Yes
+================== ================= ===================== ====================
+
+You can find additional HTTP download handlers in the
+scrapy-download-handlers-incubator_ package. This package is made by the Scrapy
+developers and contains experimental handlers that may be included in some
+later Scrapy version but can already be used. Please refer to the documentation
+of this package for more information.
+
+.. _scrapy-download-handlers-incubator: https://github.com/scrapy-plugins/scrapy-download-handlers-incubator
+
+.. _twisted-http2-handler:
+
+H2DownloadHandler
+-----------------
+
+.. note:: Requires the :ref:`twisted-http2 <extras>` extra.
+
+.. autoclass:: scrapy.core.downloader.handlers.http2.H2DownloadHandler
+
+| Supported scheme: ``https``.
+| :ref:`Lazy <lazy-download-handlers>`: yes.
+| :ref:`Requires asyncio support <using-asyncio>`: no.
+| :ref:`Requires a Twisted reactor <asyncio-without-reactor>`: yes.
+
+This handler supports ``https://host/path`` URLs and uses the HTTP/2 protocol
+for them.
+
+It's implemented using :mod:`twisted.web.client` and the ``h2`` library.
+
+If you want to use this handler you need to replace the default one for the
+``https`` scheme:
+
+.. code-block:: python
+
+    DOWNLOAD_HANDLERS = {
+        "https": "scrapy.core.downloader.handlers.http2.H2DownloadHandler",
+    }
+
+Features and limitations
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. warning::
+
+    This handler is experimental, and not yet recommended for production
+    environments. Future Scrapy versions may introduce related changes without
+    a deprecation period or warning.
+
+=========================== ================================================
+HTTP proxies                No (not implemented)
+SOCKS proxies               No (not supported by the library)
+HTTP/2                      Yes
+``response.certificate``    :class:`twisted.internet.ssl.Certificate` object
+Per-request ``bindaddress`` Yes
+TLS implementation          ``pyOpenSSL``/``cryptography``
+=========================== ================================================
+
+Other limitations:
+
+-   No support for HTTP/1.1.
+
+-   IPv6 support requires setting :setting:`TWISTED_DNS_RESOLVER`
+    to ``scrapy.resolver.CachingHostnameResolver``.
+
+-   No support for the :signal:`bytes_received` and :signal:`headers_received`
+    signals.
+
+Known limitations of the HTTP/2 support:
+
+-   No support for HTTP/2 Cleartext (h2c), since no major browser supports
+    HTTP/2 unencrypted (refer `http2 faq`_).
+
+-   No setting to specify a maximum `frame size`_ larger than the default
+    value, 16384. Connections to servers that send a larger frame will fail.
+
+-   No support for `server pushes`_, which are ignored.
+
+.. _frame size: https://datatracker.ietf.org/doc/html/rfc7540#section-4.2
+.. _http2 faq: https://http2.github.io/faq/#does-http2-require-encryption
+.. _server pushes: https://datatracker.ietf.org/doc/html/rfc7540#section-8.2
+
+HTTP11DownloadHandler
+---------------------
+
+.. autoclass:: scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler
+
+| Supported schemes: ``http``, ``https``.
+| :ref:`Lazy <lazy-download-handlers>`: no.
+| :ref:`Requires asyncio support <using-asyncio>`: no.
+| :ref:`Requires a Twisted reactor <asyncio-without-reactor>`: yes.
+
+This handler supports ``http://host/path`` and ``https://host/path`` URLs and
+uses the HTTP/1.1 protocol for them.
+
+It's implemented using :mod:`twisted.web.client`.
+
+Features and limitations
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+=========================== ================================================
+HTTP proxies                Yes
+SOCKS proxies               No (not supported by the library)
+HTTP/2                      No (implemented as a separate handler)
+``response.certificate``    :class:`twisted.internet.ssl.Certificate` object
+Per-request ``bindaddress`` Yes
+TLS implementation          ``pyOpenSSL``/``cryptography``
+=========================== ================================================
+
+Other limitations:
+
+-   IPv6 support requires setting :setting:`TWISTED_DNS_RESOLVER`
+    to ``scrapy.resolver.CachingHostnameResolver``.
+
+-   HTTPS proxies to HTTPS destinations are not supported.
+
+.. _httpx-handler:
+
+HttpxDownloadHandler
+--------------------
+
+.. note:: Requires the :ref:`httpx <extras>` extra.
+
+.. versionadded:: 2.15.0
+
+.. autoclass:: scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler
+
+| Supported schemes: ``http``, ``https``.
+| :ref:`Lazy <lazy-download-handlers>`: no.
+| :ref:`Requires asyncio support <using-asyncio>`: yes.
+| :ref:`Requires a Twisted reactor <asyncio-without-reactor>`: no.
+
+This handler supports ``http://host/path`` and ``https://host/path`` URLs and
+uses the HTTP/1.1 or HTTP/2 protocol for them.
+
+It's implemented using the httpx2_ library.
+
+.. _httpx2: https://httpx2.pydantic.dev/
+
+If you want to use this handler you need to replace the default ones for the
+``http`` and ``https`` schemes:
+
+.. code-block:: python
+
+    DOWNLOAD_HANDLERS = {
+        "http": "scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler",
+        "https": "scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler",
+    }
+
+Features and limitations
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. warning::
+
+    This handler is experimental, and not yet recommended for production
+    environments. Future Scrapy versions may introduce related changes without
+    a deprecation period or warning or even remove it altogether.
+
+=========================== =======================================
+HTTP proxies                Yes
+SOCKS proxies               Yes (SOCKS5)
+HTTP/2                      Yes
+``response.certificate``    DER bytes
+Per-request ``bindaddress`` No (not supported by the library)
+TLS implementation          Standard library ``ssl``
+=========================== =======================================
+
+Other limitations:
+
+-   The handler creates a separate connection pool for each proxy URL (due to
+    limitations of ``httpx``) which may lead to higher resource usage when
+    using proxy rotation.
+
+.. setting:: HTTPX_HTTP2_ENABLED
+
+HTTPX_HTTP2_ENABLED
+^^^^^^^^^^^^^^^^^^^
+
+.. versionadded:: 2.17.0
+
+Default: ``False``
+
+Whether to enable HTTP/2 support in this handler.
+
+Built-in non-HTTP download handlers reference
+=============================================
+
+DataURIDownloadHandler
+----------------------
+
+.. autoclass:: scrapy.core.downloader.handlers.datauri.DataURIDownloadHandler
+
+| Supported scheme: ``data``.
+| :ref:`Lazy <lazy-download-handlers>`: no.
+| :ref:`Requires asyncio support <using-asyncio>`: no.
+| :ref:`Requires a Twisted reactor <asyncio-without-reactor>`: no.
+
+This handler supports RFC 2397 ``data:content/type;base64,`` data URIs.
+
+FileDownloadHandler
+-------------------
+
+.. autoclass:: scrapy.core.downloader.handlers.file.FileDownloadHandler
+
+| Supported scheme: ``file``.
+| :ref:`Lazy <lazy-download-handlers>`: no.
+| :ref:`Requires asyncio support <using-asyncio>`: no.
+| :ref:`Requires a Twisted reactor <asyncio-without-reactor>`: no.
+
+This handler supports ``file:///path`` local file URIs. It doesn't
+support remote files.
+
+FTPDownloadHandler
+------------------
+
+.. autoclass:: scrapy.core.downloader.handlers.ftp.FTPDownloadHandler
+
+| Supported scheme: ``ftp``.
+| :ref:`Lazy <lazy-download-handlers>`: no.
+| :ref:`Requires asyncio support <using-asyncio>`: no.
+| :ref:`Requires a Twisted reactor <asyncio-without-reactor>`: yes.
+
+This handler supports ``ftp://host/path`` FTP URIs.
+
+It's implemented using :mod:`twisted.protocols.ftp`.
+
+.. _s3-handler:
+
+S3DownloadHandler
+-----------------
+
+.. note:: Requires the :ref:`s3 <extras>` extra.
+
+.. autoclass:: scrapy.core.downloader.handlers.s3.S3DownloadHandler
+
+| Supported scheme: ``s3``.
+| :ref:`Lazy <lazy-download-handlers>`: yes.
+| :ref:`Requires asyncio support <using-asyncio>`: no.
+| :ref:`Requires a Twisted reactor <asyncio-without-reactor>`: no.
+
+This handler supports ``s3://bucket/path`` S3 URIs.
+
+It's implemented using the botocore_ library.
+
+.. _botocore: https://github.com/boto/botocore

docs/topics/downloader-middleware.rst

@@ -17,10 +17,12 @@ To activate a downloader middleware component, add it to the
 :setting:`DOWNLOADER_MIDDLEWARES` setting, which is a dict whose keys are the
 middleware class paths and their values are the middleware orders.
 
-Here's an example::
+Here's an example:
+
+.. code-block:: python
 
     DOWNLOADER_MIDDLEWARES = {
-        'myproject.middlewares.CustomDownloaderMiddleware': 543,
+        "myproject.middlewares.CustomDownloaderMiddleware": 543,
     }
 
 The :setting:`DOWNLOADER_MIDDLEWARES` setting is merged with the
@@ -42,11 +44,13 @@ previous (or subsequent) middleware being applied.
 If you want to disable a built-in middleware (the ones defined in
 :setting:`DOWNLOADER_MIDDLEWARES_BASE` and enabled by default) you must define it
 in your project's :setting:`DOWNLOADER_MIDDLEWARES` setting and assign ``None``
-as its value.  For example, if you want to disable the user-agent middleware::
+as its value.  For example, if you want to disable the user-agent middleware:
+
+.. code-block:: python
 
     DOWNLOADER_MIDDLEWARES = {
-        'myproject.middlewares.CustomDownloaderMiddleware': 543,
-        'scrapy.downloadermiddlewares.useragent.UserAgentMiddleware': None,
+        "myproject.middlewares.CustomDownloaderMiddleware": 543,
+        "scrapy.downloadermiddlewares.useragent.UserAgentMiddleware": None,
     }
 
 Finally, keep in mind that some middlewares may need to be enabled through a
@@ -57,26 +61,23 @@ particular setting. See each middleware documentation for more info.
 Writing your own downloader middleware
 ======================================
 
-Each downloader middleware is a Python class that defines one or more of the
-methods defined below.
-
-The main entry point is the ``from_crawler`` class method, which receives a
-:class:`~scrapy.crawler.Crawler` instance. The :class:`~scrapy.crawler.Crawler`
-object gives you access, for example, to the :ref:`settings <topics-settings>`.
+Each downloader middleware is a :ref:`component <topics-components>` that
+defines one or more of these methods:
 
 .. module:: scrapy.downloadermiddlewares
 
 .. class:: DownloaderMiddleware
 
-   .. note::  Any of the downloader middleware methods may also return a deferred.
+   .. note::  Any of the downloader middleware methods may be defined as a
+        coroutine function (``async def``).
 
-   .. method:: process_request(request, spider)
+   .. method:: process_request(request)
 
       This method is called for each request that goes through the download
       middleware.
 
       :meth:`process_request` should either: return ``None``, return a
-      :class:`~scrapy.Response` object, return a :class:`~scrapy.http.Request`
+      :class:`~scrapy.http.Response` object, return a :class:`~scrapy.Request`
       object, or raise :exc:`~scrapy.exceptions.IgnoreRequest`.
 
       If it returns ``None``, Scrapy will continue processing this request, executing all
@@ -89,7 +90,7 @@ object gives you access, for example, to the :ref:`settings <topics-settings>`.
       methods of installed middleware is always called on every response.
 
       If it returns a :class:`~scrapy.Request` object, Scrapy will stop calling
-      process_request methods and reschedule the returned request. Once the newly returned
+      :meth:`process_request` methods and reschedule the returned request. Once the newly returned
       request is performed, the appropriate middleware chain will be called on
       the downloaded response.
 
@@ -102,10 +103,7 @@ object gives you access, for example, to the :ref:`settings <topics-settings>`.
       :param request: the request being processed
       :type request: :class:`~scrapy.Request` object
 
-      :param spider: the spider for which this request is intended
-      :type spider: :class:`~scrapy.Spider` object
-
-   .. method:: process_response(request, response, spider)
+   .. method:: process_response(request, response)
 
       :meth:`process_response` should either: return a :class:`~scrapy.http.Response`
       object, return a :class:`~scrapy.Request` object or
@@ -129,14 +127,12 @@ object gives you access, for example, to the :ref:`settings <topics-settings>`.
       :param response: the response being processed
       :type response: :class:`~scrapy.http.Response` object
 
-      :param spider: the spider for which this response is intended
-      :type spider: :class:`~scrapy.Spider` object
+   .. method:: process_exception(request, exception)
 
-   .. method:: process_exception(request, exception, spider)
-
-      Scrapy calls :meth:`process_exception` when a download handler
-      or a :meth:`process_request` (from a downloader middleware) raises an
-      exception (including an :exc:`~scrapy.exceptions.IgnoreRequest` exception)
+      Scrapy calls :meth:`process_exception` when a :ref:`download handler
+      <topics-download-handlers>` or a :meth:`process_request` (from a
+      downloader middleware) raises an exception (including an
+      :exc:`~scrapy.exceptions.IgnoreRequest` exception).
 
       :meth:`process_exception` should return: either ``None``,
       a :class:`~scrapy.http.Response` object, or a :class:`~scrapy.Request` object.
@@ -160,20 +156,6 @@ object gives you access, for example, to the :ref:`settings <topics-settings>`.
       :param exception: the raised exception
       :type exception: an ``Exception`` object
 
-      :param spider: the spider for which this request is intended
-      :type spider: :class:`~scrapy.Spider` object
-
-   .. method:: from_crawler(cls, crawler)
-
-      If present, this classmethod is called to create a middleware instance
-      from a :class:`~scrapy.crawler.Crawler`. It must return a new instance
-      of the middleware. Crawler object provides access to all Scrapy core
-      components like settings and signals; it is a way for middleware to
-      access them and hook its functionality into Scrapy.
-
-      :param crawler: crawler that uses this middleware
-      :type crawler: :class:`~scrapy.crawler.Crawler` object
-
 .. _topics-downloader-middleware-ref:
 
 Built-in downloader middleware reference
@@ -226,20 +208,26 @@ There is support for keeping multiple cookie sessions per spider by using the
 :reqmeta:`cookiejar` Request meta key. By default it uses a single cookie jar
 (session), but you can pass an identifier to use different ones.
 
-For example::
+For example:
+
+.. skip: next
+.. code-block:: python
 
     for i, url in enumerate(urls):
-        yield scrapy.Request(url, meta={'cookiejar': i},
-            callback=self.parse_page)
+        yield scrapy.Request(url, meta={"cookiejar": i}, callback=self.parse_page)
 
 Keep in mind that the :reqmeta:`cookiejar` meta key is not "sticky". You need to keep
-passing it along on subsequent requests. For example::
+passing it along on subsequent requests. For example:
+
+.. code-block:: python
 
     def parse_page(self, response):
         # do some processing
-        return scrapy.Request("http://www.example.com/otherpage",
-            meta={'cookiejar': response.meta['cookiejar']},
-            callback=self.parse_other_page)
+        return scrapy.Request(
+            "http://www.example.com/otherpage",
+            meta={"cookiejar": response.meta["cookiejar"]},
+            callback=self.parse_other_page,
+        )
 
 .. setting:: COOKIES_ENABLED
 
@@ -303,13 +291,12 @@ DownloadTimeoutMiddleware
 .. class:: DownloadTimeoutMiddleware
 
     This middleware sets the download timeout for requests specified in the
-    :setting:`DOWNLOAD_TIMEOUT` setting or :attr:`download_timeout`
-    spider attribute.
+    :setting:`DOWNLOAD_TIMEOUT` setting.
 
 .. note::
 
-    You can also set download timeout per-request using
-    :reqmeta:`download_timeout` Request.meta key; this is supported
+    You can also set download timeout per-request using the
+    :reqmeta:`download_timeout` :attr:`.Request.meta` key; this is supported
     even when DownloadTimeoutMiddleware is disabled.
 
 HttpAuthMiddleware
@@ -320,38 +307,86 @@ HttpAuthMiddleware
 
 .. class:: HttpAuthMiddleware
 
-    This middleware authenticates all requests generated from certain spiders
-    using `Basic access authentication`_ (aka. HTTP auth).
+    This middleware authenticates requests using `Basic access authentication`_
+    (aka. HTTP auth).
 
-    To enable HTTP authentication for a spider, set the ``http_user`` and
-    ``http_pass`` spider attributes to the authentication data and the
-    ``http_auth_domain`` spider attribute to the domain which requires this
-    authentication (its subdomains will be also handled in the same way).
-    You can set ``http_auth_domain`` to ``None`` to enable the
-    authentication for all requests but you risk leaking your authentication
-    credentials to unrelated domains.
+    Use the :setting:`HTTPAUTH_USER`, :setting:`HTTPAUTH_PASS`, and
+    :setting:`HTTPAUTH_DOMAIN` settings to configure it. You can also override
+    the credentials per request via :attr:`~scrapy.Request.meta` keys
+    :reqmeta:`http_user`, :reqmeta:`http_pass`, and :reqmeta:`http_auth_domain`.
 
-    .. warning::
-        In previous Scrapy versions HttpAuthMiddleware sent the authentication
-        data with all requests, which is a security problem if the spider
-        makes requests to several different domains. Currently if the
-        ``http_auth_domain`` attribute is not set, the middleware will use the
-        domain of the first request, which will work for some spiders but not
-        for others. In the future the middleware will produce an error instead.
+    Example using settings (e.g. in :attr:`~scrapy.Spider.custom_settings`):
 
-    Example::
+    .. code-block:: python
 
         from scrapy.spiders import CrawlSpider
 
-        class SomeIntranetSiteSpider(CrawlSpider):
 
-            http_user = 'someuser'
-            http_pass = 'somepass'
-            http_auth_domain = 'intranet.example.com'
-            name = 'intranet.example.com'
+        class SomeIntranetSiteSpider(CrawlSpider):
+            name = "intranet.example.com"
+            custom_settings = {
+                "HTTPAUTH_USER": "someuser",
+                "HTTPAUTH_PASS": "somepass",
+                "HTTPAUTH_DOMAIN": "intranet.example.com",
+            }
 
             # .. rest of the spider code omitted ...
 
+    Example using per-request meta:
+
+    .. code-block:: python
+
+        async def start(self):
+            yield Request(
+                "https://intranet.example.com/protected/",
+                meta={
+                    "http_user": "someuser",
+                    "http_pass": "somepass",
+                    "http_auth_domain": "intranet.example.com",
+                },
+            )
+
+.. setting:: HTTPAUTH_USER
+
+HTTPAUTH_USER
+~~~~~~~~~~~~~
+
+.. versionadded:: 2.17.0
+
+Default: ``""``
+
+The username to use for HTTP basic authentication, applied to all requests
+whose URL matches :setting:`HTTPAUTH_DOMAIN`.
+
+.. setting:: HTTPAUTH_PASS
+
+HTTPAUTH_PASS
+~~~~~~~~~~~~~
+
+.. versionadded:: 2.17.0
+
+Default: ``""``
+
+The password to use for HTTP basic authentication.
+
+.. setting:: HTTPAUTH_DOMAIN
+
+HTTPAUTH_DOMAIN
+~~~~~~~~~~~~~~~
+
+.. versionadded:: 2.17.0
+
+Default: ``None``
+
+The domain (and its subdomains) to which HTTP basic authentication credentials
+are sent. Set to ``None`` to send credentials with all requests, but be aware
+that this risks leaking credentials to unrelated domains.
+
+This setting must be explicitly configured whenever :setting:`HTTPAUTH_USER`
+or :setting:`HTTPAUTH_PASS` is set.
+
+.. seealso:: :ref:`security-credential-leakage`
+
 .. _Basic access authentication: https://en.wikipedia.org/wiki/Basic_access_authentication
 
 
@@ -366,7 +401,7 @@ HttpCacheMiddleware
     This middleware provides low-level cache to all HTTP requests and responses.
     It has to be combined with a cache storage backend as well as a cache policy.
 
-    Scrapy ships with three HTTP cache storage backends:
+    Scrapy ships with the following HTTP cache storage backends:
 
         * :ref:`httpcache-storage-fs`
         * :ref:`httpcache-storage-dbm`
@@ -470,7 +505,7 @@ Filesystem storage backend (default)
 
     *   ``response_body`` - the plain response body
 
-    *   ``response_headers`` - the request headers (in raw HTTP format)
+    *   ``response_headers`` - the response headers (in raw HTTP format)
 
     *   ``meta`` - some metadata of this cache resource in Python ``repr()``
         format (grep-friendly format)
@@ -512,7 +547,7 @@ defines the methods described below.
     .. method:: open_spider(spider)
 
       This method gets called after a spider has been opened for crawling. It handles
-      the :signal:`open_spider <spider_opened>` signal.
+      the :signal:`spider_opened` signal.
 
       :param spider: the spider which has been opened
       :type spider: :class:`~scrapy.Spider` object
@@ -520,7 +555,7 @@ defines the methods described below.
     .. method:: close_spider(spider)
 
       This method gets called after a spider has been closed. It handles
-      the :signal:`close_spider <spider_closed>` signal.
+      the :signal:`spider_closed` signal.
 
       :param spider: the spider which has been closed
       :type spider: :class:`~scrapy.Spider` object
@@ -529,6 +564,10 @@ defines the methods described below.
 
       Return response if present in cache, or ``None`` otherwise.
 
+      If this method raises an exception, e.g. because the cache entry is
+      corrupted, the middleware logs a warning and handles the request as a
+      cache miss.
+
       :param spider: the spider which generated the request
       :type spider: :class:`~scrapy.Spider` object
 
@@ -556,8 +595,8 @@ In order to use your storage backend, set:
 HTTPCache middleware settings
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The :class:`HttpCacheMiddleware` can be configured through the following
-settings:
+:class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware` can be
+configured through the following settings:
 
 .. setting:: HTTPCACHE_ENABLED
 
@@ -692,6 +731,8 @@ We assume that the spider will not issue Cache-Control directives
 in requests unless it actually needs them, so directives in requests are
 not filtered.
 
+.. _http-compression:
+
 HttpCompressionMiddleware
 -------------------------
 
@@ -703,14 +744,13 @@ HttpCompressionMiddleware
    This middleware allows compressed (gzip, deflate) traffic to be
    sent/received from web sites.
 
-   This middleware also supports decoding `brotli-compressed`_ as well as
-   `zstd-compressed`_ responses, provided that `brotlipy`_ or `zstandard`_ is
-   installed, respectively.
+   This middleware also supports decoding `brotli-compressed`_ responses with
+   the :ref:`brotli <extras>` extra, and `zstd-compressed`_
+   responses with the :ref:`zstd <extras>` extra.
 
 .. _brotli-compressed: https://www.ietf.org/rfc/rfc7932.txt
-.. _brotlipy: https://pypi.org/project/brotlipy/
 .. _zstd-compressed: https://www.ietf.org/rfc/rfc8478.txt
-.. _zstandard: https://pypi.org/project/zstandard/
+
 
 HttpCompressionMiddleware Settings
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -736,7 +776,7 @@ HttpProxyMiddleware
 .. class:: HttpProxyMiddleware
 
    This middleware sets the HTTP proxy to use for requests, by setting the
-   ``proxy`` meta value for :class:`~scrapy.Request` objects.
+   :reqmeta:`proxy` meta value for :class:`~scrapy.Request` objects.
 
    Like the Python standard library module :mod:`urllib.request`, it obeys
    the following environment variables:
@@ -745,11 +785,97 @@ HttpProxyMiddleware
    * ``https_proxy``
    * ``no_proxy``
 
-   You can also set the meta key ``proxy`` per-request, to a value like
+   You can also set the meta key :reqmeta:`proxy` per-request, to a value like
    ``http://some_proxy_server:port`` or ``http://username:password@some_proxy_server:port``.
    Keep in mind this value will take precedence over ``http_proxy``/``https_proxy``
    environment variables, and it will also ignore ``no_proxy`` environment variable.
 
+.. note::
+
+    Handling of this meta key needs to be implemented inside the :ref:`download
+    handler <topics-download-handlers>`, so it's not guaranteed to be supported
+    by all 3rd-party handlers. It's currently unsupported by
+    :class:`~scrapy.core.downloader.handlers.http2.H2DownloadHandler`.
+
+.. note::
+
+    Usually a proxy URL uses the ``http://`` scheme. More rarely, it uses the
+    ``https://`` one. While both kinds of proxy URLs can be used with both HTTP
+    and HTTPS destination URLs, the specifics of the network exchange are
+    different for all 4 cases and it's possible that HTTPS proxies are fully or
+    partially unsupported by a given download handler. Currently,
+    :class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler`
+    supports HTTPS proxies only for HTTP destinations.
+
+.. note::
+
+    If the download handler supports it, you can use a SOCKS proxy URL (e.g.
+    ``socks5://username:password@some_proxy_server:port``).
+    :class:`~scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler`
+    supports SOCKS proxies while other built-in handlers don't.
+
+HttpProxyMiddleware settings
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. setting:: HTTPPROXY_ENABLED
+
+HTTPPROXY_ENABLED
+^^^^^^^^^^^^^^^^^
+
+Default: ``True``
+
+Whether or not to enable the :class:`HttpProxyMiddleware`.
+
+.. setting:: HTTPPROXY_AUTH_ENCODING
+
+HTTPPROXY_AUTH_ENCODING
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Default: ``"latin-1"``
+
+The default encoding for proxy authentication on :class:`HttpProxyMiddleware`.
+
+OffsiteMiddleware
+-----------------
+
+.. module:: scrapy.downloadermiddlewares.offsite
+   :synopsis: Offsite Middleware
+
+.. class:: OffsiteMiddleware
+
+   .. versionadded:: 2.11.2
+
+   Filters out Requests for URLs outside the domains covered by the spider.
+
+   This middleware filters out every request whose host names aren't in the
+   spider's :attr:`~scrapy.Spider.allowed_domains` attribute.
+   All subdomains of any domain in the list are also allowed.
+   E.g. the rule ``www.example.org`` will also allow ``bob.www.example.org``
+   but not ``www2.example.com`` nor ``example.com``.
+
+   When your spider returns a request for a domain not belonging to those
+   covered by the spider, this middleware will log a debug message similar to
+   this one::
+
+      DEBUG: Filtered offsite request to 'offsite.example': <GET http://offsite.example/some/page.html>
+
+   To avoid filling the log with too much noise, it will only print one of
+   these messages for each new domain filtered. So, for example, if another
+   request for ``offsite.example`` is filtered, no log message will be
+   printed. But if a request for ``other.example`` is filtered, a message
+   will be printed (but only for the first request filtered).
+
+   If the spider doesn't define an
+   :attr:`~scrapy.Spider.allowed_domains` attribute, or the
+   attribute is empty, the offsite middleware will allow all requests.
+
+   .. reqmeta:: allow_offsite
+
+   If the request has the :attr:`~scrapy.Request.dont_filter` attribute set to
+   ``True`` or :attr:`Request.meta <scrapy.Request.meta>` has ``allow_offsite``
+   set to ``True``, then the OffsiteMiddleware will allow the request even if
+   its domain is not listed in allowed domains.
+
 RedirectMiddleware
 ------------------
 
@@ -791,7 +917,9 @@ If you want to handle some redirect status codes in your spider, you can
 specify these in the ``handle_httpstatus_list`` spider attribute.
 
 For example, if you want the redirect middleware to ignore 301 and 302
-responses (and pass them through to your spider) you can do this::
+responses (and pass them through to your spider) you can do this:
+
+.. code-block:: python
 
     class MySpider(CrawlSpider):
         handle_httpstatus_list = [301, 302]
@@ -823,7 +951,7 @@ REDIRECT_MAX_TIMES
 Default: ``20``
 
 The maximum number of redirections that will be followed for a single request.
-After this maximum, the request's response is returned as is.
+If maximum redirections are exceeded, the request is aborted and ignored.
 
 MetaRefreshMiddleware
 ---------------------
@@ -861,13 +989,13 @@ Whether the Meta Refresh middleware will be enabled.
 METAREFRESH_IGNORE_TAGS
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-Default: ``[]``
+Default: ``["noscript"]``
 
 Meta tags within these tags are ignored.
 
-.. versionchanged:: 2.0
+.. versionchanged:: 2.11.2
    The default value of :setting:`METAREFRESH_IGNORE_TAGS` changed from
-   ``['script', 'noscript']`` to ``[]``.
+   ``[]`` to ``["noscript"]``.
 
 .. setting:: METAREFRESH_MAXDELAY
 
@@ -891,16 +1019,6 @@ RetryMiddleware
    A middleware to retry failed requests that are potentially caused by
    temporary problems such as a connection timeout or HTTP 500 error.
 
-Failed pages are collected on the scraping process and rescheduled at the
-end, once the spider has finished crawling all regular (non failed) pages.
-
-The :class:`RetryMiddleware` can be configured through the following
-settings (see the settings documentation for more info):
-
-* :setting:`RETRY_ENABLED`
-* :setting:`RETRY_TIMES`
-* :setting:`RETRY_HTTP_CODES`
-
 .. reqmeta:: dont_retry
 
 If :attr:`Request.meta <scrapy.Request.meta>` has ``dont_retry`` key
@@ -951,10 +1069,57 @@ In some cases you may want to add 400 to :setting:`RETRY_HTTP_CODES` because
 it is a common code used to indicate server overload. It is not included by
 default because HTTP specs say so.
 
+.. setting:: RETRY_EXCEPTIONS
+
+RETRY_EXCEPTIONS
+^^^^^^^^^^^^^^^^
+
+Default::
+
+    [
+        'scrapy.exceptions.CannotResolveHostError',
+        'scrapy.exceptions.DownloadConnectionRefusedError',
+        'scrapy.exceptions.DownloadFailedError',
+        'scrapy.exceptions.DownloadTimeoutError',
+        'scrapy.exceptions.ResponseDataLossError',
+        'twisted.internet.error.ConnectionDone',
+        'twisted.internet.error.ConnectError',
+        'twisted.internet.error.ConnectionLost',
+        OSError,
+        'scrapy.core.downloader.handlers.http11.TunnelError',
+    ]
+
+List of exceptions to retry.
+
+Each list entry may be an exception type or its import path as a string.
+
+An exception will not be caught when the exception type is not in
+:setting:`RETRY_EXCEPTIONS` or when the maximum number of retries for a request
+has been exceeded (see :setting:`RETRY_TIMES`). To learn about uncaught
+exception propagation, see
+:meth:`~scrapy.downloadermiddlewares.DownloaderMiddleware.process_exception`.
+
+.. setting:: RETRY_GIVE_UP_LOG_LEVEL
+
+RETRY_GIVE_UP_LOG_LEVEL
+^^^^^^^^^^^^^^^^^^^^^^^
+
+.. versionadded:: 2.17.0
+
+Default: ``"ERROR"``
+
+:ref:`Logging level <levels>` used for the message logged when a request
+exceeds its retries.
+
+Can be a level name (e.g. ``"WARNING"``) or a number (e.g. ``logging.WARNING``
+or ``30``).
+
+See also: :reqmeta:`give_up_log_level`, :func:`get_retry_request`.
+
 .. setting:: RETRY_PRIORITY_ADJUST
 
 RETRY_PRIORITY_ADJUST
----------------------
+^^^^^^^^^^^^^^^^^^^^^
 
 Default: ``-1``
 
@@ -992,7 +1157,6 @@ RobotsTxtMiddleware
 
     * :ref:`Protego <protego-parser>` (default)
     * :ref:`RobotFileParser <python-robotfileparser>`
-    * :ref:`Reppy <reppy-parser>`
     * :ref:`Robotexclusionrulesparser <rerp-parser>`
 
     You can change the robots.txt_ parser with the :setting:`ROBOTSTXT_PARSER`
@@ -1013,13 +1177,13 @@ Parsers vary in several aspects:
 
 * Support for wildcard matching
 
-* Usage of `length based rule <https://developers.google.com/search/reference/robots_txt#order-of-precedence-for-group-member-lines>`_:
+* Usage of `length based rule <https://developers.google.com/crawling/docs/robots-txt/robots-txt-spec#order-of-precedence-for-rules>`_:
   in particular for ``Allow`` and ``Disallow`` directives, where the most
   specific rule based on the length of the path trumps the less specific
   (shorter) rule
 
 Performance comparison of different parsers is available at `the following link
-<https://anubhavp28.github.io/gsoc-weekly-checkin-12/>`_.
+<https://github.com/scrapy/scrapy/issues/3969>`_.
 
 .. _protego-parser:
 
@@ -1031,7 +1195,7 @@ Based on `Protego <https://github.com/scrapy/protego>`_:
 * implemented in Python
 
 * is compliant with `Google's Robots.txt Specification
-  <https://developers.google.com/search/reference/robots_txt>`_
+  <https://developers.google.com/crawling/docs/robots-txt/robots-txt-spec>`_
 
 * supports wildcard matching
 
@@ -1051,9 +1215,9 @@ Based on :class:`~urllib.robotparser.RobotFileParser`:
 * is compliant with `Martijn Koster's 1996 draft specification
   <https://www.robotstxt.org/norobots-rfc.txt>`_
 
-* lacks support for wildcard matching
+* lacks support for wildcard matching (before Python 3.14.5)
 
-* doesn't use the length based rule
+* doesn't use the length based rule (before Python 3.14.5)
 
 It is faster than Protego and backward-compatible with versions of Scrapy before 1.8.0.
 
@@ -1061,42 +1225,12 @@ In order to use this parser, set:
 
 * :setting:`ROBOTSTXT_PARSER` to ``scrapy.robotstxt.PythonRobotParser``
 
-.. _reppy-parser:
-
-Reppy parser
-~~~~~~~~~~~~
-
-Based on `Reppy <https://github.com/seomoz/reppy/>`_:
-
-* is a Python wrapper around `Robots Exclusion Protocol Parser for C++
-  <https://github.com/seomoz/rep-cpp>`_
-
-* is compliant with `Martijn Koster's 1996 draft specification
-  <https://www.robotstxt.org/norobots-rfc.txt>`_
-
-* supports wildcard matching
-
-* uses the length based rule
-
-Native implementation, provides better speed than Protego.
-
-In order to use this parser:
-
-* Install `Reppy <https://github.com/seomoz/reppy/>`_ by running ``pip install reppy``
-
-    .. warning:: `Upstream issue #122
-        <https://github.com/seomoz/reppy/issues/122>`_ prevents reppy usage in Python 3.9+.
-
-* Set :setting:`ROBOTSTXT_PARSER` setting to
-  ``scrapy.robotstxt.ReppyRobotParser``
-
-
 .. _rerp-parser:
 
 Robotexclusionrulesparser
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Based on `Robotexclusionrulesparser <http://nikitathespider.com/python/rerp/>`_:
+Based on `Robotexclusionrulesparser <https://pypi.org/project/robotexclusionrulesparser/>`_:
 
 * implemented in Python
 
@@ -1109,8 +1243,7 @@ Based on `Robotexclusionrulesparser <http://nikitathespider.com/python/rerp/>`_:
 
 In order to use this parser:
 
-* Install `Robotexclusionrulesparser <http://nikitathespider.com/python/rerp/>`_ by running
-  ``pip install robotexclusionrulesparser``
+* Install the :ref:`robotparser <extras>` extra.
 
 * Set :setting:`ROBOTSTXT_PARSER` setting to
   ``scrapy.robotstxt.RerpRobotParser``
@@ -1118,7 +1251,7 @@ In order to use this parser:
 .. _support-for-new-robots-parser:
 
 Implementing support for a new parser
--------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You can implement support for a new robots.txt_ parser by subclassing
 the abstract base class :class:`~scrapy.robotstxt.RobotParser` and
@@ -1154,64 +1287,8 @@ UserAgentMiddleware
 
 .. class:: UserAgentMiddleware
 
-   Middleware that allows spiders to override the default user agent.
-
-   In order for a spider to override the default user agent, its ``user_agent``
-   attribute must be set.
-
-.. _ajaxcrawl-middleware:
-
-AjaxCrawlMiddleware
--------------------
-
-.. module:: scrapy.downloadermiddlewares.ajaxcrawl
-
-.. class:: AjaxCrawlMiddleware
-
-   Middleware that finds 'AJAX crawlable' page variants based
-   on meta-fragment html tag. See
-   https://developers.google.com/search/docs/ajax-crawling/docs/getting-started
-   for more info.
-
-   .. note::
-
-       Scrapy finds 'AJAX crawlable' pages for URLs like
-       ``'http://example.com/!#foo=bar'`` even without this middleware.
-       AjaxCrawlMiddleware is necessary when URL doesn't contain ``'!#'``.
-       This is often a case for 'index' or 'main' website pages.
-
-AjaxCrawlMiddleware Settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. setting:: AJAXCRAWL_ENABLED
-
-AJAXCRAWL_ENABLED
-^^^^^^^^^^^^^^^^^
-
-Default: ``False``
-
-Whether the AjaxCrawlMiddleware will be enabled. You may want to
-enable it for :ref:`broad crawls <topics-broad-crawls>`.
-
-HttpProxyMiddleware settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. setting:: HTTPPROXY_ENABLED
-.. setting:: HTTPPROXY_AUTH_ENCODING
-
-HTTPPROXY_ENABLED
-^^^^^^^^^^^^^^^^^
-
-Default: ``True``
-
-Whether or not to enable the :class:`HttpProxyMiddleware`.
-
-HTTPPROXY_AUTH_ENCODING
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Default: ``"latin-1"``
-
-The default encoding for proxy authentication on :class:`HttpProxyMiddleware`.
+   Middleware that sets the ``User-Agent`` header.
 
+   The header value is taken from the :setting:`USER_AGENT` setting.
 
 .. _DBM: https://en.wikipedia.org/wiki/Dbm

docs/topics/dynamic-content.rst

@@ -14,7 +14,7 @@ from it.
 
 If you fail to do that, and you can nonetheless access the desired data through
 the :ref:`DOM <topics-livedom>` from your web browser, see
-:ref:`topics-javascript-rendering`.
+:ref:`topics-headless-browsing`.
 
 .. _topics-finding-data-source:
 
@@ -83,11 +83,10 @@ request with Scrapy.
 
 It might be enough to yield a :class:`~scrapy.Request` with the same HTTP
 method and URL. However, you may also need to reproduce the body, headers and
-form parameters (see :class:`~scrapy.FormRequest`) of that request.
+form parameters (see :ref:`form`) of that request.
 
-As all major browsers allow to export the requests in `cURL
-<https://curl.haxx.se/>`_ format, Scrapy incorporates the method
-:meth:`~scrapy.Request.from_curl()` to generate an equivalent
+As all major browsers allow to export the requests in curl_ format, Scrapy
+incorporates the method :meth:`~scrapy.Request.from_curl` to generate an equivalent
 :class:`~scrapy.Request` from a cURL command. To get more information
 visit :ref:`request from curl <requests-from-curl>` inside the network
 tool section.
@@ -98,7 +97,7 @@ it <topics-handling-response-formats>`.
 You can reproduce any request with Scrapy. However, some times reproducing all
 necessary requests may not seem efficient in developer time. If that is your
 case, and crawling speed is not a major concern for you, you can alternatively
-consider :ref:`JavaScript pre-rendering <topics-javascript-rendering>`.
+consider :ref:`using a headless browser <topics-headless-browsing>`.
 
 If you get the expected response `sometimes`, but not always, the issue is
 probably not your request, but the target server. The target server might be
@@ -112,23 +111,29 @@ you may use `curl2scrapy <https://michael-shub.github.io/curl2scrapy/>`_.
 Handling different response formats
 ===================================
 
+.. skip: start
+
 Once you have a response with the desired data, how you extract the desired
 data from it depends on the type of response:
 
--   If the response is HTML or XML, use :ref:`selectors
+-   If the response is HTML, XML or JSON, use :ref:`selectors
     <topics-selectors>` as usual.
 
--   If the response is JSON, use :func:`json.loads` to load the desired data from
-    :attr:`response.text <scrapy.http.TextResponse.text>`::
+-   If the response is JSON, use :func:`response.json()
+    <scrapy.http.TextResponse.json>` to load the desired data:
 
-        data = json.loads(response.text)
+    .. code-block:: python
+
+        data = response.json()
 
     If the desired data is inside HTML or XML code embedded within JSON data,
     you can load that HTML or XML code into a
     :class:`~scrapy.Selector` and then
-    :ref:`use it <topics-selectors>` as usual::
+    :ref:`use it <topics-selectors>` as usual:
 
-        selector = Selector(data['html'])
+    .. code-block:: python
+
+        selector = Selector(text=data["html"])
 
 -   If the response is JavaScript, or HTML with a ``<script/>`` element
     containing the desired data, see :ref:`topics-parsing-javascript`.
@@ -141,7 +146,7 @@ data from it depends on the type of response:
 
 -   If the response is an image or another format based on images (e.g. PDF),
     read the response as bytes from
-    :attr:`response.body <scrapy.http.TextResponse.body>` and use an OCR
+    :attr:`response.body <scrapy.http.Response.body>` and use an OCR
     solution to extract the desired data as text.
 
     For example, you can use pytesseract_. To read a table from a PDF,
@@ -154,11 +159,15 @@ data from it depends on the type of response:
     Otherwise, you might need to convert the SVG code into a raster image, and
     :ref:`handle that raster image <topics-parsing-images>`.
 
+.. skip: end
+
 .. _topics-parsing-javascript:
 
 Parsing JavaScript code
 =======================
 
+.. skip: start
+
 If the desired data is hardcoded in JavaScript, you first need to get the
 JavaScript code:
 
@@ -179,10 +188,12 @@ data from it:
     For example, if the JavaScript code contains a separate line like
     ``var data = {"field": "value"};`` you can extract that data as follows:
 
-    >>> pattern = r'\bvar\s+data\s*=\s*(\{.*?\})\s*;\s*\n'
-    >>> json_data = response.css('script::text').re_first(pattern)
-    >>> json.loads(json_data)
-    {'field': 'value'}
+    .. code-block:: pycon
+
+        >>> pattern = r"\bvar\s+data\s*=\s*(\{.*?\})\s*;\s*\n"
+        >>> json_data = response.css("script::text").re_first(pattern)
+        >>> json.loads(json_data)
+        {'field': 'value'}
 
 -   chompjs_ provides an API to parse JavaScript objects into a :class:`dict`.
 
@@ -190,11 +201,13 @@ data from it:
     ``var data = {field: "value", secondField: "second value"};``
     you can extract that data as follows:
 
-    >>> import chompjs
-    >>> javascript = response.css('script::text').get()
-    >>> data = chompjs.parse_js_object(javascript)
-    >>> data
-    {'field': 'value', 'secondField': 'second value'}
+    .. code-block:: pycon
+
+        >>> import chompjs
+        >>> javascript = response.css("script::text").get()
+        >>> data = chompjs.parse_js_object(javascript)
+        >>> data
+        {'field': 'value', 'secondField': 'second value'}
 
 -   Otherwise, use js2xml_ to convert the JavaScript code into an XML document
     that you can parse using :ref:`selectors <topics-selectors>`.
@@ -202,18 +215,22 @@ data from it:
     For example, if the JavaScript code contains
     ``var data = {field: "value"};`` you can extract that data as follows:
 
-    >>> import js2xml
-    >>> import lxml.etree
-    >>> from parsel import Selector
-    >>> javascript = response.css('script::text').get()
-    >>> xml = lxml.etree.tostring(js2xml.parse(javascript), encoding='unicode')
-    >>> selector = Selector(text=xml)
-    >>> selector.css('var[name="data"]').get()
-    '<var name="data"><object><property name="field"><string>value</string></property></object></var>'
+    .. code-block:: pycon
 
-.. _topics-javascript-rendering:
+        >>> import js2xml
+        >>> import lxml.etree
+        >>> from parsel import Selector
+        >>> javascript = response.css("script::text").get()
+        >>> xml = lxml.etree.tostring(js2xml.parse(javascript), encoding="unicode")
+        >>> selector = Selector(text=xml)
+        >>> selector.css('var[name="data"]').get()
+        '<var name="data"><object><property name="field"><string>value</string></property></object></var>'
 
-Pre-rendering JavaScript
+.. skip: end
+
+.. _topics-headless-browsing:
+
+Using a headless browser
 ========================
 
 On webpages that fetch data from additional requests, reproducing those
@@ -223,38 +240,23 @@ network transfer.
 
 However, sometimes it can be really hard to reproduce certain requests. Or you
 may need something that no request can give you, such as a screenshot of a
-webpage as seen in a web browser.
+webpage as seen in a web browser. In this case using a `headless browser`_ will
+help.
 
-In these cases use the Splash_ JavaScript-rendering service, along with
-`scrapy-splash`_ for seamless integration.
-
-Splash returns as HTML the :ref:`DOM <topics-livedom>` of a webpage, so that
-you can parse it with :ref:`selectors <topics-selectors>`. It provides great
-flexibility through configuration_ or scripting_.
-
-If you need something beyond what Splash offers, such as interacting with the
-DOM on-the-fly from Python code instead of using a previously-written script,
-or handling multiple web browser windows, you might need to
-:ref:`use a headless browser <topics-headless-browsing>` instead.
-
-.. _configuration: https://splash.readthedocs.io/en/stable/api.html
-.. _scripting: https://splash.readthedocs.io/en/stable/scripting-tutorial.html
-
-.. _topics-headless-browsing:
-
-Using a headless browser
-========================
-
-A `headless browser`_ is a special web browser that provides an API for
+A headless browser is a special web browser that provides an API for
 automation. By installing the :ref:`asyncio reactor <install-asyncio>`,
 it is possible to integrate ``asyncio``-based libraries which handle headless browsers.
 
 One such library is `playwright-python`_ (an official Python port of `playwright`_).
-The following is a simple snippet to illustrate its usage within a Scrapy spider::
+The following is a simple snippet to illustrate its usage within a Scrapy spider:
+
+.. skip: next
+.. code-block:: python
 
     import scrapy
     from playwright.async_api import async_playwright
 
+
     class PlaywrightSpider(scrapy.Spider):
         name = "playwright"
         start_urls = ["data:,"]  # avoid using the default Scrapy downloader
@@ -263,7 +265,7 @@ The following is a simple snippet to illustrate its usage within a Scrapy spider
             async with async_playwright() as pw:
                 browser = await pw.chromium.launch()
                 page = await browser.new_page()
-                await page.goto("https:/example.org")
+                await page.goto("https://example.org")
                 title = await page.title()
                 return {"title": title}
 
@@ -272,20 +274,15 @@ However, using `playwright-python`_ directly as in the above example
 circumvents most of the Scrapy components (middlewares, dupefilter, etc).
 We recommend using `scrapy-playwright`_ for a better integration.
 
-.. _AJAX: https://en.wikipedia.org/wiki/Ajax_%28programming%29
 .. _CSS: https://en.wikipedia.org/wiki/Cascading_Style_Sheets
-.. _JavaScript: https://en.wikipedia.org/wiki/JavaScript
-.. _Splash: https://github.com/scrapinghub/splash
 .. _chompjs: https://github.com/Nykakin/chompjs
-.. _curl: https://curl.haxx.se/
+.. _curl: https://curl.se/
 .. _headless browser: https://en.wikipedia.org/wiki/Headless_browser
 .. _js2xml: https://github.com/scrapinghub/js2xml
 .. _playwright-python: https://github.com/microsoft/playwright-python
 .. _playwright: https://github.com/microsoft/playwright
-.. _pyppeteer: https://pyppeteer.github.io/pyppeteer/
 .. _pytesseract: https://github.com/madmaze/pytesseract
 .. _scrapy-playwright: https://github.com/scrapy-plugins/scrapy-playwright
-.. _scrapy-splash: https://github.com/scrapy-plugins/scrapy-splash
 .. _tabula-py: https://github.com/chezou/tabula-py
 .. _wget: https://www.gnu.org/software/wget/
 .. _wgrep: https://github.com/stav/wgrep

docs/topics/email.rst

@@ -1,179 +0,0 @@
-.. _topics-email:
-
-==============
-Sending e-mail
-==============
-
-.. module:: scrapy.mail
-   :synopsis: Email sending facility
-
-Although Python makes sending e-mails relatively easy via the :mod:`smtplib`
-library, Scrapy provides its own facility for sending e-mails which is very
-easy to use and it's implemented using :doc:`Twisted non-blocking IO
-<twisted:core/howto/defer-intro>`, to avoid interfering with the non-blocking
-IO of the crawler. It also provides a simple API for sending attachments and
-it's very easy to configure, with a few :ref:`settings
-<topics-email-settings>`.
-
-Quick example
-=============
-
-There are two ways to instantiate the mail sender. You can instantiate it using
-the standard ``__init__`` method::
-
-    from scrapy.mail import MailSender
-    mailer = MailSender()
-
-Or you can instantiate it passing a Scrapy settings object, which will respect
-the :ref:`settings <topics-email-settings>`::
-
-    mailer = MailSender.from_settings(settings)
-
-And here is how to use it to send an e-mail (without attachments)::
-
-    mailer.send(to=["someone@example.com"], subject="Some subject", body="Some body", cc=["another@example.com"])
-
-MailSender class reference
-==========================
-
-MailSender is the preferred class to use for sending emails from Scrapy, as it
-uses :doc:`Twisted non-blocking IO <twisted:core/howto/defer-intro>`, like the
-rest of the framework.
-
-.. class:: MailSender(smtphost=None, mailfrom=None, smtpuser=None, smtppass=None, smtpport=None)
-
-    :param smtphost: the SMTP host to use for sending the emails. If omitted, the
-      :setting:`MAIL_HOST` setting will be used.
-    :type smtphost: str
-
-    :param mailfrom: the address used to send emails (in the ``From:`` header).
-      If omitted, the :setting:`MAIL_FROM` setting will be used.
-    :type mailfrom: str
-
-    :param smtpuser: the SMTP user. If omitted, the :setting:`MAIL_USER`
-      setting will be used. If not given, no SMTP authentication will be
-      performed.
-    :type smtphost: str or bytes
-
-    :param smtppass: the SMTP pass for authentication.
-    :type smtppass: str or bytes
-
-    :param smtpport: the SMTP port to connect to
-    :type smtpport: int
-
-    :param smtptls: enforce using SMTP STARTTLS
-    :type smtptls: bool
-
-    :param smtpssl: enforce using a secure SSL connection
-    :type smtpssl: bool
-
-    .. classmethod:: from_settings(settings)
-
-        Instantiate using a Scrapy settings object, which will respect
-        :ref:`these Scrapy settings <topics-email-settings>`.
-
-        :param settings: the e-mail recipients
-        :type settings: :class:`scrapy.settings.Settings` object
-
-    .. method:: send(to, subject, body, cc=None, attachs=(), mimetype='text/plain', charset=None)
-
-        Send email to the given recipients.
-
-        :param to: the e-mail recipients as a string or as a list of strings
-        :type to: str or list
-
-        :param subject: the subject of the e-mail
-        :type subject: str
-
-        :param cc: the e-mails to CC as a string or as a list of strings
-        :type cc: str or list
-
-        :param body: the e-mail body
-        :type body: str
-
-        :param attachs: an iterable of tuples ``(attach_name, mimetype,
-          file_object)`` where  ``attach_name`` is a string with the name that will
-          appear on the e-mail's attachment, ``mimetype`` is the mimetype of the
-          attachment and ``file_object`` is a readable file object with the
-          contents of the attachment
-        :type attachs: collections.abc.Iterable
-
-        :param mimetype: the MIME type of the e-mail
-        :type mimetype: str
-
-        :param charset: the character encoding to use for the e-mail contents
-        :type charset: str
-
-
-.. _topics-email-settings:
-
-Mail settings
-=============
-
-These settings define the default ``__init__`` method values of the :class:`MailSender`
-class, and can be used to configure e-mail notifications in your project without
-writing any code (for those extensions and code that uses :class:`MailSender`).
-
-.. setting:: MAIL_FROM
-
-MAIL_FROM
----------
-
-Default: ``'scrapy@localhost'``
-
-Sender email to use (``From:`` header) for sending emails.
-
-.. setting:: MAIL_HOST
-
-MAIL_HOST
----------
-
-Default: ``'localhost'``
-
-SMTP host to use for sending emails.
-
-.. setting:: MAIL_PORT
-
-MAIL_PORT
----------
-
-Default: ``25``
-
-SMTP port to use for sending emails.
-
-.. setting:: MAIL_USER
-
-MAIL_USER
----------
-
-Default: ``None``
-
-User to use for SMTP authentication. If disabled no SMTP authentication will be
-performed.
-
-.. setting:: MAIL_PASS
-
-MAIL_PASS
----------
-
-Default: ``None``
-
-Password to use for SMTP authentication, along with :setting:`MAIL_USER`.
-
-.. setting:: MAIL_TLS
-
-MAIL_TLS
---------
-
-Default: ``False``
-
-Enforce using STARTTLS. STARTTLS is a way to take an existing insecure connection, and upgrade it to a secure connection using SSL/TLS.
-
-.. setting:: MAIL_SSL
-
-MAIL_SSL
---------
-
-Default: ``False``
-
-Enforce connecting using an SSL encrypted connection

docs/topics/exceptions.rst

@@ -1,115 +1,25 @@
 .. _topics-exceptions:
+.. _topics-exceptions-ref:
 
 ==========
 Exceptions
 ==========
 
+Here's a list of all exceptions included in Scrapy and their usage, except for
+the :ref:`download handler exceptions <download-handlers-exceptions>`.
+
 .. module:: scrapy.exceptions
-   :synopsis: Scrapy exceptions
 
-.. _topics-exceptions-ref:
+.. autoexception:: CloseSpider
 
-Built-in Exceptions reference
-=============================
+.. autoexception:: DontCloseSpider
 
-Here's a list of all exceptions included in Scrapy and their usage.
+.. autoexception:: DropItem
 
+.. autoexception:: IgnoreRequest
 
-CloseSpider
------------
+.. autoexception:: NotConfigured
 
-.. exception:: CloseSpider(reason='cancelled')
+.. autoexception:: NotSupported
 
-    This exception can be raised from a spider callback to request the spider to be
-    closed/stopped. Supported arguments:
-
-    :param reason: the reason for closing
-    :type reason: str
-
-For example::
-
-    def parse_page(self, response):
-        if 'Bandwidth exceeded' in response.body:
-            raise CloseSpider('bandwidth_exceeded')
-
-DontCloseSpider
----------------
-
-.. exception:: DontCloseSpider
-
-This exception can be raised in a :signal:`spider_idle` signal handler to
-prevent the spider from being closed.
-
-DropItem
---------
-
-.. exception:: DropItem
-
-The exception that must be raised by item pipeline stages to stop processing an
-Item. For more information see :ref:`topics-item-pipeline`.
-
-IgnoreRequest
--------------
-
-.. exception:: IgnoreRequest
-
-This exception can be raised by the Scheduler or any downloader middleware to
-indicate that the request should be ignored.
-
-NotConfigured
--------------
-
-.. exception:: NotConfigured
-
-This exception can be raised by some components to indicate that they will
-remain disabled. Those components include:
-
--   Extensions
--   Item pipelines
--   Downloader middlewares
--   Spider middlewares
-
-The exception must be raised in the component's ``__init__`` method.
-
-NotSupported
-------------
-
-.. exception:: NotSupported
-
-This exception is raised to indicate an unsupported feature.
-
-StopDownload
--------------
-
-.. versionadded:: 2.2
-
-.. exception:: StopDownload(fail=True)
-
-Raised from a :class:`~scrapy.signals.bytes_received` or :class:`~scrapy.signals.headers_received`
-signal handler to indicate that no further bytes should be downloaded for a response.
-
-The ``fail`` boolean parameter controls which method will handle the resulting
-response:
-
-* If ``fail=True`` (default), the request errback is called. The response object is
-  available as the ``response`` attribute of the ``StopDownload`` exception,
-  which is in turn stored as the ``value`` attribute of the received
-  :class:`~twisted.python.failure.Failure` object. This means that in an errback
-  defined as ``def errback(self, failure)``, the response can be accessed though
-  ``failure.value.response``.
-
-* If ``fail=False``, the request callback is called instead.
-
-In both cases, the response could have its body truncated: the body contains
-all bytes received up until the exception is raised, including the bytes
-received in the signal handler that raises the exception. Also, the response
-object is marked with ``"download_stopped"`` in its :attr:`Response.flags`
-attribute.
-
-.. note:: ``fail`` is a keyword-only parameter, i.e. raising
-    ``StopDownload(False)`` or ``StopDownload(True)`` will raise
-    a :class:`TypeError`.
-
-See the documentation for the :class:`~scrapy.signals.bytes_received` and
-:class:`~scrapy.signals.headers_received` signals
-and the :ref:`topics-stop-response-download` topic for additional information and examples.
+.. autoexception:: StopDownload

docs/topics/exporters.rst

@@ -38,11 +38,14 @@ the end of the exporting process
 
 Here you can see an :doc:`Item Pipeline <item-pipeline>` which uses multiple
 Item Exporters to group scraped items to different files according to the
-value of one of their fields::
+value of one of their fields:
+
+.. code-block:: python
 
     from itemadapter import ItemAdapter
     from scrapy.exporters import XmlItemExporter
 
+
     class PerYearXmlExportPipeline:
         """Distribute items across multiple XML files according to their 'year' field"""
 
@@ -56,15 +59,15 @@ value of one of their fields::
 
         def _exporter_for_item(self, item):
             adapter = ItemAdapter(item)
-            year = adapter['year']
+            year = adapter["year"]
             if year not in self.year_to_exporter:
-                xml_file = open(f'{year}.xml', 'wb')
+                xml_file = open(f"{year}.xml", "wb")
                 exporter = XmlItemExporter(xml_file)
                 exporter.start_exporting()
                 self.year_to_exporter[year] = (exporter, xml_file)
             return self.year_to_exporter[year][0]
 
-        def process_item(self, item, spider):
+        def process_item(self, item):
             exporter = self._exporter_for_item(item)
             exporter.export_item(item)
             return item
@@ -90,40 +93,47 @@ described next.
 1. Declaring a serializer in the field
 --------------------------------------
 
-If you use :class:`~scrapy.Item` you can declare a serializer in the
-:ref:`field metadata <topics-items-fields>`. The serializer must be
-a callable which receives a value and returns its serialized form.
+Every :ref:`item type <item-types>` except :class:`dict` lets you declare a
+serializer in the :ref:`field metadata <topics-items-fields>`. The serializer
+must be a callable which receives a value and returns its serialized form.
 
-Example::
+Example:
+
+.. code-block:: python
+
+    from dataclasses import dataclass, field
 
-    import scrapy
 
     def serialize_price(value):
-        return f'$ {str(value)}'
+        return f"$ {str(value)}"
 
-    class Product(scrapy.Item):
-        name = scrapy.Field()
-        price = scrapy.Field(serializer=serialize_price)
+
+    @dataclass
+    class Product:
+        name: str
+        price: float = field(metadata={"serializer": serialize_price})
 
 
 2. Overriding the serialize_field() method
 ------------------------------------------
 
-You can also override the :meth:`~BaseItemExporter.serialize_field()` method to
+You can also override the :meth:`~BaseItemExporter.serialize_field` method to
 customize how your field value will be exported.
 
-Make sure you call the base class :meth:`~BaseItemExporter.serialize_field()` method
+Make sure you call the base class :meth:`~BaseItemExporter.serialize_field` method
 after your custom code.
 
-Example::
+Example:
+
+.. code-block:: python
+
+      from scrapy.exporters import XmlItemExporter
 
-      from scrapy.exporter import XmlItemExporter
 
       class ProductXmlExporter(XmlItemExporter):
-
           def serialize_field(self, field, name, value):
-              if name == 'price':
-                  return f'$ {str(value)}'
+              if name == "price":
+                  return f"$ {str(value)}"
               return super().serialize_field(field, name, value)
 
 .. _topics-exporters-reference:
@@ -132,15 +142,18 @@ Built-in Item Exporters reference
 =================================
 
 Here is a list of the Item Exporters bundled with Scrapy. Some of them contain
-output examples, which assume you're exporting these two items::
+output examples, which assume you're exporting these two items:
 
-    Item(name='Color TV', price='1200')
-    Item(name='DVD player', price='200')
+.. skip: next
+.. code-block:: python
+
+    Item(name="Color TV", price="1200")
+    Item(name="DVD player", price="200")
 
 BaseItemExporter
 ----------------
 
-.. class:: BaseItemExporter(fields_to_export=None, export_empty_fields=False, encoding='utf-8', indent=0, dont_fail=False)
+.. class:: BaseItemExporter(fields_to_export=None, export_empty_fields=False, encoding=None, indent=None, dont_fail=False)
 
    This is the (abstract) base class for all Item Exporters. It provides
    support for common features used by all (concrete) Item Exporters, such as
@@ -151,9 +164,6 @@ BaseItemExporter
    populate their respective instance attributes: :attr:`fields_to_export`,
    :attr:`export_empty_fields`, :attr:`encoding`, :attr:`indent`.
 
-   .. versionadded:: 2.0
-      The *dont_fail* parameter.
-
    .. method:: export_item(item)
 
       Exports the given item. This method must be implemented in subclasses.
@@ -195,17 +205,39 @@ BaseItemExporter
 
    .. attribute:: fields_to_export
 
-      A list with the name of the fields that will be exported, or ``None`` if
-      you want to export all fields. Defaults to ``None``.
+      Fields to export, their order [1]_ and their output names.
 
-      Some exporters (like :class:`CsvItemExporter`) respect the order of the
-      fields defined in this attribute.
+      Possible values are:
 
-      When using :ref:`item objects <item-types>` that do not expose all their
-      possible fields, exporters that do not support exporting a different
-      subset of fields per item will only export the fields found in the first
-      item exported. Use ``fields_to_export`` to define all the fields to be
-      exported.
+      -   ``None`` (all fields [2]_, default)
+
+          Fields are exported in declaration order, i.e. the order in which
+          they are defined in the :ref:`item class <item-types>`. For
+          :class:`dict` items, which have no declared fields, the key order of
+          each item is used instead.
+
+          .. versionchanged:: VERSION
+             Fields of non-\ :class:`dict` items used to be exported in the
+             order in which they had been populated, except in
+             :class:`CsvItemExporter`, which has always used declaration order.
+
+      -   A list of fields:
+
+          .. code-block:: python
+
+              ["field1", "field2"]
+
+      -   A dict where keys are fields and values are output names:
+
+          .. code-block:: python
+
+              {"field1": "Field 1", "field2": "Field 2"}
+
+      .. [1] Not all exporters respect the specified field order.
+      .. [2] When using :ref:`item objects <item-types>` that do not expose
+             all their possible fields, exporters that do not support exporting
+             a different subset of fields per item will only export the fields
+             found in the first item exported.
 
    .. attribute:: export_empty_fields
 
@@ -221,7 +253,7 @@ BaseItemExporter
 
    .. attribute:: indent
 
-      Amount of spaces used to indent the output on each level. Defaults to ``0``.
+      Amount of spaces used to indent the output on each level. Defaults to ``None``.
 
       * ``indent=None`` selects the most compact representation,
         all items in the same line with no indentation
@@ -255,7 +287,9 @@ XmlItemExporter
    The additional keyword arguments of this ``__init__`` method are passed to the
    :class:`BaseItemExporter` ``__init__`` method.
 
-   A typical output of this exporter would be::
+   A typical output of this exporter would be:
+
+   .. code-block:: xml
 
        <?xml version="1.0" encoding="utf-8"?>
        <items>
@@ -273,11 +307,17 @@ XmlItemExporter
    exported by serializing each value inside a ``<value>`` element. This is for
    convenience, as multi-valued fields are very common.
 
-   For example, the item::
+   For example, the item:
 
-        Item(name=['John', 'Doe'], age='23')
+   .. skip: next
 
-   Would be serialized as::
+   .. code-block:: python
+
+        Item(name=["John", "Doe"], age="23")
+
+   Would be serialized as:
+
+   .. code-block:: xml
 
        <?xml version="1.0" encoding="utf-8"?>
        <items>
@@ -297,8 +337,8 @@ CsvItemExporter
 
    Exports items in CSV format to the given file-like object. If the
    :attr:`fields_to_export` attribute is set, it will be used to define the
-   CSV columns and their order. The :attr:`export_empty_fields` attribute has
-   no effect on this exporter.
+   CSV columns, their order and their column names. The
+   :attr:`export_empty_fields` attribute has no effect on this exporter.
 
    :param file: the file-like object to use for exporting the data. Its ``write`` method should
                 accept ``bytes`` (a disk file opened in binary mode, a ``io.BytesIO`` object, etc)
@@ -310,7 +350,7 @@ CsvItemExporter
 
    :param join_multivalued: The char (or chars) that will be used for joining
       multi-valued fields, if found.
-   :type include_headers_line: str
+   :type join_multivalued: str
 
    :param errors: The optional string that specifies how encoding and decoding
       errors are to be handled. For more information see
@@ -324,14 +364,14 @@ CsvItemExporter
 
    A typical output of this exporter would be::
 
-      product,price
+      name,price
       Color TV,1200
       DVD player,200
 
 PickleItemExporter
 ------------------
 
-.. class:: PickleItemExporter(file, protocol=0, **kwargs)
+.. class:: PickleItemExporter(file, protocol=4, **kwargs)
 
    Exports items in pickle format to the given file-like object.
 
@@ -361,10 +401,12 @@ PprintItemExporter
    The additional keyword arguments of this ``__init__`` method are passed to the
    :class:`BaseItemExporter` ``__init__`` method.
 
-   A typical output of this exporter would be::
+   A typical output of this exporter would be:
 
-        {'name': 'Color TV', 'price': '1200'}
-        {'name': 'DVD player', 'price': '200'}
+   .. code-block:: python
+
+        {"name": "Color TV", "price": "1200"}
+        {"name": "DVD player", "price": "200"}
 
    Longer lines (when present) are pretty-formatted.
 
@@ -382,7 +424,9 @@ JsonItemExporter
    :param file: the file-like object to use for exporting the data. Its ``write`` method should
                 accept ``bytes`` (a disk file opened in binary mode, a ``io.BytesIO`` object, etc)
 
-   A typical output of this exporter would be::
+   A typical output of this exporter would be:
+
+   .. code-block:: json
 
         [{"name": "Color TV", "price": "1200"},
         {"name": "DVD player", "price": "200"}]
@@ -411,7 +455,9 @@ JsonLinesItemExporter
    :param file: the file-like object to use for exporting the data. Its ``write`` method should
                 accept ``bytes`` (a disk file opened in binary mode, a ``io.BytesIO`` object, etc)
 
-   A typical output of this exporter would be::
+   A typical output of this exporter would be:
+
+   .. code-block:: json
 
         {"name": "Color TV", "price": "1200"}
         {"name": "DVD player", "price": "200"}

docs/topics/extensions.rst

@@ -4,87 +4,47 @@
 Extensions
 ==========
 
-The extensions framework provides a mechanism for inserting your own
-custom functionality into Scrapy.
+Extensions are :ref:`components <topics-components>` that allow inserting your
+own custom functionality into Scrapy.
 
-Extensions are just regular classes.
+Unlike other components, extensions do not have a specific role in Scrapy. They
+are “wildcard” components that can be used for anything that does not fit the
+role of any other type of component.
 
-Extension settings
-==================
+Loading and activating extensions
+=================================
 
-Extensions use the :ref:`Scrapy settings <topics-settings>` to manage their
-settings, just like any other Scrapy code.
+Extensions are loaded at startup by creating a single instance of the extension
+class per spider being run.
 
-It is customary for extensions to prefix their settings with their own name, to
-avoid collision with existing (and future) extensions. For example, a
-hypothetic extension to handle `Google Sitemaps`_ would use settings like
-``GOOGLESITEMAP_ENABLED``, ``GOOGLESITEMAP_DEPTH``, and so on.
+To enable an extension, add it to the :setting:`EXTENSIONS` setting. For
+example:
 
-.. _Google Sitemaps: https://en.wikipedia.org/wiki/Sitemaps
-
-Loading & activating extensions
-===============================
-
-Extensions are loaded and activated at startup by instantiating a single
-instance of the extension class per spider being run. All the extension
-initialization code must be performed in the class ``__init__`` method.
-
-To make an extension available, add it to the :setting:`EXTENSIONS` setting in
-your Scrapy settings. In :setting:`EXTENSIONS`, each extension is represented
-by a string: the full Python path to the extension's class name. For example::
+.. code-block:: python
 
     EXTENSIONS = {
-        'scrapy.extensions.corestats.CoreStats': 500,
-        'scrapy.extensions.telnet.TelnetConsole': 500,
+        "scrapy.extensions.corestats.CoreStats": 500,
+        "scrapy.extensions.telnet.TelnetConsole": 500,
     }
 
-
-As you can see, the :setting:`EXTENSIONS` setting is a dict where the keys are
-the extension paths, and their values are the orders, which define the
-extension *loading* order. The :setting:`EXTENSIONS` setting is merged with the
-:setting:`EXTENSIONS_BASE` setting defined in Scrapy (and not meant to be
-overridden) and then sorted by order to get the final sorted list of enabled
-extensions.
+:setting:`EXTENSIONS` is merged with :setting:`EXTENSIONS_BASE` (not meant to
+be overridden), and the priorities in the resulting value determine the
+*loading* order.
 
 As extensions typically do not depend on each other, their loading order is
 irrelevant in most cases. This is why the :setting:`EXTENSIONS_BASE` setting
-defines all extensions with the same order (``0``). However, this feature can
-be exploited if you need to add an extension which depends on other extensions
-already loaded.
-
-Available, enabled and disabled extensions
-==========================================
-
-Not all available extensions will be enabled. Some of them usually depend on a
-particular setting. For example, the HTTP Cache extension is available by default
-but disabled unless the :setting:`HTTPCACHE_ENABLED` setting is set.
-
-Disabling an extension
-======================
-
-In order to disable an extension that comes enabled by default (i.e. those
-included in the :setting:`EXTENSIONS_BASE` setting) you must set its order to
-``None``. For example::
-
-    EXTENSIONS = {
-        'scrapy.extensions.corestats.CoreStats': None,
-    }
+defines all extensions with the same order (``0``). However, you may need to
+carefully use priorities if you add an extension that depends on other
+extensions being already loaded.
 
 Writing your own extension
 ==========================
 
-Each extension is a Python class. The main entry point for a Scrapy extension
-(this also includes middlewares and pipelines) is the ``from_crawler``
-class method which receives a ``Crawler`` instance. Through the Crawler object
-you can access settings, signals, stats, and also control the crawling behaviour.
+Each extension is a :ref:`component <topics-components>`.
 
 Typically, extensions connect to :ref:`signals <topics-signals>` and perform
 tasks triggered by them.
 
-Finally, if the ``from_crawler`` method raises the
-:exc:`~scrapy.exceptions.NotConfigured` exception, the extension will be
-disabled. Otherwise, the extension will be enabled.
-
 Sample extension
 ----------------
 
@@ -98,7 +58,9 @@ in the previous section. This extension will log a message every time:
 The extension will be enabled through the ``MYEXT_ENABLED`` setting and the
 number of items will be specified through the ``MYEXT_ITEMCOUNT`` setting.
 
-Here is the code of such extension::
+Here is the code of such extension:
+
+.. code-block:: python
 
     import logging
     from scrapy import signals
@@ -106,8 +68,8 @@ Here is the code of such extension::
 
     logger = logging.getLogger(__name__)
 
-    class SpiderOpenCloseLogging:
 
+    class SpiderOpenCloseLogging:
         def __init__(self, item_count):
             self.item_count = item_count
             self.items_scraped = 0
@@ -116,11 +78,11 @@ Here is the code of such extension::
         def from_crawler(cls, crawler):
             # first check if the extension should be enabled and raise
             # NotConfigured otherwise
-            if not crawler.settings.getbool('MYEXT_ENABLED'):
+            if not crawler.settings.getbool("MYEXT_ENABLED"):
                 raise NotConfigured
 
             # get the number of items from settings
-            item_count = crawler.settings.getint('MYEXT_ITEMCOUNT', 1000)
+            item_count = crawler.settings.getint("MYEXT_ITEMCOUNT", 1000)
 
             # instantiate the extension object
             ext = cls(item_count)
@@ -174,6 +136,19 @@ Core Stats extension
 Enable the collection of core statistics, provided the stats collection is
 enabled (see :ref:`topics-stats`).
 
+The following stats are collected: :stat:`elapsed_time_seconds`,
+:stat:`finish_reason`, :stat:`finish_time`, :stat:`item_dropped_count`,
+:stat:`item_dropped_reasons_count/{exception}`, :stat:`item_scraped_count`,
+:stat:`response_received_count`, :stat:`start_time`.
+
+Log Count extension
+~~~~~~~~~~~~~~~~~~~
+
+.. module:: scrapy.extensions.logcount
+   :synopsis: Basic stats logging
+
+.. autoclass:: LogCount
+
 .. _topics-extensions-ref-telnetconsole:
 
 Telnet console extension
@@ -205,20 +180,16 @@ Memory usage extension
 
 Monitors the memory used by the Scrapy process that runs the spider and:
 
-1. sends a notification e-mail when it exceeds a certain value
-2. closes the spider when it exceeds a certain value
-
-The notification e-mails can be triggered when a certain warning value is
-reached (:setting:`MEMUSAGE_WARNING_MB`) and when the maximum value is reached
-(:setting:`MEMUSAGE_LIMIT_MB`) which will also cause the spider to be closed
-and the Scrapy process to be terminated.
+1. sends a :signal:`memusage_warning_reached` signal when it exceeds
+   :setting:`MEMUSAGE_WARNING_MB`
+2. closes the spider with the ``"memusage_exceeded"`` reason when it exceeds
+   :setting:`MEMUSAGE_LIMIT_MB`
 
 This extension is enabled by the :setting:`MEMUSAGE_ENABLED` setting and
 can be configured with the following settings:
 
 * :setting:`MEMUSAGE_LIMIT_MB`
 * :setting:`MEMUSAGE_WARNING_MB`
-* :setting:`MEMUSAGE_NOTIFY_MAIL`
 * :setting:`MEMUSAGE_CHECK_INTERVAL_SECONDS`
 
 Memory debugger extension
@@ -235,7 +206,34 @@ An extension for debugging memory usage. It collects information about:
 * objects left alive that shouldn't. For more info, see :ref:`topics-leaks-trackrefs`
 
 To enable this extension, turn on the :setting:`MEMDEBUG_ENABLED` setting. The
-info will be stored in the stats.
+info will be stored in the :stat:`memdebug/gc_garbage_count` and
+:stat:`memdebug/live_refs/{cls}` stats.
+
+.. _topics-extensions-ref-spiderstate:
+
+Spider state extension
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. module:: scrapy.extensions.spiderstate
+   :synopsis: Spider state extension
+
+.. class:: SpiderState
+
+Manages spider state data by loading it before a crawl and saving it after.
+
+Give a value to the :setting:`JOBDIR` setting to enable this extension.
+When enabled, this extension manages the :attr:`~scrapy.Spider.state`
+attribute of your :class:`~scrapy.Spider` instance:
+
+-   When your spider closes (:signal:`spider_closed`), the contents of its
+    :attr:`~scrapy.Spider.state` attribute are serialized into a file named
+    ``spider.state`` in the :setting:`JOBDIR` folder.
+-   When your spider opens (:signal:`spider_opened`), if a previously-generated
+    ``spider.state`` file exists in the :setting:`JOBDIR` folder, it is loaded
+    into the :attr:`~scrapy.Spider.state` attribute.
+
+
+For an example, see :ref:`topics-keeping-persistent-state-between-batches`.
 
 Close spider extension
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -252,14 +250,16 @@ The conditions for closing a spider can be configured through the following
 settings:
 
 * :setting:`CLOSESPIDER_TIMEOUT`
+* :setting:`CLOSESPIDER_TIMEOUT_NO_ITEM`
 * :setting:`CLOSESPIDER_ITEMCOUNT`
 * :setting:`CLOSESPIDER_PAGECOUNT`
+* :setting:`CLOSESPIDER_PAGECOUNT_NO_ITEM`
 * :setting:`CLOSESPIDER_ERRORCOUNT`
 
 .. note::
 
-   When a certain closing condition is met, requests which are 
-   currently in the downloader queue (up to :setting:`CONCURRENT_REQUESTS` 
+   When a certain closing condition is met, requests which are
+   currently in the downloader queue (up to :setting:`CONCURRENT_REQUESTS`
    requests) are still processed.
 
 .. setting:: CLOSESPIDER_TIMEOUT
@@ -267,12 +267,23 @@ settings:
 CLOSESPIDER_TIMEOUT
 """""""""""""""""""
 
+Default: ``0.0``
+
+If the spider remains open for more than this number of seconds, it will be
+automatically closed with the reason ``closespider_timeout``. If zero (or non
+set), spiders won't be closed by timeout.
+
+.. setting:: CLOSESPIDER_TIMEOUT_NO_ITEM
+
+CLOSESPIDER_TIMEOUT_NO_ITEM
+"""""""""""""""""""""""""""
+
 Default: ``0``
 
-An integer which specifies a number of seconds. If the spider remains open for
-more than that number of second, it will be automatically closed with the
-reason ``closespider_timeout``. If zero (or non set), spiders won't be closed by
-timeout.
+An integer which specifies a number of seconds. If the spider has not produced
+any items in the last number of seconds, it will be closed with the reason
+``closespider_timeout_no_item``. If zero (or non set), spiders won't be closed
+regardless if it hasn't produced any items.
 
 .. setting:: CLOSESPIDER_ITEMCOUNT
 
@@ -298,6 +309,19 @@ crawls more than that, the spider will be closed with the reason
 ``closespider_pagecount``. If zero (or non set), spiders won't be closed by
 number of crawled responses.
 
+.. setting:: CLOSESPIDER_PAGECOUNT_NO_ITEM
+
+CLOSESPIDER_PAGECOUNT_NO_ITEM
+"""""""""""""""""""""""""""""
+
+Default: ``0``
+
+An integer which specifies the maximum number of consecutive responses to crawl
+without items scraped. If the spider crawls more consecutive responses than that
+and no items are scraped in the meantime, the spider will be closed with the
+reason ``closespider_pagecount_no_item``. If zero (or not set), spiders won't be
+closed by number of crawled responses with no items.
+
 .. setting:: CLOSESPIDER_ERRORCOUNT
 
 CLOSESPIDER_ERRORCOUNT
@@ -310,30 +334,128 @@ closing the spider. If the spider generates more than that number of errors,
 it will be closed with the reason ``closespider_errorcount``. If zero (or non
 set), spiders won't be closed by number of errors.
 
-StatsMailer extension
-~~~~~~~~~~~~~~~~~~~~~
+.. module:: scrapy.extensions.periodic_log
+   :synopsis: Periodic stats logging
 
-.. module:: scrapy.extensions.statsmailer
-   :synopsis: StatsMailer extension
+Periodic log extension
+~~~~~~~~~~~~~~~~~~~~~~
 
-.. class:: StatsMailer
+.. class:: PeriodicLog
 
-This simple extension can be used to send a notification e-mail every time a
-domain has finished scraping, including the Scrapy stats collected. The email
-will be sent to all recipients specified in the :setting:`STATSMAILER_RCPTS`
-setting.
+This extension periodically logs rich stat data as a JSON object::
 
-Emails can be sent using the :class:`~scrapy.mail.MailSender` class. To see a
-full list of parameters, including examples on how to instantiate
-:class:`~scrapy.mail.MailSender` and use mail settings, see
-:ref:`topics-email`.
+    2023-08-04 02:30:57 [scrapy.extensions.logstats] INFO: Crawled 976 pages (at 162 pages/min), scraped 925 items (at 161 items/min)
+    2023-08-04 02:30:57 [scrapy.extensions.periodic_log] INFO: {
+        "delta": {
+            "downloader/request_bytes": 55582,
+            "downloader/request_count": 162,
+            "downloader/request_method_count/GET": 162,
+            "downloader/response_bytes": 618133,
+            "downloader/response_count": 162,
+            "downloader/response_status_count/200": 162,
+            "item_scraped_count": 161
+        },
+        "stats": {
+            "downloader/request_bytes": 338243,
+            "downloader/request_count": 992,
+            "downloader/request_method_count/GET": 992,
+            "downloader/response_bytes": 3836736,
+            "downloader/response_count": 976,
+            "downloader/response_status_count/200": 976,
+            "item_scraped_count": 925,
+            "log_count/INFO": 21,
+            "log_count/WARNING": 1,
+            "scheduler/dequeued": 992,
+            "scheduler/dequeued/memory": 992,
+            "scheduler/enqueued": 1050,
+            "scheduler/enqueued/memory": 1050
+        },
+        "time": {
+            "elapsed": 360.008903,
+            "log_interval": 60.0,
+            "log_interval_real": 60.006694,
+            "start_time": "2023-08-03 23:24:57",
+            "utcnow": "2023-08-03 23:30:57"
+        }
+    }
+
+This extension logs the following configurable sections:
+
+-   ``"delta"`` shows how some numeric stats have changed since the last stats
+    log message.
+
+    The :setting:`PERIODIC_LOG_DELTA` setting determines the target stats. They
+    must have ``int`` or ``float`` values.
+
+-   ``"stats"`` shows the current value of some stats.
+
+    The :setting:`PERIODIC_LOG_STATS` setting determines the target stats.
+
+-   ``"time"`` shows detailed timing data.
+
+    The :setting:`PERIODIC_LOG_TIMING_ENABLED` setting determines whether or
+    not to show this section.
+
+This extension logs data at the start, then on a fixed time interval
+configurable through the :setting:`LOGSTATS_INTERVAL` setting, and finally
+right before the crawl ends.
+
+
+Example extension configuration:
+
+.. code-block:: python
+
+    custom_settings = {
+        "LOG_LEVEL": "INFO",
+        "PERIODIC_LOG_STATS": {
+            "include": ["downloader/", "scheduler/", "log_count/", "item_scraped_count"],
+        },
+        "PERIODIC_LOG_DELTA": {"include": ["downloader/"]},
+        "PERIODIC_LOG_TIMING_ENABLED": True,
+        "EXTENSIONS": {
+            "scrapy.extensions.periodic_log.PeriodicLog": 0,
+        },
+    }
+
+.. setting:: PERIODIC_LOG_DELTA
+
+PERIODIC_LOG_DELTA
+""""""""""""""""""
+
+Default: ``None``
+
+* ``"PERIODIC_LOG_DELTA": True`` - show deltas for all ``int`` and ``float`` stat values.
+* ``"PERIODIC_LOG_DELTA": {"include": ["downloader/", "scheduler/"]}`` - show deltas for stats with names containing any configured substring.
+* ``"PERIODIC_LOG_DELTA": {"exclude": ["downloader/"]}`` - show deltas for all stats with names not containing any configured substring.
+
+.. setting:: PERIODIC_LOG_STATS
+
+PERIODIC_LOG_STATS
+""""""""""""""""""
+
+Default: ``None``
+
+* ``"PERIODIC_LOG_STATS": True`` - show the current value of all stats.
+* ``"PERIODIC_LOG_STATS": {"include": ["downloader/", "scheduler/"]}`` - show current values for stats with names containing any configured substring.
+* ``"PERIODIC_LOG_STATS": {"exclude": ["downloader/"]}`` - show current values for all stats with names not containing any configured substring.
+
+
+.. setting:: PERIODIC_LOG_TIMING_ENABLED
+
+PERIODIC_LOG_TIMING_ENABLED
+"""""""""""""""""""""""""""
+
+Default: ``False``
+
+``True`` enables logging of timing data (i.e. the ``"time"`` section).
 
-.. module:: scrapy.extensions.debug
-   :synopsis: Extensions for debugging Scrapy
 
 Debugging extensions
 --------------------
 
+.. module:: scrapy.extensions.debug
+   :synopsis: Extensions for debugging Scrapy
+
 Stack trace dump extension
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -372,8 +494,4 @@ Invokes a :doc:`Python debugger <library/pdb>` inside a running Scrapy process w
 signal is received. After the debugger is exited, the Scrapy process continues
 running normally.
 
-For more info see `Debugging in Python`_.
-
 This extension only works on POSIX-compliant platforms (i.e. not Windows).
-
-.. _Debugging in Python: https://pythonconquerstheuniverse.wordpress.com/2009/09/10/debugging-in-python/

docs/topics/feed-exports.rst

@@ -13,6 +13,11 @@ Scrapy provides this functionality out of the box with the Feed Exports, which
 allows you to generate feeds with the scraped items, using multiple
 serialization formats and storage backends.
 
+This page provides detailed documentation for all feed export features. If you
+are looking for a step-by-step guide, check out `Zyte’s export guides`_.
+
+.. _Zyte’s export guides: https://docs.zyte.com/web-scraping/guides/export/index.html#exporting-scraped-data
+
 .. _topics-feed-format:
 
 Serialization formats
@@ -58,7 +63,7 @@ CSV
 
 -   Exporter used: :class:`~scrapy.exporters.CsvItemExporter`
 
--   To specify columns to export and their order use
+-   To specify columns to export, their order and their column names, use
     :setting:`FEED_EXPORT_FIELDS`. Other feed exporters can also use this
     option, but it is important for CSV because unlike many other export
     formats CSV uses a fixed header.
@@ -87,7 +92,6 @@ Marshal
 -   Value for the ``format`` key in the :setting:`FEEDS` setting: ``marshal``
 -   Exporter used: :class:`~scrapy.exporters.MarshalItemExporter`
 
-
 .. _topics-feed-storage:
 
 Storages
@@ -101,14 +105,13 @@ The storages backends supported out of the box are:
 
 -   :ref:`topics-feed-storage-fs`
 -   :ref:`topics-feed-storage-ftp`
--   :ref:`topics-feed-storage-s3` (requires botocore_)
--   :ref:`topics-feed-storage-gcs` (requires `google-cloud-storage`_)
+-   :ref:`topics-feed-storage-s3` (requires the :ref:`s3 <extras>` extra)
+-   :ref:`topics-feed-storage-gcs` (requires the :ref:`gcs <extras>` extra)
 -   :ref:`topics-feed-storage-stdout`
 
-Some storage backends may be unavailable if the required external libraries are
-not available. For example, the S3 backend is only available if the botocore_
-library is installed.
-
+Some storage backends may be unavailable if the required :ref:`extras <extras>`
+are not installed. For example, the S3 backend requires the :ref:`s3 <extras>`
+extra.
 
 .. _topics-feed-uri-params:
 
@@ -138,6 +141,11 @@ Here are some examples to illustrate:
 .. note:: :ref:`Spider arguments <spiderargs>` become spider attributes, hence
           they can also be used as storage URI parameters.
 
+.. note:: Only ``%(...)s`` parameters are replaced. Any other percent
+          character is kept as-is, so percent-encoded URIs (e.g. ``%20`` for a
+          space or percent-encoded FTP credentials) and :class:`pathlib.Path`
+          keys containing ``%(...)s`` parameters both work as expected.
+
 
 .. _topics-feed-storage-backends:
 
@@ -156,8 +164,8 @@ The feeds are stored in the local filesystem.
 -   Required external libraries: none
 
 Note that for the local filesystem storage (only) you can omit the scheme if
-you specify an absolute path like ``/tmp/export.csv``. This only works on Unix
-systems though.
+you specify a path (e.g. ``/tmp/export.csv``).
+Alternatively you can also use a :class:`pathlib.Path` object.
 
 .. _topics-feed-storage-ftp:
 
@@ -175,6 +183,12 @@ FTP supports two different connection modes: `active or passive
 mode by default. To use the active connection mode instead, set the
 :setting:`FEED_STORAGE_FTP_ACTIVE` setting to ``True``.
 
+The default value for the ``overwrite`` key in the :setting:`FEEDS` for this
+storage backend is: ``True``.
+
+.. caution:: The value ``True`` in ``overwrite`` will cause you to lose the
+     previous version of your data.
+
 This storage backend uses :ref:`delayed file delivery <delayed-file-delivery>`.
 
 
@@ -193,7 +207,7 @@ The feeds are stored on `Amazon S3`_.
 
     -   ``s3://aws_key:aws_secret@mybucket/path/to/export.csv``
 
--   Required external libraries: `botocore`_ >= 1.4.87
+-   Required extras: :ref:`s3 <extras>`
 
 The AWS credentials can be passed as user/password in the URI, or they can be
 passed through the following settings:
@@ -202,12 +216,21 @@ passed through the following settings:
 -   :setting:`AWS_SECRET_ACCESS_KEY`
 -   :setting:`AWS_SESSION_TOKEN` (only needed for `temporary security credentials`_)
 
-.. _temporary security credentials: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#temporary-access-keys
+.. _temporary security credentials: https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html
 
-You can also define a custom ACL and custom endpoint for exported feeds using this setting:
+You can also define a custom ACL, custom endpoint, region name and connection
+pool size for exported feeds using these settings:
 
 -   :setting:`FEED_STORAGE_S3_ACL`
 -   :setting:`AWS_ENDPOINT_URL`
+-   :setting:`AWS_REGION_NAME`
+-   :setting:`AWS_MAX_POOL_CONNECTIONS`
+
+The default value for the ``overwrite`` key in the :setting:`FEEDS` for this
+storage backend is: ``True``.
+
+.. caution:: The value ``True`` in ``overwrite`` will cause you to lose the
+     previous version of your data.
 
 This storage backend uses :ref:`delayed file delivery <delayed-file-delivery>`.
 
@@ -217,8 +240,6 @@ This storage backend uses :ref:`delayed file delivery <delayed-file-delivery>`.
 Google Cloud Storage (GCS)
 --------------------------
 
-.. versionadded:: 2.3
-
 The feeds are stored on `Google Cloud Storage`_.
 
 -   URI scheme: ``gs``
@@ -227,18 +248,23 @@ The feeds are stored on `Google Cloud Storage`_.
 
     -   ``gs://mybucket/path/to/export.csv``
 
--   Required external libraries: `google-cloud-storage`_.
+-   Required extras: :ref:`gcs <extras>`
 
-For more information about authentication, please refer to `Google Cloud documentation <https://cloud.google.com/docs/authentication/production>`_.
+For more information about authentication, please refer to `Google Cloud documentation <https://docs.cloud.google.com/docs/authentication>`_.
 
 You can set a *Project ID* and *Access Control List (ACL)* through the following settings:
 
 -   :setting:`FEED_STORAGE_GCS_ACL`
 -   :setting:`GCS_PROJECT_ID`
 
+The default value for the ``overwrite`` key in the :setting:`FEEDS` for this
+storage backend is: ``True``.
+
+.. caution:: The value ``True`` in ``overwrite`` will cause you to lose the
+     previous version of your data.
+
 This storage backend uses :ref:`delayed file delivery <delayed-file-delivery>`.
 
-.. _google-cloud-storage: https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python
 
 
 .. _topics-feed-storage-stdout:
@@ -278,8 +304,6 @@ feed URI, allowing item delivery to start way before the end of the crawl.
 Item filtering
 ==============
 
-.. versionadded:: VERSION
-
 You can filter items that you want to allow for a particular feed by using the
 ``item_classes`` option in :ref:`feeds options <feed-options>`. Only items of
 the specified types will be added to the feed.
@@ -290,10 +314,11 @@ class, which is the default value of the ``item_filter`` :ref:`feed option <feed
 You can create your own custom filtering class by implementing :class:`~scrapy.extensions.feedexport.ItemFilter`'s
 method ``accepts`` and taking ``feed_options`` as an argument.
 
-For instance::
+For instance:
+
+.. code-block:: python
 
     class MyCustomFilter:
-
         def __init__(self, feed_options):
             self.feed_options = feed_options
 
@@ -318,11 +343,9 @@ ItemFilter
 Post-Processing
 ===============
 
-.. versionadded:: VERSION
-
 Scrapy provides an option to activate plugins to post-process feeds before they are exported
 to feed storages. In addition to using :ref:`builtin plugins <builtin-plugins>`, you
-can create your own :ref:`plugins <custom-plugins>`. 
+can create your own :ref:`plugins <custom-plugins>`.
 
 These plugins can be activated through the ``postprocessing`` option of a feed.
 The option must be passed a list of post-processing plugins in the order you want
@@ -364,9 +387,15 @@ Each plugin is a class that must implement the following methods:
 
 .. method:: close(self)
 
-    Close the target file object.
+    Clean up the plugin.
 
-To pass a parameter to your plugin, use :ref:`feed options <feed-options>`. You 
+    For example, you might want to close a file wrapper that you might have
+    used to compress data written into the file received in the ``__init__``
+    method.
+
+    .. warning:: Do not close the file from the ``__init__`` method.
+
+To pass a parameter to your plugin, use :ref:`feed options <feed-options>`. You
 can then access those parameters from the ``__init__`` method of your plugin.
 
 
@@ -393,8 +422,6 @@ These are the settings used for configuring the feed exports:
 FEEDS
 -----
 
-.. versionadded:: 2.1
-
 Default: ``{}``
 
 A dictionary in which every key is a feed URI (or a :class:`pathlib.Path`
@@ -405,33 +432,37 @@ This setting is required for enabling the feed export feature.
 
 See :ref:`topics-feed-storage-backends` for supported URI schemes.
 
-For instance::
+For instance:
+
+.. skip: next
+
+.. code-block:: python
 
     {
-        'items.json': {
-            'format': 'json',
-            'encoding': 'utf8',
-            'store_empty': False,
-            'item_classes': [MyItemClass1, 'myproject.items.MyItemClass2'],
-            'fields': None,
-            'indent': 4,
-            'item_export_kwargs': {
-               'export_empty_fields': True,
+        "items.json": {
+            "format": "json",
+            "encoding": "utf8",
+            "store_empty": False,
+            "item_classes": [MyItemClass1, "myproject.items.MyItemClass2"],
+            "fields": None,
+            "indent": 4,
+            "item_export_kwargs": {
+                "export_empty_fields": True,
             },
         },
-        '/home/user/documents/items.xml': {
-            'format': 'xml',
-            'fields': ['name', 'price'],
-            'item_filter': MyCustomFilter1,
-            'encoding': 'latin1',
-            'indent': 8,
+        "/home/user/documents/items.xml": {
+            "format": "xml",
+            "fields": ["name", "price"],
+            "item_filter": MyCustomFilter1,
+            "encoding": "latin1",
+            "indent": 8,
         },
-        pathlib.Path('items.csv.gz'): {
-            'format': 'csv',
-            'fields': ['price', 'name'],
-            'item_filter': 'myproject.filters.MyCustomFilter2',
-            'postprocessing': [MyPlugin1, 'scrapy.extensions.postprocessing.GzipPlugin'],
-            'gzip_compresslevel': 5,
+        pathlib.Path("items.csv.gz"): {
+            "format": "csv",
+            "fields": ["price", "name"],
+            "item_filter": "myproject.filters.MyCustomFilter2",
+            "postprocessing": [MyPlugin1, "scrapy.extensions.postprocessing.GzipPlugin"],
+            "gzip_compresslevel": 5,
         },
     }
 
@@ -447,8 +478,6 @@ as a fallback value if that key is not provided for a specific feed definition:
 -   ``batch_item_count``: falls back to
     :setting:`FEED_EXPORT_BATCH_ITEM_COUNT`.
 
-    .. versionadded:: 2.3.0
-
 -   ``encoding``: falls back to :setting:`FEED_EXPORT_ENCODING`.
 
 -   ``fields``: falls back to :setting:`FEED_EXPORT_FIELDS`.
@@ -457,20 +486,14 @@ as a fallback value if that key is not provided for a specific feed definition:
 
     If undefined or empty, all items are exported.
 
-    .. versionadded:: VERSION
-
 -   ``item_filter``: a :ref:`filter class <item-filter>` to filter items to export.
 
     :class:`~scrapy.extensions.feedexport.ItemFilter` is used be default.
 
-    .. versionadded:: VERSION
-
 -   ``indent``: falls back to :setting:`FEED_EXPORT_INDENT`.
 
 -   ``item_export_kwargs``: :class:`dict` with keyword arguments for the corresponding :ref:`item exporter class <topics-exporters>`.
 
-    .. versionadded:: 2.4.0
-
 -   ``overwrite``: whether to overwrite the file if it already exists
     (``True``) or append to its content (``False``).
 
@@ -484,13 +507,12 @@ as a fallback value if that key is not provided for a specific feed definition:
         .. note:: Some FTP servers may not support appending to files (the
                   ``APPE`` FTP command).
 
-    -   :ref:`topics-feed-storage-s3`: ``True`` (appending `is not supported
-        <https://forums.aws.amazon.com/message.jspa?messageID=540395>`_)
+    -   :ref:`topics-feed-storage-s3`: ``True`` (appending is not supported)
+
+    -   :ref:`topics-feed-storage-gcs`: ``True`` (appending is not supported)
 
     -   :ref:`topics-feed-storage-stdout`: ``False`` (overwriting is not supported)
 
-    .. versionadded:: 2.4.0
-
 -   ``store_empty``: falls back to :setting:`FEED_STORE_EMPTY`.
 
 -   ``uri_params``: falls back to :setting:`FEED_URI_PARAMS`.
@@ -499,21 +521,19 @@ as a fallback value if that key is not provided for a specific feed definition:
 
     The plugins will be used in the order of the list passed.
 
-    .. versionadded:: VERSION
-
 .. setting:: FEED_EXPORT_ENCODING
 
 FEED_EXPORT_ENCODING
 --------------------
 
-Default: ``None``
+Default: ``"utf-8"`` (:ref:`fallback <default-settings>`: ``None``)
 
 The encoding to be used for the feed.
 
-If unset or set to ``None`` (default) it uses UTF-8 for everything except JSON output,
-which uses safe numeric encoding (``\uXXXX`` sequences) for historic reasons.
+If set to ``None``, it uses UTF-8 for everything except JSON output, which uses
+safe numeric encoding (``\uXXXX`` sequences) for historic reasons.
 
-Use ``utf-8`` if you want UTF-8 for JSON too.
+Use ``"utf-8"`` if you want UTF-8 for JSON too.
 
 .. setting:: FEED_EXPORT_FIELDS
 
@@ -522,18 +542,9 @@ FEED_EXPORT_FIELDS
 
 Default: ``None``
 
-A list of fields to export, optional.
-Example: ``FEED_EXPORT_FIELDS = ["foo", "bar", "baz"]``.
-
-Use FEED_EXPORT_FIELDS option to define fields to export and their order.
-
-When FEED_EXPORT_FIELDS is empty or None (default), Scrapy uses the fields
-defined in :ref:`item objects <topics-items>` yielded by your spider.
-
-If an exporter requires a fixed set of fields (this is the case for
-:ref:`CSV <topics-feed-format-csv>` export format) and FEED_EXPORT_FIELDS
-is empty or None, then Scrapy tries to infer field names from the
-exported data - currently it uses field names from the first item.
+Use the ``FEED_EXPORT_FIELDS`` setting to define the fields to export, their
+order and their output names. See :attr:`BaseItemExporter.fields_to_export
+<scrapy.exporters.BaseItemExporter.fields_to_export>` for more information.
 
 .. setting:: FEED_EXPORT_INDENT
 
@@ -556,9 +567,12 @@ to ``.json`` or ``.xml``.
 FEED_STORE_EMPTY
 ----------------
 
-Default: ``False``
+Default: ``True``
 
 Whether to export empty feeds (i.e. feeds with no items).
+If ``False``, and there are no items to export, no new files are created and
+existing files are not modified, even if the :ref:`overwrite feed option
+<feed-options>` is enabled.
 
 .. setting:: FEED_STORAGES
 
@@ -599,23 +613,28 @@ For a complete list of available values, access the `Canned ACL`_ section on Ama
 FEED_STORAGES_BASE
 ------------------
 
-Default::
+Default:
+
+.. code-block:: python
 
     {
-        '': 'scrapy.extensions.feedexport.FileFeedStorage',
-        'file': 'scrapy.extensions.feedexport.FileFeedStorage',
-        'stdout': 'scrapy.extensions.feedexport.StdoutFeedStorage',
-        's3': 'scrapy.extensions.feedexport.S3FeedStorage',
-        'ftp': 'scrapy.extensions.feedexport.FTPFeedStorage',
+        "": "scrapy.extensions.feedexport.FileFeedStorage",
+        "file": "scrapy.extensions.feedexport.FileFeedStorage",
+        "stdout": "scrapy.extensions.feedexport.StdoutFeedStorage",
+        "s3": "scrapy.extensions.feedexport.S3FeedStorage",
+        "gs": "scrapy.extensions.feedexport.GCSFeedStorage",
+        "ftp": "scrapy.extensions.feedexport.FTPFeedStorage",
     }
 
 A dict containing the built-in feed storage backends supported by Scrapy. You
 can disable any of these backends by assigning ``None`` to their URI scheme in
 :setting:`FEED_STORAGES`. E.g., to disable the built-in FTP storage backend
-(without replacement), place this in your ``settings.py``::
+(without replacement), place this in your ``settings.py``:
+
+.. code-block:: python
 
     FEED_STORAGES = {
-        'ftp': None,
+        "ftp": None,
     }
 
 .. setting:: FEED_EXPORTERS
@@ -633,25 +652,30 @@ serialization formats and the values are paths to :ref:`Item exporter
 
 FEED_EXPORTERS_BASE
 -------------------
-Default::
+Default:
+
+.. code-block:: python
 
     {
-        'json': 'scrapy.exporters.JsonItemExporter',
-        'jsonlines': 'scrapy.exporters.JsonLinesItemExporter',
-        'jl': 'scrapy.exporters.JsonLinesItemExporter',
-        'csv': 'scrapy.exporters.CsvItemExporter',
-        'xml': 'scrapy.exporters.XmlItemExporter',
-        'marshal': 'scrapy.exporters.MarshalItemExporter',
-        'pickle': 'scrapy.exporters.PickleItemExporter',
+        "json": "scrapy.exporters.JsonItemExporter",
+        "jsonlines": "scrapy.exporters.JsonLinesItemExporter",
+        "jsonl": "scrapy.exporters.JsonLinesItemExporter",
+        "jl": "scrapy.exporters.JsonLinesItemExporter",
+        "csv": "scrapy.exporters.CsvItemExporter",
+        "xml": "scrapy.exporters.XmlItemExporter",
+        "marshal": "scrapy.exporters.MarshalItemExporter",
+        "pickle": "scrapy.exporters.PickleItemExporter",
     }
 
 A dict containing the built-in feed exporters supported by Scrapy. You can
 disable any of these exporters by assigning ``None`` to their serialization
 format in :setting:`FEED_EXPORTERS`. E.g., to disable the built-in CSV exporter
-(without replacement), place this in your ``settings.py``::
+(without replacement), place this in your ``settings.py``:
+
+.. code-block:: python
 
     FEED_EXPORTERS = {
-        'csv': None,
+        "csv": None,
     }
 
 
@@ -660,8 +684,6 @@ format in :setting:`FEED_EXPORTERS`. E.g., to disable the built-in CSV exporter
 FEED_EXPORT_BATCH_ITEM_COUNT
 ----------------------------
 
-.. versionadded:: 2.3.0
-
 Default: ``0``
 
 If assigned an integer number higher than ``0``, Scrapy generates multiple output files
@@ -681,7 +703,9 @@ generated:
   number by introducing leading zeroes as needed, use ``%(batch_id)05d``
   (e.g. ``3`` becomes ``00003``, ``123`` becomes ``00123``).
 
-For instance, if your settings include::
+For instance, if your settings include:
+
+.. code-block:: python
 
     FEED_EXPORT_BATCH_ITEM_COUNT = 100
 
@@ -729,42 +753,44 @@ The function signature should be as follows:
             If :setting:`FEED_EXPORT_BATCH_ITEM_COUNT` is ``0``, ``batch_id``
             is always ``1``.
 
-            .. versionadded:: 2.3.0
-
         -   ``batch_time``: UTC date and time, in ISO format with ``:``
             replaced with ``-``.
 
             See :setting:`FEED_EXPORT_BATCH_ITEM_COUNT`.
 
-            .. versionadded:: 2.3.0
-
         -   ``time``: ``batch_time``, with microseconds set to ``0``.
    :type params: dict
 
    :param spider: source spider of the feed items
    :type spider: scrapy.Spider
 
+   .. caution:: The function must return a new dictionary instead of modifying
+                the received ``params`` in-place.
+
 For example, to include the :attr:`name <scrapy.Spider.name>` of the
 source spider in the feed URI:
 
-#.  Define the following function somewhere in your project::
+#.  Define the following function somewhere in your project:
+
+    .. code-block:: python
 
         # myproject/utils.py
         def uri_params(params, spider):
-            return {**params, 'spider_name': spider.name}
+            return {**params, "spider_name": spider.name}
 
-#.  Point :setting:`FEED_URI_PARAMS` to that function in your settings::
+#.  Point :setting:`FEED_URI_PARAMS` to that function in your settings:
+
+    .. code-block:: python
 
         # myproject/settings.py
-        FEED_URI_PARAMS = 'myproject.utils.uri_params'
+        FEED_URI_PARAMS = "myproject.utils.uri_params"
 
 #.  Use ``%(spider_name)s`` in your feed URI::
 
-        scrapy crawl <spider_name> -o "%(spider_name)s.jl"
+        scrapy crawl <spider_name> -o "%(spider_name)s.jsonl"
 
 
 .. _URIs: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier
 .. _Amazon S3: https://aws.amazon.com/s3/
-.. _botocore: https://github.com/boto/botocore
-.. _Canned ACL: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
+.. _Canned ACL: https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl
 .. _Google Cloud Storage: https://cloud.google.com/storage/

docs/topics/item-pipeline.rst

@@ -23,102 +23,91 @@ Typical uses of item pipelines are:
 Writing your own item pipeline
 ==============================
 
-Each item pipeline component is a Python class that must implement the following method:
+Each item pipeline is a :ref:`component <topics-components>` that must
+implement the following method:
 
-.. method:: process_item(self, item, spider)
+.. method:: process_item(self, item)
 
    This method is called for every item pipeline component.
 
    `item` is an :ref:`item object <item-types>`, see
    :ref:`supporting-item-types`.
 
-   :meth:`process_item` must either: return an :ref:`item object <item-types>`,
-   return a :class:`~twisted.internet.defer.Deferred` or raise a
-   :exc:`~scrapy.exceptions.DropItem` exception.
+   :meth:`process_item` must either return an :ref:`item object <item-types>`
+   or raise a :exc:`~scrapy.exceptions.DropItem` exception.
 
    Dropped items are no longer processed by further pipeline components.
 
    :param item: the scraped item
    :type item: :ref:`item object <item-types>`
 
-   :param spider: the spider which scraped the item
-   :type spider: :class:`~scrapy.Spider` object
-
 Additionally, they may also implement the following methods:
 
-.. method:: open_spider(self, spider)
+.. method:: open_spider(self)
 
    This method is called when the spider is opened.
 
-   :param spider: the spider which was opened
-   :type spider: :class:`~scrapy.Spider` object
-
-.. method:: close_spider(self, spider)
+.. method:: close_spider(self)
 
    This method is called when the spider is closed.
 
-   :param spider: the spider which was closed
-   :type spider: :class:`~scrapy.Spider` object
-
-.. method:: from_crawler(cls, crawler)
-
-   If present, this classmethod is called to create a pipeline instance
-   from a :class:`~scrapy.crawler.Crawler`. It must return a new instance
-   of the pipeline. Crawler object provides access to all Scrapy core
-   components like settings and signals; it is a way for pipeline to
-   access them and hook its functionality into Scrapy.
-
-   :param crawler: crawler that uses this pipeline
-   :type crawler: :class:`~scrapy.crawler.Crawler` object
+Any of these methods may be defined as a coroutine function (``async def``).
 
 
 Item pipeline example
 =====================
 
+.. _price-pipeline-example:
+
 Price validation and dropping items with no prices
 --------------------------------------------------
 
 Let's take a look at the following hypothetical pipeline that adjusts the
 ``price`` attribute for those items that do not include VAT
 (``price_excludes_vat`` attribute), and drops those items which don't
-contain a price::
+contain a price:
+
+.. code-block:: python
 
     from itemadapter import ItemAdapter
     from scrapy.exceptions import DropItem
-    class PricePipeline:
 
+
+    class PricePipeline:
         vat_factor = 1.15
 
-        def process_item(self, item, spider):
+        def process_item(self, item):
             adapter = ItemAdapter(item)
-            if adapter.get('price'):
-                if adapter.get('price_excludes_vat'):
-                    adapter['price'] = adapter['price'] * self.vat_factor
+            if adapter.get("price"):
+                if adapter.get("price_excludes_vat"):
+                    adapter["price"] = adapter["price"] * self.vat_factor
                 return item
             else:
-                raise DropItem(f"Missing price in {item}")
+                raise DropItem("Missing price")
 
 
-Write items to a JSON file
---------------------------
+Write items to a JSON lines file
+--------------------------------
 
 The following pipeline stores all scraped items (from all spiders) into a
-single ``items.jl`` file, containing one item per line serialized in JSON
-format::
+single ``items.jsonl`` file, containing one item per line serialized in JSON
+format:
+
+.. code-block:: python
 
    import json
 
    from itemadapter import ItemAdapter
 
+
    class JsonWriterPipeline:
+       def open_spider(self):
+           self.file = open("items.jsonl", "w")
 
-       def open_spider(self, spider):
-           self.file = open('items.jl', 'w')
-
-       def close_spider(self, spider):
+       def close_spider(self):
            self.file.close()
 
-       def process_item(self, item, spider):
+       def process_item(self, item):
            line = json.dumps(ItemAdapter(item).asdict()) + "\n"
            self.file.write(line)
            return item
@@ -132,17 +121,20 @@ Write items to MongoDB
 
 In this example we'll write items to MongoDB_ using pymongo_.
 MongoDB address and database name are specified in Scrapy settings;
-MongoDB collection is named after item class.
+MongoDB collection is specified in a class attribute.
 
-The main point of this example is to show how to use :meth:`from_crawler`
-method and how to clean up the resources properly.::
+The main point of this example is to show how to :ref:`get the crawler
+<from-crawler>` and how to clean up the resources properly.
+
+.. skip: next
+.. code-block:: python
 
     import pymongo
     from itemadapter import ItemAdapter
 
-    class MongoPipeline:
 
-        collection_name = 'scrapy_items'
+    class MongoPipeline:
+        collection_name = "scrapy_items"
 
         def __init__(self, mongo_uri, mongo_db):
             self.mongo_uri = mongo_uri
@@ -151,23 +143,23 @@ method and how to clean up the resources properly.::
         @classmethod
         def from_crawler(cls, crawler):
             return cls(
-                mongo_uri=crawler.settings.get('MONGO_URI'),
-                mongo_db=crawler.settings.get('MONGO_DATABASE', 'items')
+                mongo_uri=crawler.settings.get("MONGO_URI"),
+                mongo_db=crawler.settings.get("MONGO_DATABASE", "items"),
             )
 
-        def open_spider(self, spider):
+        def open_spider(self):
             self.client = pymongo.MongoClient(self.mongo_uri)
             self.db = self.client[self.mongo_db]
 
-        def close_spider(self, spider):
+        def close_spider(self):
             self.client.close()
 
-        def process_item(self, item, spider):
+        def process_item(self, item):
             self.db[self.collection_name].insert_one(ItemAdapter(item).asdict())
             return item
 
 .. _MongoDB: https://www.mongodb.com/
-.. _pymongo: https://api.mongodb.com/python/current/
+.. _pymongo: https://pymongo.readthedocs.io/en/stable/
 
 
 .. _ScreenshotPipeline:
@@ -183,14 +175,15 @@ render a screenshot of the item URL. After the request response is downloaded,
 the item pipeline saves the screenshot to a file and adds the filename to the
 item.
 
-::
+.. code-block:: python
 
     import hashlib
+    from pathlib import Path
     from urllib.parse import quote
 
     import scrapy
     from itemadapter import ItemAdapter
-    from scrapy.utils.defer import maybe_deferred_to_future
+    from scrapy.http.request import NO_CALLBACK
 
 
     class ScreenshotPipeline:
@@ -199,12 +192,19 @@ item.
 
         SPLASH_URL = "http://localhost:8050/render.png?url={}"
 
-        async def process_item(self, item, spider):
+        def __init__(self, crawler):
+            self.crawler = crawler
+
+        @classmethod
+        def from_crawler(cls, crawler):
+            return cls(crawler)
+
+        async def process_item(self, item):
             adapter = ItemAdapter(item)
             encoded_item_url = quote(adapter["url"])
             screenshot_url = self.SPLASH_URL.format(encoded_item_url)
-            request = scrapy.Request(screenshot_url)
-            response = await maybe_deferred_to_future(spider.crawler.engine.download(request, spider))
+            request = scrapy.Request(screenshot_url, callback=NO_CALLBACK)
+            response = await self.crawler.engine.download_async(request)
 
             if response.status != 200:
                 # Error happened, return item.
@@ -214,8 +214,7 @@ item.
             url = adapter["url"]
             url_hash = hashlib.md5(url.encode("utf8")).hexdigest()
             filename = f"{url_hash}.png"
-            with open(filename, "wb") as f:
-                f.write(response.body)
+            Path(filename).write_bytes(response.body)
 
             # Store filename in item.
             adapter["screenshot_filename"] = filename
@@ -228,37 +227,179 @@ Duplicates filter
 
 A filter that looks for duplicate items, and drops those items that were
 already processed. Let's say that our items have a unique id, but our spider
-returns multiples items with the same id::
+returns multiples items with the same id:
 
+.. code-block:: python
 
     from itemadapter import ItemAdapter
     from scrapy.exceptions import DropItem
 
-    class DuplicatesPipeline:
 
+    class DuplicatesPipeline:
         def __init__(self):
             self.ids_seen = set()
 
-        def process_item(self, item, spider):
+        def process_item(self, item):
             adapter = ItemAdapter(item)
-            if adapter['id'] in self.ids_seen:
-                raise DropItem(f"Duplicate item found: {item!r}")
+            if adapter["id"] in self.ids_seen:
+                raise DropItem(f"Item ID already seen: {adapter['id']}")
             else:
-                self.ids_seen.add(adapter['id'])
+                self.ids_seen.add(adapter["id"])
                 return item
 
 
+.. _activating-item-pipeline:
+
 Activating an Item Pipeline component
 =====================================
 
 To activate an Item Pipeline component you must add its class to the
-:setting:`ITEM_PIPELINES` setting, like in the following example::
+:setting:`ITEM_PIPELINES` setting, like in the following example:
+
+.. code-block:: python
 
    ITEM_PIPELINES = {
-       'myproject.pipelines.PricePipeline': 300,
-       'myproject.pipelines.JsonWriterPipeline': 800,
+       "myproject.pipelines.PricePipeline": 300,
+       "myproject.pipelines.JsonWriterPipeline": 800,
    }
 
 The integer values you assign to classes in this setting determine the
 order in which they run: items go through from lower valued to higher
 valued classes. It's customary to define these numbers in the 0-1000 range.
+
+A complete example
+==================
+
+The examples above show item pipeline components on their own. In a project, a
+pipeline is one of four pieces that work together: the :ref:`item
+<topics-items>` your spider produces, the :ref:`spider <topics-spiders>` that
+yields it, the pipeline that processes it, and the :setting:`ITEM_PIPELINES`
+setting that enables the pipeline.
+
+The following example wires those pieces together to validate the price of
+books scraped from `books.toscrape.com`_, reusing the ``PricePipeline`` from
+:ref:`price-pipeline-example` above.
+
+Define the item in ``myproject/items.py``:
+
+.. code-block:: python
+
+    from dataclasses import dataclass
+
+
+    @dataclass
+    class BookItem:
+        title: str
+        price: float
+
+Yield instances of that item from your spider, e.g. in
+``myproject/spiders/books.py``:
+
+.. skip: next
+.. code-block:: python
+
+    import scrapy
+
+    from myproject.items import BookItem
+
+
+    class BooksSpider(scrapy.Spider):
+        name = "books"
+        start_urls = ["https://books.toscrape.com/"]
+
+        def parse(self, response):
+            for book in response.css("article.product_pod"):
+                yield BookItem(
+                    title=book.css("h3 a::attr(title)").get(),
+                    price=float(book.css("p.price_color::text").re_first(r"[\d.]+")),
+                )
+
+Put the ``PricePipeline`` shown earlier in ``myproject/pipelines.py``, and
+enable it in ``myproject/settings.py``:
+
+.. code-block:: python
+
+    ITEM_PIPELINES = {
+        "myproject.pipelines.PricePipeline": 300,
+    }
+
+With these pieces in place, every ``BookItem`` that ``BooksSpider`` yields
+passes through ``PricePipeline`` before it reaches the :ref:`feed exports
+<topics-feed-exports>` or any other output.
+
+.. _books.toscrape.com: https://books.toscrape.com/
+
+
+.. _test-item-pipeline:
+
+Testing an item pipeline
+========================
+
+To send the items from a single URL through your item pipelines, use the
+:command:`parse` command with the ``--pipelines`` option::
+
+    scrapy parse --pipelines "https://books.toscrape.com/"
+
+To test specific item data instead, add a callback that builds an item out of
+its keyword arguments:
+
+.. skip: next
+.. code-block:: python
+
+    class BooksSpider(scrapy.Spider):
+        # ...
+
+        def parse_item(self, response, **fields):
+            yield BookItem(**fields)
+
+and pass those keyword arguments in the command line::
+
+    scrapy parse --pipelines -c parse_item --cbkwargs '{"title": "Test", "price": 10}' "https://books.toscrape.com/"
+
+Pass any URL that your spider handles; it is downloaded even though the
+callback ignores it.
+
+
+Common pitfalls
+===============
+
+The pipeline does not run
+-------------------------
+
+A pipeline component only runs if its class is listed in the
+:setting:`ITEM_PIPELINES` setting, normally in your project's
+:file:`settings.py` file (see :ref:`activating-item-pipeline`). Adding it to
+the spider or elsewhere has no effect.
+
+To confirm that Scrapy loaded your pipeline, look for a line like this near the
+start of the crawl log::
+
+    [scrapy.middleware] INFO: Enabled item pipelines:
+    ['myproject.pipelines.PricePipeline']
+
+If your pipeline is missing from that list, check that its import path matches
+the :setting:`ITEM_PIPELINES` entry, and that the setting is not being
+overridden, for example by :attr:`~scrapy.Spider.custom_settings` or by a
+redefinition of :setting:`ITEM_PIPELINES` in :file:`settings.py`.
+
+The item is not returned
+------------------------
+
+:meth:`process_item` must return the item (or raise
+:exc:`~scrapy.exceptions.DropItem`). A common mistake is to modify the item but
+forget to return it:
+
+.. code-block:: python
+
+    def process_item(self, item):
+        ItemAdapter(item)["price"] *= 1.15
+        # Bug: returns None, so the next component gets None instead of the item.
+
+Return the item so that the next component, and the rest of Scrapy, can keep
+processing it:
+
+.. code-block:: python
+
+    def process_item(self, item):
+        ItemAdapter(item)["price"] *= 1.15
+        return item

docs/topics/items.rst

@@ -23,7 +23,8 @@ Item Types
 
 Scrapy supports the following types of items, via the `itemadapter`_ library:
 :ref:`dictionaries <dict-items>`, :ref:`Item objects <item-objects>`,
-:ref:`dataclass objects <dataclass-items>`, and :ref:`attrs objects <attrs-items>`.
+:ref:`dataclass objects <dataclass-items>`, :ref:`attrs objects <attrs-items>`
+and :ref:`Pydantic models <pydantic-items>`.
 
 .. _itemadapter: https://github.com/scrapy/itemadapter
 
@@ -42,44 +43,35 @@ Item objects
 :class:`Item` provides a :class:`dict`-like API plus additional features that
 make it the most feature-complete item type:
 
-.. class:: scrapy.item.Item([arg])
-.. class:: scrapy.Item([arg])
+.. autoclass:: scrapy.Item
+   :members: copy, deepcopy, fields
+   :undoc-members:
 
-    :class:`Item` objects replicate the standard :class:`dict` API, including
-    its ``__init__`` method.
+:class:`Item` objects replicate the standard :class:`dict` API, including
+its ``__init__`` method.
 
-    :class:`Item` allows defining field names, so that:
+:class:`Item` allows the defining of field names, so that:
 
-    -   :class:`KeyError` is raised when using undefined field names (i.e.
-        prevents typos going unnoticed)
+-   :class:`KeyError` is raised when using undefined field names (i.e.
+    prevents typos going unnoticed)
 
-    -   :ref:`Item exporters <topics-exporters>` can export all fields by
-        default even if the first scraped object does not have values for all
-        of them
+-   :ref:`Item exporters <topics-exporters>` can export all fields by
+    default even if the first scraped object does not have values for all
+    of them
 
-    :class:`Item` also allows defining field metadata, which can be used to
-    :ref:`customize serialization <topics-exporters-field-serialization>`.
+:class:`Item` also allows the defining of field metadata, which can be used to
+:ref:`customize serialization <topics-exporters-field-serialization>`.
 
-    :mod:`trackref` tracks :class:`Item` objects to help find memory leaks
-    (see :ref:`topics-leaks-trackrefs`).
+:mod:`scrapy.utils.trackref` tracks :class:`Item` objects to help find memory
+leaks (see :ref:`topics-leaks-trackrefs`).
 
-    :class:`Item` objects also provide the following additional API members:
+Example:
 
-    .. automethod:: copy
-
-    .. automethod:: deepcopy
-
-    .. attribute:: fields
-
-        A dictionary containing *all declared fields* for this Item, not only
-        those populated. The keys are the field names and the values are the
-        :class:`Field` objects used in the :ref:`Item declaration
-        <topics-items-declaring>`.
-
-Example::
+.. code-block:: python
 
     from scrapy.item import Item, Field
 
+
     class CustomItem(Item):
         one_field = Field()
         another_field = Field()
@@ -89,28 +81,24 @@ Example::
 Dataclass objects
 -----------------
 
-.. versionadded:: 2.2
-
-:func:`~dataclasses.dataclass` allows defining item classes with field names,
+:func:`~dataclasses.dataclass` allows the defining of item classes with field names,
 so that :ref:`item exporters <topics-exporters>` can export all fields by
 default even if the first scraped object does not have values for all of them.
 
-Additionally, ``dataclass`` items also allow to:
+Additionally, ``dataclass`` items also allow you to:
 
 * define the type and default value of each defined field.
 
 * define custom field metadata through :func:`dataclasses.field`, which can be used to
   :ref:`customize serialization <topics-exporters-field-serialization>`.
 
-They work natively in Python 3.7 or later, or using the `dataclasses
-backport`_ in Python 3.6.
+Example:
 
-.. _dataclasses backport: https://pypi.org/project/dataclasses/
-
-Example::
+.. code-block:: python
 
     from dataclasses import dataclass
 
+
     @dataclass
     class CustomItem:
         one_field: str
@@ -123,9 +111,7 @@ Example::
 attr.s objects
 --------------
 
-.. versionadded:: 2.2
-
-:func:`attr.s` allows defining item classes with field names,
+:func:`attr.s` allows the defining of item classes with field names,
 so that :ref:`item exporters <topics-exporters>` can export all fields by
 default even if the first scraped object does not have values for all of them.
 
@@ -138,16 +124,58 @@ Additionally, ``attr.s`` items also allow to:
 
 In order to use this type, the :doc:`attrs package <attrs:index>` needs to be installed.
 
-Example::
+Example:
+
+.. code-block:: python
 
     import attr
 
+
     @attr.s
     class CustomItem:
         one_field = attr.ib()
         another_field = attr.ib()
 
 
+.. _pydantic-items:
+
+Pydantic models
+---------------
+
+`Pydantic <https://docs.pydantic.dev/>`_ models allow the defining of item
+classes with field names, so that :ref:`item exporters <topics-exporters>` can
+export all fields by default even if the first scraped object does not have
+values for all of them.
+
+Additionally, ``pydantic`` items also allow you to:
+
+* define the type and default value of each defined field with run-time type
+  validation.
+
+* define custom field metadata through `pydantic.Field
+  <https://docs.pydantic.dev/latest/concepts/fields/>`_, which can be used to
+  :ref:`customize serialization <topics-exporters-field-serialization>`.
+
+* benefit from automatic data validation and conversion based on type
+  annotations.
+
+In order to use this type, the `pydantic package <https://docs.pydantic.dev/>`_
+needs to be installed.
+
+Example:
+
+.. code-block:: python
+
+    from pydantic import BaseModel, Field
+
+
+    class CustomItem(BaseModel):
+        one_field: str = Field(default="", description="First field")
+        another_field: int = Field(default=0, description="Second field")
+
+.. note:: Unlike other item types, Pydantic models enforce field types at
+    run time and will raise validation errors for invalid data types.
+
 Working with Item objects
 =========================
 
@@ -157,10 +185,13 @@ Declaring Item subclasses
 -------------------------
 
 Item subclasses are declared using a simple class definition syntax and
-:class:`Field` objects. Here is an example::
+:class:`Field` objects. Here is an example:
+
+.. code-block:: python
 
     import scrapy
 
+
     class Product(scrapy.Item):
         name = scrapy.Field()
         price = scrapy.Field()
@@ -198,10 +229,9 @@ documentation to see which metadata keys are used by each component.
 
 It's important to note that the :class:`Field` objects used to declare the item
 do not stay assigned as class attributes. Instead, they can be accessed through
-the :attr:`Item.fields` attribute.
+the :attr:`~scrapy.Item.fields` attribute.
 
-.. class:: scrapy.item.Field([arg])
-.. class:: scrapy.Field([arg])
+.. autoclass:: scrapy.Field
 
     The :class:`Field` class is just an alias to the built-in :class:`dict` class and
     doesn't provide any extra functionality or attributes. In other words,
@@ -214,12 +244,14 @@ the :attr:`Item.fields` attribute.
     `attr.ib`_ for additional information.
 
     .. _dataclasses.field: https://docs.python.org/3/library/dataclasses.html#dataclasses.field
-    .. _attr.ib: https://www.attrs.org/en/stable/api.html#attr.ib
+    .. _attr.ib: https://www.attrs.org/en/stable/api-attr.html#attr.ib
 
 
 Working with Item objects
 -------------------------
 
+.. skip: start
+
 Here are some examples of common tasks performed with items, using the
 ``Product`` item :ref:`declared above  <topics-items-declaring>`. You will
 notice the API is very similar to the :class:`dict` API.
@@ -227,62 +259,68 @@ notice the API is very similar to the :class:`dict` API.
 Creating items
 ''''''''''''''
 
->>> product = Product(name='Desktop PC', price=1000)
->>> print(product)
-Product(name='Desktop PC', price=1000)
+.. code-block:: pycon
+
+    >>> product = Product(name="Desktop PC", price=1000)
+    >>> print(product)
+    {'name': 'Desktop PC', 'price': 1000}
 
 
 Getting field values
 ''''''''''''''''''''
 
->>> product['name']
-Desktop PC
->>> product.get('name')
-Desktop PC
+.. code-block:: pycon
 
->>> product['price']
-1000
+    >>> product["name"]
+    Desktop PC
+    >>> product.get("name")
+    Desktop PC
 
->>> product['last_updated']
-Traceback (most recent call last):
-    ...
-KeyError: 'last_updated'
+    >>> product["price"]
+    1000
 
->>> product.get('last_updated', 'not set')
-not set
+    >>> product["last_updated"]
+    Traceback (most recent call last):
+        ...
+    KeyError: 'last_updated'
 
->>> product['lala'] # getting unknown field
-Traceback (most recent call last):
-    ...
-KeyError: 'lala'
+    >>> product.get("last_updated", "not set")
+    not set
 
->>> product.get('lala', 'unknown field')
-'unknown field'
+    >>> product["lala"]  # getting unknown field
+    Traceback (most recent call last):
+        ...
+    KeyError: 'lala'
 
->>> 'name' in product  # is name field populated?
-True
+    >>> product.get("lala", "unknown field")
+    'unknown field'
 
->>> 'last_updated' in product  # is last_updated populated?
-False
+    >>> "name" in product  # is name field populated?
+    True
 
->>> 'last_updated' in product.fields  # is last_updated a declared field?
-True
+    >>> "last_updated" in product  # is last_updated populated?
+    False
 
->>> 'lala' in product.fields  # is lala a declared field?
-False
+    >>> "last_updated" in product.fields  # is last_updated a declared field?
+    True
+
+    >>> "lala" in product.fields  # is lala a declared field?
+    False
 
 
 Setting field values
 ''''''''''''''''''''
 
->>> product['last_updated'] = 'today'
->>> product['last_updated']
-today
+.. code-block:: pycon
 
->>> product['lala'] = 'test' # setting unknown field
-Traceback (most recent call last):
-    ...
-KeyError: 'Product does not support field: lala'
+    >>> product["last_updated"] = "today"
+    >>> product["last_updated"]
+    today
+
+    >>> product["lala"] = "test"  # setting unknown field
+    Traceback (most recent call last):
+        ...
+    KeyError: 'Product does not support field: lala'
 
 
 Accessing all populated values
@@ -290,11 +328,13 @@ Accessing all populated values
 
 To access all populated values, just use the typical :class:`dict` API:
 
->>> product.keys()
-['price', 'name']
+.. code-block:: pycon
 
->>> product.items()
-[('price', 1000), ('name', 'Desktop PC')]
+    >>> product.keys()
+    ['price', 'name']
+
+    >>> product.items()
+    [('price', 1000), ('name', 'Desktop PC')]
 
 
 .. _copying-items:
@@ -332,18 +372,22 @@ Other common tasks
 
 Creating dicts from items:
 
->>> dict(product) # create a dict from all populated values
-{'price': 1000, 'name': 'Desktop PC'}
+.. code-block:: pycon
+
+    >>> dict(product)  # create a dict from all populated values
+    {'price': 1000, 'name': 'Desktop PC'}
 
 Creating items from dicts:
 
->>> Product({'name': 'Laptop PC', 'price': 1500})
-Product(price=1500, name='Laptop PC')
+.. code-block:: pycon
 
->>> Product({'name': 'Laptop PC', 'lala': 1500}) # warning: unknown field in dict
-Traceback (most recent call last):
-    ...
-KeyError: 'Product does not support field: lala'
+    >>> Product({"name": "Laptop PC", "price": 1500})
+    {'name': 'Laptop PC', 'price': 1500}
+
+    >>> Product({"name": "Laptop PC", "lala": 1500})  # warning: unknown field in dict
+    Traceback (most recent call last):
+        ...
+    KeyError: 'Product does not support field: lala'
 
 
 Extending Item subclasses
@@ -352,21 +396,27 @@ Extending Item subclasses
 You can extend Items (to add more fields or to change some metadata for some
 fields) by declaring a subclass of your original Item.
 
-For example::
+For example:
+
+.. code-block:: python
 
     class DiscountedProduct(Product):
         discount_percent = scrapy.Field(serializer=str)
         discount_expiration_date = scrapy.Field()
 
 You can also extend field metadata by using the previous field metadata and
-appending more values, or changing existing values, like this::
+appending more values, or changing existing values, like this:
+
+.. code-block:: python
 
     class SpecificProduct(Product):
-        name = scrapy.Field(Product.fields['name'], serializer=my_serializer)
+        name = scrapy.Field(Product.fields["name"], serializer=my_serializer)
 
 That adds (or replaces) the ``serializer`` metadata key for the ``name`` field,
 keeping all the previously existing metadata values.
 
+.. skip: end
+
 
 .. _supporting-item-types:
 
@@ -376,14 +426,8 @@ Supporting All Item Types
 In code that receives an item, such as methods of :ref:`item pipelines
 <topics-item-pipeline>` or :ref:`spider middlewares
 <topics-spider-middleware>`, it is a good practice to use the
-:class:`~itemadapter.ItemAdapter` class and the
-:func:`~itemadapter.is_item` function to write code that works for
-any :ref:`supported item type <item-types>`:
-
-.. autoclass:: itemadapter.ItemAdapter
-
-.. autofunction:: itemadapter.is_item
-
+:class:`~itemadapter.ItemAdapter` class to write code that works for any
+supported item type.
 
 Other classes related to items
 ==============================

docs/topics/jobs.rst

@@ -17,15 +17,25 @@ facilities:
 * an extension that keeps some spider state (key/value pairs) persistent
   between batches
 
+.. _job-dir:
+
 Job directory
 =============
 
-To enable persistence support you just need to define a *job directory* through
-the ``JOBDIR`` setting. This directory will be for storing all required data to
-keep the state of a single job (i.e. a spider run).  It's important to note that
-this directory must not be shared by different spiders, or even different
-jobs/runs of the same spider, as it's meant to be used for storing the state of
-a *single* job.
+To enable persistence support, define a *job directory* through the
+:setting:`JOBDIR` setting.
+
+The job directory will store all required data to keep the state of a *single*
+job (i.e. a spider run), so that if stopped cleanly, it can be resumed later.
+
+.. warning:: This directory must *not* be shared by different spiders, or even
+    different jobs of the same spider.
+
+.. warning:: Treat the job directory with the same security care as your
+    Scrapy project source code. Do not point ``JOBDIR`` to a path that
+    untrusted parties can write to.
+
+See also :ref:`job-dir-contents`.
 
 How to use it
 =============
@@ -46,16 +56,18 @@ Keeping persistent state between batches
 
 Sometimes you'll want to keep some persistent spider state between pause/resume
 batches. You can use the ``spider.state`` attribute for that, which should be a
-dict. There's a built-in extension that takes care of serializing, storing and
-loading that attribute from the job directory, when the spider starts and
-stops.
+dict. There's :ref:`a built-in extension <topics-extensions-ref-spiderstate>`
+that takes care of serializing, storing and loading that attribute from the job
+directory, when the spider starts and stops.
 
 Here's an example of a callback that uses the spider state (other spider code
-is omitted for brevity)::
+is omitted for brevity):
+
+.. code-block:: python
 
     def parse_item(self, response):
         # parse item here
-        self.state['items_count'] = self.state.get('items_count', 0) + 1
+        self.state["items_count"] = self.state.get("items_count", 0) + 1
 
 Persistence gotchas
 ===================
@@ -63,6 +75,22 @@ Persistence gotchas
 There are a few things to keep in mind if you want to be able to use the Scrapy
 persistence support:
 
+Pause limitations
+-----------------
+
+Job pausing and resuming is only supported when the spider is paused by
+stopping it cleanly. Forced, sudden or otherwise unclean shutdown can lead to
+data corruption in the job directory, which may prevent the spider from
+resuming correctly.
+
+Scrapy version changes
+----------------------
+
+The contents of a job directory are an implementation detail of the Scrapy
+version that wrote them. A job must be resumed with the same Scrapy version
+that paused it; after upgrading or downgrading Scrapy, start a new job with a
+new job directory.
+
 Cookies expiration
 ------------------
 
@@ -70,17 +98,78 @@ Cookies may expire. So, if you don't resume your spider quickly the requests
 scheduled may no longer work. This won't be an issue if your spider doesn't rely
 on cookies.
 
-
 .. _request-serialization:
 
 Request serialization
 ---------------------
 
 For persistence to work, :class:`~scrapy.Request` objects must be
-serializable with :mod:`pickle`, except for the ``callback`` and ``errback``
-values passed to their ``__init__`` method, which must be methods of the
-running :class:`~scrapy.Spider` class.
+serializable with :mod:`pickle`, except for the :ref:`callback
+<callbacks>` and :ref:`errback
+<errbacks>` values passed to their ``__init__``
+method, which must be methods of the running :class:`~scrapy.Spider` class.
+
+Requests that cannot be serialized are kept in memory only: they are still
+sent, but they are lost when the crawl is paused.
 
 If you wish to log the requests that couldn't be serialized, you can set the
 :setting:`SCHEDULER_DEBUG` setting to ``True`` in the project's settings page.
 It is ``False`` by default.
+
+.. note:: Because requests are serialized with :mod:`pickle`, the objects you
+    store on a request, such as the values of its
+    :attr:`~scrapy.Request.cb_kwargs` and :attr:`~scrapy.Request.meta`
+    dictionaries, are deep-copied when the request is written to and later read
+    back from the job directory. As a result, the callback receives a *copy* of
+    those objects rather than the original ones, and changes made to the copy are
+    not reflected in the original object. Keep this in mind if you rely on
+    sharing mutable state through ``cb_kwargs`` or ``meta``.
+
+.. _job-dir-contents:
+
+Job directory contents
+======================
+
+The contents of a job directory depend on the components used during the job.
+Components known to write in the job directory include the :ref:`scheduler
+<topics-scheduler>` and the :class:`~scrapy.extensions.spiderstate.SpiderState`
+extension. See the reference documentation of the corresponding components for
+details.
+
+For example, with default settings, the job directory may look like this:
+
+.. code-block:: none
+
+    ├── requests.queue
+    |   ├── active.json
+    |   └── {hostname}-{hash}
+    |       └── {priority}{s?}
+    |           ├── q{00000}
+    |           └── info.json
+    ├── requests.seen
+    └── spider.state
+
+Where:
+
+-   :class:`~scrapy.core.scheduler.Scheduler` creates the ``requests.queue/``
+    directory and the ``active.json`` file, the latter containing the state
+    data returned by :meth:`DownloaderAwarePriorityQueue.close()
+    <scrapy.pqueues.DownloaderAwarePriorityQueue.close>` the last time the job
+    was paused.
+
+-   :class:`~scrapy.pqueues.DownloaderAwarePriorityQueue` creates the
+    ``{hostname}-{hash}`` directories.
+
+-   :class:`~scrapy.pqueues.ScrapyPriorityQueue` creates the ``{priority}{s?}``
+    directories.
+
+-   :class:`scrapy.squeues.PickleFifoDiskQueue`, a subclass of
+    :class:`queuelib.FifoDiskQueue` that uses :mod:`pickle` to serialize
+    :class:`dict` representations of :class:`scrapy.Request` objects, creates
+    the ``info.json`` and ``q{00000}`` files.
+
+-   :class:`~scrapy.dupefilters.RFPDupeFilter` creates the ``requests.seen``
+    file.
+
+-   :class:`~scrapy.extensions.spiderstate.SpiderState` creates the
+    ``spider.state`` file.

docs/topics/leaks.rst

@@ -60,23 +60,29 @@ in control.
 Debugging memory leaks with ``trackref``
 ========================================
 
-:mod:`trackref` is a module provided by Scrapy to debug the most common cases of
-memory leaks. It basically tracks the references to all live Request,
-Response, Item, Spider and Selector objects.
+.. skip: start
+
+:mod:`scrapy.utils.trackref` is a module provided by Scrapy to debug the most
+common cases of memory leaks. It basically tracks the references to all live
+Request, Response, Item, Spider and Selector objects.
 
 You can enter the telnet console and inspect how many objects (of the classes
 mentioned above) are currently alive using the ``prefs()`` function which is an
-alias to the :func:`~scrapy.utils.trackref.print_live_refs` function::
+alias to the :func:`~scrapy.utils.trackref.print_live_refs` function:
+
+.. code-block:: bash
 
     telnet localhost 6023
 
+.. code-block:: pycon
+
     >>> prefs()
     Live References
 
     ExampleSpider                       1   oldest: 15s ago
     HtmlResponse                       10   oldest: 1s ago
     Selector                            2   oldest: 0s ago
-    FormRequest                       878   oldest: 7s ago
+    Request                           878   oldest: 7s ago
 
 As you can see, that report also shows the "age" of the oldest object in each
 class. If you're running multiple spiders per process chances are you can
@@ -87,7 +93,7 @@ You can get the oldest object of each class using the
 Which objects are tracked?
 --------------------------
 
-The objects tracked by ``trackrefs`` are all from these classes (and all its
+The objects tracked by ``trackref`` are all from these classes (and all its
 subclasses):
 
 * :class:`scrapy.Request`
@@ -100,10 +106,15 @@ A real example
 --------------
 
 Let's see a concrete example of a hypothetical case of memory leaks.
-Suppose we have some spider with a line similar to this one::
+Suppose we have some spider with a line similar to this one:
 
-    return Request(f"http://www.somenastyspider.com/product.php?pid={product_id}",
-                   callback=self.parse, cb_kwargs={'referer': response})
+.. code-block:: python
+
+    return Request(
+        f"http://www.somenastyspider.com/product.php?pid={product_id}",
+        callback=self.parse,
+        cb_kwargs={"referer": response},
+    )
 
 That line is passing a response reference inside a request which effectively
 ties the response lifetime to the requests' one, and that would definitely
@@ -114,7 +125,9 @@ a priori, of course) by using the ``trackref`` tool.
 
 After the crawler is running for a few minutes and we notice its memory usage
 has grown a lot, we can enter its telnet console and check the live
-references::
+references:
+
+.. code-block:: pycon
 
     >>> prefs()
     Live References
@@ -134,31 +147,37 @@ generating the leaks (passing response references inside requests).
 Sometimes extra information about live objects can be helpful.
 Let's check the oldest response:
 
->>> from scrapy.utils.trackref import get_oldest
->>> r = get_oldest('HtmlResponse')
->>> r.url
-'http://www.somenastyspider.com/product.php?pid=123'
+.. code-block:: pycon
+
+    >>> from scrapy.utils.trackref import get_oldest
+    >>> r = get_oldest("HtmlResponse")
+    >>> r.url
+    'http://www.somenastyspider.com/product.php?pid=123'
 
 If you want to iterate over all objects, instead of getting the oldest one, you
 can use the :func:`scrapy.utils.trackref.iter_all` function:
 
->>> from scrapy.utils.trackref import iter_all
->>> [r.url for r in iter_all('HtmlResponse')]
-['http://www.somenastyspider.com/product.php?pid=123',
- 'http://www.somenastyspider.com/product.php?pid=584',
-...]
+.. code-block:: pycon
+
+    >>> from scrapy.utils.trackref import iter_all
+    >>> [r.url for r in iter_all("HtmlResponse")]
+    ['http://www.somenastyspider.com/product.php?pid=123',
+    'http://www.somenastyspider.com/product.php?pid=584',
+    ...]
 
 Too many spiders?
 -----------------
 
 If your project has too many spiders executed in parallel,
-the output of :func:`prefs()` can be difficult to read.
+the output of ``prefs()`` can be difficult to read.
 For this reason, that function has a ``ignore`` argument which can be used to
-ignore a particular class (and all its subclases). For
+ignore a particular class (and all its subclasses). For
 example, this won't show any live references to spiders:
 
->>> from scrapy.spiders import Spider
->>> prefs(ignore=Spider)
+.. code-block:: pycon
+
+    >>> from scrapy.spiders import Spider
+    >>> prefs(ignore=Spider)
 
 .. module:: scrapy.utils.trackref
    :synopsis: Track references of live objects
@@ -168,30 +187,15 @@ scrapy.utils.trackref module
 
 Here are the functions available in the :mod:`~scrapy.utils.trackref` module.
 
-.. class:: object_ref
+.. autoclass:: object_ref
 
-    Inherit from this class if you want to track live
-    instances with the ``trackref`` module.
+.. autofunction:: print_live_refs(ignore=NoneType)
 
-.. function:: print_live_refs(class_name, ignore=NoneType)
+.. autofunction:: get_oldest
 
-    Print a report of live references, grouped by class name.
+.. autofunction:: iter_all
 
-    :param ignore: if given, all objects from the specified class (or tuple of
-        classes) will be ignored.
-    :type ignore: type or tuple
-
-.. function:: get_oldest(class_name)
-
-    Return the oldest object alive with the given class name, or ``None`` if
-    none is found. Use :func:`print_live_refs` first to get a list of all
-    tracked live objects per class name.
-
-.. function:: iter_all(class_name)
-
-    Return an iterator over all objects alive with the given class name, or
-    ``None`` if none is found. Use :func:`print_live_refs` first to get a list
-    of all tracked live objects per class name.
+.. skip: end
 
 .. _topics-leaks-muppy:
 
@@ -216,30 +220,35 @@ If you use ``pip``, you can install muppy with the following command::
 Here's an example to view all Python objects available in
 the heap using muppy:
 
->>> from pympler import muppy
->>> all_objects = muppy.get_objects()
->>> len(all_objects)
-28667
->>> from pympler import summary
->>> suml = summary.summarize(all_objects)
->>> summary.print_(suml)
-                               types |   # objects |   total size
-==================================== | =========== | ============
-                         <class 'str |        9822 |      1.10 MB
-                        <class 'dict |        1658 |    856.62 KB
-                        <class 'type |         436 |    443.60 KB
-                        <class 'code |        2974 |    419.56 KB
-          <class '_io.BufferedWriter |           2 |    256.34 KB
-                         <class 'set |         420 |    159.88 KB
-          <class '_io.BufferedReader |           1 |    128.17 KB
-          <class 'wrapper_descriptor |        1130 |     88.28 KB
-                       <class 'tuple |        1304 |     86.57 KB
-                     <class 'weakref |        1013 |     79.14 KB
-  <class 'builtin_function_or_method |         958 |     67.36 KB
-           <class 'method_descriptor |         865 |     60.82 KB
-                 <class 'abc.ABCMeta |          62 |     59.96 KB
-                        <class 'list |         446 |     58.52 KB
-                         <class 'int |        1425 |     43.20 KB
+.. skip: start
+.. code-block:: pycon
+
+    >>> from pympler import muppy
+    >>> all_objects = muppy.get_objects()
+    >>> len(all_objects)
+    28667
+    >>> from pympler import summary
+    >>> suml = summary.summarize(all_objects)
+    >>> summary.print_(suml)
+                                   types |   # objects |   total size
+    ==================================== | =========== | ============
+                             <class 'str |        9822 |      1.10 MB
+                            <class 'dict |        1658 |    856.62 KB
+                            <class 'type |         436 |    443.60 KB
+                            <class 'code |        2974 |    419.56 KB
+              <class '_io.BufferedWriter |           2 |    256.34 KB
+                             <class 'set |         420 |    159.88 KB
+              <class '_io.BufferedReader |           1 |    128.17 KB
+              <class 'wrapper_descriptor |        1130 |     88.28 KB
+                           <class 'tuple |        1304 |     86.57 KB
+                         <class 'weakref |        1013 |     79.14 KB
+      <class 'builtin_function_or_method |         958 |     67.36 KB
+               <class 'method_descriptor |         865 |     60.82 KB
+                     <class 'abc.ABCMeta |          62 |     59.96 KB
+                            <class 'list |         446 |     58.52 KB
+                             <class 'int |        1425 |     43.20 KB
+
+.. skip: end
 
 For more info about muppy, refer to the `muppy documentation`_.
 

docs/topics/link-extractors.rst

@@ -18,7 +18,9 @@ through a set of :class:`~scrapy.spiders.Rule` objects.
 
 You can also use link extractors in regular spiders. For example, you can instantiate
 :class:`LinkExtractor <scrapy.linkextractors.lxmlhtml.LxmlLinkExtractor>` into a class
-variable in your spider, and use it from your spider callbacks::
+variable in your spider, and use it from your spider callbacks:
+
+.. code-block:: python
 
     def parse(self, response):
         for link in self.link_extractor.extract_links(response):
@@ -34,7 +36,9 @@ Link extractor reference
 
 The link extractor class is
 :class:`scrapy.linkextractors.lxmlhtml.LxmlLinkExtractor`. For convenience it
-can also be imported as ``scrapy.linkextractors.LinkExtractor``::
+can also be imported as ``scrapy.linkextractors.LinkExtractor``:
+
+.. code-block:: python
 
     from scrapy.linkextractors import LinkExtractor
 
@@ -45,110 +49,7 @@ LxmlLinkExtractor
    :synopsis: lxml's HTMLParser-based link extractors
 
 
-.. class:: LxmlLinkExtractor(allow=(), deny=(), allow_domains=(), deny_domains=(), deny_extensions=None, restrict_xpaths=(), restrict_css=(), tags=('a', 'area'), attrs=('href',), canonicalize=False, unique=True, process_value=None, strip=True)
-
-    LxmlLinkExtractor is the recommended link extractor with handy filtering
-    options. It is implemented using lxml's robust HTMLParser.
-
-    :param allow: a single regular expression (or list of regular expressions)
-        that the (absolute) urls must match in order to be extracted. If not
-        given (or empty), it will match all links.
-    :type allow: str or list
-
-    :param deny: a single regular expression (or list of regular expressions)
-        that the (absolute) urls must match in order to be excluded (i.e. not
-        extracted). It has precedence over the ``allow`` parameter. If not
-        given (or empty) it won't exclude any links.
-    :type deny: str or list
-
-    :param allow_domains: a single value or a list of string containing
-        domains which will be considered for extracting the links
-    :type allow_domains: str or list
-
-    :param deny_domains: a single value or a list of strings containing
-        domains which won't be considered for extracting the links
-    :type deny_domains: str or list
-
-    :param deny_extensions: a single value or list of strings containing
-        extensions that should be ignored when extracting links.
-        If not given, it will default to
-        :data:`scrapy.linkextractors.IGNORED_EXTENSIONS`.
-
-        .. versionchanged:: 2.0
-           :data:`~scrapy.linkextractors.IGNORED_EXTENSIONS` now includes
-           ``7z``, ``7zip``, ``apk``, ``bz2``, ``cdr``, ``dmg``, ``ico``,
-           ``iso``, ``tar``, ``tar.gz``, ``webm``, and ``xz``.
-    :type deny_extensions: list
-
-    :param restrict_xpaths: is an XPath (or list of XPath's) which defines
-        regions inside the response where links should be extracted from.
-        If given, only the text selected by those XPath will be scanned for
-        links. See examples below.
-    :type restrict_xpaths: str or list
-
-    :param restrict_css: a CSS selector (or list of selectors) which defines
-        regions inside the response where links should be extracted from.
-        Has the same behaviour as ``restrict_xpaths``.
-    :type restrict_css: str or list
-
-    :param restrict_text: a single regular expression (or list of regular expressions)
-        that the link's text must match in order to be extracted. If not
-        given (or empty), it will match all links. If a list of regular expressions is
-        given, the link will be extracted if it matches at least one.
-    :type restrict_text: str or list
-
-    :param tags: a tag or a list of tags to consider when extracting links.
-        Defaults to ``('a', 'area')``.
-    :type tags: str or list
-
-    :param attrs: an attribute or list of attributes which should be considered when looking
-        for links to extract (only for those tags specified in the ``tags``
-        parameter). Defaults to ``('href',)``
-    :type attrs: list
-
-    :param canonicalize: canonicalize each extracted url (using
-        w3lib.url.canonicalize_url). Defaults to ``False``.
-        Note that canonicalize_url is meant for duplicate checking;
-        it can change the URL visible at server side, so the response can be
-        different for requests with canonicalized and raw URLs. If you're
-        using LinkExtractor to follow links it is more robust to
-        keep the default ``canonicalize=False``.
-    :type canonicalize: bool
-
-    :param unique: whether duplicate filtering should be applied to extracted
-        links.
-    :type unique: bool
-
-    :param process_value: a function which receives each value extracted from
-        the tag and attributes scanned and can modify the value and return a
-        new one, or return ``None`` to ignore the link altogether. If not
-        given, ``process_value`` defaults to ``lambda x: x``.
-
-        .. highlight:: html
-
-        For example, to extract links from this code::
-
-            <a href="javascript:goToPage('../other/page.html'); return false">Link text</a>
-
-        .. highlight:: python
-
-        You can use the following function in ``process_value``::
-
-            def process_value(value):
-                m = re.search("javascript:goToPage\('(.*?)'", value)
-                if m:
-                    return m.group(1)
-
-    :type process_value: collections.abc.Callable
-
-    :param strip: whether to strip whitespaces from extracted attributes.
-        According to HTML5 standard, leading and trailing whitespaces
-        must be stripped from ``href`` attributes of ``<a>``, ``<area>``
-        and many other elements, ``src`` attribute of ``<img>``, ``<iframe>``
-        elements, etc., so LinkExtractor strips space chars by default.
-        Set ``strip=False`` to turn it off (e.g. if you're extracting urls
-        from elements or attributes which allow leading/trailing whitespaces).
-    :type strip: bool
+.. autoclass:: LxmlLinkExtractor
 
     .. automethod:: extract_links
 
@@ -159,5 +60,3 @@ Link
    :synopsis: Link from link extractors
 
 .. autoclass:: Link
-
-.. _scrapy.linkextractors: https://github.com/scrapy/scrapy/blob/master/scrapy/linkextractors/__init__.py

docs/topics/loaders.rst

@@ -46,18 +46,22 @@ using a proper processing function.
 
 Here is a typical Item Loader usage in a :ref:`Spider <topics-spiders>`, using
 the :ref:`Product item <topics-items-declaring>` declared in the :ref:`Items
-chapter <topics-items>`::
+chapter <topics-items>`:
+
+.. skip: next
+.. code-block:: python
 
     from scrapy.loader import ItemLoader
     from myproject.items import Product
 
+
     def parse(self, response):
         l = ItemLoader(item=Product(), response=response)
-        l.add_xpath('name', '//div[@class="product_name"]')
-        l.add_xpath('name', '//div[@class="product_title"]')
-        l.add_xpath('price', '//p[@id="price"]')
-        l.add_css('stock', 'p#stock')
-        l.add_value('last_updated', 'today') # you can also use literal values
+        l.add_xpath("name", '//div[@class="product_name"]')
+        l.add_xpath("name", '//div[@class="product_title"]')
+        l.add_xpath("price", '//p[@id="price"]')
+        l.add_css("stock", "p#stock")
+        l.add_value("last_updated", "today")  # you can also use literal values
         return l.load_item()
 
 By quickly looking at that code, we can see the ``name`` field is being
@@ -72,7 +76,7 @@ data that will be assigned to the ``name`` field later.
 
 Afterwards, similar calls are used for ``price`` and ``stock`` fields
 (the latter using a CSS selector with the :meth:`~ItemLoader.add_css` method),
-and finally the ``last_update`` field is populated directly with a literal value
+and finally the ``last_updated`` field is populated directly with a literal value
 (``today``) using a different method: :meth:`~ItemLoader.add_value`.
 
 Finally, when all data is collected, the :meth:`ItemLoader.load_item` method is
@@ -93,16 +97,18 @@ will be populated incrementally using the loader's :meth:`~ItemLoader.add_xpath`
 :meth:`~ItemLoader.add_css` and :meth:`~ItemLoader.add_value` methods.
 
 One approach to overcome this is to define items using the
-:func:`~dataclasses.field` function, with a ``default`` argument::
+:func:`~dataclasses.field` function, with a ``default`` argument:
+
+.. code-block:: python
 
     from dataclasses import dataclass, field
-    from typing import Optional
+
 
     @dataclass
     class InventoryItem:
-        name: Optional[str] = field(default=None)
-        price: Optional[float] = field(default=None)
-        stock: Optional[int] = field(default=None)
+        name: str | None = field(default=None)
+        price: float | None = field(default=None)
+        stock: int | None = field(default=None)
 
 
 .. _topics-loaders-processors:
@@ -122,14 +128,17 @@ processor). The result of the output processor is the final value that gets
 assigned to the item.
 
 Let's see an example to illustrate how the input and output processors are
-called for a particular field (the same applies for any other field)::
+called for a particular field (the same applies for any other field):
+
+.. skip: next
+.. code-block:: python
 
     l = ItemLoader(Product(), some_selector)
-    l.add_xpath('name', xpath1) # (1)
-    l.add_xpath('name', xpath2) # (2)
-    l.add_css('name', css) # (3)
-    l.add_value('name', 'test') # (4)
-    return l.load_item() # (5)
+    l.add_xpath("name", xpath1)  # (1)
+    l.add_xpath("name", xpath2)  # (2)
+    l.add_css("name", css)  # (3)
+    l.add_value("name", "test")  # (4)
+    return l.load_item()  # (5)
 
 So what happens is:
 
@@ -164,9 +173,6 @@ with the data to be parsed, and return a parsed value. So you can use any
 function as input or output processor. The only requirement is that they must
 accept one (and only one) positional argument, which will be an iterable.
 
-.. versionchanged:: 2.0
-   Processors no longer need to be methods.
-
 .. note:: Both input and output processors must receive an iterable as their
    first argument. The output of those functions can be anything. The result of
    input processors will be appended to an internal list (in the Loader)
@@ -184,13 +190,15 @@ processors <itemloaders:built-in-processors>` built-in for convenience.
 Declaring Item Loaders
 ======================
 
-Item Loaders are declared using a class definition syntax. Here is an example::
+Item Loaders are declared using a class definition syntax. Here is an example:
+
+.. code-block:: python
 
     from itemloaders.processors import TakeFirst, MapCompose, Join
     from scrapy.loader import ItemLoader
 
-    class ProductLoader(ItemLoader):
 
+    class ProductLoader(ItemLoader):
         default_output_processor = TakeFirst()
 
         name_in = MapCompose(str.title)
@@ -215,40 +223,58 @@ As seen in the previous section, input and output processors can be declared in
 the Item Loader definition, and it's very common to declare input processors
 this way. However, there is one more place where you can specify the input and
 output processors to use: in the :ref:`Item Field <topics-items-fields>`
-metadata. Here is an example::
+metadata. Here is an example:
+
+.. code-block:: python
+
+    from dataclasses import dataclass, field
 
-    import scrapy
     from itemloaders.processors import Join, MapCompose, TakeFirst
     from w3lib.html import remove_tags
 
+
     def filter_price(value):
         if value.isdigit():
             return value
 
-    class Product(scrapy.Item):
-        name = scrapy.Field(
-            input_processor=MapCompose(remove_tags),
-            output_processor=Join(),
+
+    @dataclass
+    class Product:
+        name: str | None = field(
+            default=None,
+            metadata={
+                "input_processor": MapCompose(remove_tags),
+                "output_processor": Join(),
+            },
         )
-        price = scrapy.Field(
-            input_processor=MapCompose(remove_tags, filter_price),
-            output_processor=TakeFirst(),
+        price: str | None = field(
+            default=None,
+            metadata={
+                "input_processor": MapCompose(remove_tags, filter_price),
+                "output_processor": TakeFirst(),
+            },
         )
 
->>> from scrapy.loader import ItemLoader
->>> il = ItemLoader(item=Product())
->>> il.add_value('name', ['Welcome to my', '<strong>website</strong>'])
->>> il.add_value('price', ['&euro;', '<span>1000</span>'])
->>> il.load_item()
-{'name': 'Welcome to my website', 'price': '1000'}
+
+.. skip: start
+.. code-block:: pycon
+
+    >>> from scrapy.loader import ItemLoader
+    >>> il = ItemLoader(item=Product())
+    >>> il.add_value("name", ["Welcome to my", "<strong>website</strong>"])
+    >>> il.add_value("price", ["&euro;", "<span>1000</span>"])
+    >>> il.load_item()
+    Product(name='Welcome to my website', price='1000')
+
+.. skip: end
 
 The precedence order, for both input and output processors, is as follows:
 
 1. Item Loader field-specific attributes: ``field_in`` and ``field_out`` (most
    precedence)
 2. Field metadata (``input_processor`` and ``output_processor`` key)
-3. Item Loader defaults: :meth:`ItemLoader.default_input_processor` and
-   :meth:`ItemLoader.default_output_processor` (least precedence)
+3. Item Loader defaults: :attr:`ItemLoader.default_input_processor` and
+   :attr:`ItemLoader.default_output_processor` (least precedence)
 
 See also: :ref:`topics-loaders-extending`.
 
@@ -263,10 +289,12 @@ declaring, instantiating or using Item Loader. They are used to modify the
 behaviour of the input/output processors.
 
 For example, suppose you have a function ``parse_length`` which receives a text
-value and extracts a length from it::
+value and extracts a length from it:
+
+.. code-block:: python
 
     def parse_length(text, loader_context):
-        unit = loader_context.get('unit', 'm')
+        unit = loader_context.get("unit", "m")
         # ... length parsing code goes here ...
         return parsed_length
 
@@ -275,25 +303,35 @@ the Item Loader that it's able to receive an Item Loader context, so the Item
 Loader passes the currently active context when calling it, and the processor
 function (``parse_length`` in this case) can thus use them.
 
+.. skip: start
+
 There are several ways to modify Item Loader context values:
 
 1. By modifying the currently active Item Loader context
-   (:attr:`~ItemLoader.context` attribute)::
+   (:attr:`~ItemLoader.context` attribute):
+
+   .. code-block:: python
 
       loader = ItemLoader(product)
-      loader.context['unit'] = 'cm'
+      loader.context["unit"] = "cm"
 
 2. On Item Loader instantiation (the keyword arguments of Item Loader
-   ``__init__`` method are stored in the Item Loader context)::
+   ``__init__`` method are stored in the Item Loader context):
 
-      loader = ItemLoader(product, unit='cm')
+   .. code-block:: python
+
+      loader = ItemLoader(product, unit="cm")
 
 3. On Item Loader declaration, for those input/output processors that support
-   instantiating them with an Item Loader context. :class:`~processor.MapCompose` is one of
-   them::
+   instantiating them with an Item Loader context.
+   :class:`~itemloaders.processors.MapCompose` is one of them:
+
+   .. code-block:: python
 
        class ProductLoader(ItemLoader):
-           length_out = MapCompose(parse_length, unit='cm')
+           length_out = MapCompose(parse_length, unit="cm")
+
+.. skip: end
 
 
 ItemLoader objects
@@ -312,7 +350,9 @@ When parsing related values from a subsection of a document, it can be
 useful to create nested loaders.  Imagine you're extracting details from
 a footer of a page that looks something like:
 
-Example::
+Example:
+
+.. code-block:: html
 
     <footer>
         <a class="social" href="https://facebook.com/whatever">Like Us</a>
@@ -323,25 +363,31 @@ Example::
 Without nested loaders, you need to specify the full xpath (or css) for each value
 that you wish to extract.
 
-Example::
+Example:
+
+.. skip: next
+.. code-block:: python
 
     loader = ItemLoader(item=Item())
     # load stuff not in the footer
-    loader.add_xpath('social', '//footer/a[@class = "social"]/@href')
-    loader.add_xpath('email', '//footer/a[@class = "email"]/@href')
+    loader.add_xpath("social", '//footer/a[@class = "social"]/@href')
+    loader.add_xpath("email", '//footer/a[@class = "email"]/@href')
     loader.load_item()
 
 Instead, you can create a nested loader with the footer selector and add values
 relative to the footer.  The functionality is the same but you avoid repeating
 the footer selector.
 
-Example::
+Example:
+
+.. skip: next
+.. code-block:: python
 
     loader = ItemLoader(item=Item())
     # load stuff not in the footer
-    footer_loader = loader.nested_xpath('//footer')
-    footer_loader.add_xpath('social', 'a[@class = "social"]/@href')
-    footer_loader.add_xpath('email', 'a[@class = "email"]/@href')
+    footer_loader = loader.nested_xpath("//footer")
+    footer_loader.add_xpath("social", 'a[@class = "social"]/@href')
+    footer_loader.add_xpath("email", 'a[@class = "email"]/@href')
     # no need to call footer_loader.load_item()
     loader.load_item()
 
@@ -370,25 +416,34 @@ three dashes (e.g. ``---Plasma TV---``) and you don't want to end up scraping
 those dashes in the final product names.
 
 Here's how you can remove those dashes by reusing and extending the default
-Product Item Loader (``ProductLoader``)::
+Product Item Loader (``ProductLoader``):
+
+.. skip: next
+.. code-block:: python
 
     from itemloaders.processors import MapCompose
     from myproject.ItemLoaders import ProductLoader
 
+
     def strip_dashes(x):
-        return x.strip('-')
+        return x.strip("-")
+
 
     class SiteSpecificLoader(ProductLoader):
         name_in = MapCompose(strip_dashes, ProductLoader.name_in)
 
 Another case where extending Item Loaders can be very helpful is when you have
 multiple source formats, for example XML and HTML. In the XML version you may
-want to remove ``CDATA`` occurrences. Here's an example of how to do it::
+want to remove ``CDATA`` occurrences. Here's an example of how to do it:
+
+.. skip: next
+.. code-block:: python
 
     from itemloaders.processors import MapCompose
     from myproject.ItemLoaders import ProductLoader
     from myproject.utils.xml import remove_cdata
 
+
     class XmlProductLoader(ProductLoader):
         name_in = MapCompose(remove_cdata, ProductLoader.name_in)
 
@@ -406,4 +461,3 @@ organization of your Loaders collection - that's up to you and your project's
 needs.
 
 .. _itemloaders: https://itemloaders.readthedocs.io/en/latest/
-.. _processors: https://itemloaders.readthedocs.io/en/latest/built-in-processors.html

docs/topics/logging.rst

@@ -4,11 +4,6 @@
 Logging
 =======
 
-.. note::
-    :mod:`scrapy.log` has been deprecated alongside its functions in favor of
-    explicit calls to the Python standard logging. Keep reading to learn more
-    about the new logging system.
-
 Scrapy uses :mod:`logging` for event logging. We'll
 provide some simple examples to get you started, but for more advanced
 use-cases it's strongly suggested to read thoroughly its documentation.
@@ -39,16 +34,22 @@ How to log messages
 ===================
 
 Here's a quick example of how to log a message using the ``logging.WARNING``
-level::
+level:
+
+.. code-block:: python
 
     import logging
+
     logging.warning("This is a warning")
 
 There are shortcuts for issuing log messages on any of the standard 5 levels,
 and there's also a general ``logging.log`` method which takes a given level as
-argument.  If needed, the last example could be rewritten as::
+argument.  If needed, the last example could be rewritten as:
+
+.. code-block:: python
 
     import logging
+
     logging.log(logging.WARNING, "This is a warning")
 
 On top of that, you can create different "loggers" to encapsulate messages. (For
@@ -59,24 +60,33 @@ constructions.
 The previous examples use the root logger behind the scenes, which is a top level
 logger where all messages are propagated to (unless otherwise specified). Using
 ``logging`` helpers is merely a shortcut for getting the root logger
-explicitly, so this is also an equivalent of the last snippets::
+explicitly, so this is also an equivalent of the last snippets:
+
+.. code-block:: python
 
     import logging
+
     logger = logging.getLogger()
     logger.warning("This is a warning")
 
 You can use a different logger just by getting its name with the
-``logging.getLogger`` function::
+``logging.getLogger`` function:
+
+.. code-block:: python
 
     import logging
-    logger = logging.getLogger('mycustomlogger')
+
+    logger = logging.getLogger("mycustomlogger")
     logger.warning("This is a warning")
 
 Finally, you can ensure having a custom logger for any module you're working on
 by using the ``__name__`` variable, which is populated with current module's
-path::
+path:
+
+.. code-block:: python
 
     import logging
+
     logger = logging.getLogger(__name__)
     logger.warning("This is a warning")
 
@@ -94,33 +104,37 @@ Logging from Spiders
 ====================
 
 Scrapy provides a :data:`~scrapy.Spider.logger` within each Spider
-instance, which can be accessed and used like this::
+instance, which can be accessed and used like this:
+
+.. code-block:: python
 
     import scrapy
 
-    class MySpider(scrapy.Spider):
 
-        name = 'myspider'
-        start_urls = ['https://scrapy.org']
+    class MySpider(scrapy.Spider):
+        name = "myspider"
+        start_urls = ["https://scrapy.org"]
 
         def parse(self, response):
-            self.logger.info('Parse function called on %s', response.url)
+            self.logger.info("Parse function called on %s", response.url)
 
 That logger is created using the Spider's name, but you can use any custom
-Python logger you want. For example::
+Python logger you want. For example:
+
+.. code-block:: python
 
     import logging
     import scrapy
 
-    logger = logging.getLogger('mycustomlogger')
+    logger = logging.getLogger("mycustomlogger")
+
 
     class MySpider(scrapy.Spider):
-
-        name = 'myspider'
-        start_urls = ['https://scrapy.org']
+        name = "myspider"
+        start_urls = ["https://scrapy.org"]
 
         def parse(self, response):
-            logger.info('Parse function called on %s', response.url)
+            logger.info("Parse function called on %s", response.url)
 
 .. _topics-logging-configuration:
 
@@ -175,6 +189,48 @@ If :setting:`LOG_SHORT_NAMES` is set, then the logs will not display the Scrapy
 component that prints the log. It is unset by default, hence logs contain the
 Scrapy component responsible for that log output.
 
+Rotating log files
+------------------
+
+Scrapy's :setting:`LOG_FILE` setting writes logs to a single file. It does not
+rotate log files automatically, but you can use Python's standard
+:mod:`logging.handlers` module when running Scrapy from a script.
+
+For example, to rotate the log file every day:
+
+.. skip: next
+
+.. code-block:: python
+
+    import logging
+    from logging.handlers import TimedRotatingFileHandler
+
+    from scrapy.crawler import CrawlerProcess
+    from scrapy.utils.project import get_project_settings
+
+    from myproject.spiders.myspider import MySpider
+
+    settings = get_project_settings()
+    process = CrawlerProcess(settings, install_root_handler=False)
+
+    handler = TimedRotatingFileHandler(
+        "scrapy.log",
+        when="midnight",
+        backupCount=7,
+        encoding=settings.get("LOG_ENCODING"),
+    )
+    handler.setFormatter(
+        logging.Formatter(settings.get("LOG_FORMAT"), settings.get("LOG_DATEFORMAT"))
+    )
+
+    root_logger = logging.getLogger()
+    root_logger.setLevel(settings.get("LOG_LEVEL"))
+    root_logger.addHandler(handler)
+
+    process.crawl(MySpider)
+    process.start()
+
+
 Command-line options
 --------------------
 
@@ -218,7 +274,7 @@ For example, let's say you're scraping a website which returns many
 HTTP 404 and 500 responses, and you want to hide all messages like this::
 
     2016-12-16 22:00:06 [scrapy.spidermiddlewares.httperror] INFO: Ignoring
-    response <500 http://quotes.toscrape.com/page/1-34/>: HTTP status code
+    response <500 https://quotes.toscrape.com/page/1-34/>: HTTP status code
     is not handled or not allowed
 
 The first thing to note is a logger name - it is in brackets:
@@ -229,7 +285,9 @@ the crawl.
 Next, we can see that the message has INFO level. To hide it
 we should set logging level for ``scrapy.spidermiddlewares.httperror``
 higher than INFO; next level after INFO is WARNING. It could be done
-e.g. in the spider's ``__init__`` method::
+e.g. in the spider's ``__init__`` method:
+
+.. code-block:: python
 
     import logging
     import scrapy
@@ -238,54 +296,64 @@ e.g. in the spider's ``__init__`` method::
     class MySpider(scrapy.Spider):
         # ...
         def __init__(self, *args, **kwargs):
-            logger = logging.getLogger('scrapy.spidermiddlewares.httperror')
+            logger = logging.getLogger("scrapy.spidermiddlewares.httperror")
             logger.setLevel(logging.WARNING)
             super().__init__(*args, **kwargs)
 
 If you run this spider again then INFO messages from
 ``scrapy.spidermiddlewares.httperror`` logger will be gone.
 
-You can also filter log records by :class:`~logging.LogRecord` data. For 
+You can also filter log records by :class:`~logging.LogRecord` data. For
 example, you can filter log records by message content using a substring or
-a regular expression. Create a :class:`logging.Filter` subclass 
+a regular expression. Create a :class:`logging.Filter` subclass
 and equip it with a regular expression pattern to
-filter out unwanted messages::
+filter out unwanted messages:
+
+.. code-block:: python
 
     import logging
     import re
-    
+
+
     class ContentFilter(logging.Filter):
         def filter(self, record):
-            match = re.search(r'\d{3} [Ee]rror, retrying', record.message)
+            match = re.search(r"\d{3} [Ee]rror, retrying", record.message)
             if match:
                 return False
-                
-A project-level filter may be attached to the root 
-handler created by Scrapy, this is a wieldy way to 
+
+A project-level filter may be attached to the root
+handler created by Scrapy, this is a wieldy way to
 filter all loggers in different parts of the project
-(middlewares, spider, etc.)::
+(middlewares, spider, etc.):
+
+.. code-block:: python
+
+ import logging
+ import scrapy
+
+
+ class MySpider(scrapy.Spider):
+     # ...
+     def __init__(self, *args, **kwargs):
+         for handler in logging.root.handlers:
+             handler.addFilter(ContentFilter())
+
+Alternatively, you may choose a specific logger
+and hide it without affecting other loggers:
+
+.. code-block:: python
 
     import logging
     import scrapy
 
-    class MySpider(scrapy.Spider):
-        # ...
-        def __init__(self, *args, **kwargs):
-            for handler in logging.root.handlers:
-                handler.addFilter(ContentFilter())
- 
-Alternatively, you may choose a specific logger 
-and hide it without affecting other loggers::
 
-    import logging
-    import scrapy
-    
     class MySpider(scrapy.Spider):
         # ...
         def __init__(self, *args, **kwargs):
-            logger = logging.getLogger('my_logger')
+            logger = logging.getLogger("my_logger")
             logger.addFilter(ContentFilter())
-            
+
+
 scrapy.utils.log module
 =======================
 
@@ -306,14 +374,14 @@ scrapy.utils.log module
     so it is recommended to only use :func:`logging.basicConfig` together with
     :class:`~scrapy.crawler.CrawlerRunner`.
 
-    This is an example on how to redirect ``INFO`` or higher messages to a file::
+    This is an example on how to redirect ``INFO`` or higher messages to a file:
+
+    .. code-block:: python
 
         import logging
 
         logging.basicConfig(
-            filename='log.txt',
-            format='%(levelname)s: %(message)s',
-            level=logging.INFO
+            filename="log.txt", format="%(levelname)s: %(message)s", level=logging.INFO
         )
 
     Refer to :ref:`run-from-script` for more details about using Scrapy this

docs/topics/media-pipeline.rst

@@ -41,11 +41,10 @@ this:
 2. The item is returned from the spider and goes to the item pipeline.
 
 3. When the item reaches the :class:`FilesPipeline`, the URLs in the
-   ``file_urls`` field are scheduled for download using the standard
-   Scrapy scheduler and downloader (which means the scheduler and downloader
-   middlewares are reused), but with a higher priority, processing them before other
-   pages are scraped. The item remains "locked" at that particular pipeline stage
-   until the files have finish downloading (or fail for some reason).
+   ``file_urls`` field are downloaded using the standard Scrapy downloader
+   (which means the downloader middlewares are used, but the spider middlewares
+   aren't). The item remains "locked" at that particular pipeline stage until
+   the files have finished downloading (or failed for some reason).
 
 4. When the files are downloaded, another field (``files``) will be populated
    with the results. This field will contain a list of dicts with information
@@ -61,6 +60,8 @@ this:
 Using the Images Pipeline
 =========================
 
+.. note:: Requires the :ref:`images <extras>` extra.
+
 Using the :class:`ImagesPipeline` is a lot like using the :class:`FilesPipeline`,
 except the default field names used are different: you use ``image_urls`` for
 the image URLs of an item and it will populate an ``images`` field for the information
@@ -70,46 +71,47 @@ The advantage of using the :class:`ImagesPipeline` for image files is that you
 can configure some extra functions like generating thumbnails and filtering
 the images based on their size.
 
-The Images Pipeline requires Pillow_ 4.0.0 or greater. It is used for
-thumbnailing and normalizing images to JPEG/RGB format.
-
-.. _Pillow: https://github.com/python-pillow/Pillow
-
-
 .. _topics-media-pipeline-enabling:
 
 Enabling your Media Pipeline
 ============================
 
-.. setting:: IMAGES_STORE
-.. setting:: FILES_STORE
-
 To enable your media pipeline you must first add it to your project
 :setting:`ITEM_PIPELINES` setting.
 
-For Images Pipeline, use::
+For Images Pipeline, use:
 
-    ITEM_PIPELINES = {'scrapy.pipelines.images.ImagesPipeline': 1}
+.. code-block:: python
 
-For Files Pipeline, use::
+    ITEM_PIPELINES = {"scrapy.pipelines.images.ImagesPipeline": 1}
 
-    ITEM_PIPELINES = {'scrapy.pipelines.files.FilesPipeline': 1}
+For Files Pipeline, use:
+
+.. code-block:: python
+
+    ITEM_PIPELINES = {"scrapy.pipelines.files.FilesPipeline": 1}
 
 .. note::
     You can also use both the Files and Images Pipeline at the same time.
 
+.. setting:: IMAGES_STORE
+.. setting:: FILES_STORE
 
 Then, configure the target storage setting to a valid value that will be used
 for storing the downloaded images. Otherwise the pipeline will remain disabled,
 even if you include it in the :setting:`ITEM_PIPELINES` setting.
 
-For the Files Pipeline, set the :setting:`FILES_STORE` setting::
+For the Files Pipeline, set the :setting:`FILES_STORE` setting:
 
-   FILES_STORE = '/path/to/valid/dir'
+.. code-block:: python
 
-For the Images Pipeline, set the :setting:`IMAGES_STORE` setting::
+   FILES_STORE = "/path/to/valid/dir"
 
-   IMAGES_STORE = '/path/to/valid/dir'
+For the Images Pipeline, set the :setting:`IMAGES_STORE` setting:
+
+.. code-block:: python
+
+   IMAGES_STORE = "/path/to/valid/dir"
 
 .. _topics-file-naming:
 
@@ -156,12 +158,12 @@ By overriding ``file_path`` like this:
 .. code-block:: python
 
   import hashlib
-  from os.path import splitext
+
 
   def file_path(self, request, response=None, info=None, *, item=None):
       image_url_hash = hashlib.shake_256(request.url.encode()).hexdigest(5)
-      image_perspective = request.url.split('/')[-2]
-      image_filename = f'{image_url_hash}_{image_perspective}.jpg'
+      image_perspective = request.url.split("/")[-2]
+      image_filename = f"{image_url_hash}_{image_perspective}.jpg"
 
       return image_filename
 
@@ -204,8 +206,6 @@ Where:
 FTP server storage
 ------------------
 
-.. versionadded:: 2.0
-
 :setting:`FILES_STORE` and :setting:`IMAGES_STORE` can point to an FTP server.
 Scrapy will automatically upload the files to the server.
 
@@ -227,42 +227,53 @@ set the :setting:`FEED_STORAGE_FTP_ACTIVE` setting to ``True``.
 Amazon S3 storage
 -----------------
 
+.. note:: Requires the :ref:`s3 <extras>` extra.
+
 .. setting:: FILES_STORE_S3_ACL
 .. setting:: IMAGES_STORE_S3_ACL
 
-If botocore_ >= 1.4.87 is installed, :setting:`FILES_STORE` and
-:setting:`IMAGES_STORE` can represent an Amazon S3 bucket. Scrapy will
-automatically upload the files to the bucket.
+:setting:`FILES_STORE` and :setting:`IMAGES_STORE` can represent an Amazon S3
+bucket. Scrapy will automatically upload the files to the bucket.
 
-For example, this is a valid :setting:`IMAGES_STORE` value::
+For example, this is a valid :setting:`IMAGES_STORE` value:
 
-    IMAGES_STORE = 's3://bucket/images'
+.. code-block:: python
+
+    IMAGES_STORE = "s3://bucket/images"
 
 You can modify the Access Control List (ACL) policy used for the stored files,
 which is defined by the :setting:`FILES_STORE_S3_ACL` and
 :setting:`IMAGES_STORE_S3_ACL` settings. By default, the ACL is set to
 ``private``. To make the files publicly available use the ``public-read``
-policy::
+policy:
 
-    IMAGES_STORE_S3_ACL = 'public-read'
+.. code-block:: python
+
+    IMAGES_STORE_S3_ACL = "public-read"
 
 For more information, see `canned ACLs`_ in the Amazon S3 Developer Guide.
 
 You can also use other S3-like storages. Storages like self-hosted `Minio`_ or
-`s3.scality`_. All you need to do is set endpoint option in you Scrapy
-settings::
+`Zenko CloudServer`_. All you need to do is set endpoint option in you Scrapy
+settings:
 
-    AWS_ENDPOINT_URL = 'http://minio.example.com:9000'
+.. code-block:: python
 
-For self-hosting you also might feel the need not to use SSL and not to verify SSL connection::
+    AWS_ENDPOINT_URL = "http://minio.example.com:9000"
 
-    AWS_USE_SSL = False # or True (None by default)
-    AWS_VERIFY = False # or True (None by default)
+For self-hosting you also might feel the need not to use SSL and not to verify SSL connection:
 
-.. _botocore: https://github.com/boto/botocore
-.. _canned ACLs: https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl
+.. code-block:: python
+
+    AWS_USE_SSL = False  # or True (None by default)
+    AWS_VERIFY = False  # or True (None by default)
+
+To reuse connections for as many files as you check or upload in parallel, set
+:setting:`AWS_MAX_POOL_CONNECTIONS` accordingly.
+
+.. _canned ACLs: https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl
 .. _Minio: https://github.com/minio/minio
-.. _s3.scality: https://s3.scality.com/
+.. _Zenko CloudServer: https://www.zenko.io/cloudserver/
 
 
 .. _media-pipeline-gcs:
@@ -270,35 +281,39 @@ For self-hosting you also might feel the need not to use SSL and not to verify S
 Google Cloud Storage
 ---------------------
 
+.. note:: Requires the :ref:`gcs <extras>` extra.
+
 .. setting:: FILES_STORE_GCS_ACL
 .. setting:: IMAGES_STORE_GCS_ACL
 
-:setting:`FILES_STORE` and :setting:`IMAGES_STORE` can represent a Google Cloud Storage
-bucket. Scrapy will automatically upload the files to the bucket. (requires `google-cloud-storage`_ )
+:setting:`FILES_STORE` and :setting:`IMAGES_STORE` can represent a Google Cloud
+Storage bucket. Scrapy will automatically upload the files to the bucket.
 
-.. _google-cloud-storage: https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python
+For example, these are valid :setting:`IMAGES_STORE` and :setting:`GCS_PROJECT_ID` settings:
 
-For example, these are valid :setting:`IMAGES_STORE` and :setting:`GCS_PROJECT_ID` settings::
+.. code-block:: python
 
-    IMAGES_STORE = 'gs://bucket/images/'
-    GCS_PROJECT_ID = 'project_id'
+    IMAGES_STORE = "gs://bucket/images/"
+    GCS_PROJECT_ID = "project_id"
 
 For information about authentication, see this `documentation`_.
 
-.. _documentation: https://cloud.google.com/docs/authentication/production
+.. _documentation: https://docs.cloud.google.com/docs/authentication
 
 You can modify the Access Control List (ACL) policy used for the stored files,
 which is defined by the :setting:`FILES_STORE_GCS_ACL` and
 :setting:`IMAGES_STORE_GCS_ACL` settings. By default, the ACL is set to
 ``''`` (empty string) which means that Cloud Storage applies the bucket's default object ACL to the object.
 To make the files publicly available use the ``publicRead``
-policy::
+policy:
 
-    IMAGES_STORE_GCS_ACL = 'publicRead'
+.. code-block:: python
+
+    IMAGES_STORE_GCS_ACL = "publicRead"
 
 For more information, see `Predefined ACLs`_ in the Google Cloud Platform Developer Guide.
 
-.. _Predefined ACLs: https://cloud.google.com/storage/docs/access-control/lists#predefined-acl
+.. _Predefined ACLs: https://docs.cloud.google.com/storage/docs/access-control/lists#predefined-acl
 
 Usage example
 =============
@@ -319,43 +334,54 @@ respectively), the pipeline will put the results under the respective field
 When using :ref:`item types <item-types>` for which fields are defined beforehand,
 you must define both the URLs field and the results field. For example, when
 using the images pipeline, items must define both the ``image_urls`` and the
-``images`` field. For instance, using the :class:`~scrapy.Item` class::
+``images`` field. For instance, using a dataclass:
 
-    import scrapy
+.. code-block:: python
 
-    class MyItem(scrapy.Item):
+    from dataclasses import dataclass, field
+
+
+    @dataclass
+    class MyItem:
         # ... other item fields ...
-        image_urls = scrapy.Field()
-        images = scrapy.Field()
+        image_urls: list[str] = field(default_factory=list)
+        images: list[dict] = field(default_factory=list)
 
 If you want to use another field name for the URLs key or for the results key,
 it is also possible to override it.
 
 For the Files Pipeline, set :setting:`FILES_URLS_FIELD` and/or
-:setting:`FILES_RESULT_FIELD` settings::
+:setting:`FILES_RESULT_FIELD` settings:
 
-    FILES_URLS_FIELD = 'field_name_for_your_files_urls'
-    FILES_RESULT_FIELD = 'field_name_for_your_processed_files'
+.. code-block:: python
+
+    FILES_URLS_FIELD = "field_name_for_your_files_urls"
+    FILES_RESULT_FIELD = "field_name_for_your_processed_files"
 
 For the Images Pipeline, set :setting:`IMAGES_URLS_FIELD` and/or
-:setting:`IMAGES_RESULT_FIELD` settings::
+:setting:`IMAGES_RESULT_FIELD` settings:
 
-    IMAGES_URLS_FIELD = 'field_name_for_your_images_urls'
-    IMAGES_RESULT_FIELD = 'field_name_for_your_processed_images'
+.. code-block:: python
+
+    IMAGES_URLS_FIELD = "field_name_for_your_images_urls"
+    IMAGES_RESULT_FIELD = "field_name_for_your_processed_images"
 
 If you need something more complex and want to override the custom pipeline
 behaviour, see :ref:`topics-media-pipeline-override`.
 
-If you have multiple image pipelines inheriting from ImagePipeline and you want
-to have different settings in different pipelines you can set setting keys
-preceded with uppercase name of your pipeline class. E.g. if your pipeline is
-called MyPipeline and you want to have custom IMAGES_URLS_FIELD you define
-setting MYPIPELINE_IMAGES_URLS_FIELD and your custom settings will be used.
+If you have multiple image pipelines inheriting from :class:`ImagesPipeline`
+and you want to have different settings in different pipelines you can set
+setting keys preceded with uppercase name of your pipeline class. E.g. if your
+pipeline is called ``MyPipeline`` and you want to have custom
+:setting:`IMAGES_URLS_FIELD` you define setting
+``MYPIPELINE_IMAGES_URLS_FIELD`` and your custom settings will be used.
 
 
 Additional features
 ===================
 
+.. _file-expiration:
+
 File expiration
 ---------------
 
@@ -365,7 +391,9 @@ File expiration
 The Image Pipeline avoids downloading files that were downloaded recently. To
 adjust this retention delay use the :setting:`FILES_EXPIRES` setting (or
 :setting:`IMAGES_EXPIRES`, in case of Images Pipeline), which
-specifies the delay in number of days::
+specifies the delay in number of days:
+
+.. code-block:: python
 
     # 120 days of delay for files expiration
     FILES_EXPIRES = 120
@@ -383,7 +411,7 @@ class name. E.g. given pipeline class called MyPipeline you can set setting key:
 
 and pipeline class MyPipeline will have expiration time set to 180.
 
-The last modified time from the file is used to determine the age of the file in days, 
+The last modified time from the file is used to determine the age of the file in days,
 which is then compared to the set expiration time to determine if the file is expired.
 
 .. _topics-images-thumbnails:
@@ -399,11 +427,13 @@ images.
 In order to use this feature, you must set :setting:`IMAGES_THUMBS` to a dictionary
 where the keys are the thumbnail names and the values are their dimensions.
 
-For example::
+For example:
+
+.. code-block:: python
 
    IMAGES_THUMBS = {
-       'small': (50, 50),
-       'big': (270, 270),
+       "small": (50, 50),
+       "big": (270, 270),
    }
 
 When you use this feature, the Images Pipeline will create thumbnails of the
@@ -439,7 +469,9 @@ When using the Images Pipeline, you can drop images which are too small, by
 specifying the minimum allowed size in the :setting:`IMAGES_MIN_HEIGHT` and
 :setting:`IMAGES_MIN_WIDTH` settings.
 
-For example::
+For example:
+
+.. code-block:: python
 
    IMAGES_MIN_HEIGHT = 110
    IMAGES_MIN_WIDTH = 110
@@ -462,7 +494,9 @@ Allowing redirections
 By default media pipelines ignore redirects, i.e. an HTTP redirection
 to a media file URL request will mean the media download is considered failed.
 
-To handle media redirections, set this setting to ``True``::
+To handle media redirections, set this setting to ``True``:
+
+.. code-block:: python
 
     MEDIA_ALLOW_REDIRECTS = True
 
@@ -486,7 +520,7 @@ See here the methods that you can override in your custom Files Pipeline:
 
       In addition to ``response``, this method receives the original
       :class:`request <scrapy.Request>`,
-      :class:`info <scrapy.pipelines.media.MediaPipeline.SpiderInfo>` and 
+      :class:`info <scrapy.pipelines.media.MediaPipeline.SpiderInfo>` and
       :class:`item <scrapy.Item>`
 
       You can override this method to customize the download path of each file.
@@ -494,39 +528,40 @@ See here the methods that you can override in your custom Files Pipeline:
       For example, if file URLs end like regular paths (e.g.
       ``https://example.com/a/b/c/foo.png``), you can use the following
       approach to download all files into the ``files`` folder with their
-      original filenames (e.g. ``files/foo.png``)::
+      original filenames (e.g. ``files/foo.png``):
 
-        import os
-        from urllib.parse import urlparse
+      .. code-block:: python
+
+        from pathlib import PurePosixPath
+        from scrapy.utils.httpobj import urlparse_cached
 
         from scrapy.pipelines.files import FilesPipeline
 
+
         class MyFilesPipeline(FilesPipeline):
-
             def file_path(self, request, response=None, info=None, *, item=None):
-                return 'files/' + os.path.basename(urlparse(request.url).path)
+                return "files/" + PurePosixPath(urlparse_cached(request).path).name
 
-      Similarly, you can use the ``item`` to determine the file path based on some item 
+      Similarly, you can use the ``item`` to determine the file path based on some item
       property.
-      
+
       By default the :meth:`file_path` method returns
       ``full/<request URL hash>.<extension>``.
 
-      .. versionadded:: 2.4
-         The *item* parameter.
-
    .. method:: FilesPipeline.get_media_requests(item, info)
 
-      As seen on the workflow, the pipeline will get the URLs of the images to
-      download from the item. In order to do this, you can override the
-      :meth:`~get_media_requests` method and return a Request for each
-      file URL::
+      As seen on the workflow, the pipeline will get the requests for the files
+      to download from the item by calling this method. You can override it to
+      change what requests are returned:
+
+      .. code-block:: python
 
          from itemadapter import ItemAdapter
 
+
          def get_media_requests(self, item, info):
              adapter = ItemAdapter(item)
-             for file_url in adapter['file_urls']:
+             for file_url in adapter["file_urls"]:
                  yield scrapy.Request(file_url)
 
       Those requests will be processed by the pipeline and, when they have finished
@@ -552,32 +587,39 @@ See here the methods that you can override in your custom Files Pipeline:
 
         * ``status`` - the file status indication.
 
-          .. versionadded:: 2.2
-
           It can be one of the following:
 
           * ``downloaded`` - file was downloaded.
           * ``uptodate`` - file was not downloaded, as it was downloaded recently,
             according to the file expiration policy.
-          * ``cached`` - file was already scheduled for download, by another item
-            sharing the same file.
+          * ``cached`` - file was taken from a cache (the response has a
+            ``"cached"`` flag, e.g. from
+            :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`).
 
       The list of tuples received by :meth:`~item_completed` is
       guaranteed to retain the same order of the requests returned from the
       :meth:`~get_media_requests` method.
 
-      Here's a typical value of the ``results`` argument::
+      Here's a typical value of the ``results`` argument:
 
-          [(True,
-            {'checksum': '2b00042f7481c7b056c4b410d28f33cf',
-             'path': 'full/0a79c461a4062ac383dc4fade7bc09f1384a3910.jpg',
-             'url': 'http://www.example.com/files/product1.pdf',
-             'status': 'downloaded'}),
-           (False,
-            Failure(...))]
+      .. invisible-code-block: python
 
-      By default the :meth:`get_media_requests` method returns ``None`` which
-      means there are no files to download for the item.
+          from twisted.python.failure import Failure
+
+      .. code-block:: python
+
+          [
+              (
+                  True,
+                  {
+                      "checksum": "2b00042f7481c7b056c4b410d28f33cf",
+                      "path": "full/0a79c461a4062ac383dc4fade7bc09f1384a3910.jpg",
+                      "url": "http://www.example.com/files/product1.pdf",
+                      "status": "downloaded",
+                  },
+              ),
+              (False, Failure(...)),
+          ]
 
    .. method:: FilesPipeline.item_completed(results, item, info)
 
@@ -591,17 +633,20 @@ See here the methods that you can override in your custom Files Pipeline:
 
       Here is an example of the :meth:`~item_completed` method where we
       store the downloaded file paths (passed in results) in the ``file_paths``
-      item field, and we drop the item if it doesn't contain any files::
+      item field, and we drop the item if it doesn't contain any files:
+
+      .. code-block:: python
 
           from itemadapter import ItemAdapter
           from scrapy.exceptions import DropItem
 
+
           def item_completed(self, results, item, info):
-              file_paths = [x['path'] for ok, x in results if ok]
+              file_paths = [x["path"] for ok, x in results if ok]
               if not file_paths:
                   raise DropItem("Item contains no files")
               adapter = ItemAdapter(item)
-              adapter['file_paths'] = file_paths
+              adapter["file_paths"] = file_paths
               return item
 
       By default, the :meth:`item_completed` method returns the item.
@@ -625,7 +670,7 @@ See here the methods that you can override in your custom Images Pipeline:
 
       In addition to ``response``, this method receives the original
       :class:`request <scrapy.Request>`,
-      :class:`info <scrapy.pipelines.media.MediaPipeline.SpiderInfo>` and 
+      :class:`info <scrapy.pipelines.media.MediaPipeline.SpiderInfo>` and
       :class:`item <scrapy.Item>`
 
       You can override this method to customize the download path of each file.
@@ -633,26 +678,45 @@ See here the methods that you can override in your custom Images Pipeline:
       For example, if file URLs end like regular paths (e.g.
       ``https://example.com/a/b/c/foo.png``), you can use the following
       approach to download all files into the ``files`` folder with their
-      original filenames (e.g. ``files/foo.png``)::
+      original filenames (e.g. ``files/foo.png``):
 
-        import os
-        from urllib.parse import urlparse
+      .. code-block:: python
+
+        from pathlib import PurePosixPath
+        from scrapy.utils.httpobj import urlparse_cached
 
         from scrapy.pipelines.images import ImagesPipeline
 
+
         class MyImagesPipeline(ImagesPipeline):
-
             def file_path(self, request, response=None, info=None, *, item=None):
-                return 'files/' + os.path.basename(urlparse(request.url).path)
+                return "files/" + PurePosixPath(urlparse_cached(request).path).name
 
-      Similarly, you can use the ``item`` to determine the file path based on some item 
+      Similarly, you can use the ``item`` to determine the file path based on some item
       property.
-      
+
       By default the :meth:`file_path` method returns
       ``full/<request URL hash>.<extension>``.
 
-      .. versionadded:: 2.4
-         The *item* parameter.
+   .. method:: ImagesPipeline.thumb_path(self, request, thumb_id, response=None, info=None, *, item=None)
+
+      This method is called for every item of  :setting:`IMAGES_THUMBS` per downloaded item. It returns the
+      thumbnail download path of the image originating from the specified
+      :class:`response <scrapy.http.Response>`.
+
+      In addition to ``response``, this method receives the original
+      :class:`request <scrapy.Request>`,
+      ``thumb_id``,
+      :class:`info <scrapy.pipelines.media.MediaPipeline.SpiderInfo>` and
+      :class:`item <scrapy.Item>`.
+
+      You can override this method to customize the thumbnail download path of each image.
+      You can use the ``item`` to determine the file path based on some item
+      property.
+
+      By default the :meth:`thumb_path` method returns
+      ``thumbs/<size name>/<request URL hash>.<extension>``.
+
 
    .. method:: ImagesPipeline.get_media_requests(item, info)
 
@@ -679,33 +743,59 @@ Custom Images pipeline example
 ==============================
 
 Here is a full example of the Images Pipeline whose methods are exemplified
-above::
+above:
+
+.. code-block:: python
 
     import scrapy
     from itemadapter import ItemAdapter
     from scrapy.exceptions import DropItem
     from scrapy.pipelines.images import ImagesPipeline
 
-    class MyImagesPipeline(ImagesPipeline):
 
+    class MyImagesPipeline(ImagesPipeline):
         def get_media_requests(self, item, info):
-            for image_url in item['image_urls']:
+            for image_url in item["image_urls"]:
                 yield scrapy.Request(image_url)
 
         def item_completed(self, results, item, info):
-            image_paths = [x['path'] for ok, x in results if ok]
+            image_paths = [x["path"] for ok, x in results if ok]
             if not image_paths:
                 raise DropItem("Item contains no images")
             adapter = ItemAdapter(item)
-            adapter['image_paths'] = image_paths
+            adapter["image_paths"] = image_paths
             return item
 
 
 To enable your custom media pipeline component you must add its class import path to the
-:setting:`ITEM_PIPELINES` setting, like in the following example::
+:setting:`ITEM_PIPELINES` setting, like in the following example:
+
+.. code-block:: python
+
+   ITEM_PIPELINES = {"myproject.pipelines.MyImagesPipeline": 300}
+
+Content-based image filtering pipeline
+--------------------------------------
+
+This example overrides ``get_images()`` to filter images using a classifier,
+such as a TensorFlow_ model. Override ``is_valid_image()`` with your
+classification logic:
+
+.. code-block:: python
+
+    from scrapy.pipelines.images import ImagesPipeline, ImageException
+
+
+    class ImageClassifierPipeline(ImagesPipeline):
+        def is_valid_image(self, image):
+            raise NotImplementedError
+
+        def get_images(self, response, request, info, *, item=None):
+            for path, image, buf in super().get_images(response, request, info, item=item):
+                if not self.is_valid_image(image):
+                    raise ImageException("Image does not match criteria")
+                yield path, image, buf
 
-   ITEM_PIPELINES = {
-       'myproject.pipelines.MyImagesPipeline': 300
-   }
 
 .. _MD5 hash: https://en.wikipedia.org/wiki/MD5
+.. _TensorFlow: https://tensorflow.org

docs/topics/practices.rst

@@ -7,6 +7,8 @@ Common Practices
 This section documents common practices when using Scrapy. These are things
 that cover many topics and don't often fall into any other specific section.
 
+.. skip: start
+
 .. _run-from-script:
 
 Run Scrapy from a script
@@ -15,95 +17,341 @@ Run Scrapy from a script
 You can use the :ref:`API <topics-api>` to run Scrapy from a script, instead of
 the typical way of running Scrapy via ``scrapy crawl``.
 
-Remember that Scrapy is built on top of the Twisted
-asynchronous networking library, so you need to run it inside the Twisted reactor.
+Remember that Scrapy requires a Twisted reactor or (with
+:setting:`TWISTED_REACTOR_ENABLED` set to ``False``) an asyncio event loop, so
+you need to run one of those in your script for it to work (helpers described
+below can do it for you).
 
 The first utility you can use to run your spiders is
-:class:`scrapy.crawler.CrawlerProcess`. This class will start a Twisted reactor
-for you, configuring the logging and setting shutdown handlers. This class is
-the one used by all Scrapy commands.
+:class:`scrapy.crawler.AsyncCrawlerProcess` or
+:class:`scrapy.crawler.CrawlerProcess`. These classes will start a Twisted
+reactor for you, configuring the logging and setting shutdown handlers. These
+classes are the ones used by all Scrapy commands. They have similar
+functionality, differing in their asynchronous API style:
+:class:`~scrapy.crawler.AsyncCrawlerProcess` returns coroutines from its
+asynchronous methods while :class:`~scrapy.crawler.CrawlerProcess` returns
+:class:`~twisted.internet.defer.Deferred` objects.
 
 Here's an example showing how to run a single spider with it.
 
-::
+.. code-block:: python
 
     import scrapy
-    from scrapy.crawler import CrawlerProcess
+    from scrapy.crawler import AsyncCrawlerProcess
+
 
     class MySpider(scrapy.Spider):
         # Your spider definition
         ...
 
-    process = CrawlerProcess(settings={
-        "FEEDS": {
-            "items.json": {"format": "json"},
-        },
-    })
+
+    process = AsyncCrawlerProcess(
+        settings={
+            "FEEDS": {
+                "items.json": {"format": "json"},
+            },
+        }
+    )
 
     process.crawl(MySpider)
-    process.start() # the script will block here until the crawling is finished
+    process.start()  # the script will block here until the crawling is finished
 
-Define settings within dictionary in CrawlerProcess. Make sure to check :class:`~scrapy.crawler.CrawlerProcess`
+You can define :ref:`settings <topics-settings>` within the dictionary passed
+to :class:`~scrapy.crawler.AsyncCrawlerProcess`. Make sure to check the
+:class:`~scrapy.crawler.AsyncCrawlerProcess`
 documentation to get acquainted with its usage details.
 
 If you are inside a Scrapy project there are some additional helpers you can
 use to import those components within the project. You can automatically import
-your spiders passing their name to :class:`~scrapy.crawler.CrawlerProcess`, and
-use ``get_project_settings`` to get a :class:`~scrapy.settings.Settings`
-instance with your project settings.
+your spiders passing their name to
+:class:`~scrapy.crawler.AsyncCrawlerProcess`, and use
+:func:`scrapy.utils.project.get_project_settings` to get a
+:class:`~scrapy.settings.Settings` instance with your project settings.
 
 What follows is a working example of how to do that, using the `testspiders`_
 project as example.
 
-::
+.. code-block:: python
 
-    from scrapy.crawler import CrawlerProcess
+    from scrapy.crawler import AsyncCrawlerProcess
     from scrapy.utils.project import get_project_settings
 
-    process = CrawlerProcess(get_project_settings())
+    process = AsyncCrawlerProcess(get_project_settings())
 
     # 'followall' is the name of one of the spiders of the project.
-    process.crawl('followall', domain='scrapy.org')
-    process.start() # the script will block here until the crawling is finished
+    process.crawl("followall", domain="scrapy.org")
+    process.start()  # the script will block here until the crawling is finished
 
 There's another Scrapy utility that provides more control over the crawling
-process: :class:`scrapy.crawler.CrawlerRunner`. This class is a thin wrapper
-that encapsulates some simple helpers to run multiple crawlers, but it won't
-start or interfere with existing reactors in any way.
+process: :class:`scrapy.crawler.AsyncCrawlerRunner` or
+:class:`scrapy.crawler.CrawlerRunner`. These classes are thin wrappers
+that encapsulate some simple helpers to run multiple crawlers, but they won't
+start or interfere with existing reactors in any way. Just like
+:class:`scrapy.crawler.AsyncCrawlerProcess` and
+:class:`scrapy.crawler.CrawlerProcess` they differ in their asynchronous API
+style.
 
-Using this class the reactor should be explicitly run after scheduling your
-spiders. It's recommended you use :class:`~scrapy.crawler.CrawlerRunner`
-instead of :class:`~scrapy.crawler.CrawlerProcess` if your application is
-already using Twisted and you want to run Scrapy in the same reactor.
+When using these classes the reactor should be explicitly run after scheduling
+your spiders. It's recommended that you use
+:class:`~scrapy.crawler.AsyncCrawlerRunner` or
+:class:`~scrapy.crawler.CrawlerRunner` instead of
+:class:`~scrapy.crawler.AsyncCrawlerProcess` or
+:class:`~scrapy.crawler.CrawlerProcess` if your application is already using
+Twisted and you want to run Scrapy in the same reactor.
 
-Note that you will also have to shutdown the Twisted reactor yourself after the
-spider is finished. This can be achieved by adding callbacks to the deferred
-returned by the :meth:`CrawlerRunner.crawl
-<scrapy.crawler.CrawlerRunner.crawl>` method.
+If you want to stop the reactor or run any other code right after the spider
+finishes you can do that after the task returned from
+:meth:`AsyncCrawlerRunner.crawl() <scrapy.crawler.AsyncCrawlerRunner.crawl>`
+completes (or the Deferred returned from :meth:`CrawlerRunner.crawl()
+<scrapy.crawler.CrawlerRunner.crawl>` fires). In the simplest case you can also
+use :func:`twisted.internet.task.react` to start and stop the reactor, though
+it may be easier to just use :class:`~scrapy.crawler.AsyncCrawlerProcess` or
+:class:`~scrapy.crawler.CrawlerProcess` instead.
 
-Here's an example of its usage, along with a callback to manually stop the
-reactor after ``MySpider`` has finished running.
+Here's an example of using :class:`~scrapy.crawler.AsyncCrawlerRunner` together
+with simple reactor management code:
 
-::
+.. code-block:: python
 
-    from twisted.internet import reactor
     import scrapy
-    from scrapy.crawler import CrawlerRunner
+    from scrapy.crawler import AsyncCrawlerRunner
+    from scrapy.utils.defer import deferred_f_from_coro_f
     from scrapy.utils.log import configure_logging
+    from scrapy.utils.reactor import install_reactor
+    from twisted.internet.task import react
+
 
     class MySpider(scrapy.Spider):
         # Your spider definition
         ...
 
-    configure_logging({'LOG_FORMAT': '%(levelname)s: %(message)s'})
-    runner = CrawlerRunner()
 
-    d = runner.crawl(MySpider)
-    d.addBoth(lambda _: reactor.stop())
-    reactor.run() # the script will block here until the crawling is finished
+    async def crawl(_):
+        configure_logging({"LOG_FORMAT": "%(levelname)s: %(message)s"})
+        runner = AsyncCrawlerRunner()
+        await runner.crawl(MySpider)  # completes when the spider finishes
+
+
+    install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor")
+    react(deferred_f_from_coro_f(crawl))
+
+Same example but using :class:`~scrapy.crawler.CrawlerRunner` and a
+different reactor (:class:`~scrapy.crawler.AsyncCrawlerRunner` only works
+with :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor`):
+
+.. code-block:: python
+
+    import scrapy
+    from scrapy.crawler import CrawlerRunner
+    from scrapy.utils.log import configure_logging
+    from scrapy.utils.reactor import install_reactor
+    from twisted.internet.task import react
+
+
+    class MySpider(scrapy.Spider):
+        custom_settings = {
+            "TWISTED_REACTOR": "twisted.internet.epollreactor.EPollReactor",
+        }
+        # Your spider definition
+        ...
+
+
+    def crawl(_):
+        configure_logging({"LOG_FORMAT": "%(levelname)s: %(message)s"})
+        runner = CrawlerRunner()
+        d = runner.crawl(MySpider)
+        return d  # this Deferred fires when the spider finishes
+
+
+    install_reactor("twisted.internet.epollreactor.EPollReactor")
+    react(crawl)
 
 .. seealso:: :doc:`twisted:core/howto/reactor-basics`
 
+And here are examples of using these classes with
+:setting:`TWISTED_REACTOR_ENABLED` set to ``False``.
+
+Simple usage of :class:`~scrapy.crawler.AsyncCrawlerProcess`:
+
+.. code-block:: python
+
+    import scrapy
+    from scrapy.crawler import AsyncCrawlerProcess
+
+
+    class MySpider(scrapy.Spider):
+        # Your spider definition
+        ...
+
+
+    process = AsyncCrawlerProcess(
+        settings={
+            "TWISTED_REACTOR_ENABLED": False,
+        }
+    )
+
+    process.crawl(MySpider)
+    process.start()  # the script will block here until the crawling is finished
+
+With ``TWISTED_REACTOR_ENABLED=False`` you can use several instances of
+:class:`~scrapy.crawler.AsyncCrawlerProcess` in the same process:
+
+.. code-block:: python
+
+    import scrapy
+    from scrapy.crawler import AsyncCrawlerProcess
+
+
+    class MySpider(scrapy.Spider):
+        # Your spider definition
+        ...
+
+
+    process1 = AsyncCrawlerProcess(
+        settings={
+            "TWISTED_REACTOR_ENABLED": False,
+        }
+    )
+    process1.crawl(MySpider)
+    process1.start()
+
+    process2 = AsyncCrawlerProcess(
+        settings={
+            "TWISTED_REACTOR_ENABLED": False,
+        }
+    )
+    process2.crawl(MySpider)
+    process2.start()
+
+Using :func:`asyncio.run` with :class:`~scrapy.crawler.AsyncCrawlerRunner`:
+
+.. code-block:: python
+
+    import asyncio
+
+    import scrapy
+    from scrapy.crawler import AsyncCrawlerRunner
+    from scrapy.utils.log import configure_logging
+
+
+    class MySpider(scrapy.Spider):
+        # Your spider definition
+        ...
+
+
+    async def main():
+        configure_logging({"LOG_FORMAT": "%(levelname)s: %(message)s"})
+        runner = AsyncCrawlerRunner(settings={"TWISTED_REACTOR_ENABLED": False})
+        await runner.crawl(MySpider)  # completes when the spider finishes
+
+
+    asyncio.run(main())
+
+.. _run-spiders-in-apps:
+
+Running spiders inside existing applications
+============================================
+
+You may want to run Scrapy spiders inside an existing application. In simple
+cases (e.g. task queues that spawn a process for every task, or applications
+that can execute tasks synchronously in the same process) you can use the same
+approach as for standalone scripts (see :ref:`run-from-script`). More complex
+cases, e.g. asynchronous web applications, have additional caveats and
+limitations.
+
+If the application runs its own Twisted reactor, you can use
+:class:`~scrapy.crawler.AsyncCrawlerRunner` or
+:class:`~scrapy.crawler.CrawlerRunner` to run spiders using this reactor, see
+:ref:`run-from-script` for examples.
+
+If the application doesn't run a Twisted reactor or an asyncio event loop (for
+example, a Django web app deployed with a WSGI server such as uWSGI), you can
+use :class:`~scrapy.crawler.AsyncCrawlerProcess` with
+:setting:`TWISTED_REACTOR_ENABLED` set to ``False``, so that Scrapy starts and
+stops an asyncio event loop for every spider run:
+
+.. code-block:: python
+
+    import scrapy
+    from django.http import HttpResponse
+    from scrapy.crawler import AsyncCrawlerProcess
+
+
+    class MySpider(scrapy.Spider):
+        # Your spider definition
+        ...
+
+
+    def crawl_view(request):
+        process = AsyncCrawlerProcess(settings={"TWISTED_REACTOR_ENABLED": False})
+        process.crawl(MySpider)
+        process.start()  # returns when the spider finishes
+        return HttpResponse("Crawling finished")
+
+If the application runs its own asyncio event loop (for example, a Django web
+app deployed with an ASGI server such as uvicorn), you can use
+:class:`~scrapy.crawler.AsyncCrawlerRunner` with
+:setting:`TWISTED_REACTOR_ENABLED` set to ``False``, so that Scrapy uses the
+existing event loop:
+
+.. code-block:: python
+
+    import scrapy
+    from django.http import HttpResponse
+    from scrapy.crawler import AsyncCrawlerRunner
+
+
+    class MySpider(scrapy.Spider):
+        # Your spider definition
+        ...
+
+
+    async def crawl_view(request):
+        runner = AsyncCrawlerRunner(settings={"TWISTED_REACTOR_ENABLED": False})
+        await runner.crawl(MySpider)  # completes when the spider finishes
+        return HttpResponse("Crawling finished")
+
+.. note:: Running Scrapy without a Twisted reactor is experimental and has
+    some limitations, described in :ref:`asyncio-without-reactor`.
+
+.. _run-in-notebook:
+
+Running spiders in Jupyter notebooks
+====================================
+
+You can run Scrapy spiders in Jupyter notebooks. You need to use
+:class:`~scrapy.crawler.AsyncCrawlerRunner` with
+:setting:`TWISTED_REACTOR_ENABLED` set to ``False`` for this, so that Scrapy
+uses the event loop provided by the notebook kernel. As
+:class:`~scrapy.crawler.AsyncCrawlerRunner` doesn't configure logging, and you
+most likely want to see the spider log in the notebook, you should call
+:func:`scrapy.utils.log.configure_logging`. Here is a full example, which
+supports rerunning both as a single cell and as separate cells:
+
+.. code-block:: python
+
+    from scrapy import Spider
+    from scrapy.crawler import AsyncCrawlerRunner
+    from scrapy.utils.log import configure_logging
+
+    configure_logging()
+
+
+    class BooksSpider(Spider):
+        name = "books"
+        start_urls = ["https://books.toscrape.com"]
+
+        def parse(self, response):
+            for book in response.css("h3"):
+                yield {"title": book.css("a::attr(title)").get()}
+
+
+    runner = AsyncCrawlerRunner({"TWISTED_REACTOR_ENABLED": False})
+    await runner.crawl(BooksSpider)
+
+.. note:: Running Scrapy without a Twisted reactor is experimental and has
+    some limitations, described in :ref:`asyncio-without-reactor`.
+
 .. _run-multiple-spiders:
 
 Running multiple spiders in the same process
@@ -115,92 +363,111 @@ the :ref:`internal API <topics-api>`.
 
 Here is an example that runs multiple spiders simultaneously:
 
-::
+.. code-block:: python
 
     import scrapy
-    from scrapy.crawler import CrawlerProcess
+    from scrapy.crawler import AsyncCrawlerProcess
     from scrapy.utils.project import get_project_settings
 
+
     class MySpider1(scrapy.Spider):
         # Your first spider definition
         ...
 
+
     class MySpider2(scrapy.Spider):
         # Your second spider definition
         ...
 
+
     settings = get_project_settings()
-    process = CrawlerProcess(settings)
+    process = AsyncCrawlerProcess(settings)
     process.crawl(MySpider1)
     process.crawl(MySpider2)
-    process.start() # the script will block here until all crawling jobs are finished
+    process.start()  # the script will block here until all crawling jobs are finished
 
-Same example using :class:`~scrapy.crawler.CrawlerRunner`:
+Same example using :class:`~scrapy.crawler.AsyncCrawlerRunner`:
 
-::
+.. code-block:: python
 
     import scrapy
-    from twisted.internet import reactor
-    from scrapy.crawler import CrawlerRunner
+    from scrapy.crawler import AsyncCrawlerRunner
+    from scrapy.utils.defer import deferred_f_from_coro_f
     from scrapy.utils.log import configure_logging
-    from scrapy.utils.project import get_project_settings
+    from scrapy.utils.reactor import install_reactor
+    from twisted.internet.task import react
+
 
     class MySpider1(scrapy.Spider):
         # Your first spider definition
         ...
 
+
     class MySpider2(scrapy.Spider):
         # Your second spider definition
         ...
 
-    configure_logging()
-    settings = get_project_settings()
-    runner = CrawlerRunner(settings)
-    runner.crawl(MySpider1)
-    runner.crawl(MySpider2)
-    d = runner.join()
-    d.addBoth(lambda _: reactor.stop())
 
-    reactor.run() # the script will block here until all crawling jobs are finished
+    async def crawl(_):
+        configure_logging({"LOG_FORMAT": "%(levelname)s: %(message)s"})
+        runner = AsyncCrawlerRunner()
+        runner.crawl(MySpider1)
+        runner.crawl(MySpider2)
+        await runner.join()  # completes when both spiders finish
 
-Same example but running the spiders sequentially by chaining the deferreds:
 
-::
+    install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor")
+    react(deferred_f_from_coro_f(crawl))
 
-    from twisted.internet import reactor, defer
-    from scrapy.crawler import CrawlerRunner
+
+Same example but running the spiders sequentially by awaiting until each one
+finishes before starting the next one:
+
+.. code-block:: python
+
+    import scrapy
+    from scrapy.crawler import AsyncCrawlerRunner
+    from scrapy.utils.defer import deferred_f_from_coro_f
     from scrapy.utils.log import configure_logging
-    from scrapy.utils.project import get_project_settings
+    from scrapy.utils.reactor import install_reactor
+    from twisted.internet.task import react
+
 
     class MySpider1(scrapy.Spider):
         # Your first spider definition
         ...
 
+
     class MySpider2(scrapy.Spider):
         # Your second spider definition
         ...
 
-    configure_logging()
-    settings = get_project_settings()
-    runner = CrawlerRunner(settings)
 
-    @defer.inlineCallbacks
-    def crawl():
-        yield runner.crawl(MySpider1)
-        yield runner.crawl(MySpider2)
-        reactor.stop()
+    async def crawl(_):
+        configure_logging({"LOG_FORMAT": "%(levelname)s: %(message)s"})
+        runner = AsyncCrawlerRunner()
+        await runner.crawl(MySpider1)
+        await runner.crawl(MySpider2)
 
-    crawl()
-    reactor.run() # the script will block here until the last crawl call is finished
+
+    install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor")
+    react(deferred_f_from_coro_f(crawl))
+
+.. note:: When running multiple spiders in the same process, :ref:`logging
+    settings <logging-settings>` and :ref:`reactor settings <reactor-settings>`
+    should not have a different value per spider, and :ref:`pre-crawler
+    settings <pre-crawler-settings>` cannot be defined per spider.
 
 .. seealso:: :ref:`run-from-script`.
 
+.. skip: end
+
 .. _distributed-crawls:
 
 Distributed crawls
 ==================
 
-Scrapy doesn't provide any built-in facility for running crawls in a distribute
+Scrapy doesn't provide any built-in facility for running crawls in a distributed
 (multi-server) manner. However, there are some ways to distribute crawls, which
 vary depending on how you plan to distribute them.
 
@@ -208,10 +475,10 @@ If you have many spiders, the obvious way to distribute the load is to setup
 many Scrapyd instances and distribute spider runs among those.
 
 If you instead want to run a single (big) spider through many machines, what
-you usually do is partition the urls to crawl and send them to each separate
+you usually do is partition the URLs to crawl and send them to each separate
 spider. Here is a concrete example:
 
-First, you prepare the list of urls to crawl and put them into separate
+First, you prepare the list of URLs to crawl and put them into separate
 files/urls::
 
     http://somedomain.com/urls-to-crawl/spider1/part1.list
@@ -226,6 +493,26 @@ crawl::
     curl http://scrapy2.mycompany.com:6800/schedule.json -d project=myproject -d spider=spider1 -d part=2
     curl http://scrapy3.mycompany.com:6800/schedule.json -d project=myproject -d spider=spider1 -d part=3
 
+.. _large-project-startup:
+
+Reducing startup time in large projects
+=======================================
+
+When running a spider with ``scrapy crawl``, Scrapy loads all modules listed in
+:setting:`SPIDER_MODULES` to find the target spider. In large projects with
+many spiders, this can noticeably increase startup time and memory usage.
+
+To avoid loading every spider module, override :setting:`SPIDER_MODULES` on the
+command line to point only to the module that contains the spider you want to
+run:
+
+.. code-block:: shell
+
+    scrapy crawl myspider -s SPIDER_MODULES=myproject.spiders.myspider
+
+Because :setting:`SPIDER_MODULES` is a list setting, you can include multiple
+modules by separating them with commas.
+
 .. _bans:
 
 Avoiding getting banned
@@ -238,27 +525,37 @@ consider contacting `commercial support`_ if in doubt.
 
 Here are some tips to keep in mind when dealing with these kinds of sites:
 
-* rotate your user agent from a pool of well-known ones from browsers (google
+* rotate your user agent from a pool of well-known ones from browsers (Google
   around to get a list of them)
 * disable cookies (see :setting:`COOKIES_ENABLED`) as some sites may use
   cookies to spot bot behaviour
 * use download delays (2 or higher). See :setting:`DOWNLOAD_DELAY` setting.
-* if possible, use `Google cache`_ to fetch pages, instead of hitting the sites
+* if possible, use `Common Crawl`_ to fetch pages, instead of hitting the sites
   directly
 * use a pool of rotating IPs. For example, the free `Tor project`_ or paid
-  services like `ProxyMesh`_. An open source alternative is `scrapoxy`_, a
-  super proxy that you can attach your own proxies to.
-* use a highly distributed downloader that circumvents bans internally, so you
-  can just focus on parsing clean pages. One example of such downloaders is
-  `Zyte Smart Proxy Manager`_
+  services like `ProxyMesh`_.
+* for HTTPS websites, if blocking appears related to TLS behavior, consider
+  adjusting the :setting:`DOWNLOAD_TLS_MIN_VERSION` and
+  :setting:`DOWNLOAD_TLS_MAX_VERSION` settings, since some websites may respond
+  differently depending on the TLS method used by the client.
+* use a ban avoidance service, such as `Zyte API`_, which provides a `Scrapy
+  plugin <https://github.com/scrapy-plugins/scrapy-zyte-api>`__ and additional
+  features, like `AI web scraping <https://www.zyte.com/ai-web-scraping/>`__
 
 If you are still unable to prevent your bot getting banned, consider contacting
 `commercial support`_.
 
+.. _static-analysis:
+
+Static analysis
+===============
+
+Consider using :doc:`scrapy-lint <scrapy-lint:index>`, a linter for Scrapy
+projects that detects common mistakes and anti-patterns.
+
 .. _Tor project: https://www.torproject.org/
-.. _commercial support: https://scrapy.org/support/
+.. _commercial support: https://www.scrapy.org/companies
 .. _ProxyMesh: https://proxymesh.com/
-.. _Google cache: http://www.googleguide.com/cached_pages.html
+.. _Common Crawl: https://commoncrawl.org/
 .. _testspiders: https://github.com/scrapinghub/testspiders
-.. _scrapoxy: https://scrapoxy.io/
-.. _Zyte Smart Proxy Manager: https://www.zyte.com/smart-proxy-manager/
+.. _Zyte API: https://docs.zyte.com/zyte-api/get-started.html

docs/topics/scheduler.rst

@@ -26,9 +26,16 @@ Minimal scheduler interface
    :members:
 
 
-Default Scrapy scheduler
-========================
+Default scheduler
+=================
 
-.. autoclass:: Scheduler
+.. autoclass:: Scheduler()
    :members:
-   :special-members: __len__
+   :special-members: __init__, __len__
+
+
+Priority queues
+===============
+
+.. autoclass:: scrapy.pqueues.DownloaderAwarePriorityQueue
+.. autoclass:: scrapy.pqueues.ScrapyPriorityQueue

docs/topics/security.rst

@@ -0,0 +1,207 @@
+.. _security:
+
+========
+Security
+========
+
+Scrapy defaults are optimized for web scraping, not for the security posture
+that you might expect from software that handles untrusted input or runs in a
+shared or exposed environment. Some common security practices are unnecessary
+for many scraping use cases, and a few can even prevent valid ones (for
+example, sites that you must scrape may use misconfigured TLS certificates or
+serve content over unencrypted protocols).
+
+This page highlights the Scrapy defaults that have security implications, so
+that you can make an informed decision about whether to keep them, and explains
+how to harden them along with the trade-offs involved.
+
+.. note::
+
+    None of the options below are silver bullets. Which of them make sense
+    depends on your threat model: whether the URLs you crawl come from trusted
+    sources, whether the machine running Scrapy is exposed to a network you do
+    not control, whether the data you handle is sensitive, and so on.
+
+.. _security-untrusted-responses:
+
+Treat responses as untrusted input
+==================================
+
+Regardless of any setting, remember that response data comes from servers you
+do not control, even when you trust the site you are crawling, as responses may
+be tampered with in transit or the server itself may be compromised.
+
+Never pass response data to functions that can execute code or otherwise act on
+their input in an unsafe way, such as :func:`eval`, :func:`exec`, or
+:func:`pickle.loads`, and be careful when writing response data to paths
+derived from the response itself.
+
+TLS connections
+===============
+
+.. _security-certificate-verification:
+
+Certificate verification
+------------------------
+
+By default Scrapy does **not** verify the TLS certificate of HTTPS servers, as
+controlled by the :setting:`DOWNLOAD_VERIFY_CERTIFICATES` setting (default:
+``False``).
+
+This default favors reach over security: many sites that are otherwise fine to
+scrape have expired, self-signed, or otherwise invalid certificates, and
+verifying certificates would make requests to them fail.
+
+If the integrity of the connection matters to you (for example, to detect
+man-in-the-middle attacks), set:
+
+.. code-block:: python
+
+    DOWNLOAD_VERIFY_CERTIFICATES = True
+
+* **Pro:** requests to servers with invalid or untrusted certificates fail
+  instead of silently succeeding, protecting you from some man-in-the-middle
+  attacks.
+
+* **Con:** you can no longer scrape sites with misconfigured certificates
+  without re-disabling verification for them.
+
+.. _security-tls-protocols-ciphers:
+
+Protocol versions and ciphers
+-----------------------------
+
+You can restrict the TLS protocol versions that Scrapy accepts through the
+:setting:`DOWNLOAD_TLS_MIN_VERSION` and :setting:`DOWNLOAD_TLS_MAX_VERSION`
+settings, e.g. to reject obsolete protocol versions.
+
+By default Scrapy uses the OpenSSL ``DEFAULT`` cipher list
+(:setting:`DOWNLOADER_CLIENT_TLS_CIPHERS`), which favors compatibility and still
+allows some older, weaker ciphers. Set it to ``None`` to instead use the curated
+cipher list of the underlying TLS implementation (Twisted), which excludes weak
+ciphers:
+
+.. code-block:: python
+
+    DOWNLOADER_CLIENT_TLS_CIPHERS = None
+
+* **Pro:** connections that would negotiate a weak cipher fail instead of
+  succeeding.
+
+* **Con:** you can no longer connect to servers that only support the excluded
+  ciphers.
+
+.. _security-unencrypted-protocols:
+
+Unencrypted protocols
+=====================
+
+By default Scrapy enables download handlers for unencrypted protocols, namely
+``http://`` and ``ftp://`` (see :setting:`DOWNLOAD_HANDLERS_BASE`). Data sent
+and received over these protocols, including any credentials, travels in plain
+text and can be read or modified by anyone on the network path.
+
+If you only crawl over encrypted protocols, you can disable the unencrypted
+ones so that no request can accidentally be sent unencrypted:
+
+.. code-block:: python
+
+    DOWNLOAD_HANDLERS = {
+        "http": None,
+        "ftp": None,
+    }
+
+* **Pro:** a misconfigured or maliciously-redirected request cannot leak data
+  over an unencrypted connection, as such requests fail instead.
+
+* **Con:** you can no longer crawl resources that are only available over those
+  protocols.
+
+Note that disabling the ``http`` handler also prevents plain-HTTP requests that
+result from following an ``http://`` redirect or link, which is often the point
+of disabling it.
+
+.. _security-local-resources:
+
+Local and non-network resources
+===============================
+
+By default Scrapy enables download handlers for the ``file://`` and ``data:``
+schemes (see :setting:`DOWNLOAD_HANDLERS_BASE`). The ``file://`` handler reads
+arbitrary files from the local filesystem, limited only by the permissions of
+the process running Scrapy.
+
+This is convenient (for example, to parse a local HTML file), but it is a risk
+if any of the URLs you schedule come from an untrusted source: a crafted
+``file:///etc/passwd`` URL could read local files.
+
+If you do not need them, disable these handlers:
+
+.. code-block:: python
+
+    DOWNLOAD_HANDLERS = {
+        "file": None,
+        "data": None,
+    }
+
+* **Pro:** crawled URLs cannot be used to read local files or inline data.
+
+* **Con:** you can no longer fetch ``file://`` or ``data:`` URLs.
+
+More generally, if you crawl URLs from untrusted sources, consider validating
+their schemes (and, where applicable, their hosts) before scheduling requests,
+to avoid server-side request forgery (SSRF) and similar issues.
+
+.. _security-telnet:
+
+Telnet console
+==============
+
+Scrapy enables the :ref:`telnet console <topics-telnetconsole>` by default
+(:setting:`TELNETCONSOLE_ENABLED`). The telnet console is a Python shell
+running inside the Scrapy process, so anyone who can connect to it can run
+arbitrary code in that process.
+
+By default the console binds to ``127.0.0.1`` (:setting:`TELNETCONSOLE_HOST`)
+and is protected by a username (:setting:`TELNETCONSOLE_USERNAME`, default
+``scrapy``) and an automatically generated password
+(:setting:`TELNETCONSOLE_PASSWORD`), so it is only reachable from the local
+machine.
+
+.. warning::
+
+    Telnet does not provide any transport-layer security, so the
+    username/password authentication does not protect the credentials or the
+    session from anyone able to observe the traffic. Never expose the telnet
+    console over an untrusted network by changing :setting:`TELNETCONSOLE_HOST`
+    to a non-local address.
+
+If you do not use the telnet console, disable it entirely:
+
+.. code-block:: python
+
+    TELNETCONSOLE_ENABLED = False
+
+* **Pro:** removes a local code-execution surface and one less listening port.
+
+* **Con:** you can no longer :ref:`inspect and control a running crawler
+  <topics-telnetconsole>` through it.
+
+.. _security-credential-leakage:
+
+Credential leakage across domains
+=================================
+
+Some Scrapy features attach credentials or other sensitive headers to requests,
+and a crawl that spans multiple domains can leak them to unintended hosts:
+
+* HTTP authentication credentials set through
+  :class:`~scrapy.downloadermiddlewares.httpauth.HttpAuthMiddleware` are only
+  sent to the domain set in :setting:`HTTPAUTH_DOMAIN`. Leave this set to the
+  intended domain rather than ``None`` so that credentials are not sent to
+  every domain you crawl.
+
+* The ``Referer`` header may disclose the URLs you crawl to other sites. The
+  default :setting:`REFERRER_POLICY` already avoids sending the referrer from
+  HTTPS to HTTP, but you can tighten it further (for example, to
+  ``same-origin`` or ``no-referrer``) if needed.

docs/topics/shell.rst

@@ -17,30 +17,35 @@ spider, without having to run the spider to test every change.
 Once you get familiarized with the Scrapy shell, you'll see that it's an
 invaluable tool for developing and debugging your spiders.
 
+.. _shell-config:
+
 Configuring the shell
 =====================
 
-If you have `IPython`_ installed, the Scrapy shell will use it (instead of the
-standard Python console). The `IPython`_ console is much more powerful and
-provides smart auto-completion and colorized output, among other things.
+With the :ref:`ptpython <extras>` extra, the Scrapy shell will use ptpython_
+instead of the :term:`REPL`. ptpython provides syntax highlighting, smart
+auto-completion, and more.
 
-We highly recommend you install `IPython`_, specially if you're working on
-Unix systems (where `IPython`_ excels). See the `IPython installation guide`_
-for more info.
+Failing that, with the :ref:`ipython <extras>` extra, the Scrapy shell will
+use IPython_ instead. IPython provides smart auto-completion, colorized
+output, and more.
 
-Scrapy also has support for `bpython`_, and will try to use it where `IPython`_
-is unavailable.
+Scrapy also has support for `bpython`_ via the :ref:`bpython <extras>` extra,
+and will try to use it where neither ptpython nor IPython is available.
 
 Through Scrapy's settings you can configure it to use any one of
-``ipython``, ``bpython`` or the standard ``python`` shell, regardless of which
-are installed. This is done by setting the ``SCRAPY_PYTHON_SHELL`` environment
-variable; or by defining it in your :ref:`scrapy.cfg <topics-config-settings>`::
+``ptpython``, ``ipython``, ``bpython`` or the standard ``python`` shell,
+regardless of which are installed. This is done by setting the
+``SCRAPY_PYTHON_SHELL`` environment variable; or by defining it in your
+:ref:`scrapy.cfg <topics-config-settings>`:
+
+.. code-block:: ini
 
     [settings]
     shell = bpython
 
+.. _ptpython: https://github.com/prompt-toolkit/ptpython
 .. _IPython: https://ipython.org/
-.. _IPython installation guide: https://ipython.org/install.html
 .. _bpython: https://bpython-interpreter.org/
 
 Launch the shell
@@ -111,7 +116,7 @@ Available Shortcuts
     Note, however, that this will create a temporary file in your computer,
     which won't be removed automatically.
 
-.. _<base> tag: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base
+.. _<base> tag: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/base
 
 Available Scrapy objects
 ------------------------
@@ -142,8 +147,10 @@ Those objects are:
 Example of shell session
 ========================
 
+.. skip: start
+
 Here's an example of a typical shell session where we start by scraping the
-https://scrapy.org page, and then proceed to scrape the https://old.reddit.com/
+https://www.scrapy.org/ page, and then proceed to scrape the https://old.reddit.com/
 page. Finally, we modify the (Reddit) request method to POST and re-fetch it
 getting an error. We end the session by typing Ctrl-D (in Unix systems) or
 Ctrl-Z in Windows.
@@ -191,44 +198,48 @@ all start with the ``[s]`` prefix)::
 
 After that, we can start playing with the objects:
 
->>> response.xpath('//title/text()').get()
-'Scrapy | A Fast and Powerful Scraping and Web Crawling Framework'
+.. code-block:: pycon
 
->>> fetch("https://old.reddit.com/")
+    >>> response.xpath("//title/text()").get()
+    'Scrapy | A Fast and Powerful Scraping and Web Crawling Framework'
 
->>> response.xpath('//title/text()').get()
-'reddit: the front page of the internet'
+    >>> fetch("https://old.reddit.com/")
 
->>> request = request.replace(method="POST")
+    >>> response.xpath("//title/text()").get()
+    'reddit: the front page of the internet'
 
->>> fetch(request)
+    >>> request = request.replace(method="POST")
 
->>> response.status
-404
+    >>> fetch(request)
 
->>> from pprint import pprint
+    >>> response.status
+    404
 
->>> pprint(response.headers)
-{'Accept-Ranges': ['bytes'],
- 'Cache-Control': ['max-age=0, must-revalidate'],
- 'Content-Type': ['text/html; charset=UTF-8'],
- 'Date': ['Thu, 08 Dec 2016 16:21:19 GMT'],
- 'Server': ['snooserv'],
- 'Set-Cookie': ['loid=KqNLou0V9SKMX4qb4n; Domain=reddit.com; Max-Age=63071999; Path=/; expires=Sat, 08-Dec-2018 16:21:19 GMT; secure',
-                'loidcreated=2016-12-08T16%3A21%3A19.445Z; Domain=reddit.com; Max-Age=63071999; Path=/; expires=Sat, 08-Dec-2018 16:21:19 GMT; secure',
-                'loid=vi0ZVe4NkxNWdlH7r7; Domain=reddit.com; Max-Age=63071999; Path=/; expires=Sat, 08-Dec-2018 16:21:19 GMT; secure',
-                'loidcreated=2016-12-08T16%3A21%3A19.459Z; Domain=reddit.com; Max-Age=63071999; Path=/; expires=Sat, 08-Dec-2018 16:21:19 GMT; secure'],
- 'Vary': ['accept-encoding'],
- 'Via': ['1.1 varnish'],
- 'X-Cache': ['MISS'],
- 'X-Cache-Hits': ['0'],
- 'X-Content-Type-Options': ['nosniff'],
- 'X-Frame-Options': ['SAMEORIGIN'],
- 'X-Moose': ['majestic'],
- 'X-Served-By': ['cache-cdg8730-CDG'],
- 'X-Timer': ['S1481214079.394283,VS0,VE159'],
- 'X-Ua-Compatible': ['IE=edge'],
- 'X-Xss-Protection': ['1; mode=block']}
+    >>> from pprint import pprint
+
+    >>> pprint(response.headers)
+    {'Accept-Ranges': ['bytes'],
+    'Cache-Control': ['max-age=0, must-revalidate'],
+    'Content-Type': ['text/html; charset=UTF-8'],
+    'Date': ['Thu, 08 Dec 2016 16:21:19 GMT'],
+    'Server': ['snooserv'],
+    'Set-Cookie': ['loid=KqNLou0V9SKMX4qb4n; Domain=reddit.com; Max-Age=63071999; Path=/; expires=Sat, 08-Dec-2018 16:21:19 GMT; secure',
+                    'loidcreated=2016-12-08T16%3A21%3A19.445Z; Domain=reddit.com; Max-Age=63071999; Path=/; expires=Sat, 08-Dec-2018 16:21:19 GMT; secure',
+                    'loid=vi0ZVe4NkxNWdlH7r7; Domain=reddit.com; Max-Age=63071999; Path=/; expires=Sat, 08-Dec-2018 16:21:19 GMT; secure',
+                    'loidcreated=2016-12-08T16%3A21%3A19.459Z; Domain=reddit.com; Max-Age=63071999; Path=/; expires=Sat, 08-Dec-2018 16:21:19 GMT; secure'],
+    'Vary': ['accept-encoding'],
+    'Via': ['1.1 varnish'],
+    'X-Cache': ['MISS'],
+    'X-Cache-Hits': ['0'],
+    'X-Content-Type-Options': ['nosniff'],
+    'X-Frame-Options': ['SAMEORIGIN'],
+    'X-Moose': ['majestic'],
+    'X-Served-By': ['cache-cdg8730-CDG'],
+    'X-Timer': ['S1481214079.394283,VS0,VE159'],
+    'X-Ua-Compatible': ['IE=edge'],
+    'X-Xss-Protection': ['1; mode=block']}
+
+.. skip: end
 
 
 .. _topics-shell-inspect-response:
@@ -242,7 +253,9 @@ getting there.
 
 This can be achieved by using the ``scrapy.shell.inspect_response`` function.
 
-Here's an example of how you would call it from your spider::
+Here's an example of how you would call it from your spider:
+
+.. code-block:: python
 
     import scrapy
 
@@ -259,10 +272,13 @@ Here's an example of how you would call it from your spider::
             # We want to inspect one specific response.
             if ".org" in response.url:
                 from scrapy.shell import inspect_response
+
                 inspect_response(response, self)
 
             # Rest of parsing code.
 
+.. skip: start
+
 When you run the spider, you will get something similar to this::
 
     2014-01-23 17:48:31-0400 [scrapy.core.engine] DEBUG: Crawled (200) <GET http://example.com> (referer: None)
@@ -276,14 +292,18 @@ When you run the spider, you will get something similar to this::
 
 Then, you can check if the extraction code is working:
 
->>> response.xpath('//h1[@class="fn"]')
-[]
+.. code-block:: pycon
+
+    >>> response.xpath('//h1[@class="fn"]')
+    []
 
 Nope, it doesn't. So you can open the response in your web browser and see if
 it's the response you were expecting:
 
->>> view(response)
-True
+.. code-block:: pycon
+
+    >>> view(response)
+    True
 
 Finally you hit Ctrl-D (or Ctrl-Z in Windows) to exit the shell and resume the
 crawling::
@@ -292,6 +312,8 @@ crawling::
     2014-01-23 17:50:03-0400 [scrapy.core.engine] DEBUG: Crawled (200) <GET http://example.net> (referer: None)
     ...
 
+.. skip: end
+
 Note that you can't use the ``fetch`` shortcut here since the Scrapy engine is
 blocked by the shell. However, after you leave the shell, the spider will
 continue crawling where it stopped, as shown above.

docs/topics/signals.rst

@@ -16,7 +16,9 @@ deliver the arguments that the handler receives.
 You can connect to signals (or send your own) through the
 :ref:`topics-api-signals`.
 
-Here is a simple example showing how you can catch signals and perform some action::
+Here is a simple example showing how you can catch signals and perform some action:
+
+.. code-block:: python
 
     from scrapy import signals
     from scrapy import Spider
@@ -30,66 +32,70 @@ Here is a simple example showing how you can catch signals and perform some acti
             "http://www.dmoz.org/Computers/Programming/Languages/Python/Resources/",
         ]
 
-
         @classmethod
         def from_crawler(cls, crawler, *args, **kwargs):
-            spider = super(DmozSpider, cls).from_crawler(crawler, *args, **kwargs)
+            spider = super().from_crawler(crawler, *args, **kwargs)
             crawler.signals.connect(spider.spider_closed, signal=signals.spider_closed)
             return spider
 
-
         def spider_closed(self, spider):
-            spider.logger.info('Spider closed: %s', spider.name)
-
+            spider.logger.info("Spider closed: %s", spider.name)
 
         def parse(self, response):
             pass
 
 .. _signal-deferred:
 
-Deferred signal handlers
-========================
+Asynchronous signal handlers
+============================
 
 Some signals support returning :class:`~twisted.internet.defer.Deferred`
-objects from their handlers, allowing you to run asynchronous code that
-does not block Scrapy. If a signal handler returns a
-:class:`~twisted.internet.defer.Deferred`, Scrapy waits for that
-:class:`~twisted.internet.defer.Deferred` to fire.
+or :term:`awaitable objects <awaitable>` from their handlers, allowing
+you to run asynchronous code that does not block Scrapy. If a signal
+handler returns one of these objects, Scrapy waits for that asynchronous
+operation to finish.
+
+Let's take an example using :ref:`coroutines <topics-coroutines>`:
+
+.. skip: next
+.. code-block:: python
+
+    import json
+
+    import scrapy
+    import treq
 
-Let's take an example::
 
     class SignalSpider(scrapy.Spider):
-        name = 'signals'
-        start_urls = ['http://quotes.toscrape.com/page/1/']
+        name = "signals"
+        start_urls = ["https://quotes.toscrape.com/page/1/"]
 
         @classmethod
         def from_crawler(cls, crawler, *args, **kwargs):
-            spider = super(SignalSpider, cls).from_crawler(crawler, *args, **kwargs)
+            spider = super().from_crawler(crawler, *args, **kwargs)
             crawler.signals.connect(spider.item_scraped, signal=signals.item_scraped)
             return spider
 
-        def item_scraped(self, item):
+        async def item_scraped(self, item):
             # Send the scraped item to the server
-            d = treq.post(
-                'http://example.com/post',
-                json.dumps(item).encode('ascii'),
-                headers={b'Content-Type': [b'application/json']}
+            response = await treq.post(
+                "http://example.com/post",
+                json.dumps(item).encode("ascii"),
+                headers={b"Content-Type": [b"application/json"]},
             )
 
-            # The next item will be scraped only after
-            # deferred (d) is fired
-            return d
+            return response
 
         def parse(self, response):
-            for quote in response.css('div.quote'):
+            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(),
+                    "text": quote.css("span.text::text").get(),
+                    "author": quote.css("small.author::text").get(),
+                    "tags": quote.css("div.tags a.tag::text").getall(),
                 }
 
 See the :ref:`topics-signals-ref` below to know which signals support
-:class:`~twisted.internet.defer.Deferred`.
+:class:`~twisted.internet.defer.Deferred` and :term:`awaitable objects <awaitable>`.
 
 .. _topics-signals-ref:
 
@@ -101,6 +107,7 @@ Built-in signals reference
 
 Here's the list of Scrapy built-in signals and their meaning.
 
+
 Engine signals
 --------------
 
@@ -112,7 +119,7 @@ engine_started
 
     Sent when the Scrapy engine has started crawling.
 
-    This signal supports returning deferreds from its handlers.
+    This signal supports :ref:`asynchronous handlers <signal-deferred>`.
 
 .. note:: This signal may be fired *after* the :signal:`spider_opened` signal,
     depending on how the spider was started. So **don't** rely on this signal
@@ -127,7 +134,23 @@ engine_stopped
     Sent when the Scrapy engine is stopped (for example, when a crawling
     process has finished).
 
-    This signal supports returning deferreds from its handlers.
+    This signal supports :ref:`asynchronous handlers <signal-deferred>`.
+
+scheduler_empty
+~~~~~~~~~~~~~~~
+
+.. signal:: scheduler_empty
+.. function:: scheduler_empty()
+
+    Sent whenever the engine asks for a pending request from the
+    :ref:`scheduler <topics-scheduler>` (i.e. calls its
+    :meth:`~scrapy.core.scheduler.BaseScheduler.next_request` method) and the
+    scheduler returns none.
+
+    See :ref:`start-requests-lazy` for an example.
+
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
+
 
 Item signals
 ------------
@@ -149,7 +172,7 @@ item_scraped
     Sent when an item has been scraped, after it has passed all the
     :ref:`topics-item-pipeline` stages (without being dropped).
 
-    This signal supports returning deferreds from its handlers.
+    This signal supports :ref:`asynchronous handlers <signal-deferred>`.
 
     :param item: the scraped item
     :type item: :ref:`item object <item-types>`
@@ -157,8 +180,9 @@ item_scraped
     :param spider: the spider which scraped the item
     :type spider: :class:`~scrapy.Spider` object
 
-    :param response: the response from where the item was scraped
-    :type response: :class:`~scrapy.http.Response` object
+    :param response: the response from where the item was scraped, or ``None``
+        if it was yielded from :meth:`~scrapy.Spider.start`.
+    :type response: :class:`~scrapy.http.Response` | ``None``
 
 item_dropped
 ~~~~~~~~~~~~
@@ -169,7 +193,7 @@ item_dropped
     Sent after an item has been dropped from the :ref:`topics-item-pipeline`
     when some stage raised a :exc:`~scrapy.exceptions.DropItem` exception.
 
-    This signal supports returning deferreds from its handlers.
+    This signal supports :ref:`asynchronous handlers <signal-deferred>`.
 
     :param item: the item dropped from the :ref:`topics-item-pipeline`
     :type item: :ref:`item object <item-types>`
@@ -177,8 +201,9 @@ item_dropped
     :param spider: the spider which scraped the item
     :type spider: :class:`~scrapy.Spider` object
 
-    :param response: the response from where the item was dropped
-    :type response: :class:`~scrapy.http.Response` object
+    :param response: the response from where the item was dropped, or ``None``
+        if it was yielded from :meth:`~scrapy.Spider.start`.
+    :type response: :class:`~scrapy.http.Response` | ``None``
 
     :param exception: the exception (which must be a
         :exc:`~scrapy.exceptions.DropItem` subclass) which caused the item
@@ -194,13 +219,15 @@ item_error
     Sent when a :ref:`topics-item-pipeline` generates an error (i.e. raises
     an exception), except :exc:`~scrapy.exceptions.DropItem` exception.
 
-    This signal supports returning deferreds from its handlers.
+    This signal supports :ref:`asynchronous handlers <signal-deferred>`.
 
     :param item: the item that caused the error in the :ref:`topics-item-pipeline`
     :type item: :ref:`item object <item-types>`
 
-    :param response: the response being processed when the exception was raised
-    :type response: :class:`~scrapy.http.Response` object
+    :param response: the response being processed when the exception was
+        raised, or ``None`` if it was yielded from
+        :meth:`~scrapy.Spider.start`.
+    :type response: :class:`~scrapy.http.Response` | ``None``
 
     :param spider: the spider which raised the exception
     :type spider: :class:`~scrapy.Spider` object
@@ -208,6 +235,7 @@ item_error
     :param failure: the exception raised
     :type failure: twisted.python.failure.Failure
 
+
 Spider signals
 --------------
 
@@ -220,7 +248,7 @@ spider_closed
     Sent after a spider has been closed. This can be used to release per-spider
     resources reserved on :signal:`spider_opened`.
 
-    This signal supports returning deferreds from its handlers.
+    This signal supports :ref:`asynchronous handlers <signal-deferred>`.
 
     :param spider: the spider which has been closed
     :type spider: :class:`~scrapy.Spider` object
@@ -244,7 +272,7 @@ spider_opened
     reserve per-spider resources, but can be used for any task that needs to be
     performed when a spider is opened.
 
-    This signal supports returning deferreds from its handlers.
+    This signal supports :ref:`asynchronous handlers <signal-deferred>`.
 
     :param spider: the spider which has been opened
     :type spider: :class:`~scrapy.Spider` object
@@ -275,16 +303,16 @@ spider_idle
     accordingly (e.g. setting it to 'too_few_results' instead of
     'finished').
 
-    This signal does not support returning deferreds from its handlers.
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
 
     :param spider: the spider which has gone idle
     :type spider: :class:`~scrapy.Spider` object
 
-.. note:: Scheduling some requests in your :signal:`spider_idle` handler does
-    **not** guarantee that it can prevent the spider from being closed,
-    although it sometimes can. That's because the spider may still remain idle
-    if all the scheduled requests are rejected by the scheduler (e.g. filtered
-    due to duplication).
+    .. note:: Scheduling some requests in your :signal:`spider_idle` handler does
+        **not** guarantee that it can prevent the spider from being closed,
+        although it sometimes can. That's because the spider may still remain idle
+        if all the scheduled requests are rejected by the scheduler (e.g. filtered
+        due to duplication).
 
 spider_error
 ~~~~~~~~~~~~
@@ -294,7 +322,7 @@ spider_error
 
     Sent when a spider callback generates an error (i.e. raises an exception).
 
-    This signal does not support returning deferreds from its handlers.
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
 
     :param failure: the exception raised
     :type failure: twisted.python.failure.Failure
@@ -305,6 +333,44 @@ spider_error
     :param spider: the spider which raised the exception
     :type spider: :class:`~scrapy.Spider` object
 
+feed_slot_closed
+~~~~~~~~~~~~~~~~
+
+.. signal:: feed_slot_closed
+.. function:: feed_slot_closed(slot)
+
+    Sent when a :ref:`feed exports <topics-feed-exports>` slot is closed.
+
+    This signal supports :ref:`asynchronous handlers <signal-deferred>`.
+
+    :param slot: the slot closed
+    :type slot: scrapy.extensions.feedexport.FeedSlot
+
+feed_exporter_closed
+~~~~~~~~~~~~~~~~~~~~
+
+.. signal:: feed_exporter_closed
+.. function:: feed_exporter_closed()
+
+    Sent when the :ref:`feed exports <topics-feed-exports>` extension is closed,
+    during the handling of the :signal:`spider_closed` signal by the extension,
+    after all feed exporting has been handled.
+
+    This signal supports :ref:`asynchronous handlers <signal-deferred>`.
+
+memusage_warning_reached
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. signal:: memusage_warning_reached
+
+.. function:: memusage_warning_reached()
+
+    Sent by the :class:`~scrapy.extensions.memusage.MemoryUsage` extension when the
+    memory usage reaches the warning threshold (:setting:`MEMUSAGE_WARNING_MB`).
+
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
+
+
 Request signals
 ---------------
 
@@ -314,10 +380,17 @@ request_scheduled
 .. signal:: request_scheduled
 .. function:: request_scheduled(request, spider)
 
-    Sent when the engine schedules a :class:`~scrapy.Request`, to be
-    downloaded later.
+    Sent when the engine is asked to schedule a :class:`~scrapy.Request`, to be
+    downloaded later, before the request reaches the :ref:`scheduler
+    <topics-scheduler>`.
 
-    This signal does not support returning deferreds from its handlers.
+    Raise :exc:`~scrapy.exceptions.IgnoreRequest` to drop a request before it
+    reaches the scheduler.
+
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
+
+    .. versionadded:: 2.11.2
+        Allow dropping requests with :exc:`~scrapy.exceptions.IgnoreRequest`.
 
     :param request: the request that reached the scheduler
     :type request: :class:`~scrapy.Request` object
@@ -334,7 +407,7 @@ request_dropped
     Sent when a :class:`~scrapy.Request`, scheduled by the engine to be
     downloaded later, is rejected by the scheduler.
 
-    This signal does not support returning deferreds from its handlers.
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
 
     :param request: the request that reached the scheduler
     :type request: :class:`~scrapy.Request` object
@@ -350,7 +423,7 @@ request_reached_downloader
 
     Sent when a :class:`~scrapy.Request` reached downloader.
 
-    This signal does not support returning deferreds from its handlers.
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
 
     :param request: the request that reached downloader
     :type request: :class:`~scrapy.Request` object
@@ -364,12 +437,10 @@ request_left_downloader
 .. signal:: request_left_downloader
 .. function:: request_left_downloader(request, spider)
 
-    .. versionadded:: 2.0
-
     Sent when a :class:`~scrapy.Request` leaves the downloader, even in case of
     failure.
 
-    This signal does not support returning deferreds from its handlers.
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
 
     :param request: the request that reached the downloader
     :type request: :class:`~scrapy.Request` object
@@ -380,12 +451,10 @@ request_left_downloader
 bytes_received
 ~~~~~~~~~~~~~~
 
-.. versionadded:: 2.2
-
 .. signal:: bytes_received
 .. function:: bytes_received(data, request, spider)
 
-    Sent by the HTTP 1.1 and S3 download handlers when a group of bytes is
+    Sent by some download handlers when a group of bytes is
     received for a specific request. This signal might be fired multiple
     times for the same request, with partial data each time. For instance,
     a possible scenario for a 25 kb response would be two signals fired
@@ -396,7 +465,7 @@ bytes_received
     exception. Please refer to the :ref:`topics-stop-response-download` topic
     for additional information and examples.
 
-    This signal does not support returning deferreds from its handlers.
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
 
     :param data: the data received by the download handler
     :type data: :class:`bytes` object
@@ -410,12 +479,10 @@ bytes_received
 headers_received
 ~~~~~~~~~~~~~~~~
 
-.. versionadded:: 2.5
-
 .. signal:: headers_received
 .. function:: headers_received(headers, body_length, request, spider)
 
-    Sent by the HTTP 1.1 and S3 download handlers when the response headers are
+    Sent by some download handlers when the response headers are
     available for a given request, before downloading any additional content.
 
     Handlers for this signal can stop the download of a response while it
@@ -423,7 +490,7 @@ headers_received
     exception. Please refer to the :ref:`topics-stop-response-download` topic
     for additional information and examples.
 
-    This signal does not support returning deferreds from its handlers.
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
 
     :param headers: the headers received by the download handler
     :type headers: :class:`scrapy.http.headers.Headers` object
@@ -437,6 +504,28 @@ headers_received
     :param spider: the spider associated with the response
     :type spider: :class:`~scrapy.Spider` object
 
+robots_parsed
+~~~~~~~~~~~~~
+
+.. signal:: robots_parsed
+.. function:: robots_parsed(robotparser, request)
+
+    .. versionadded:: VERSION
+
+    Sent by
+    :class:`~scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware` after it
+    downloads and parses a :file:`robots.txt` file, for the host that *request*
+    targets.
+
+    This signal supports :ref:`asynchronous handlers <signal-deferred>`.
+
+    :param robotparser: the parser holding the parsed :file:`robots.txt` contents
+    :type robotparser: :class:`~scrapy.robotstxt.RobotParser` object
+
+    :param request: the request that triggered the :file:`robots.txt` download
+    :type request: :class:`~scrapy.Request` object
+
+
 Response signals
 ----------------
 
@@ -449,7 +538,7 @@ response_received
     Sent when the engine receives a new :class:`~scrapy.http.Response` from the
     downloader.
 
-    This signal does not support returning deferreds from its handlers.
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
 
     :param response: the response received
     :type response: :class:`~scrapy.http.Response` object
@@ -471,9 +560,9 @@ response_downloaded
 .. signal:: response_downloaded
 .. function:: response_downloaded(response, request, spider)
 
-    Sent by the downloader right after a ``HTTPResponse`` is downloaded.
+    Sent by the downloader right after a :class:`~scrapy.http.Response` is downloaded.
 
-    This signal does not support returning deferreds from its handlers.
+    This signal does not support :ref:`asynchronous handlers <signal-deferred>`.
 
     :param response: the response downloaded
     :type response: :class:`~scrapy.http.Response` object

docs/topics/spider-middleware.rst

@@ -18,10 +18,12 @@ To activate a spider middleware component, add it to the
 :setting:`SPIDER_MIDDLEWARES` setting, which is a dict whose keys are the
 middleware class path and their values are the middleware orders.
 
-Here's an example::
+Here's an example:
+
+.. code-block:: python
 
     SPIDER_MIDDLEWARES = {
-        'myproject.middlewares.CustomSpiderMiddleware': 543,
+        "myproject.middlewares.CustomSpiderMiddleware": 543,
     }
 
 The :setting:`SPIDER_MIDDLEWARES` setting is merged with the
@@ -44,11 +46,13 @@ previous (or subsequent) middleware being applied.
 If you want to disable a builtin middleware (the ones defined in
 :setting:`SPIDER_MIDDLEWARES_BASE`, and enabled by default) you must define it
 in your project :setting:`SPIDER_MIDDLEWARES` setting and assign ``None`` as its
-value.  For example, if you want to disable the off-site middleware::
+value.  For example, if you want to disable the referer middleware:
+
+.. code-block:: python
 
     SPIDER_MIDDLEWARES = {
-        'myproject.middlewares.CustomSpiderMiddleware': 543,
-        'scrapy.spidermiddlewares.offsite.OffsiteMiddleware': None,
+        "scrapy.spidermiddlewares.referer.RefererMiddleware": None,
+        "myproject.middlewares.CustomRefererSpiderMiddleware": 700,
     }
 
 Finally, keep in mind that some middlewares may need to be enabled through a
@@ -59,18 +63,38 @@ particular setting. See each middleware documentation for more info.
 Writing your own spider middleware
 ==================================
 
-Each spider middleware is a Python class that defines one or more of the
-methods defined below.
-
-The main entry point is the ``from_crawler`` class method, which receives a
-:class:`~scrapy.crawler.Crawler` instance. The :class:`~scrapy.crawler.Crawler`
-object gives you access, for example, to the :ref:`settings <topics-settings>`.
+Each spider middleware is a :ref:`component <topics-components>` that defines
+one or more of these methods:
 
 .. module:: scrapy.spidermiddlewares
 
 .. class:: SpiderMiddleware
 
-    .. method:: process_spider_input(response, spider)
+    .. method:: process_start(start: AsyncIterator[Any], /) -> AsyncIterator[Any]
+        :async:
+
+        Iterate over the output of :meth:`~scrapy.Spider.start` or that
+        of the :meth:`process_start` method of an earlier spider middleware,
+        overriding it. For example:
+
+        .. code-block:: python
+
+            async def process_start(self, start):
+                async for item_or_request in start:
+                    yield item_or_request
+
+        You may yield the same type of objects as :meth:`~scrapy.Spider.start`.
+
+        To write spider middlewares that work on Scrapy versions lower than
+        2.13, define also a synchronous ``process_start_requests()`` method
+        that returns an iterable. For example:
+
+        .. code-block:: python
+
+            def process_start_requests(self, start, spider):
+                yield from start
+
+    .. method:: process_spider_input(response)
 
         This method is called for each response that goes through the spider
         middleware and into the spider, for processing.
@@ -92,37 +116,37 @@ object gives you access, for example, to the :ref:`settings <topics-settings>`.
         :param response: the response being processed
         :type response: :class:`~scrapy.http.Response` object
 
-        :param spider: the spider for which this response is intended
-        :type spider: :class:`~scrapy.Spider` object
+    .. method:: process_spider_output(response, result)
+        :async:
 
+        This method is an :term:`asynchronous generator` called with the
+        results from the spider after the spider has processed the response.
 
-    .. method:: process_spider_output(response, result, spider)
-
-        This method is called with the results returned from the Spider, after
-        it has processed the response.
-
-        :meth:`process_spider_output` must return an iterable of
-        :class:`~scrapy.Request` objects and :ref:`item object
-        <topics-items>`.
+        .. seealso:: :ref:`universal-spider-middleware`.
 
         :param response: the response which generated this output from the
           spider
         :type response: :class:`~scrapy.http.Response` object
 
-        :param result: the result returned by the spider
-        :type result: an iterable of :class:`~scrapy.Request` objects and
-          :ref:`item object <topics-items>`
+        :param result: the results from the spider
+        :type result: an :term:`asynchronous iterable` of
+          :class:`~scrapy.Request` objects and :ref:`item objects
+          <topics-items>`
 
-        :param spider: the spider whose result is being processed
-        :type spider: :class:`~scrapy.Spider` object
+    .. method:: process_spider_output_async(response, result)
+        :async:
 
-    .. method:: process_spider_exception(response, exception, spider)
+        Alternative name for :meth:`process_spider_output` used when
+        implementing a :ref:`universal spider middleware
+        <universal-spider-middleware>`.
+
+    .. method:: process_spider_exception(response, exception)
 
         This method is called when a spider or :meth:`process_spider_output`
         method (from a previous spider middleware) raises an exception.
 
         :meth:`process_spider_exception` should return either ``None`` or an
-        iterable of :class:`~scrapy.Request` or :ref:`item <topics-items>` 
+        iterable of :class:`~scrapy.Request` or :ref:`item <topics-items>`
         objects.
 
         If it returns ``None``, Scrapy will continue processing this exception,
@@ -141,44 +165,46 @@ object gives you access, for example, to the :ref:`settings <topics-settings>`.
         :param exception: the exception raised
         :type exception: :exc:`Exception` object
 
-        :param spider: the spider which raised the exception
-        :type spider: :class:`~scrapy.Spider` object
 
-    .. method:: process_start_requests(start_requests, spider)
+.. _universal-spider-middleware:
 
-        This method is called with the start requests of the spider, and works
-        similarly to the :meth:`process_spider_output` method, except that it
-        doesn't have a response associated and must return only requests (not
-        items).
+Universal spider middlewares
+----------------------------
 
-        It receives an iterable (in the ``start_requests`` parameter) and must
-        return another iterable of :class:`~scrapy.Request` objects.
+In Scrapy 2.6.3 and lower, ``process_spider_output()`` must be a *synchronous*
+generator.
 
-        .. note:: When implementing this method in your spider middleware, you
-           should always return an iterable (that follows the input one) and
-           not consume all ``start_requests`` iterator because it can be very
-           large (or even unbounded) and cause a memory overflow. The Scrapy
-           engine is designed to pull start requests while it has capacity to
-           process them, so the start requests iterator can be effectively
-           endless where there is some other condition for stopping the spider
-           (like a time limit or item/page count).
+To support those versions and higher Scrapy versions in the same middleware,
+rename your asynchronous :meth:`~SpiderMiddleware.process_spider_output`
+method to :meth:`~SpiderMiddleware.process_spider_output_async`, and define a
+synchronous ``process_spider_output()`` method to be used by 2.6.3 and lower
+versions.
 
-        :param start_requests: the start requests
-        :type start_requests: an iterable of :class:`~scrapy.Request`
+For example:
 
-        :param spider: the spider to whom the start requests belong
-        :type spider: :class:`~scrapy.Spider` object
+.. code-block:: python
 
-    .. method:: from_crawler(cls, crawler)
+    class UniversalSpiderMiddleware:
+        async def process_spider_output_async(self, response, result):
+            async for r in result:
+                # ... do something with r
+                yield r
 
-       If present, this classmethod is called to create a middleware instance
-       from a :class:`~scrapy.crawler.Crawler`. It must return a new instance
-       of the middleware. Crawler object provides access to all Scrapy core
-       components like settings and signals; it is a way for middleware to
-       access them and hook its functionality into Scrapy.
+        def process_spider_output(self, response, result):
+            for r in result:
+                # ... do something with r
+                yield r
 
-       :param crawler: crawler that uses this middleware
-       :type crawler: :class:`~scrapy.crawler.Crawler` object
+Base class for custom spider middlewares
+----------------------------------------
+
+Scrapy provides a base class for custom spider middlewares. It's not required
+to use it but it can help with simplifying middleware implementations.
+
+.. module:: scrapy.spidermiddlewares.base
+
+.. autoclass:: BaseSpiderMiddleware
+   :members:
 
 .. _topics-spider-middleware-ref:
 
@@ -241,7 +267,12 @@ specify which response codes the spider is able to handle using the
 :setting:`HTTPERROR_ALLOWED_CODES` setting.
 
 For example, if you want your spider to handle 404 responses you can do
-this::
+this:
+
+.. code-block:: python
+
+    from scrapy.spiders import CrawlSpider
+
 
     class MySpider(CrawlSpider):
         handle_httpstatus_list = [404]
@@ -284,41 +315,34 @@ Default: ``False``
 
 Pass all responses, regardless of its status code.
 
-OffsiteMiddleware
------------------
 
-.. module:: scrapy.spidermiddlewares.offsite
-   :synopsis: Offsite Spider Middleware
+MetaCopyDetectionMiddleware
+---------------------------
 
-.. class:: OffsiteMiddleware
+.. module:: scrapy.spidermiddlewares.metacopy
+   :synopsis: Meta Copy Detection Spider Middleware
 
-   Filters out Requests for URLs outside the domains covered by the spider.
+.. class:: MetaCopyDetectionMiddleware
 
-   This middleware filters out every request whose host names aren't in the
-   spider's :attr:`~scrapy.Spider.allowed_domains` attribute.
-   All subdomains of any domain in the list are also allowed.
-   E.g. the rule ``www.example.org`` will also allow ``bob.www.example.org``
-   but not ``www2.example.com`` nor ``example.com``.
+   Warns when a spider yields a request that contains internal meta keys which
+   should not be copied from :attr:`response.meta <scrapy.http.Response.meta>`
+   into new requests. See :attr:`~scrapy.http.Request.meta` to learn why.
 
-   When your spider returns a request for a domain not belonging to those
-   covered by the spider, this middleware will log a debug message similar to
-   this one::
+   Only 1 warning is emitted per crawl.
 
-      DEBUG: Filtered offsite request to 'www.othersite.com': <GET http://www.othersite.com/some/page.html>
+   MetaCopyDetectionMiddleware settings
+   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-   To avoid filling the log with too much noise, it will only print one of
-   these messages for each new domain filtered. So, for example, if another
-   request for ``www.othersite.com`` is filtered, no log message will be
-   printed. But if a request for ``someothersite.com`` is filtered, a message
-   will be printed (but only for the first request filtered).
+   .. setting:: META_COPY_WARN_SKIP_KEYS
 
-   If the spider doesn't define an
-   :attr:`~scrapy.Spider.allowed_domains` attribute, or the
-   attribute is empty, the offsite middleware will allow all requests.
+   META_COPY_WARN_SKIP_KEYS
+   ^^^^^^^^^^^^^^^^^^^^^^^^
 
-   If the request has the :attr:`~scrapy.Request.dont_filter` attribute
-   set, the offsite middleware will allow the request even if its domain is not
-   listed in allowed domains.
+   Default: ``[]``
+
+   A list of internal meta key names to exclude from the internal-keys check.
+   Use this when you intentionally copy one of the monitored keys and want to
+   suppress the resulting warning without disabling the middleware entirely.
 
 
 RefererMiddleware
@@ -360,12 +384,14 @@ Default: ``'scrapy.spidermiddlewares.referer.DefaultReferrerPolicy'``
     using the special ``"referrer_policy"`` :ref:`Request.meta <topics-request-meta>` key,
     with the same acceptable values as for the ``REFERRER_POLICY`` setting.
 
+.. seealso:: :ref:`security-credential-leakage`
+
 Acceptable values for REFERRER_POLICY
 *************************************
 
-- either a path to a ``scrapy.spidermiddlewares.referer.ReferrerPolicy``
+- either a path to a :class:`scrapy.spidermiddlewares.referer.ReferrerPolicy`
   subclass — a custom policy or one of the built-in ones (see classes below),
-- or one of the standard W3C-defined string values,
+- or one or more comma-separated standard W3C-defined string values,
 - or the special ``"scrapy-default"``.
 
 =======================================  ========================================================================
@@ -382,6 +408,8 @@ String value                             Class name (as a string)
 `"unsafe-url"`_                          :class:`scrapy.spidermiddlewares.referer.UnsafeUrlPolicy`
 =======================================  ========================================================================
 
+.. autoclass:: ReferrerPolicy
+
 .. autoclass:: DefaultReferrerPolicy
 .. warning::
     Scrapy's default referrer policy — just like `"no-referrer-when-downgrade"`_,
@@ -425,6 +453,33 @@ String value                             Class name (as a string)
 .. _"strict-origin-when-cross-origin": https://www.w3.org/TR/referrer-policy/#referrer-policy-strict-origin-when-cross-origin
 .. _"unsafe-url": https://www.w3.org/TR/referrer-policy/#referrer-policy-unsafe-url
 
+.. setting:: REFERRER_POLICIES
+
+REFERRER_POLICIES
+^^^^^^^^^^^^^^^^^
+
+.. versionadded:: 2.14.2
+
+Default: ``{}``
+
+A dictionary mapping policy names to import paths of
+:class:`scrapy.spidermiddlewares.referer.ReferrerPolicy` subclasses, or
+``None`` to disable support for a given policy name.
+
+This allows overriding the policies triggered by the ``Referrer-Policy``
+response header.
+
+Use ``""`` to override the policy for responses with `no referrer policy
+<https://www.w3.org/TR/referrer-policy/#referrer-policy-empty-string>`__.
+
+
+StartSpiderMiddleware
+---------------------
+
+.. module:: scrapy.spidermiddlewares.start
+
+.. autoclass:: StartSpiderMiddleware
+
 
 UrlLengthMiddleware
 -------------------

docs/topics/spiders.rst

@@ -4,61 +4,39 @@
 Spiders
 =======
 
-Spiders are classes which define how a certain site (or a group of sites) will be
-scraped, including how to perform the crawl (i.e. follow links) and how to
-extract structured data from their pages (i.e. scraping items). In other words,
-Spiders are the place where you define the custom behaviour for crawling and
-parsing pages for a particular site (or, in some cases, a group of sites).
+Spiders are classes that define how a site, or a group of sites, is scraped:
+which requests to send, and how to parse their responses to extract data and to
+send additional requests.
 
-For spiders, the scraping cycle goes through something like this:
+A crawl goes as follows:
 
-1. You start by generating the initial Requests to crawl the first URLs, and
-   specify a callback function to be called with the response downloaded from
-   those requests.
+1.  Scrapy iterates the :meth:`~scrapy.Spider.start` method of the spider to
+    get the initial requests. By default, that method yields a
+    :class:`~scrapy.Request` object for each URL in
+    :attr:`~scrapy.Spider.start_urls`, with :meth:`~scrapy.Spider.parse` as
+    :ref:`callback <callbacks>`.
 
-   The first requests to perform are obtained by calling the
-   :meth:`~scrapy.Spider.start_requests` method which (by default)
-   generates :class:`~scrapy.Request` for the URLs specified in the
-   :attr:`~scrapy.Spider.start_urls` and the
-   :attr:`~scrapy.Spider.parse` method as callback function for the
-   Requests.
+2.  Scrapy downloads each request and calls its callback with the resulting
+    :class:`~scrapy.http.Response`.
 
-2. In the callback function, you parse the response (web page) and return
-   :ref:`item objects <topics-items>`,
-   :class:`~scrapy.Request` objects, or an iterable of these objects.
-   Those Requests will also contain a callback (maybe
-   the same) and will then be downloaded by Scrapy and then their
-   response handled by the specified callback.
+3.  Callbacks parse the response, typically using :ref:`topics-selectors`, and
+    return or yield :ref:`item objects <topics-items>` with the extracted data
+    and :class:`~scrapy.Request` objects to continue the crawl, which go back
+    to step 2. See :ref:`callback-output`.
 
-3. In callback functions, you parse the page contents, typically using
-   :ref:`topics-selectors` (but you can also use BeautifulSoup, lxml or whatever
-   mechanism you prefer) and generate items with the parsed data.
+4.  Items go through :ref:`item pipelines <topics-item-pipeline>`, and are
+    usually stored through :ref:`topics-feed-exports`.
 
-4. Finally, the items returned from the spider will be typically persisted to a
-   database (in some :ref:`Item Pipeline <topics-item-pipeline>`) or written to
-   a file using :ref:`topics-feed-exports`.
-
-Even though this cycle applies (more or less) to any kind of spider, there are
-different kinds of default spiders bundled into Scrapy for different purposes.
-We will talk about those types here.
-
-.. module:: scrapy.spiders
-   :synopsis: Spiders base class, spider manager and spider middleware
+Scrapy includes different spider classes for different purposes, described
+below.
 
 .. _topics-spiders-ref:
 
 scrapy.Spider
 =============
 
-.. class:: scrapy.spiders.Spider()
-.. class:: scrapy.Spider()
-
-   This is the simplest spider, and the one from which every other spider
-   must inherit (including spiders that come bundled with Scrapy, as well as spiders
-   that you write yourself). It doesn't provide any special functionality. It just
-   provides a default :meth:`start_requests` implementation which sends requests from
-   the :attr:`start_urls` spider attribute and calls the spider's method ``parse``
-   for each of the resulting responses.
+.. class:: scrapy.spiders.Spider
+.. autoclass:: scrapy.Spider
 
    .. attribute:: name
 
@@ -78,17 +56,13 @@ scrapy.Spider
        An optional list of strings containing domains that this spider is
        allowed to crawl. Requests for URLs not belonging to the domain names
        specified in this list (or their subdomains) won't be followed if
-       :class:`~scrapy.spidermiddlewares.offsite.OffsiteMiddleware` is enabled.
+       :class:`~scrapy.downloadermiddlewares.offsite.OffsiteMiddleware` is
+       enabled.
 
        Let's say your target url is ``https://www.example.com/1.html``,
        then add ``'example.com'`` to the list.
 
-   .. attribute:: start_urls
-
-       A list of URLs where the spider will begin to crawl from, when no
-       particular URLs are specified. So, the first pages downloaded will be those
-       listed here. The subsequent :class:`~scrapy.Request` will be generated successively from data
-       contained in the start URLs.
+   .. autoattribute:: start_urls
 
    .. attribute:: custom_settings
 
@@ -102,7 +76,7 @@ scrapy.Spider
    .. attribute:: crawler
 
       This attribute is set by the :meth:`from_crawler` class method after
-      initializating the class, and links to the
+      initializing the class, and links to the
       :class:`~scrapy.crawler.Crawler` object to which this spider instance is
       bound.
 
@@ -139,6 +113,21 @@ scrapy.Spider
        attributes in the new instance so they can be accessed later inside the
        spider's code.
 
+       .. versionchanged:: 2.11
+
+           The settings in ``crawler.settings`` can now be modified in this
+           method, which is handy if you want to modify them based on
+           arguments. As a consequence, these settings aren't the final values
+           as they can be modified later by e.g. :ref:`add-ons
+           <topics-addons>`. For the same reason, most of the
+           :class:`~scrapy.crawler.Crawler` attributes aren't initialized at
+           this point.
+
+           The final settings and the initialized
+           :class:`~scrapy.crawler.Crawler` attributes are available in the
+           :meth:`start` method, handlers of the
+           :signal:`engine_started` signal and later.
+
        :param crawler: crawler to which the spider will be bound
        :type crawler: :class:`~scrapy.crawler.Crawler` instance
 
@@ -148,117 +137,122 @@ scrapy.Spider
        :param kwargs: keyword arguments passed to the :meth:`__init__` method
        :type kwargs: dict
 
-   .. method:: start_requests()
+   .. classmethod:: update_settings(settings)
 
-       This method must return an iterable with the first Requests to crawl for
-       this spider. It is called by Scrapy when the spider is opened for
-       scraping. Scrapy calls it only once, so it is safe to implement
-       :meth:`start_requests` as a generator.
+       The ``update_settings()`` method is used to modify the spider's settings
+       and is called during initialization of a spider instance.
 
-       The default implementation generates ``Request(url, dont_filter=True)``
-       for each url in :attr:`start_urls`.
+       It takes a :class:`~scrapy.settings.Settings` object as a parameter and
+       can add or update the spider's configuration values. This method is a
+       class method, meaning that it is called on the :class:`~scrapy.Spider`
+       class and allows all instances of the spider to share the same
+       configuration.
+
+       While per-spider settings can be set in
+       :attr:`~scrapy.Spider.custom_settings`, using ``update_settings()``
+       allows you to dynamically add, remove or change settings based on other
+       settings, spider attributes or other factors and use setting priorities
+       other than ``'spider'``. Also, it's easy to extend ``update_settings()``
+       in a subclass by overriding it, while doing the same with
+       :attr:`~scrapy.Spider.custom_settings` can be hard.
+
+       For example, suppose a spider needs to modify :setting:`FEEDS`:
+
+       .. code-block:: python
+
+           import scrapy
 
-       If you want to change the Requests used to start scraping a domain, this is
-       the method to override. For example, if you need to start by logging in using
-       a POST request, you could do::
 
            class MySpider(scrapy.Spider):
-               name = 'myspider'
+               name = "myspider"
+               custom_feed = {
+                   "/home/user/documents/items.json": {
+                       "format": "json",
+                       "indent": 4,
+                   }
+               }
 
-               def start_requests(self):
-                   return [scrapy.FormRequest("http://www.example.com/login",
-                                              formdata={'user': 'john', 'pass': 'secret'},
-                                              callback=self.logged_in)]
+               @classmethod
+               def update_settings(cls, settings):
+                   super().update_settings(settings)
+                   settings.setdefault("FEEDS", {}).update(cls.custom_feed)
 
-               def logged_in(self, response):
-                   # here you would extract links to follow and return Requests for
-                   # each of them, with another callback
-                   pass
+   .. automethod:: start
 
-   .. method:: parse(response)
-
-       This is the default callback used by Scrapy to process downloaded
-       responses, when their requests don't specify a callback.
-
-       The ``parse`` method is in charge of processing the response and returning
-       scraped data and/or more URLs to follow. Other Requests callbacks have
-       the same requirements as the :class:`Spider` class.
-
-       This method, as well as any other Request callback, must return an
-       iterable of :class:`~scrapy.Request` and/or :ref:`item objects
-       <topics-items>`.
-
-       :param response: the response to parse
-       :type response: :class:`~scrapy.http.Response`
-
-   .. method:: log(message, [level, component])
-
-       Wrapper that sends a log message through the Spider's :attr:`logger`,
-       kept for backward compatibility. For more information see
-       :ref:`topics-logging-from-spiders`.
+   .. automethod:: parse
 
    .. method:: closed(reason)
 
        Called when the spider closes. This method provides a shortcut to
        signals.connect() for the :signal:`spider_closed` signal.
 
-Let's see an example::
+Let's see an example:
+
+.. code-block:: python
 
     import scrapy
 
 
     class MySpider(scrapy.Spider):
-        name = 'example.com'
-        allowed_domains = ['example.com']
+        name = "example.com"
+        allowed_domains = ["example.com"]
         start_urls = [
-            'http://www.example.com/1.html',
-            'http://www.example.com/2.html',
-            'http://www.example.com/3.html',
+            "http://www.example.com/1.html",
+            "http://www.example.com/2.html",
+            "http://www.example.com/3.html",
         ]
 
         def parse(self, response):
-            self.logger.info('A response from %s just arrived!', response.url)
+            self.logger.info("A response from %s just arrived!", response.url)
 
-Return multiple Requests and items from a single callback::
+Return multiple Requests and items from a single callback:
+
+.. code-block:: python
 
     import scrapy
 
+
     class MySpider(scrapy.Spider):
-        name = 'example.com'
-        allowed_domains = ['example.com']
+        name = "example.com"
+        allowed_domains = ["example.com"]
         start_urls = [
-            'http://www.example.com/1.html',
-            'http://www.example.com/2.html',
-            'http://www.example.com/3.html',
+            "http://www.example.com/1.html",
+            "http://www.example.com/2.html",
+            "http://www.example.com/3.html",
         ]
 
         def parse(self, response):
-            for h3 in response.xpath('//h3').getall():
+            for h3 in response.xpath("//h3").getall():
                 yield {"title": h3}
 
-            for href in response.xpath('//a/@href').getall():
+            for href in response.xpath("//a/@href").getall():
                 yield scrapy.Request(response.urljoin(href), self.parse)
 
-Instead of :attr:`~.start_urls` you can use :meth:`~.start_requests` directly;
-to give data more structure you can use :class:`~scrapy.Item` objects::
+Instead of :attr:`~.start_urls` you can use :meth:`~scrapy.Spider.start`
+directly; to give data more structure you can use :class:`~scrapy.Item`
+objects:
+
+.. skip: next
+.. code-block:: python
 
     import scrapy
     from myproject.items import MyItem
 
-    class MySpider(scrapy.Spider):
-        name = 'example.com'
-        allowed_domains = ['example.com']
 
-        def start_requests(self):
-            yield scrapy.Request('http://www.example.com/1.html', self.parse)
-            yield scrapy.Request('http://www.example.com/2.html', self.parse)
-            yield scrapy.Request('http://www.example.com/3.html', self.parse)
+    class MySpider(scrapy.Spider):
+        name = "example.com"
+        allowed_domains = ["example.com"]
+
+        async def start(self):
+            yield scrapy.Request("http://www.example.com/1.html", self.parse)
+            yield scrapy.Request("http://www.example.com/2.html", self.parse)
+            yield scrapy.Request("http://www.example.com/3.html", self.parse)
 
         def parse(self, response):
-            for h3 in response.xpath('//h3').getall():
+            for h3 in response.xpath("//h3").getall():
                 yield MyItem(title=h3)
 
-            for href in response.xpath('//a/@href').getall():
+            for href in response.xpath("//a/@href").getall():
                 yield scrapy.Request(response.urljoin(href), self.parse)
 
 .. _spiderargs:
@@ -276,34 +270,43 @@ Spider arguments are passed through the :command:`crawl` command using the
 
     scrapy crawl myspider -a category=electronics
 
-Spiders can access arguments in their `__init__` methods::
+Spiders can access arguments in their `__init__` methods:
+
+.. code-block:: python
 
     import scrapy
 
+
     class MySpider(scrapy.Spider):
-        name = 'myspider'
+        name = "myspider"
 
         def __init__(self, category=None, *args, **kwargs):
-            super(MySpider, self).__init__(*args, **kwargs)
-            self.start_urls = [f'http://www.example.com/categories/{category}']
+            super().__init__(*args, **kwargs)
+            self.start_urls = [f"http://www.example.com/categories/{category}"]
             # ...
 
 The default `__init__` method will take any spider arguments
 and copy them to the spider as attributes.
-The above example can also be written as follows::
+The above example can also be written as follows:
+
+.. code-block:: python
 
     import scrapy
 
+
     class MySpider(scrapy.Spider):
-        name = 'myspider'
+        name = "myspider"
 
-        def start_requests(self):
-            yield scrapy.Request(f'http://www.example.com/categories/{self.category}')
+        async def start(self):
+            yield scrapy.Request(f"http://www.example.com/categories/{self.category}")
 
-If you are :ref:`running Scrapy from a script <run-from-script>`, you can 
-specify spider arguments when calling 
-:class:`CrawlerProcess.crawl <scrapy.crawler.CrawlerProcess.crawl>` or
-:class:`CrawlerRunner.crawl <scrapy.crawler.CrawlerRunner.crawl>`::
+If you are :ref:`running Scrapy from a script <run-from-script>`, you can
+specify spider arguments when calling
+:meth:`CrawlerProcess.crawl <scrapy.crawler.CrawlerProcess.crawl>` or
+:meth:`CrawlerRunner.crawl <scrapy.crawler.CrawlerRunner.crawl>`:
+
+.. skip: next
+.. code-block:: python
 
     process = CrawlerProcess()
     process.crawl(MySpider, category="electronics")
@@ -318,16 +321,89 @@ Otherwise, you would cause iteration over a ``start_urls`` string
 (a very common python pitfall)
 resulting in each character being seen as a separate url.
 
-A valid use case is to set the http auth credentials
-used by :class:`~scrapy.downloadermiddlewares.httpauth.HttpAuthMiddleware`
-or the user agent
-used by :class:`~scrapy.downloadermiddlewares.useragent.UserAgentMiddleware`::
-
-    scrapy crawl myspider -a http_user=myuser -a http_pass=mypassword -a user_agent=mybot
-
 Spider arguments can also be passed through the Scrapyd ``schedule.json`` API.
 See `Scrapyd documentation`_.
 
+.. _spiderargs-scrapy-spider-metadata:
+
+scrapy-spider-metadata parameters
+---------------------------------
+
+Another alternative to pass spider arguments is the library `scrapy-spider-metadata`_.
+
+This allows for Scrapy spiders to define, validate, document and pre-process
+their arguments as Pydantic models.
+
+The example shows how to define typed parameters where a string argument
+is automatically converted to an integer:
+
+.. code-block:: python
+
+    import scrapy
+    from pydantic import BaseModel
+    from scrapy_spider_metadata import Args
+
+
+    class MyParams(BaseModel):
+        pages: int
+
+
+    class BookSpider(Args[MyParams], scrapy.Spider):
+        name = "bookspider"
+        start_urls = ["http://books.toscrape.com/catalogue"]
+
+        async def start(self):
+            for start_url in self.start_urls:
+                for index in range(1, self.args.pages + 1):
+                    yield scrapy.Request(f"{start_url}/page-{index}.html")
+
+        def parse(self, response):
+            book_links = response.css("article.product_pod h3 a::attr(href)").getall()
+            for book_link in book_links:
+                yield response.follow(book_link, self.parse_book)
+
+        def parse_book(self, response):
+            yield {
+                "title": response.css("h1::text").get(),
+                "price": response.css("p.price_color::text").get(),
+            }
+
+This spider can be called from the command line::
+
+    scrapy crawl bookspider -a pages=2
+
+.. _start-requests:
+
+Start requests
+==============
+
+**Start requests** are :class:`~scrapy.Request` objects yielded from the
+:meth:`~scrapy.Spider.start` method of a spider or from the
+:meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_start` method of a
+:ref:`spider middleware <topics-spider-middleware>`.
+
+.. seealso:: :ref:`start-request-order`
+
+.. _start-requests-lazy:
+
+Delaying start request iteration
+--------------------------------
+
+You can override the :meth:`~scrapy.Spider.start` method as follows to pause
+its iteration whenever there are scheduled requests:
+
+.. code-block:: python
+
+    async def start(self):
+        async for item_or_request in super().start():
+            if self.crawler.engine.needs_backout():
+                await self.crawler.signals.wait_for(signals.scheduler_empty)
+            yield item_or_request
+
+This can help minimize the number of requests in the scheduler at any given
+time, to minimize resource usage (memory or disk, depending on
+:setting:`JOBDIR`).
+
 .. _builtin-spiders:
 
 Generic Spiders
@@ -339,14 +415,18 @@ common scraping cases, like following all links on a site based on certain
 rules, crawling from `Sitemaps`_, or parsing an XML/CSV feed.
 
 For the examples used in the following spiders, we'll assume you have a project
-with a ``TestItem`` declared in a ``myproject.items`` module::
+with a ``TestItem`` declared in a ``myproject.items`` module:
 
-    import scrapy
+.. code-block:: python
 
-    class TestItem(scrapy.Item):
-        id = scrapy.Field()
-        name = scrapy.Field()
-        description = scrapy.Field()
+    from dataclasses import dataclass
+
+
+    @dataclass
+    class TestItem:
+        id: str | None = None
+        name: str | None = None
+        description: str | None = None
 
 
 .. currentmodule:: scrapy.spiders
@@ -432,51 +512,55 @@ Crawling rules
       callbacks for new requests when writing :class:`CrawlSpider`-based spiders;
       unexpected behaviour can occur otherwise.
 
-   .. versionadded:: 2.0
-      The *errback* parameter.
-
 CrawlSpider example
 ~~~~~~~~~~~~~~~~~~~
 
-Let's now take a look at an example CrawlSpider with rules::
+Let's now take a look at an example CrawlSpider with rules:
+
+.. code-block:: python
 
-    import scrapy
     from scrapy.spiders import CrawlSpider, Rule
     from scrapy.linkextractors import LinkExtractor
 
+
     class MySpider(CrawlSpider):
-        name = 'example.com'
-        allowed_domains = ['example.com']
-        start_urls = ['http://www.example.com']
+        name = "example.com"
+        allowed_domains = ["example.com"]
+        start_urls = ["http://www.example.com"]
 
         rules = (
             # Extract links matching 'category.php' (but not matching 'subsection.php')
             # and follow links from them (since no callback means follow=True by default).
-            Rule(LinkExtractor(allow=('category\.php', ), deny=('subsection\.php', ))),
-
+            Rule(LinkExtractor(allow=(r"category\.php",), deny=(r"subsection\.php",))),
             # Extract links matching 'item.php' and parse them with the spider's method parse_item
-            Rule(LinkExtractor(allow=('item\.php', )), callback='parse_item'),
+            Rule(LinkExtractor(allow=(r"item\.php",)), callback="parse_item"),
         )
 
         def parse_item(self, response):
-            self.logger.info('Hi, this is an item page! %s', response.url)
-            item = scrapy.Item()
-            item['id'] = response.xpath('//td[@id="item_id"]/text()').re(r'ID: (\d+)')
-            item['name'] = response.xpath('//td[@id="item_name"]/text()').get()
-            item['description'] = response.xpath('//td[@id="item_description"]/text()').get()
-            item['link_text'] = response.meta['link_text']
+            self.logger.info("Hi, this is an item page! %s", response.url)
+            item = {}
+            item["id"] = response.xpath('//td[@id="item_id"]/text()').re(r"ID: (\d+)")
+            item["name"] = response.xpath('//td[@id="item_name"]/text()').get()
+            item["description"] = response.xpath(
+                '//td[@id="item_description"]/text()'
+            ).get()
+            item["link_text"] = response.meta["link_text"]
             url = response.xpath('//td[@id="additional_data"]/@href').get()
-            return response.follow(url, self.parse_additional_page, cb_kwargs=dict(item=item))
+            return response.follow(
+                url, self.parse_additional_page, cb_kwargs=dict(item=item)
+            )
 
         def parse_additional_page(self, response, item):
-            item['additional_data'] = response.xpath('//p[@id="additional_data"]/text()').get()
+            item["additional_data"] = response.xpath(
+                '//p[@id="additional_data"]/text()'
+            ).get()
             return item
 
 
 This spider would start crawling example.com's home page, collecting category
 links, and item links, parsing the latter with the ``parse_item`` method. For
 each item response, some data will be extracted from the HTML using XPath, and
-an :class:`~scrapy.Item` will be filled with it.
+a dictionary will be filled with it.
 
 XMLFeedSpider
 -------------
@@ -497,7 +581,7 @@ XMLFeedSpider
 
         A string which defines the iterator to use. It can be either:
 
-           - ``'iternodes'`` - a fast iterator based on regular expressions
+           - ``'iternodes'`` - a fast iterator based on ``lxml``
 
            - ``'html'`` - an iterator which uses :class:`~scrapy.Selector`.
              Keep in mind this uses DOM parsing and must load all DOM in memory
@@ -511,9 +595,11 @@ XMLFeedSpider
 
     .. attribute:: itertag
 
-        A string with the name of the node (or element) to iterate in. Example::
+        A string with the name of the node (or element) to iterate in. Example:
 
-            itertag = 'product'
+        .. code-block:: python
+
+            itertag = "product"
 
     .. attribute:: namespaces
 
@@ -526,12 +612,17 @@ XMLFeedSpider
         You can then specify nodes with namespaces in the :attr:`itertag`
         attribute.
 
-        Example::
+        Example:
+
+        .. code-block:: python
+
+            from scrapy.spiders import XMLFeedSpider
+
 
             class YourSpider(XMLFeedSpider):
 
-                namespaces = [('n', 'http://www.sitemaps.org/schemas/sitemap/0.9')]
-                itertag = 'n:url'
+                namespaces = [("n", "http://www.sitemaps.org/schemas/sitemap/0.9")]
+                itertag = "n:url"
                 # ...
 
     Apart from these new attributes, this spider has the following overridable
@@ -549,7 +640,7 @@ XMLFeedSpider
         This method is called for the nodes matching the provided tag name
         (``itertag``).  Receives the response and an
         :class:`~scrapy.Selector` for each node.  Overriding this
-        method is mandatory. Otherwise, you spider won't work.  This method
+        method is mandatory. Otherwise, your spider won't work.  This method
         must return an :ref:`item object <topics-items>`, a
         :class:`~scrapy.Request` object, or an iterable containing any of
         them.
@@ -570,25 +661,31 @@ XMLFeedSpider
 XMLFeedSpider example
 ~~~~~~~~~~~~~~~~~~~~~
 
-These spiders are pretty easy to use, let's have a look at one example::
+These spiders are pretty easy to use, let's have a look at one example:
+
+.. skip: next
+.. code-block:: python
 
     from scrapy.spiders import XMLFeedSpider
     from myproject.items import TestItem
 
+
     class MySpider(XMLFeedSpider):
-        name = 'example.com'
-        allowed_domains = ['example.com']
-        start_urls = ['http://www.example.com/feed.xml']
-        iterator = 'iternodes'  # This is actually unnecessary, since it's the default value
-        itertag = 'item'
+        name = "example.com"
+        allowed_domains = ["example.com"]
+        start_urls = ["http://www.example.com/feed.xml"]
+        iterator = "iternodes"  # This is actually unnecessary, since it's the default value
+        itertag = "item"
 
         def parse_node(self, response, node):
-            self.logger.info('Hi, this is a <%s> node!: %s', self.itertag, ''.join(node.getall()))
+            self.logger.info(
+                "Hi, this is a <%s> node!: %s", self.itertag, "".join(node.getall())
+            )
 
             item = TestItem()
-            item['id'] = node.xpath('@id').get()
-            item['name'] = node.xpath('name').get()
-            item['description'] = node.xpath('description').get()
+            item.id = node.xpath("@id").get()
+            item.name = node.xpath("name").get()
+            item.description = node.xpath("description").get()
             return item
 
 Basically what we did up there was to create a spider that downloads a feed from
@@ -629,26 +726,30 @@ CSVFeedSpider example
 ~~~~~~~~~~~~~~~~~~~~~
 
 Let's see an example similar to the previous one, but using a
-:class:`CSVFeedSpider`::
+:class:`CSVFeedSpider`:
+
+.. skip: next
+.. code-block:: python
 
     from scrapy.spiders import CSVFeedSpider
     from myproject.items import TestItem
 
+
     class MySpider(CSVFeedSpider):
-        name = 'example.com'
-        allowed_domains = ['example.com']
-        start_urls = ['http://www.example.com/feed.csv']
-        delimiter = ';'
+        name = "example.com"
+        allowed_domains = ["example.com"]
+        start_urls = ["http://www.example.com/feed.csv"]
+        delimiter = ";"
         quotechar = "'"
-        headers = ['id', 'name', 'description']
+        headers = ["id", "name", "description"]
 
         def parse_row(self, response, row):
-            self.logger.info('Hi, this is a row!: %r', row)
+            self.logger.info("Hi, this is a row!: %r", row)
 
             item = TestItem()
-            item['id'] = row['id']
-            item['name'] = row['name']
-            item['description'] = row['description']
+            item.id = row["id"]
+            item.name = row["name"]
+            item.description = row["description"]
             return item
 
 
@@ -681,9 +782,11 @@ SitemapSpider
           the regular expression. ``callback`` can be a string (indicating the
           name of a spider method) or a callable.
 
-        For example::
+        For example:
 
-            sitemap_rules = [('/product/', 'parse_product')]
+        .. code-block:: python
+
+            sitemap_rules = [("/product/", "parse_product")]
 
         Rules are applied in order, and only the first one that matches will be
         used.
@@ -705,7 +808,9 @@ SitemapSpider
         are links for the same website in another language passed within
         the same ``url`` block.
 
-        For example::
+        For example:
+
+        .. code-block:: xml
 
             <url>
                 <loc>http://example.com/</loc>
@@ -723,26 +828,31 @@ SitemapSpider
         This is a filter function that could be overridden to select sitemap entries
         based on their attributes.
 
-        For example::
+        For example:
+
+        .. code-block:: xml
 
             <url>
                 <loc>http://example.com/</loc>
                 <lastmod>2005-01-01</lastmod>
             </url>
 
-        We can define a ``sitemap_filter`` function to filter ``entries`` by date::
+        We can define a ``sitemap_filter`` function to filter ``entries`` by date:
+
+        .. code-block:: python
 
             from datetime import datetime
             from scrapy.spiders import SitemapSpider
 
+
             class FilteredSitemapSpider(SitemapSpider):
-                name = 'filtered_sitemap_spider'
-                allowed_domains = ['example.com']
-                sitemap_urls = ['http://example.com/sitemap.xml']
+                name = "filtered_sitemap_spider"
+                allowed_domains = ["example.com"]
+                sitemap_urls = ["http://example.com/sitemap.xml"]
 
                 def sitemap_filter(self, entries):
                     for entry in entries:
-                        date_time = datetime.strptime(entry['lastmod'], '%Y-%m-%d')
+                        date_time = datetime.strptime(entry["lastmod"], "%Y-%m-%d")
                         if date_time.year >= 2005:
                             yield entry
 
@@ -767,72 +877,87 @@ SitemapSpider examples
 ~~~~~~~~~~~~~~~~~~~~~~
 
 Simplest example: process all urls discovered through sitemaps using the
-``parse`` callback::
+``parse`` callback:
+
+.. code-block:: python
 
     from scrapy.spiders import SitemapSpider
 
+
     class MySpider(SitemapSpider):
-        sitemap_urls = ['http://www.example.com/sitemap.xml']
+        sitemap_urls = ["http://www.example.com/sitemap.xml"]
 
         def parse(self, response):
-            pass # ... scrape item here ...
+            pass  # ... scrape item here ...
 
 Process some urls with certain callback and other urls with a different
-callback::
+callback:
+
+.. code-block:: python
 
     from scrapy.spiders import SitemapSpider
 
+
     class MySpider(SitemapSpider):
-        sitemap_urls = ['http://www.example.com/sitemap.xml']
+        sitemap_urls = ["http://www.example.com/sitemap.xml"]
         sitemap_rules = [
-            ('/product/', 'parse_product'),
-            ('/category/', 'parse_category'),
+            ("/product/", "parse_product"),
+            ("/category/", "parse_category"),
         ]
 
         def parse_product(self, response):
-            pass # ... scrape product ...
+            pass  # ... scrape product ...
 
         def parse_category(self, response):
-            pass # ... scrape category ...
+            pass  # ... scrape category ...
 
 Follow sitemaps defined in the `robots.txt`_ file and only follow sitemaps
-whose url contains ``/sitemap_shop``::
+whose url contains ``/sitemap_shop``:
+
+.. code-block:: python
 
     from scrapy.spiders import SitemapSpider
 
+
     class MySpider(SitemapSpider):
-        sitemap_urls = ['http://www.example.com/robots.txt']
+        sitemap_urls = ["http://www.example.com/robots.txt"]
         sitemap_rules = [
-            ('/shop/', 'parse_shop'),
+            ("/shop/", "parse_shop"),
         ]
-        sitemap_follow = ['/sitemap_shops']
+        sitemap_follow = ["/sitemap_shops"]
 
         def parse_shop(self, response):
-            pass # ... scrape shop here ...
+            pass  # ... scrape shop here ...
 
-Combine SitemapSpider with other sources of urls::
+Combine SitemapSpider with other sources of urls:
 
+.. code-block:: python
+
+    from scrapy import Request
     from scrapy.spiders import SitemapSpider
 
+
     class MySpider(SitemapSpider):
-        sitemap_urls = ['http://www.example.com/robots.txt']
+        sitemap_urls = ["http://www.example.com/robots.txt"]
         sitemap_rules = [
-            ('/shop/', 'parse_shop'),
+            ("/shop/", "parse_shop"),
         ]
 
-        other_urls = ['http://www.example.com/about']
+        other_urls = ["http://www.example.com/about"]
 
-        def start_requests(self):
-            requests = list(super(MySpider, self).start_requests())
-            requests += [scrapy.Request(x, self.parse_other) for x in self.other_urls]
-            return requests
+        async def start(self):
+            async for item_or_request in super().start():
+                yield item_or_request
+            for url in self.other_urls:
+                yield Request(url, self.parse_other)
 
         def parse_shop(self, response):
-            pass # ... scrape shop here ...
+            pass  # ... scrape shop here ...
 
         def parse_other(self, response):
-            pass # ... scrape other here ...
+            pass  # ... scrape other here ...
 
+.. _scrapy-spider-metadata: https://scrapy-spider-metadata.readthedocs.io/en/latest/params.html
 .. _Sitemaps: https://www.sitemaps.org/index.html
 .. _Sitemap index files: https://www.sitemaps.org/protocol.html#index
 .. _robots.txt: https://www.robotstxt.org/

docs/topics/stats.rst

@@ -10,8 +10,8 @@ Collector, and can be accessed through the :attr:`~scrapy.crawler.Crawler.stats`
 attribute of the :ref:`topics-api-crawler`, as illustrated by the examples in
 the :ref:`topics-stats-usecases` section below.
 
-However, the Stats Collector is always available, so you can always import it
-in your module and use its API (to increment or set new stat keys), regardless
+The Stats Collector API is always available, so you can always use it (to
+increment or set new stat keys), regardless
 of whether the stats collection is enabled or not. If it's disabled, the API
 will still work but it won't collect anything. This is aimed at simplifying the
 stats collector usage: you should spend no more than one line of code for
@@ -21,8 +21,7 @@ using the Stats Collector from.
 Another feature of the Stats Collector is that it's very efficient (when
 enabled) and extremely efficient (almost unnoticeable) when disabled.
 
-The Stats Collector keeps a stats table per open spider which is automatically
-opened when the spider is opened, and closed when the spider is closed.
+See :ref:`topics-stats-reference` below for the stats that Scrapy sets.
 
 .. _topics-stats-usecases:
 
@@ -30,10 +29,11 @@ Common Stats Collector uses
 ===========================
 
 Access the stats collector through the :attr:`~scrapy.crawler.Crawler.stats`
-attribute. Here is an example of an extension that access stats::
+attribute. Here is an example of an extension that access stats:
+
+.. code-block:: python
 
     class ExtensionThatAccessStats:
-
         def __init__(self, stats):
             self.stats = stats
 
@@ -41,67 +41,704 @@ attribute. Here is an example of an extension that access stats::
         def from_crawler(cls, crawler):
             return cls(crawler.stats)
 
-Set stat value::
+.. skip: start
 
-    stats.set_value('hostname', socket.gethostname())
+Set stat value:
 
-Increment stat value::
+.. code-block:: python
 
-    stats.inc_value('custom_count')
+    stats.set_value("hostname", socket.gethostname())
 
-Set stat value only if greater than previous::
+Increment stat value:
 
-    stats.max_value('max_items_scraped', value)
+.. code-block:: python
 
-Set stat value only if lower than previous::
+    stats.inc_value("custom_count")
 
-    stats.min_value('min_free_memory_percent', value)
+Set stat value only if greater than previous:
+
+.. code-block:: python
+
+    stats.max_value("max_items_scraped", value)
+
+Set stat value only if lower than previous:
+
+.. code-block:: python
+
+    stats.min_value("min_free_memory_percent", value)
 
 Get stat value:
 
->>> stats.get_value('custom_count')
-1
+.. code-block:: pycon
+
+    >>> stats.get_value("custom_count")
+    1
 
 Get all stats:
 
->>> stats.get_stats()
-{'custom_count': 1, 'start_time': datetime.datetime(2009, 7, 14, 21, 47, 28, 977139)}
+.. code-block:: pycon
+
+    >>> stats.get_stats()
+    {'custom_count': 1, 'start_time': datetime.datetime(2009, 7, 14, 21, 47, 28, 977139)}
+
+.. skip: end
 
 Available Stats Collectors
 ==========================
 
+.. currentmodule:: scrapy.statscollectors
+
 Besides the basic :class:`StatsCollector` there are other Stats Collectors
 available in Scrapy which extend the basic Stats Collector. You can select
 which Stats Collector to use through the :setting:`STATS_CLASS` setting. The
-default Stats Collector used is the :class:`MemoryStatsCollector`. 
-
-.. currentmodule:: scrapy.statscollectors
+default Stats Collector used is the :class:`MemoryStatsCollector`.
 
 MemoryStatsCollector
 --------------------
 
-.. class:: MemoryStatsCollector
-
-    A simple stats collector that keeps the stats of the last scraping run (for
-    each spider) in memory, after they're closed. The stats can be accessed
-    through the :attr:`spider_stats` attribute, which is a dict keyed by spider
-    domain name.
-
-    This is the default Stats Collector used in Scrapy.
-
-    .. attribute:: spider_stats
-
-       A dict of dicts (keyed by spider name) containing the stats of the last
-       scraping run for each spider.
+.. autoclass:: MemoryStatsCollector
+   :members:
 
 DummyStatsCollector
 -------------------
 
-.. class:: DummyStatsCollector
+.. autoclass:: DummyStatsCollector
 
-    A Stats collector which does nothing but is very efficient (because it does
-    nothing). This stats collector can be set via the :setting:`STATS_CLASS`
-    setting, to disable stats collect in order to improve performance. However,
-    the performance penalty of stats collection is usually marginal compared to
-    other Scrapy workload like parsing pages.
+.. _topics-stats-reference:
 
+Built-in stats reference
+========================
+
+Scrapy sets the following :ref:`stats <topics-stats>`. Components other than
+those built into Scrapy may set additional stats; see their documentation.
+
+Stat keys that contain a ``{placeholder}`` below stand for a family of stats,
+one per actual value of the placeholder.
+
+.. note:: Most stats are set by a specific :ref:`component
+    <topics-components>`, and are only present if that component is enabled and
+    its code path is reached. A stat that is missing from
+    :meth:`~scrapy.statscollectors.StatsCollector.get_stats` output is
+    equivalent to a counter of 0.
+
+.. stat:: downloader/exception_count
+
+``downloader/exception_count``
+    Number of exceptions raised while downloading requests.
+
+    Set by :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats`.
+
+.. stat:: downloader/exception_type_count/{exception_type}
+
+``downloader/exception_type_count/{exception_type}``
+    Number of exceptions raised while downloading requests, per exception type,
+    where ``{exception_type}`` is the import path of the exception class, e.g.
+    ``twisted.internet.error.DNSLookupError``.
+
+    Set by :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats`.
+
+.. stat:: downloader/request_bytes
+
+``downloader/request_bytes``
+    Total size, in bytes, of the requests sent, counting the request line, the
+    headers and the body. As with :stat:`downloader/request_count`, requests
+    served from the cache are also counted.
+
+    It is an approximation, reconstructed from each :class:`~scrapy.Request`
+    object instead of measured on the wire, so it does not account for the
+    actual bytes that the :ref:`download handler
+    <topics-download-handlers>` sends, e.g. transport-level overhead.
+
+    Set by :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats`.
+
+.. stat:: downloader/request_count
+
+``downloader/request_count``
+    Number of requests sent.
+
+    Requests that :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`
+    serves from the cache are also counted, even though they are never sent,
+    because it handles requests after
+    :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats`.
+
+    Set by :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats`.
+
+.. stat:: downloader/request_method_count/{method}
+
+``downloader/request_method_count/{method}``
+    Number of requests sent, per HTTP method, e.g. ``GET`` or ``POST``. As with
+    :stat:`downloader/request_count`, requests served from the cache are also
+    counted.
+
+    Set by :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats`.
+
+.. stat:: downloader/response_bytes
+
+``downloader/response_bytes``
+    Total size, in bytes, of the responses received, counting the status line,
+    the headers and the body. It covers the same responses as
+    :stat:`downloader/response_count`.
+
+    The body is counted as received, i.e. still compressed for responses that
+    used ``Content-Encoding``, because
+    :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats` handles
+    responses before
+    :class:`~scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware`
+    decompresses them. See :stat:`httpcompression/response_bytes` for
+    decompressed sizes.
+
+    Set by :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats`.
+
+.. stat:: downloader/response_count
+
+``downloader/response_count``
+    Number of responses received.
+
+    It counts responses that :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`
+    serves from the cache, even though they do not come from the network, and
+    responses that a downloader middleware consumes before they reach your
+    spider, e.g. redirect responses that :class:`~scrapy.downloadermiddlewares.redirect.RedirectMiddleware`
+    turns into new requests. Compare with :stat:`response_received_count`.
+
+    Set by :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats`.
+
+.. stat:: downloader/response_status_count/{status_code}
+
+``downloader/response_status_count/{status_code}``
+    Number of responses received, per HTTP status code, e.g. ``200`` or
+    ``404``. It covers the same responses as :stat:`downloader/response_count`.
+
+    Set by :class:`~scrapy.downloadermiddlewares.stats.DownloaderStats`.
+
+.. stat:: dupefilter/filtered
+
+``dupefilter/filtered``
+    Number of requests dropped as duplicates.
+
+    Set by :class:`~scrapy.dupefilters.RFPDupeFilter`.
+
+.. stat:: elapsed_time_seconds
+
+``elapsed_time_seconds``
+    Time, as a :class:`float`, in seconds, between the :signal:`spider_opened`
+    and the :signal:`spider_closed` signals.
+
+    Set by :class:`~scrapy.extensions.corestats.CoreStats`.
+
+.. stat:: feedexport/failed_count/{storage}
+
+``feedexport/failed_count/{storage}``
+    Number of :ref:`feeds <topics-feed-exports>` that could not be stored, per
+    :ref:`storage backend <topics-feed-storage-backends>`, where ``{storage}``
+    is the class name of the storage backend, e.g. ``FileFeedStorage``.
+
+.. stat:: feedexport/success_count/{storage}
+
+``feedexport/success_count/{storage}``
+    Number of :ref:`feeds <topics-feed-exports>` stored successfully, per
+    :ref:`storage backend <topics-feed-storage-backends>`, where ``{storage}``
+    is the class name of the storage backend, e.g. ``FileFeedStorage``.
+
+.. stat:: file_count
+
+``file_count``
+    Number of files handled by the :ref:`media pipelines
+    <topics-media-pipeline>`.
+
+.. stat:: file_status_count/{status}
+
+``file_status_count/{status}``
+    Number of files handled by the :ref:`media pipelines
+    <topics-media-pipeline>`, per status, where ``{status}`` is one of:
+
+    -   ``downloaded``: the file was downloaded.
+
+    -   ``cached``: the file came from the
+        :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`
+        cache.
+
+    -   ``uptodate``: the file was already in the storage backend and had not
+        :ref:`expired <file-expiration>`, so it was not downloaded again.
+
+.. stat:: finish_reason
+
+``finish_reason``
+    String indicating why the crawl finished. It matches the *reason* argument
+    of the :signal:`spider_closed` signal.
+
+    Scrapy uses the following reasons:
+
+    -   ``cancelled``: the spider was closed without a more specific reason,
+        e.g. because :exc:`~scrapy.exceptions.CloseSpider` was raised without
+        one.
+
+    -   ``closespider_errorcount``: see :setting:`CLOSESPIDER_ERRORCOUNT`.
+
+    -   ``closespider_itemcount``: see :setting:`CLOSESPIDER_ITEMCOUNT`.
+
+    -   ``closespider_pagecount``: see :setting:`CLOSESPIDER_PAGECOUNT`.
+
+    -   ``closespider_pagecount_no_item``: see
+        :setting:`CLOSESPIDER_PAGECOUNT_NO_ITEM`.
+
+    -   ``closespider_timeout``: see :setting:`CLOSESPIDER_TIMEOUT`.
+
+    -   ``closespider_timeout_no_item``: see
+        :setting:`CLOSESPIDER_TIMEOUT_NO_ITEM`.
+
+    -   ``finished``: the spider became idle with no pending requests, i.e. it
+        finished normally.
+
+    -   ``memusage_exceeded``: see :setting:`MEMUSAGE_LIMIT_MB`.
+
+    -   ``shutdown``: the crawl was interrupted, e.g. by a system signal such
+        as ``SIGINT`` (:kbd:`Ctrl-C`).
+
+    Third-party components and your own code may use any other reason, e.g. by
+    raising :exc:`~scrapy.exceptions.CloseSpider` with it.
+
+    Set by :class:`~scrapy.extensions.corestats.CoreStats`.
+
+.. stat:: finish_time
+
+``finish_time``
+    Timezone-aware :class:`~datetime.datetime` object, in UTC, indicating when
+    the :signal:`spider_closed` signal was sent.
+
+    Set by :class:`~scrapy.extensions.corestats.CoreStats`.
+
+.. stat:: httpcache/errorrecovery
+
+``httpcache/errorrecovery``
+    Number of times that a stale cached response was used because downloading a
+    fresh response raised an exception.
+
+    Set by :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`.
+
+.. stat:: httpcache/firsthand
+
+``httpcache/firsthand``
+    Number of responses that were downloaded without a matching cache entry to
+    validate against, i.e. responses for requests counted in
+    :stat:`httpcache/miss`.
+
+    It is lower than :stat:`httpcache/miss` when some of those requests yield
+    no response, either because they are dropped (see
+    :stat:`httpcache/ignore`) or because their download fails.
+
+    Set by :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`.
+
+.. stat:: httpcache/hit
+
+``httpcache/hit``
+    Number of requests served from the cache.
+
+    Set by :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`.
+
+.. stat:: httpcache/ignore
+
+``httpcache/ignore``
+    Number of requests dropped because they were not in the cache and
+    :setting:`HTTPCACHE_IGNORE_MISSING` is ``True``.
+
+    Set by :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`.
+
+.. stat:: httpcache/invalidate
+
+``httpcache/invalidate``
+    Number of times that a cached response failed validation and was replaced
+    with a freshly downloaded response.
+
+    Set by :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`.
+
+.. stat:: httpcache/miss
+
+``httpcache/miss``
+    Number of requests for which no cache entry could be read, either because
+    there was none or because reading it failed, in which case the request is
+    also counted in :stat:`httpcache/retrieve_error`. Those requests are
+    downloaded (see :stat:`httpcache/firsthand`), or dropped if
+    :setting:`HTTPCACHE_IGNORE_MISSING` is ``True`` (see
+    :stat:`httpcache/ignore`).
+
+    Requests with a stale cache entry are not counted here; see
+    :stat:`httpcache/revalidate` and :stat:`httpcache/invalidate`.
+
+    Set by :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`.
+
+.. stat:: httpcache/retrieve_error
+
+``httpcache/retrieve_error``
+    Number of cache entries that could not be read, and hence were treated as
+    cache misses. Those requests are also counted in :stat:`httpcache/miss`.
+
+    Set by :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`.
+
+.. stat:: httpcache/revalidate
+
+``httpcache/revalidate``
+    Number of times that a cached response was successfully validated against
+    the target server, and hence used instead of the fresh response.
+
+    Set by :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`.
+
+.. stat:: httpcache/store
+
+``httpcache/store``
+    Number of responses stored in the cache.
+
+    Set by :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`.
+
+.. stat:: httpcache/uncacheable
+
+``httpcache/uncacheable``
+    Number of responses not stored in the cache because the
+    :setting:`HTTPCACHE_POLICY` did not allow it.
+
+    Every response considered for caching is counted either here or in
+    :stat:`httpcache/store`, so ``httpcache/store + httpcache/uncacheable``
+    equals ``httpcache/firsthand + httpcache/invalidate``.
+
+    Set by :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`.
+
+.. stat:: httpcompression/response_bytes
+
+``httpcompression/response_bytes``
+    Total size, in bytes, of decompressed response bodies, counting only the
+    body and only responses that were actually decompressed. Compare with
+    :stat:`downloader/response_bytes`.
+
+    Set by
+    :class:`~scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware`.
+
+.. stat:: httpcompression/response_count
+
+``httpcompression/response_count``
+    Number of decompressed responses.
+
+    Set by
+    :class:`~scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware`.
+
+.. stat:: httperror/response_ignored_count
+
+``httperror/response_ignored_count``
+    Number of responses dropped because of their HTTP status code.
+
+    Set by :class:`~scrapy.spidermiddlewares.httperror.HttpErrorMiddleware`.
+
+.. stat:: httperror/response_ignored_status_count/{status_code}
+
+``httperror/response_ignored_status_count/{status_code}``
+    Number of responses dropped because of their HTTP status code, per HTTP
+    status code, e.g. ``404``.
+
+    Set by :class:`~scrapy.spidermiddlewares.httperror.HttpErrorMiddleware`.
+
+.. stat:: item_dropped_count
+
+``item_dropped_count``
+    Number of items dropped by an :ref:`item pipeline
+    <topics-item-pipeline>`, i.e. number of times that the
+    :signal:`item_dropped` signal was sent.
+
+    Set by :class:`~scrapy.extensions.corestats.CoreStats`.
+
+.. stat:: item_dropped_reasons_count/{exception}
+
+``item_dropped_reasons_count/{exception}``
+    Number of items dropped, per exception, where ``{exception}`` is the class
+    name of the exception that caused the item to be dropped.
+
+    Only :exc:`~scrapy.exceptions.DropItem` and its subclasses drop items, and
+    each one is counted under its own class name, e.g.
+    ``item_dropped_reasons_count/DropItem`` for
+    :exc:`~scrapy.exceptions.DropItem` itself and
+    ``item_dropped_reasons_count/MyDropItem`` for a ``MyDropItem`` subclass of
+    it. Any other exception raised by an :ref:`item pipeline
+    <topics-item-pipeline>` triggers the :signal:`item_error` signal instead of
+    :signal:`item_dropped`, and is not counted here or in
+    :stat:`item_dropped_count`.
+
+    Set by :class:`~scrapy.extensions.corestats.CoreStats`.
+
+.. stat:: item_scraped_count
+
+``item_scraped_count``
+    Number of items that passed all :ref:`item pipelines
+    <topics-item-pipeline>`, i.e. number of times that the
+    :signal:`item_scraped` signal was sent.
+
+    Set by :class:`~scrapy.extensions.corestats.CoreStats`.
+
+.. stat:: items_per_minute
+
+``items_per_minute``
+    Average number of items scraped per minute during the crawl.
+
+    It is ``None`` if the crawl took less than a minute.
+
+    Set by :class:`~scrapy.extensions.logstats.LogStats`.
+
+.. stat:: log_count/{level}
+
+``log_count/{level}``
+    Number of log messages, per logging level name, e.g. ``INFO`` or
+    ``WARNING``.
+
+    Only messages that the :setting:`LOG_LEVEL` setting allows are counted.
+
+    Set by :class:`~scrapy.extensions.logcount.LogCount`.
+
+.. stat:: memdebug/gc_garbage_count
+
+``memdebug/gc_garbage_count``
+    Number of objects in :data:`gc.garbage` when the spider is closed.
+
+    Set by :class:`~scrapy.extensions.memdebug.MemoryDebugger`, which requires
+    :setting:`MEMDEBUG_ENABLED` to be ``True``.
+
+.. stat:: memdebug/live_refs/{cls}
+
+``memdebug/live_refs/{cls}``
+    Number of live objects of class ``{cls}`` when the spider is closed, as
+    reported by :ref:`trackref <topics-leaks-trackrefs>`, e.g.
+    ``memdebug/live_refs/HtmlResponse``.
+
+    Only set for classes with at least 1 live object.
+
+    Set by :class:`~scrapy.extensions.memdebug.MemoryDebugger`, which requires
+    :setting:`MEMDEBUG_ENABLED` to be ``True``.
+
+.. stat:: memusage/limit_reached
+
+``memusage/limit_reached``
+    ``1`` if memory usage exceeded :setting:`MEMUSAGE_LIMIT_MB`, which also
+    stops the crawl.
+
+    Set by :class:`~scrapy.extensions.memusage.MemoryUsage`.
+
+.. stat:: memusage/max
+
+``memusage/max``
+    Maximum peak memory usage, in bytes, observed during the crawl.
+
+    Set by :class:`~scrapy.extensions.memusage.MemoryUsage`.
+
+.. stat:: memusage/startup
+
+``memusage/startup``
+    Peak memory usage, in bytes, when the engine started.
+
+    Set by :class:`~scrapy.extensions.memusage.MemoryUsage`.
+
+.. stat:: memusage/warning_reached
+
+``memusage/warning_reached``
+    ``1`` if memory usage exceeded :setting:`MEMUSAGE_WARNING_MB`.
+
+    Set by :class:`~scrapy.extensions.memusage.MemoryUsage`.
+
+.. stat:: offsite/domains
+
+``offsite/domains``
+    Number of distinct domains for which at least 1 request was dropped for
+    being offsite.
+
+    Set by :class:`~scrapy.downloadermiddlewares.offsite.OffsiteMiddleware`.
+
+.. stat:: offsite/filtered
+
+``offsite/filtered``
+    Number of requests dropped for being offsite.
+
+    Set by :class:`~scrapy.downloadermiddlewares.offsite.OffsiteMiddleware`.
+
+.. stat:: request_depth_count/{depth}
+
+``request_depth_count/{depth}``
+    Number of requests scheduled at depth ``{depth}``, e.g.
+    ``request_depth_count/2``.
+
+    Set by :class:`~scrapy.spidermiddlewares.depth.DepthMiddleware`, which
+    requires :setting:`DEPTH_STATS_VERBOSE` to be ``True`` for this stat.
+
+.. stat:: request_depth_max
+
+``request_depth_max``
+    Maximum depth reached.
+
+    Set by :class:`~scrapy.spidermiddlewares.depth.DepthMiddleware`.
+
+.. stat:: response_received_count
+
+``response_received_count``
+    Number of responses received, i.e. number of times that the
+    :signal:`response_received` signal was sent.
+
+    Unlike :stat:`downloader/response_count`, it does not count responses that
+    a downloader middleware consumes before they reach the engine, e.g.
+    redirect responses that :class:`~scrapy.downloadermiddlewares.redirect.RedirectMiddleware`
+    turns into new requests. Both count responses that :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`
+    serves from the cache.
+
+    Set by :class:`~scrapy.extensions.corestats.CoreStats`.
+
+.. stat:: responses_per_minute
+
+``responses_per_minute``
+    Average number of responses received per minute during the crawl.
+
+    It is ``None`` if the crawl took less than a minute.
+
+    Set by :class:`~scrapy.extensions.logstats.LogStats`.
+
+.. stat:: retry/count
+
+``retry/count``
+    Number of requests retried.
+
+    Set by :func:`~scrapy.downloadermiddlewares.retry.get_retry_request`, which
+    :class:`~scrapy.downloadermiddlewares.retry.RetryMiddleware` uses.
+
+.. stat:: retry/max_reached
+
+``retry/max_reached``
+    Number of requests that were not retried because they had already been
+    retried :setting:`RETRY_TIMES` times.
+
+    Set by :func:`~scrapy.downloadermiddlewares.retry.get_retry_request`, which
+    :class:`~scrapy.downloadermiddlewares.retry.RetryMiddleware` uses.
+
+.. stat:: retry/reason_count/{reason}
+
+``retry/reason_count/{reason}``
+    Number of requests retried, per reason, e.g.
+    ``retry/reason_count/twisted.internet.error.TimeoutError`` or
+    ``retry/reason_count/504 Gateway Time-out``.
+
+    Set by :func:`~scrapy.downloadermiddlewares.retry.get_retry_request`, which
+    :class:`~scrapy.downloadermiddlewares.retry.RetryMiddleware` uses.
+
+.. note:: Code calling
+    :func:`~scrapy.downloadermiddlewares.retry.get_retry_request` may pass a
+    custom *stats_base_key*, in which case ``retry`` is replaced with that key
+    in the 3 stats above.
+
+.. stat:: robotstxt/exception_count/{exception_type}
+
+``robotstxt/exception_count/{exception_type}``
+    Number of exceptions raised while downloading ``robots.txt`` files, per
+    exception type, where ``{exception_type}`` is the string representation of
+    the exception class, e.g. ``<class
+    'twisted.internet.error.DNSLookupError'>``.
+
+    Set by
+    :class:`~scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware`.
+
+.. stat:: robotstxt/forbidden
+
+``robotstxt/forbidden``
+    Number of requests dropped for being disallowed by ``robots.txt``.
+
+    Set by
+    :class:`~scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware`.
+
+.. stat:: robotstxt/request_count
+
+``robotstxt/request_count``
+    Number of ``robots.txt`` files requested, i.e. 1 per network location for
+    which at least 1 request was sent.
+
+    Set by
+    :class:`~scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware`.
+
+.. stat:: robotstxt/response_count
+
+``robotstxt/response_count``
+    Number of ``robots.txt`` responses received.
+
+    Set by
+    :class:`~scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware`.
+
+.. stat:: robotstxt/response_status_count/{status_code}
+
+``robotstxt/response_status_count/{status_code}``
+    Number of ``robots.txt`` responses received, per HTTP status code, e.g.
+    ``404``.
+
+    Set by
+    :class:`~scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware`.
+
+.. stat:: scheduler/dequeued
+
+``scheduler/dequeued``
+    Number of requests read from the :ref:`scheduler <topics-scheduler>`.
+
+.. stat:: scheduler/dequeued/disk
+
+``scheduler/dequeued/disk``
+    Number of requests read from the disk queue of the :ref:`scheduler
+    <topics-scheduler>`.
+
+.. stat:: scheduler/dequeued/memory
+
+``scheduler/dequeued/memory``
+    Number of requests read from the memory queue of the :ref:`scheduler
+    <topics-scheduler>`.
+
+.. stat:: scheduler/enqueued
+
+``scheduler/enqueued``
+    Number of requests stored into the :ref:`scheduler <topics-scheduler>`.
+
+.. stat:: scheduler/enqueued/disk
+
+``scheduler/enqueued/disk``
+    Number of requests stored into the disk queue of the :ref:`scheduler
+    <topics-scheduler>`.
+
+.. stat:: scheduler/enqueued/memory
+
+``scheduler/enqueued/memory``
+    Number of requests stored into the memory queue of the :ref:`scheduler
+    <topics-scheduler>`.
+
+.. stat:: scheduler/unserializable
+
+``scheduler/unserializable``
+    Number of requests that could not be stored into the disk queue of the
+    :ref:`scheduler <topics-scheduler>` because they could not be
+    :ref:`serialized <request-serialization>`, and hence were stored into the
+    memory queue instead.
+
+.. stat:: spider_exceptions/count
+
+``spider_exceptions/count``
+    Number of unhandled exceptions raised by spider callbacks.
+
+    Set by the :ref:`scraper <topics-architecture>`.
+
+.. stat:: spider_exceptions/{exception}
+
+``spider_exceptions/{exception}``
+    Number of unhandled exceptions raised by spider callbacks, per exception,
+    where ``{exception}`` is the class name of the exception, e.g.
+    ``spider_exceptions/ValueError``.
+
+    Set by the :ref:`scraper <topics-architecture>`.
+
+.. stat:: start_time
+
+``start_time``
+    Timezone-aware :class:`~datetime.datetime` object, in UTC, indicating when
+    the :signal:`spider_opened` signal was sent.
+
+    Set by :class:`~scrapy.extensions.corestats.CoreStats`.
+
+.. stat:: urllength/request_ignored_count
+
+``urllength/request_ignored_count``
+    Number of requests dropped for having a URL longer than
+    :setting:`URLLENGTH_LIMIT`.
+
+    Set by :class:`~scrapy.spidermiddlewares.urllength.UrlLengthMiddleware`.

docs/topics/telnetconsole.rst

@@ -26,14 +26,19 @@ disable it if you want. For more information about the extension itself see
     Please avoid using telnet console over insecure connections,
     or disable it completely using :setting:`TELNETCONSOLE_ENABLED` option.
 
+.. note::
+    This feature is not supported when :setting:`TWISTED_REACTOR_ENABLED` is ``False``.
+
+.. seealso:: :ref:`security-telnet`
+
 .. highlight:: none
 
 How to access the telnet console
 ================================
 
-The telnet console listens in the TCP port defined in the
-:setting:`TELNETCONSOLE_PORT` setting, which defaults to ``6023``. To access
-the console you need to type::
+The telnet console listens on the first available TCP port from the range
+defined in the :setting:`TELNETCONSOLE_PORT` setting, which defaults to
+``[6023, 6073]``. To access the console you need to type::
 
     telnet localhost 6023
     Trying localhost...
@@ -43,12 +48,12 @@ the console you need to type::
     Password:
     >>>
 
-By default Username is ``scrapy`` and Password is autogenerated. The
-autogenerated Password can be seen on Scrapy logs like the example below::
+By default, the username is ``scrapy`` and the password is autogenerated. The
+autogenerated password can be seen on Scrapy logs like the example below::
 
     2018-10-16 14:35:21 [scrapy.extensions.telnet] INFO: Telnet Password: 16f92501e8a59326
 
-Default Username and Password can be overridden by the settings
+The default username and password can be overridden by the settings
 :setting:`TELNETCONSOLE_USERNAME` and :setting:`TELNETCONSOLE_PASSWORD`.
 
 .. warning::
@@ -59,6 +64,8 @@ Default Username and Password can be overridden by the settings
 You need the telnet program which comes installed by default in Windows, and
 most Linux distros.
 
+.. _telnet-vars:
+
 Available variables in the telnet console
 =========================================
 
@@ -77,8 +84,6 @@ convenience:
 +----------------+-------------------------------------------------------------------+
 | ``spider``     | the active spider                                                 |
 +----------------+-------------------------------------------------------------------+
-| ``slot``       | the engine slot                                                   |
-+----------------+-------------------------------------------------------------------+
 | ``extensions`` | the Extension Manager (Crawler.extensions attribute)              |
 +----------------+-------------------------------------------------------------------+
 | ``stats``      | the Stats Collector (Crawler.stats attribute)                     |
@@ -91,19 +96,19 @@ convenience:
 +----------------+-------------------------------------------------------------------+
 | ``p``          | a shortcut to the :func:`pprint.pprint` function                  |
 +----------------+-------------------------------------------------------------------+
-| ``hpy``        | for memory debugging (see :ref:`topics-leaks`)                    |
-+----------------+-------------------------------------------------------------------+
 
 Telnet console usage examples
 =============================
 
+.. skip: start
+
 Here are some example tasks you can do with the telnet console:
 
 View engine status
 ------------------
 
-You can use the ``est()`` method of the Scrapy engine to quickly show its state
-using the telnet console::
+You can use the ``est()`` method provided by the console to quickly show the
+engine status::
 
     telnet localhost 6023
     >>> est()
@@ -114,10 +119,10 @@ using the telnet console::
     engine.scraper.is_idle()                        : False
     engine.spider.name                              : followall
     engine.spider_is_idle()                         : False
-    engine.slot.closing                             : False
-    len(engine.slot.inprogress)                     : 16
-    len(engine.slot.scheduler.dqs or [])            : 0
-    len(engine.slot.scheduler.mqs)                  : 92
+    engine._slot.closing                            : False
+    len(engine._slot.inprogress)                    : 16
+    len(engine._slot.scheduler.dqs or [])           : 0
+    len(engine._slot.scheduler.mqs)                 : 92
     len(engine.scraper.slot.queue)                  : 0
     len(engine.scraper.slot.active)                 : 0
     engine.scraper.slot.active_size                 : 0
@@ -146,6 +151,8 @@ To stop::
     >>> engine.stop()
     Connection closed by foreign host.
 
+.. skip: end
+
 Telnet Console signals
 ======================
 
@@ -172,8 +179,8 @@ TELNETCONSOLE_PORT
 
 Default: ``[6023, 6073]``
 
-The port range to use for the telnet console. If set to ``None`` or ``0``, a
-dynamically assigned port is used.
+The port range to use for the telnet console. If set to ``None``, a dynamically
+assigned port is used.
 
 
 .. setting:: TELNETCONSOLE_HOST
@@ -185,6 +192,8 @@ Default: ``'127.0.0.1'``
 
 The interface the telnet console should listen on
 
+.. seealso:: :ref:`security-telnet`
+
 
 .. setting:: TELNETCONSOLE_USERNAME
 

docs/topics/webservice.rst

@@ -1,11 +0,0 @@
-.. _topics-webservice:
-
-===========
-Web Service
-===========
-
-webservice has been moved into a separate project.
-
-It is hosted at:
-
-    https://github.com/scrapy-plugins/scrapy-jsonrpc

docs/utils/linkfix.py

@@ -13,25 +13,26 @@ Author: dufferzafar
 """
 
 import re
+import sys
+from pathlib import Path
 
 
 def main():
-
     # Used for remembering the file (and its contents)
     # so we don't have to open the same file again.
     _filename = None
     _contents = None
 
     # A regex that matches standard linkcheck output lines
-    line_re = re.compile(r'(.*)\:\d+\:\s\[(.*)\]\s(?:(.*)\sto\s(.*)|(.*))')
+    line_re = re.compile(r"(.*)\:\d+\:\s\[(.*)\]\s(?:(.*)\sto\s(.*)|(.*))")
 
     # Read lines from the linkcheck output file
     try:
-        with open("build/linkcheck/output.txt") as out:
+        with Path("build/linkcheck/output.txt").open(encoding="utf-8") as out:
             output_lines = out.readlines()
-    except IOError:
+    except OSError:
         print("linkcheck output not found; please run linkcheck first.")
-        exit(1)
+        sys.exit(1)
 
     # For every line, fix the respective file
     for line in output_lines:
@@ -48,17 +49,14 @@ def main():
             else:
                 # If this is a new file
                 if newfilename != _filename:
-
                     # Update the previous file
                     if _filename:
-                        with open(_filename, "w") as _file:
-                            _file.write(_contents)
+                        Path(_filename).write_text(_contents, encoding="utf-8")
 
                     _filename = newfilename
 
                     # Read the new file to memory
-                    with open(_filename) as _file:
-                        _contents = _file.read()
+                    _contents = Path(_filename).read_text(encoding="utf-8")
 
                 _contents = _contents.replace(match.group(3), match.group(4))
         else:
@@ -66,5 +64,5 @@ def main():
             print("Not Understood: " + line)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

docs/versioning.rst

@@ -23,7 +23,7 @@ Development releases do not follow 3-numbers version and are generally
 released as ``dev`` suffixed versions, e.g. ``1.3dev``.
 
 .. note::
-    With Scrapy 0.* series, Scrapy used `odd-numbered versions for development releases`_.
+    With Scrapy 0.* series, Scrapy used odd-numbered versions for development releases.
     This is not the case anymore from Scrapy 1.0 onwards.
 
     Starting with Scrapy 1.0, all releases should be considered production-ready.
@@ -39,8 +39,8 @@ API stability
 
 API stability was one of the major goals for the *1.0* release.
 
-Methods or functions that start with a single dash (``_``) are private and
-should never be relied as stable.
+Methods or functions that start with a single underscore (``_``) are private
+and should never be relied upon as stable.
 
 Also, keep in mind that stable doesn't mean complete: stable APIs could grow
 new methods or functionality but the existing methods should keep working the
@@ -63,7 +63,3 @@ feature.
 
 All deprecated features removed in a Scrapy release are explicitly mentioned in
 the :ref:`release notes <news>`.
-
-
-.. _odd-numbered versions for development releases: https://en.wikipedia.org/wiki/Software_versioning#Odd-numbered_versions_for_development_releases
-

extras/coverage-report.sh

@@ -1,6 +1,6 @@
 # Run tests, generate coverage report and open it on a browser
 #
-# Requires: coverage 3.3 or above from https://pypi.python.org/pypi/coverage
+# Requires: coverage 3.3 or above from https://pypi.org/pypi/coverage
 
 coverage run --branch $(which trial) --reporter=text tests
 coverage html -i

extras/qps-bench-server.py

@@ -1,13 +1,13 @@
 #!/usr/bin/env python
-from time import time
 from collections import deque
-from twisted.web.server import Site, NOT_DONE_YET
+from time import time
+
+from twisted.internet import reactor  # noqa: TID253
 from twisted.web.resource import Resource
-from twisted.internet import reactor
+from twisted.web.server import NOT_DONE_YET, Site
 
 
 class Root(Resource):
-
     def __init__(self):
         Resource.__init__(self)
         self.concurrent = 0
@@ -18,7 +18,7 @@ class Root(Resource):
         self.tail.clear()
         self.start = self.lastmark = self.lasttime = time()
 
-    def getChild(self, request, name):
+    def getChild(self, path, request):
         return self
 
     def render(self, request):
@@ -26,9 +26,9 @@ class Root(Resource):
         delta = now - self.lasttime
 
         # reset stats on high iter-request times caused by client restarts
-        if delta > 3: # seconds
+        if delta > 3:  # seconds
             self._reset_stats()
-            return ''
+            return ""
 
         self.tail.appendleft(delta)
         self.lasttime = now
@@ -37,15 +37,17 @@ class Root(Resource):
         if now - self.lastmark >= 3:
             self.lastmark = now
             qps = len(self.tail) / sum(self.tail)
-            print(f'samplesize={len(self.tail)} concurrent={self.concurrent} qps={qps:0.2f}')
+            print(
+                f"samplesize={len(self.tail)} concurrent={self.concurrent} qps={qps:0.2f}"
+            )
 
-        if 'latency' in request.args:
-            latency = float(request.args['latency'][0])
+        if "latency" in request.args:
+            latency = float(request.args["latency"][0])
             reactor.callLater(latency, self._finish, request)
             return NOT_DONE_YET
 
         self.concurrent -= 1
-        return ''
+        return ""
 
     def _finish(self, request):
         self.concurrent -= 1

extras/qpsclient.py

@@ -1,47 +1,44 @@
 """
-A spider that generate light requests to meassure QPS throughput
+A spider that generate light requests to measure QPS throughput
 
 usage:
 
-    scrapy runspider qpsclient.py --loglevel=INFO --set RANDOMIZE_DOWNLOAD_DELAY=0 --set CONCURRENT_REQUESTS=50 -a qps=10 -a latency=0.3
+    scrapy runspider qpsclient.py --loglevel=INFO --set RANDOMIZE_DOWNLOAD_DELAY=0
+     --set CONCURRENT_REQUESTS=50 -a qps=10 -a latency=0.3
 
 """
 
-from scrapy.spiders import Spider
 from scrapy.http import Request
+from scrapy.spiders import Spider
 
 
 class QPSSpider(Spider):
+    name = "qps"
+    benchurl = "http://localhost:8880/"
 
-    name = 'qps'
-    benchurl = 'http://localhost:8880/'
-
-    # Max concurrency is limited by global CONCURRENT_REQUESTS setting
-    max_concurrent_requests = 8
     # Requests per second goal
-    qps = None # same as: 1 / download_delay
-    download_delay = None
+    qps = None  # same as: 1 / DOWNLOAD_DELAY
     # time in seconds to delay server responses
     latency = None
     # number of slots to create
     slots = 1
 
-    def __init__(self, *a, **kw):
-        super().__init__(*a, **kw)
-        if self.qps is not None:
-            self.qps = float(self.qps)
-            self.download_delay = 1 / self.qps
-        elif self.download_delay is not None:
-            self.download_delay = float(self.download_delay)
+    @classmethod
+    def from_crawler(cls, crawler, *args, **kwargs):
+        spider = super().from_crawler(crawler, *args, **kwargs)
+        if spider.qps is not None:
+            spider.qps = float(spider.qps)
+            crawler.settings.set("DOWNLOAD_DELAY", 1 / spider.qps, priority="spider")
+        return spider
 
-    def start_requests(self):
+    async def start(self):
         url = self.benchurl
         if self.latency is not None:
-            url += f'?latency={self.latency}'
+            url += f"?latency={self.latency}"
 
         slots = int(self.slots)
         if slots > 1:
-            urls = [url.replace('localhost', f'127.0.0.{x + 1}') for x in range(slots)]
+            urls = [url.replace("localhost", f"127.0.0.{x + 1}") for x in range(slots)]
         else:
             urls = [url]
 

extras/scrapy_zsh_completion

@@ -41,7 +41,6 @@ _scrapy() {
 		(runspider)
 		    local options=(
 			{'(--output)-o','(-o)--output='}'[dump scraped items into FILE (use - for stdout)]:file:_files'
-			{'(--output-format)-t','(-t)--output-format='}'[format to use for dumping items with -o]:format:(FORMAT)'
 			'*-a[set spider argument (may be repeated)]:value pair:(NAME=VALUE)'
 			'1:spider file:_files -g \*.py'
 		    )
@@ -99,7 +98,6 @@ _scrapy() {
 		(crawl)
 		    local options=(
 			{'(--output)-o','(-o)--output='}'[dump scraped items into FILE (use - for stdout)]:file:_files'
-			{'(--output-format)-t','(-t)--output-format='}'[format to use for dumping items with -o]:format:(FORMAT)'
 			'*-a[set spider argument (may be repeated)]:value pair:(NAME=VALUE)'
 			'1:spider:_scrapy_spiders'
 		    )