diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs index a9fc3dd68..1f062eef2 100644 --- a/.git-blame-ignore-revs +++ b/.git-blame-ignore-revs @@ -4,4 +4,4 @@ e211ec0aa26ecae0da8ae55d064ea60e1efe4d0d # reapplying black to the code with default line length 303f0a70fcf8067adf0a909c2096a5009162383a # reapplying black again and removing line length on pre-commit black config -c5cdd0d30ceb68ccba04af0e71d1b8e6678e2962 \ No newline at end of file +c5cdd0d30ceb68ccba04af0e71d1b8e6678e2962 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..98a74f8ce --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,31 @@ + diff --git a/.github/workflows/auto-close-llm-pr.yml b/.github/workflows/auto-close-llm-pr.yml new file mode 100644 index 000000000..160b39488 --- /dev/null +++ b/.github/workflows/auto-close-llm-pr.yml @@ -0,0 +1,48 @@ +name: Auto-close LLM PRs +on: + pull_request_target: + types: [opened] +permissions: + contents: read + pull-requests: write +jobs: + close-llm-pr: + name: Close PR if marked as LLM-written + runs-on: ubuntu-latest + steps: + - name: Check PR body and close if LLM-written + uses: actions/github-script@v6 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + const marker = "This PR was written entirely using an LLM"; + const { owner, repo } = context.repo; + const prNumber = context.payload.pull_request && context.payload.pull_request.number; + if (!prNumber) { + console.log('No pull request number found in context; exiting.'); + return; + } + const { data: pr } = await github.rest.pulls.get({ owner, repo, pull_number: prNumber }); + const body = pr.body || ""; + if (body.includes(marker)) { + if (pr.state === 'closed') { + console.log(`PR #${prNumber} already closed.`); + return; + } + await github.rest.issues.addLabels({ + owner, + repo, + issue_number: prNumber, + labels: ['spam'] + }); + await github.rest.issues.createComment({ + owner, + repo, + issue_number: prNumber, + body: "Closing this PR because it contains the disclosure: \"This PR was written entirely using an LLM\"." + }); + await github.rest.pulls.update({ owner, repo, pull_number: prNumber, state: 'closed' }); + console.log(`Closed PR #${prNumber} because marker was found.`); + } else { + console.log(`Marker not found in PR #${prNumber}; nothing to do.`); + } diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 312af3b2e..ed2388a59 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -17,27 +17,31 @@ jobs: fail-fast: false matrix: include: - - python-version: "3.13" + - python-version: "3.14" env: TOXENV: pylint - - python-version: "3.9" + - python-version: "3.10" env: - TOXENV: typing - - python-version: "3.9" + TOXENV: mypy + - python-version: "3.10" env: - TOXENV: typing-tests - - python-version: "3.13" # Keep in sync with .readthedocs.yml + 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@v4 + - uses: actions/checkout@v6 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 + uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} @@ -50,5 +54,5 @@ jobs: pre-commit: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - uses: pre-commit/action@v3.0.1 diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index d1589f4f7..7779bbb6b 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -18,10 +18,10 @@ jobs: permissions: id-token: write steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 + - uses: actions/checkout@v6 + - uses: actions/setup-python@v6 with: - python-version: "3.13" + python-version: "3.14" - run: | python -m pip install --upgrade build python -m build diff --git a/.github/workflows/tests-macos.yml b/.github/workflows/tests-macos.yml index d740808cc..0409b3ef2 100644 --- a/.github/workflows/tests-macos.yml +++ b/.github/workflows/tests-macos.yml @@ -13,27 +13,38 @@ concurrency: jobs: tests: runs-on: macos-latest + env: + PYTEST_ADDOPTS: -n auto strategy: fail-fast: false matrix: - python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] + python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"] + env: + - TOXENV: py + include: + - python-version: '3.14' + env: + TOXENV: no-reactor steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 + uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} - name: Run tests + env: ${{ matrix.env }} run: | pip install -U tox - tox -e py + tox - name: Upload coverage report uses: codecov/codecov-action@v5 - name: Upload test results if: ${{ !cancelled() }} - uses: codecov/test-results-action@v1 + uses: codecov/codecov-action@v5 + with: + report_type: test_results diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml index 06da46ca1..f51dd9799 100644 --- a/.github/workflows/tests-ubuntu.yml +++ b/.github/workflows/tests-ubuntu.yml @@ -13,13 +13,12 @@ concurrency: jobs: tests: runs-on: ubuntu-latest + env: + PYTEST_ADDOPTS: -n auto strategy: fail-fast: false matrix: include: - - python-version: "3.9" - env: - TOXENV: py - python-version: "3.10" env: TOXENV: py @@ -32,53 +31,68 @@ jobs: - python-version: "3.13" env: TOXENV: py - - python-version: "3.13" + - python-version: "3.14" + env: + TOXENV: py + - python-version: "3.14" env: TOXENV: default-reactor - - python-version: pypy3.10 + - python-version: "3.14" env: - TOXENV: pypy3 - - python-version: pypy3.11 + TOXENV: no-reactor + # pinned due to https://github.com/pypy/pypy/issues/5388 + - python-version: pypy3.11-7.3.20 env: TOXENV: pypy3 - # pinned deps - - python-version: "3.9.21" + # min deps + - python-version: "3.10.19" env: - TOXENV: pinned - - python-version: "3.9.21" + TOXENV: min + - python-version: "3.10.19" env: - TOXENV: default-reactor-pinned - - python-version: pypy3.10 + TOXENV: min-default-reactor + - python-version: "3.10.19" env: - TOXENV: pypy3-pinned - - python-version: "3.9.21" + TOXENV: min-no-reactor + # pinned due to https://github.com/pypy/pypy/issues/5388 + - python-version: pypy3.11-7.3.20 env: - TOXENV: extra-deps-pinned - - python-version: "3.9.21" + TOXENV: min-pypy3 + - python-version: "3.10.19" env: - TOXENV: botocore-pinned + TOXENV: min-extra-deps + - python-version: "3.10.19" + env: + TOXENV: min-botocore - - python-version: "3.13" + - python-version: "3.14" env: TOXENV: extra-deps - - python-version: pypy3.11 + - python-version: "3.14" + env: + TOXENV: no-reactor-extra-deps + # 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.13" + - python-version: "3.14" env: TOXENV: botocore + - python-version: "3.14" + env: + TOXENV: mitmproxy steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v6 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 + uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} - name: Install system libraries - if: contains(matrix.python-version, 'pypy') || contains(matrix.env.TOXENV, 'pinned') + if: contains(matrix.python-version, 'pypy') || contains(matrix.env.TOXENV, 'min') run: | sudo apt-get update sudo apt-get install libxml2-dev libxslt-dev @@ -94,4 +108,6 @@ jobs: - name: Upload test results if: ${{ !cancelled() }} - uses: codecov/test-results-action@v1 + uses: codecov/codecov-action@v5 + with: + report_type: test_results diff --git a/.github/workflows/tests-windows.yml b/.github/workflows/tests-windows.yml index bbbb704e5..f413782bc 100644 --- a/.github/workflows/tests-windows.yml +++ b/.github/workflows/tests-windows.yml @@ -13,13 +13,12 @@ concurrency: jobs: tests: runs-on: windows-latest + env: + PYTEST_ADDOPTS: -n auto strategy: fail-fast: false matrix: include: - - python-version: "3.9" - env: - TOXENV: py - python-version: "3.10" env: TOXENV: py @@ -32,27 +31,33 @@ jobs: - python-version: "3.13" env: TOXENV: py - - python-version: "3.13" + - python-version: "3.14" + env: + TOXENV: py + - python-version: "3.14" env: TOXENV: default-reactor - - # pinned deps - - python-version: "3.9.13" + - python-version: "3.14" env: - TOXENV: pinned - - python-version: "3.9.13" - env: - TOXENV: extra-deps-pinned + TOXENV: no-reactor - - python-version: "3.13" + # 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@v4 + - uses: actions/checkout@v6 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v5 + uses: actions/setup-python@v6 with: python-version: ${{ matrix.python-version }} @@ -67,4 +72,6 @@ jobs: - name: Upload test results if: ${{ !cancelled() }} - uses: codecov/test-results-action@v1 + uses: codecov/codecov-action@v5 + with: + report_type: test_results diff --git a/.gitignore b/.gitignore index 4100bcd97..5e52ecf1e 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,7 @@ *.pyc _trial_temp* dropin.cache -docs/build +docs/_build *egg-info .tox/ venv/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6fbf74058..754bd6f9c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,21 +1,32 @@ +exclude: | + (?x)( + ^docs/_static| + ^docs/_tests| + ^tests/sample_data + ) repos: - repo: https://github.com/astral-sh/ruff-pre-commit - rev: v0.9.3 + rev: v0.15.2 hooks: - - id: ruff + - id: ruff-check args: [ --fix ] - id: ruff-format - repo: https://github.com/adamchainz/blacken-docs - rev: 1.19.1 + rev: 1.20.0 hooks: - id: blacken-docs additional_dependencies: - - black==24.10.0 + - black==25.9.0 - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v5.0.0 + rev: v6.0.0 hooks: + - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/sphinx-contrib/sphinx-lint - rev: v1.0.0 + rev: v1.0.2 hooks: - id: sphinx-lint +- repo: https://github.com/scrapy/sphinx-scrapy + rev: 0.8.8 + hooks: + - id: sphinx-scrapy diff --git a/.readthedocs.yml b/.readthedocs.yml index 23e4cabea..a2773dcf2 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,17 +1,10 @@ version: 2 -formats: all -sphinx: - configuration: docs/conf.py - fail_on_warning: true - build: os: ubuntu-24.04 tools: - # For available versions, see: - # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools-python - python: "3.13" # Keep in sync with .github/workflows/checks.yml - -python: - install: - - requirements: docs/requirements.txt - - path: . + python: "3.14" + commands: + - pip install tox + - tox -e docs + - mkdir -p $READTHEDOCS_OUTPUT/html + - cp -a docs/_build/all/. $READTHEDOCS_OUTPUT/html/ diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 000000000..24a426d36 --- /dev/null +++ b/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 diff --git a/README.rst b/README.rst index 536dec7f0..6235cb20c 100644 --- a/README.rst +++ b/README.rst @@ -40,7 +40,7 @@ :alt: Ask DeepWiki Scrapy_ is a web scraping framework to extract structured data from websites. -It is cross-platform, and requires Python 3.9+. It is maintained by Zyte_ +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 diff --git a/SECURITY.md b/SECURITY.md index a5a5c7fb3..49cafdf9e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,8 +4,8 @@ | Version | Supported | | ------- | ------------------ | -| 2.13.x | :white_check_mark: | -| < 2.13.x | :x: | +| 2.16.x | :white_check_mark: | +| < 2.16.x | :x: | ## Reporting a Vulnerability diff --git a/conftest.py b/conftest.py index f952127b9..532f83f56 100644 --- a/conftest.py +++ b/conftest.py @@ -1,10 +1,20 @@ +from __future__ import annotations + +import importlib 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 + +if TYPE_CHECKING: + from collections.abc import Generator def _py_files(folder): @@ -14,20 +24,13 @@ def _py_files(folder): collect_ignore = [ # may need extra deps "docs/_ext", - # not a test, but looks like a test - "scrapy/utils/testproc.py", - "scrapy/utils/testsite.py", - "tests/ftpserver.py", - "tests/mockserver.py", - "tests/pipelines.py", - "tests/spiders.py", - # contains scripts to be run by tests/test_crawler.py::AsyncCrawlerProcessSubprocess + # 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.py::AsyncCrawlerRunnerSubprocess + # 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.py::CrawlerProcessSubprocess + # 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"), ] @@ -47,81 +50,92 @@ if not H2_ENABLED: ) ) +try: + import httpx # noqa: F401 +except ImportError: + collect_ignore.append("scrapy/core/downloader/handlers/_httpx.py") -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="asyncio", - choices=["default", "asyncio"], + default="none", + choices=["asyncio", "default", "none"], ) -@pytest.fixture(scope="class") -def reactor_pytest(request): - if not request.cls: - # doctests - return None - request.cls.reactor_pytest = request.config.getoption("--reactor") - return request.cls.reactor_pytest +@pytest.fixture(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 == "default": - pytest.skip("This test is only run without --reactor=default") +@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) - -@pytest.fixture(autouse=True) -def only_not_asyncio(request, reactor_pytest): - if ( - request.node.get_closest_marker("only_not_asyncio") - and reactor_pytest != "default" - ): - pytest.skip("This test is only run with --reactor=default") - - -@pytest.fixture(autouse=True) -def requires_uvloop(request): - if not request.node.get_closest_marker("requires_uvloop"): - return try: - import uvloop - - del uvloop - except ImportError: - pytest.skip("uvloop is not installed") + yield kind + finally: + proxy.stop() -@pytest.fixture(autouse=True) -def requires_botocore(request): - if not request.node.get_closest_marker("requires_botocore"): - return - try: - import botocore - - del botocore - except ImportError: - pytest.skip("botocore is not installed") - - -@pytest.fixture(autouse=True) -def requires_boto3(request): - if not request.node.get_closest_marker("requires_boto3"): - return - try: - import boto3 - - del boto3 - except ImportError: - pytest.skip("boto3 is not installed") +@pytest.fixture(scope="session") +def reactor_pytest(request) -> str: + return request.config.getoption("--reactor") def pytest_configure(config): - if config.getoption("--reactor") != "default": - install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor") - else: - # install the reactor explicitly - from twisted.internet import reactor # noqa: F401 + if config.getoption("--reactor") == "asyncio": + # 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() + + +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", + "mitmproxy", + ] + + for module in optional_deps: + if item.get_closest_marker(f"requires_{module}"): + try: + importlib.import_module(module) + except ImportError: + pytest.skip(f"{module} is not installed") # Generate localhost certificate files, needed by some tests diff --git a/docs/README.rst b/docs/README.rst index 36dd5aea4..4d2236b53 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -65,4 +65,4 @@ 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. +Documentation will be generated inside the ``docs/_build/all`` dir. diff --git a/docs/_ext/scrapydocs.py b/docs/_ext/scrapydocs.py index 4ceb003c7..edb91bfb9 100644 --- a/docs/_ext/scrapydocs.py +++ b/docs/_ext/scrapydocs.py @@ -29,14 +29,14 @@ def is_setting_index(node: Node) -> bool: if node.tagname == "index" and node["entries"]: # type: ignore[index,attr-defined] # index entries for setting directives look like: # [('pair', 'SETTING_NAME; setting', 'std:setting-SETTING_NAME', '')] - entry_type, info, refid = node["entries"][0][:3] # type: ignore[index] + entry_type, info, _ = node["entries"][0][:3] # type: ignore[index] return entry_type == "pair" and info.endswith("; setting") return False def get_setting_name_and_refid(node: Node) -> tuple[str, str]: """Extract setting name from directive index node""" - entry_type, info, refid = node["entries"][0][:3] # type: ignore[index] + _, info, refid = node["entries"][0][:3] # type: ignore[index] return info.replace("; setting", ""), refid @@ -77,6 +77,25 @@ def make_setting_element( return item +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: @@ -87,13 +106,29 @@ def replace_settingslist_nodes( settings_list.extend( [ make_setting_element(d, app, fromdocname) - for d in sorted(env.scrapy_all_settings, key=itemgetter("setting_name")) # type: ignore[attr-defined] - if fromdocname != d["docname"] + for d in _iter_sorted_settings(env, fromdocname) ] ) node.replace_self(settings_list) +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 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]]: @@ -126,34 +161,22 @@ def rev_role( return [node], [] -def setup(app: Sphinx) -> None: - app.add_crossref_type( - directivename="setting", - rolename="setting", - indextemplate="pair: %s; setting", - ) - app.add_crossref_type( - directivename="signal", - rolename="signal", - indextemplate="pair: %s; signal", - ) - app.add_crossref_type( - directivename="command", - rolename="command", - indextemplate="pair: %s; command", - ) - app.add_crossref_type( - directivename="reqmeta", - rolename="reqmeta", - indextemplate="pair: %s; reqmeta", - ) +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) + 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} diff --git a/docs/_ext/scrapyfixautodoc.py b/docs/_ext/scrapyfixautodoc.py index d7a3fb514..e342e92cf 100644 --- a/docs/_ext/scrapyfixautodoc.py +++ b/docs/_ext/scrapyfixautodoc.py @@ -3,16 +3,19 @@ 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: - # autodocs was generating a text "alias of" for the following members + # 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) -> None: +def setup(app: Sphinx) -> dict[str, Any]: app.connect("autodoc-skip-member", maybe_skip_member) + return {"parallel_read_safe": True} diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index 6ec565e24..29394799b 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -1,6 +1,6 @@ {% extends "!layout.html" %} -{# Overriden to include a link to scrapy.org, not just to the docs root #} +{# 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 #} diff --git a/docs/conf.py b/docs/conf.py index 040229a4a..44de57421 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,14 +26,11 @@ author = "Scrapy developers" # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ - "hoverxref.extension", "notfound.extension", "scrapydocs", - "sphinx.ext.autodoc", + "sphinx_scrapy", "scrapyfixautodoc", # Must be after "sphinx.ext.autodoc" "sphinx.ext.coverage", - "sphinx.ext.intersphinx", - "sphinx.ext.viewcode", "sphinx_reredirects", "sphinx_rtd_dark_mode", ] @@ -70,6 +67,14 @@ html_css_files = [ "custom.css", ] +html_context = { + "display_github": True, + "github_user": "scrapy", + "github_repo": "scrapy", + "github_version": "master", + "conf_py_path": "/docs/", +} + # Set canonical URL from the Read the Docs Domain html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "") @@ -120,7 +125,7 @@ coverage_ignore_pyobjects = [ # The interface methods of duplicate request filtering classes are already # covered in the interface documentation part of the DUPEFILTER_CLASS # setting documentation. - r"^scrapy\.dupefilters\.[A-Z]\w*?\.(from_settings|request_seen|open|close|log)$", + 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", # Methods of BaseItemExporter subclasses are only documented in @@ -147,21 +152,6 @@ autodoc_type_aliases = { # -- Options for the InterSphinx extension ----------------------------------- # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration -intersphinx_mapping = { - "attrs": ("https://www.attrs.org/en/stable/", None), - "coverage": ("https://coverage.readthedocs.io/en/latest", None), - "cryptography": ("https://cryptography.io/en/latest/", None), - "cssselect": ("https://cssselect.readthedocs.io/en/latest", None), - "itemloaders": ("https://itemloaders.readthedocs.io/en/latest/", None), - "parsel": ("https://parsel.readthedocs.io/en/latest/", None), - "pytest": ("https://docs.pytest.org/en/latest", None), - "python": ("https://docs.python.org/3", None), - "sphinx": ("https://www.sphinx-doc.org/en/master", None), - "tox": ("https://tox.wiki/en/latest/", None), - "twisted": ("https://docs.twisted.org/en/stable/", None), - "twistedapi": ("https://docs.twisted.org/en/stable/api/", None), - "w3lib": ("https://w3lib.readthedocs.io/en/latest", None), -} intersphinx_disabled_reftypes: Sequence[str] = [] # -- sphinx-reredirects ------------------------------------------------------- @@ -169,22 +159,24 @@ redirects = { "topics/autothrottle": "throttling.html", } +# sphinx-scrapy --------------------------------------------------------------- -# -- Options for sphinx-hoverxref extension ---------------------------------- -# https://sphinx-hoverxref.readthedocs.io/en/latest/configuration.html - -hoverxref_auto_ref = True -hoverxref_role_types = { - "class": "tooltip", - "command": "tooltip", - "confval": "tooltip", - "hoverxref": "tooltip", - "mod": "tooltip", - "ref": "tooltip", - "reqmeta": "tooltip", - "setting": "tooltip", - "signal": "tooltip", -} -hoverxref_roles = ["command", "reqmeta", "setting", "signal"] +scrapy_intersphinx_enable = [ + "attrs", + "coverage", + "cryptography", + "cssselect", + "form2request", + "itemloaders", + "parsel", + "pytest", + "scrapy-lint", + "sphinx", + "tox", + "twisted", + "twistedapi", + "w3lib", +] +# -- Other options ------------------------------------------------------------ default_dark_mode = False diff --git a/docs/contributing.rst b/docs/contributing.rst index 3976d34c2..c868a0ac4 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -258,7 +258,7 @@ Scrapy: * Don't put your name in the code you contribute; git provides enough metadata to identify author of the code. - See https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git + See https://docs.github.com/en/get-started/git-basics/setting-your-username-in-git for setup instructions. .. _scrapy-pre-commit: @@ -390,8 +390,7 @@ 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://peps.python.org/pep-0257/ diff --git a/docs/faq.rst b/docs/faq.rst index 1d09a0e63..df90122f5 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -82,10 +82,18 @@ 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? ------------------------------------------------------------ @@ -349,7 +357,7 @@ method for this purpose. For example: class MultiplyItemsMiddleware: - def process_spider_output(self, response, result, spider): + def process_spider_output(self, response, result): for item_or_request in result: if isinstance(item_or_request, Request): continue @@ -360,7 +368,10 @@ method for this purpose. For example: 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). @@ -418,4 +429,3 @@ See :issue:`2680`. .. _has been reported: https://github.com/scrapy/scrapy/issues/2905 .. _Python standard library modules: https://docs.python.org/3/py-modindex.html .. _Python package: https://pypi.org/ -.. _user agents: https://en.wikipedia.org/wiki/User_agent diff --git a/docs/index.rst b/docs/index.rst index 2343b853c..100cdd48e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -128,18 +128,14 @@ Built-in services topics/logging topics/stats - topics/email topics/telnetconsole :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. @@ -230,6 +226,7 @@ Extending Scrapy topics/signals topics/scheduler topics/exporters + topics/download-handlers topics/components topics/api @@ -258,6 +255,9 @@ 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. diff --git a/docs/intro/install.rst b/docs/intro/install.rst index 488a66f36..8cef04ff1 100644 --- a/docs/intro/install.rst +++ b/docs/intro/install.rst @@ -9,7 +9,7 @@ Installation guide Supported Python versions ========================= -Scrapy requires Python 3.9+, either the CPython implementation (default) or +Scrapy requires Python 3.10+, either the CPython implementation (default) or the PyPy implementation (see :ref:`python:implementations`). .. _intro-install-scrapy: @@ -263,7 +263,6 @@ reinstall Twisted with the :code:`tls` extra option:: For details, see `Issue #2473 `_. .. _Python: https://www.python.org/ -.. _pip: https://pip.pypa.io/en/latest/installing/ .. _lxml: https://lxml.de/index.html .. _parsel: https://pypi.org/project/parsel/ .. _w3lib: https://pypi.org/project/w3lib/ @@ -273,8 +272,7 @@ For details, see `Issue #2473 `_. .. _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/ diff --git a/docs/intro/overview.rst b/docs/intro/overview.rst index f62dca73a..c5ff76246 100644 --- a/docs/intro/overview.rst +++ b/docs/intro/overview.rst @@ -148,7 +148,7 @@ The next steps for you are to :ref:`install Scrapy `, 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/welcome/ecs .. _Amazon S3: https://aws.amazon.com/s3/ diff --git a/docs/news.rst b/docs/news.rst index b5dcfa487..e5ccd561e 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -3,8 +3,814 @@ Release notes ============= -Scrapy VERSION (unreleased) ---------------------------- +.. _release-2.16.0: + +Scrapy 2.16.0 (2026-05-19) +-------------------------- + +Highlights: + +- Official support for Python 3.14 + +- Support for Twisted 26.4.0+ + +Modified requirements +~~~~~~~~~~~~~~~~~~~~~ + +- Increased the minimum versions of the following dependencies: + + - service_identity_: 18.1.0 → 23.1.0 + + (:issue:`7347`) + +- Added support for Twisted 26.4.0+. + (:issue:`7347`, :issue:`7505`, :issue:`7520`) + +- Added support for Python 3.14. + (:issue:`6604`, :issue:`7460`) + +Backward-incompatible changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- The following classes and functions, intended for internal use by + :class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler` + and :class:`~scrapy.core.downloader.handlers.http2.H2DownloadHandler`, have + been made private: + + - ``scrapy.core.downloader.handlers.http11.ScrapyAgent`` + + - ``scrapy.core.downloader.handlers.http11.ScrapyProxyAgent`` + + - ``scrapy.core.downloader.handlers.http11.TunnelingAgent`` + + - ``scrapy.core.downloader.handlers.http11.TunnelingTCP4ClientEndpoint`` + + - ``scrapy.core.downloader.handlers.http11.tunnel_request_data()`` + + - ``scrapy.core.downloader.handlers.http2.ScrapyH2Agent`` + + (:issue:`7496`, :issue:`7510`) + +Deprecations +~~~~~~~~~~~~ + +- ``scrapy.FormRequest`` is deprecated. You can use the :doc:`form2request + ` library instead, see :ref:`form`. + (:issue:`6438`) + +- ``scrapy.utils.python.MutableChain`` is deprecated. + (:issue:`7504`) + +Deprecation removals +~~~~~~~~~~~~~~~~~~~~ + +- The ``start_requests()`` method of :class:`~scrapy.Spider`, deprecated in + 2.13.0, is removed and no longer called. Use :meth:`~scrapy.Spider.start` + instead, or both to maintain support for lower Scrapy versions. + (:issue:`7490`) + +- Support for ``process_start_requests()`` methods of :ref:`spider middlewares + `, deprecated in 2.13.0, is removed. Use + :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_start` instead, + or both to maintain support for lower Scrapy versions. + (:issue:`7490`) + +- Support for synchronous ``process_spider_output()`` methods of spider + middlewares, deprecated in Scrapy 2.13.0, is removed. You should upgrade + the affected middlewares to have asynchronous ``process_spider_output()`` + methods. + (:issue:`7504`) + +- The ``spider`` arguments of the following methods of + :class:`~scrapy.core.scraper.Scraper`, deprecated in Scrapy 2.13.0, are + removed: + + - ``close_spider()`` + + - ``enqueue_scrape()`` + + - ``handle_spider_error()`` + + - ``handle_spider_output()`` + + (:issue:`7487`) + +- HTTP/1.0 support code, deprecated in Scrapy 2.13.0, is removed. This + includes: + + - ``scrapy.core.downloader.handlers.http10.HTTP10DownloadHandler`` + + - The ``scrapy.core.downloader.webclient`` module. + + - The ``DOWNLOADER_HTTPCLIENTFACTORY`` setting. + + (:issue:`7486`) + +- The following functions, deprecated in Scrapy 2.13.0, are removed, you + should import them from :mod:`w3lib.url` directly instead: + + - ``scrapy.utils.url.add_or_replace_parameter()`` + + - ``scrapy.utils.url.add_or_replace_parameters()`` + + - ``scrapy.utils.url.any_to_uri()`` + + - ``scrapy.utils.url.canonicalize_url()`` + + - ``scrapy.utils.url.file_uri_to_path()`` + + - ``scrapy.utils.url.is_url()`` + + - ``scrapy.utils.url.parse_data_uri()`` + + - ``scrapy.utils.url.parse_url()`` + + - ``scrapy.utils.url.path_to_file_uri()`` + + - ``scrapy.utils.url.safe_download_url()`` + + - ``scrapy.utils.url.safe_url_string()`` + + - ``scrapy.utils.url.url_query_cleaner()`` + + - ``scrapy.utils.url.url_query_parameter()`` + + (:issue:`7487`) + +- The following test-related code, deprecated in Scrapy 2.13.0, is removed: + + - the ``scrapy.utils.testproc`` module + + - the ``scrapy.utils.testsite`` module + + - ``scrapy.utils.test.assert_gcs_environ()`` + + - ``scrapy.utils.test.get_ftp_content_and_delete()`` + + - ``scrapy.utils.test.get_gcs_content_and_delete()`` + + - ``scrapy.utils.test.mock_google_cloud_storage()`` + + - ``scrapy.utils.test.skip_if_no_boto()`` + + - ``scrapy.utils.test.TestSpider`` + + (:issue:`7487`) + +- ``scrapy.utils.versions.scrapy_components_versions()``, deprecated in + Scrapy 2.13.0, is removed, you can use + :func:`scrapy.utils.versions.get_versions` instead. + (:issue:`7487`) + +- ``scrapy.downloadermiddlewares.ajaxcrawl.AjaxCrawlMiddleware`` and + ``scrapy.utils.url.escape_ajax()``, deprecated in Scrapy 2.13.0, are + removed. + (:issue:`7487`) + +- The ``__init__()`` method of priority queue classes (see + :setting:`SCHEDULER_PRIORITY_QUEUE`) now needs to support a keyword-only + ``start_queue_cls`` parameter, not supporting it was deprecated in Scrapy + 2.13.0. + (:issue:`7487`) + +- ``scrapy.spiders.init.InitSpider``, deprecated in Scrapy 2.13.0, is + removed. + (:issue:`7487`) + +New features +~~~~~~~~~~~~ + +- New features and improvements for + :class:`~scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler`: + + - Support for proxies. + + - Support for the :reqmeta:`download_latency` meta key. + + - Support for :attr:`Response.certificate + `. + + - Default headers set by the ``httpx`` library are no longer added to + requests. + + (:issue:`7441`, :issue:`7524`) + +- :class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler` now + skips HTTPS proxy certificate verification when the + :setting:`DOWNLOAD_VERIFY_CERTIFICATES` setting is set to ``False``. + (:issue:`7496`) + +Improvements +~~~~~~~~~~~~ + +- :func:`time.monotonic` is used instead of :func:`time.time` to calculate + elapsed time in various places. + (:issue:`7377`) + +- Improved extraction of the file extension from the URL in + :class:`~scrapy.pipelines.files.FilesPipeline`. + (:issue:`4225`, :issue:`7414`) + +- Other code refactoring and improvements. + (:issue:`7401`) + +Bug fixes +~~~~~~~~~ + +- :class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler` now + raises an exception when a request has an ``https://`` destination and an + ``https://`` proxy, which is not supported by this handler. Previously it + tried to connect to the proxy via HTTP in this case. + (:issue:`7496`) + +- :class:`~scrapy.core.downloader.handlers.http2.H2DownloadHandler` now + raises an exception for requests with ``http://`` URLs instead of trying to + connect, which is not supported by this handler. + (:issue:`7496`) + +- :class:`~scrapy.core.downloader.handlers.http2.H2DownloadHandler` no longer + adds the ``:status`` pseudo-header to :attr:`Response.headers + `. + (:issue:`7441`) + +- Fixed :func:`scrapy.utils.response.open_in_browser` removing the ```` + tag when adding the ```` tag. + (:issue:`7459`) + +Documentation +~~~~~~~~~~~~~ + +- Documented that + :class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler` + doesn't support HTTPS proxies for HTTPS destinations and that + :class:`~scrapy.core.downloader.handlers.http2.H2DownloadHandler` doesn't + support proxies at all. + (:issue:`7496`) + +- Added an example of using + :class:`logging.handlers.TimedRotatingFileHandler` to rotate Scrapy logs. + (:issue:`3628`, :issue:`7501`) + +- Added a ``CITATION.cff`` file. + (:issue:`7502`, :issue:`7519`) + +- Mentioned ``DOWNLOADER_CLIENT_TLS_METHOD`` in :ref:`bans`. + (:issue:`5232`, :issue:`7518`) + +- Other documentation improvements and fixes. + (:issue:`7417`, + :issue:`7463`, + :issue:`7472`, + :issue:`7480`, + :issue:`7489`, + :issue:`7503`, + :issue:`7507`) + +Quality assurance +~~~~~~~~~~~~~~~~~ + +- Added tests that connect to https://books.toscrape.com/ to test the + behavior with a real website. These tests are marked with the + ``requires_internet`` pytest mark and can be skipped with e.g. + ``-m 'not requires_internet'`` if you cannot or don't want to run them. + (:issue:`7520`) + +- Type hints improvements and fixes. + (:issue:`7492`, :issue:`7532`) + +- CI and test improvements and fixes. + (:issue:`7441`, :issue:`7466`, :issue:`7491`, :issue:`7496`) + +.. _release-2.15.2: + +Scrapy 2.15.2 (2026-04-28) +-------------------------- + +Bug fixes +~~~~~~~~~ + +- Fixed links in https://docs.scrapy.org/llms.txt (:issue:`7467`) + +.. _release-2.15.1: + +Scrapy 2.15.1 (2026-04-23) +-------------------------- + +Bug fixes +~~~~~~~~~ + +- Sharing of the SSL context between multiple connections, introduced in + Scrapy 2.15.0, is reverted as it caused problems and wasn't actually + needed. + (:issue:`7445`, :issue:`7450`) + +- Fixed :meth:`scrapy.settings.BaseSettings.getwithbase` failing on keys with + dots that aren't import names. It now works the way it worked before Scrapy + 2.15.0, without trying to match class objects and import path. A separate + method, + :func:`~scrapy.settings.BaseSettings.get_component_priority_dict_with_base`, + was added that does that, and it is now used for :ref:`component priority + dictionaries `. + (:issue:`7426`, :issue:`7449`) + +- Documentation rendering improvements. + (:issue:`7452`, :issue:`7454`) + +.. _release-2.15.0: + +Scrapy 2.15.0 (2026-04-09) +-------------------------- + +Highlights: + +- Experimental support for running without a Twisted reactor + +- Experimental ``httpx``-based download handler + +Backward-incompatible changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- The built-in HTTP :ref:`download handlers ` now + raise Scrapy-specific exceptions instead of implementation-specific ones, + see :ref:`download-handlers-exceptions`. This can affect user code that + handles downloader exceptions, such as ``process_exception()`` methods of + custom :ref:`downloader middlewares `. + (:issue:`7208`) + +- In order to fix a long-standing bug with handling of asynchronous storages, + the following changes were made to media pipeline classes, which can impact + some of the user code that subclasses them or calls their methods directly: + + - overrides of :meth:`scrapy.pipelines.media.MediaPipeline.media_downloaded` + and :meth:`~scrapy.pipelines.files.FilesPipeline.file_downloaded` can now + return coroutines + + - :meth:`~scrapy.pipelines.files.FilesPipeline.media_downloaded`, + :meth:`~scrapy.pipelines.files.FilesPipeline.file_downloaded` and + :meth:`~scrapy.pipelines.images.ImagesPipeline.image_downloaded` now + return coroutines + + (:issue:`2183`, :issue:`6369`, :issue:`7182`) + +- ``Request`` and ``Response`` objects: ``__slots__`` and setter changes: + + - :class:`scrapy.http.Request` and :class:`scrapy.http.Response` now + define ``__slots__``. Assigning arbitrary attributes to instances (for + example, ``response.foo = 1``) will raise ``AttributeError``. Store + per-request/response data in the request/response ``meta`` mapping + instead of attaching new attributes to the objects. + + - If you maintain custom ``Request`` or ``Response`` subclasses that + relied on dynamic instance attributes, either add ``'__dict__'`` to + your subclass ``__slots__`` to allow dynamic attributes, or migrate + per-instance state to ``meta`` or explicit documented attributes. + + - The setters for ``headers``, ``flags`` and ``cookies`` no longer coerce + falsy values into ``None``. For example, ``request.headers = {}`` now + stores an empty :class:`scrapy.http.headers.Headers` instance (not + ``None``), and ``request.flags = []`` remains an empty list instead of + being set to ``None``. Update code that relied on ``is None`` checks or + the previous coercion behaviour. + + (:issue:`7036`, :issue:`7367`, :issue:`7374`) + +Deprecation removals +~~~~~~~~~~~~~~~~~~~~ + +- The context factory class set as the value of the + ``DOWNLOADER_CLIENTCONTEXTFACTORY`` setting is now required to support the + ``method`` argument of ``__init__()``, recommended since Scrapy 1.2.0. + (:issue:`7353`) + +Deprecations +~~~~~~~~~~~~ + +- ``scrapy.mail.MailSender`` is deprecated. Please use :mod:`smtplib`, + :mod:`twisted.mail.smtp` or other 3rd party email libraries. + (:issue:`7249`, :issue:`7263`) + +- The ``scrapy.extensions.statsmailer.StatsMailer`` extension is deprecated. + You can instead implement your own notifications by handling the + :signal:`spider_closed` signal. + (:issue:`7249`, :issue:`7263`) + +- The ``MEMUSAGE_NOTIFY_MAIL`` setting is deprecated. You can instead + implement your own notifications by handling the + :signal:`memusage_warning_reached` and :signal:`spider_closed` signals. + (:issue:`7249`, :issue:`7263`) + +- The ``DNS_RESOLVER`` setting was renamed to :setting:`TWISTED_DNS_RESOLVER` + and the old name is deprecated. + (:issue:`7350`, :issue:`7361`) + +- The ``DOWNLOADER_CLIENTCONTEXTFACTORY`` setting is deprecated. If you were + using it to switch to + ``scrapy.core.downloader.contextfactory.BrowserLikeContextFactory``, please + use the new :setting:`DOWNLOAD_VERIFY_CERTIFICATES` setting instead. If you + cannot use the default context factory for some other reason, please + subclass the :ref:`download handler ` instead. + (:issue:`7352`, :issue:`7379`) + +- ``scrapy.core.downloader.contextfactory.BrowserLikeContextFactory`` is + deprecated. You can set the new :setting:`DOWNLOAD_VERIFY_CERTIFICATES` + setting to ``True`` instead. + (:issue:`7379`) + +- The following implementation details of the context factory handling code + are deprecated: + + - ``scrapy.core.downloader.contextfactory.AcceptableProtocolsContextFactory`` + + - ``scrapy.core.downloader.contextfactory.load_context_factory_from_settings()`` + + - ``scrapy.core.downloader.contextfactory.ScrapyClientContextFactory`` + + - ``scrapy.core.downloader.tls.ScrapyClientTLSOptions`` + + (:issue:`7353`, :issue:`7391`) + +- Passing :class:`str` instead of :class:`bytes` to + :class:`scrapy.utils.sitemap.Sitemap` and + :func:`scrapy.utils.sitemap.sitemap_urls_from_robots` is deprecated. + (:issue:`7007`) + +- ``scrapy.utils.misc.walk_modules()`` is deprecated. You can use + :func:`scrapy.utils.misc.walk_modules_iter` instead. + (:issue:`7388`) + +- ``scrapy.shell.Shell.inthread`` is deprecated. You can use + :attr:`scrapy.shell.Shell.fetch_available` instead to check if + :func:`~scrapy.shell.Shell.fetch` can be used. + (:issue:`7395`) + +- ``scrapy.commands.ScrapyCommand.set_crawler()`` is deprecated. + (:issue:`7276`) + +New features +~~~~~~~~~~~~ + +- Added an *experimental* mode for running Scrapy without installing a + Twisted reactor: set :setting:`TWISTED_REACTOR_ENABLED` to ``False`` to + enable it. This mode has limitations, refer to :ref:`its documentation + ` for details. As long as it's experimental, its + behavior and related features and APIs may change in future Scrapy releases + in a breaking way. + (:issue:`6219`, + :issue:`7185`, + :issue:`7186`, + :issue:`7187`, + :issue:`7188`, + :issue:`7190`, + :issue:`7197`, + :issue:`7199`, + :issue:`7209`, + :issue:`7228`, + :issue:`7355`, + :issue:`7366`, + :issue:`7385`, + :issue:`7395`) + +- Added the :func:`scrapy.utils.reactorless.is_reactorless` function that + checks if there is a running asyncio event loop but no Twisted reactor. + (:issue:`7185`, :issue:`7199`) + +- Changed :func:`scrapy.utils.asyncio.is_asyncio_available` to return + ``True`` if there is a running asyncio loop, even if no Twisted reactor is + installed. + (:issue:`7185`, :issue:`7199`) + +- Added an *experimental* download handler that uses the httpx_ library and + doesn't require a Twisted reactor: + :class:`~scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler`. As + long as it's experimental, its behavior may change in future Scrapy + releases in a breaking way. + (:issue:`6805`, :issue:`7239`, :issue:`7368`, :issue:`7384`) + + .. _httpx: https://www.python-httpx.org/ + +- Added the :setting:`DOWNLOAD_BIND_ADDRESS` setting as a global counterpart + to the per-request :reqmeta:`bindaddress` meta key. + (:issue:`7266`, :issue:`7283`) + +- Added the :setting:`DOWNLOAD_VERIFY_CERTIFICATES` setting that can be set + to ``True`` to make Scrapy abort HTTPS requests when the server certificate + is invalid or doesn't match the domain. + (:issue:`7379`) + +- The built-in HTTP :ref:`download handlers ` now + raise Scrapy-specific exceptions instead of implementation-specific ones, + to allow unified handling of similar problems caused by different + implementations. The default value of the :setting:`RETRY_EXCEPTIONS` + setting was updated replacing Twisted-specific exceptions with these new + ones. The exceptions: + + - :exc:`~scrapy.exceptions.CannotResolveHostError` + + - :exc:`~scrapy.exceptions.DownloadCancelledError` + + - :exc:`~scrapy.exceptions.DownloadConnectionRefusedError` + + - :exc:`~scrapy.exceptions.DownloadFailedError` + + - :exc:`~scrapy.exceptions.DownloadTimeoutError` + + - :exc:`~scrapy.exceptions.ResponseDataLossError` + + - :exc:`~scrapy.exceptions.UnsupportedURLSchemeError` + + (:issue:`7208`) + +- Added the :signal:`memusage_warning_reached` signal emitted by the + :class:`~scrapy.extensions.memusage.MemoryUsage` extension when the memory + usage reaches :setting:`MEMUSAGE_WARNING_MB`. + (:issue:`7249`, :issue:`7263`) + +- Added + :meth:`Headers.to_tuple_list() ` + that returns headers as a list of ``(key, value)`` tuples. + (:issue:`7239`) + +- :class:`~scrapy.core.downloader.handlers.s3.S3DownloadHandler` now uses the + download handler configured for the ``"https"`` scheme to make requests + instead of always using + :class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler`. + (:issue:`7369`, :issue:`7370`) + +- Added :func:`scrapy.utils.misc.walk_modules_iter` as a replacement for + ``scrapy.utils.misc.walk_modules()`` that returns an iterable instead of a + list. + (:issue:`7388`) + +Improvements +~~~~~~~~~~~~ + +- :func:`asyncio.to_thread` is now used instead of + :func:`twisted.internet.threads.deferToThread` in the built-in feed + storages, media pipeline storages and the + :func:`scrapy.utils.decorators.inthread` decorator when available. + (:issue:`7183`, :issue:`7184`, :issue:`7349`) + +- Improved memory footprint of :class:`~scrapy.Request` and + :class:`~scrapy.http.Response` objects by adding ``__slots__`` and omitting + empty lists and dicts in some internal attributes. + (:issue:`7036`, :issue:`7367`, :issue:`7374`) + +- :class:`~scrapy.core.downloader.contextfactory._ScrapyClientContextFactory` + no longer mutates the SSL context, to avoid the behavior that was + deprecated in pyOpenSSL 25.1.0. + (:issue:`6859`, :issue:`7353`) + +- Improved memory usage of :class:`~scrapy.spiders.sitemap.SitemapSpider` and + :class:`scrapy.utils.sitemap.Sitemap`. + (:issue:`3529`, :issue:`7007`) + +- Improved the scheduling behavior of + :class:`~scrapy.pqueues.DownloaderAwarePriorityQueue` when crawling + multiple domains. + (:issue:`7293`, :issue:`7351`) + +- :class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler` and + :class:`~scrapy.core.downloader.handlers.http2.H2DownloadHandler` now handle + TLS verbose logging (see :setting:`DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING`) + directly instead of relying on + :class:`~scrapy.core.downloader.contextfactory._ScrapyClientContextFactory`. + (:issue:`7387`) + +- The server certificate verification code now correctly handles certificates + with IP addresses in ``subjectAltName``. + (:issue:`7353`) + +- Improved reliability of :func:`scrapy.utils.trackref.get_oldest`. + (:issue:`1758`, :issue:`7375`) + +- Other code refactoring and improvements. + (:issue:`7210`, :issue:`7238`, :issue:`7376`, :issue:`7386`, :issue:`7395`, + :issue:`7405`, :issue:`7410`) + +Bug fixes +~~~~~~~~~ + +- :ref:`Media pipelines ` should now wait for uploads + to asynchronous storages (e.g. + :class:`~scrapy.pipelines.files.S3FilesStore`) to complete. + (:issue:`2183`, :issue:`6369`, :issue:`7182`) + +- Fixed merging ``*_BASE`` settings (e.g. merging + :setting:`DOWNLOADER_MIDDLEWARES` with + :setting:`DOWNLOADER_MIDDLEWARES_BASE`) when a component is referred to by + a class object in one setting and by a string import path in the other one. + (:issue:`6912`, :issue:`6993`) + +- ``scrapy runspider`` and ``scrapy crawl`` now set the exit code to 1 if an + exception happened early (this was broken since Scrapy 2.13.0). + (:issue:`6820`, :issue:`7255`) + +- Fixed repeated warnings about data loss (see + :setting:`DOWNLOAD_FAIL_ON_DATALOSS`) not being suppressed in + :class:`~scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler`. + (:issue:`7222`) + +- Improved FTP connection management in + :class:`scrapy.pipelines.files.FTPFilesStore`. + (:issue:`7256`) + +- Fixed the ``spider`` variable in the :ref:`shell `, which + wasn't available since Scrapy 2.13.0. + (:issue:`7395`) + +Documentation +~~~~~~~~~~~~~ + +- The ``llms.txt`` and ``llms-full.txt`` files and Markdown versions of pages + are now generated when the HTML documentation is built. + (:issue:`7380`) + +- Added a "Copy as Markdown" button to the HTML documentation. + (:issue:`7380`) + +- Added :ref:`docs for using Pydantic models as items `. + (:issue:`6955`, :issue:`6966`) + +- Documented :ref:`job directory contents `. + (:issue:`4842`, :issue:`5260`) + +- Improved docs for :attr:`~scrapy.Request.dont_filter`. + (:issue:`6398`, :issue:`7245`) + +- Clarified that settings related to :setting:`TWISTED_DNS_RESOLVER` are only + taken into account if the selected resolver supports them. + (:issue:`7385`) + +- Other documentation improvements and fixes. + (:issue:`7248`, :issue:`7274`, :issue:`7406`, :issue:`7408`) + +Quality assurance +~~~~~~~~~~~~~~~~~ + +- Added the ``no-reactor`` test environment that doesn't install a Twisted + reactor and uses ``pytest-asyncio`` instead of ``pytest-twisted`` to run + asynchronous test functions. + (:issue:`6952`, :issue:`7189`, :issue:`7233`, :issue:`7234`, :issue:`7254`, + :issue:`7259`) + +- Fixed running tests with ``pytest-xdist``. + (:issue:`7216`, :issue:`7257`) + +- Type hints improvements and fixes. + (:issue:`7300`, :issue:`7331`) + +- CI and test improvements and fixes. + (:issue:`7060`, + :issue:`7223`, + :issue:`7232`, + :issue:`7241`, + :issue:`7250`, + :issue:`7256`, + :issue:`7276`, + :issue:`7277`, + :issue:`7279`, + :issue:`7329`, + :issue:`7363`, + :issue:`7381`, + :issue:`7402`) + +.. _release-2.14.2: + +Scrapy 2.14.2 (2026-03-12) +-------------------------- + +Security bug fixes +~~~~~~~~~~~~~~~~~~ + +- Values from the ``Referrer-Policy`` header of HTTP responses are no longer + executed as Python callables. See the `cwxj-rr6w-m6w7`_ security advisory + for details. + + .. _cwxj-rr6w-m6w7: https://github.com/scrapy/scrapy/security/advisories/GHSA-cwxj-rr6w-m6w7 + +- In line with the `standard + `__, 301 redirects of + ``POST`` requests are converted into ``GET`` requests. + + Converting to a ``GET`` request implies not only a method change, but also + omitting the body and ``Content-*`` headers in the redirect request. On + cross-origin redirects (for example, cross-domain redirects), this is + effectively a security bug fix for scenarios where the body contains + secrets. + +Deprecations +~~~~~~~~~~~~ + +- Passing a response URL string as the first positional argument to + :meth:`scrapy.spidermiddlewares.referer.RefererMiddleware.policy` is + deprecated. Pass a :class:`~scrapy.http.Response` instead. + + The parameter has also been renamed to ``response`` to reflect this change. + The old parameter name (``resp_or_url``) is deprecated. + +New features +~~~~~~~~~~~~ + +- Added a new setting, :setting:`REFERER_POLICIES`, to allow customizing + supported referrer policies. + +Bug fixes +~~~~~~~~~ + +- Made additional redirect scenarios convert to ``GET`` in line with the + `standard `__: + + - Only ``POST`` 302 redirects are converted into ``GET`` requests; other + methods are preserved. + + - ``HEAD`` 303 redirects are not converted into ``GET`` requests. + + - ``GET`` 303 redirects do not have their body or standard ``Content-*`` + headers removed. + +- Redirects where the original request body is dropped now also have their + ``Content-Encoding``, ``Content-Language`` and ``Content-Location`` headers + removed, in addition to the ``Content-Type`` and ``Content-Length`` headers + that were already being removed. + +- Redirects now preserve the source URL fragment if the redirect URL does not + include one. This is useful when using browser-based download handlers, + such as `scrapy-playwright`_ or `scrapy-zyte-api`_, while letting Scrapy + handle redirects. + + .. _scrapy-playwright: https://github.com/scrapy-plugins/scrapy-playwright + .. _scrapy-zyte-api: https://scrapy-zyte-api.readthedocs.io/en/latest/ + +- The ``Referer`` header is now removed on redirect if + :class:`~scrapy.spidermiddlewares.referer.RefererMiddleware` is disabled. + +- The handling of the ``Referer`` header on redirects now takes into account + the ``Referer-Policy`` header of the response that triggers the redirect. + +.. _release-2.14.1: + +Scrapy 2.14.1 (2026-01-12) +-------------------------- + +Deprecations +~~~~~~~~~~~~ + +- ``scrapy.utils.defer.maybeDeferred_coro()`` is deprecated. (:issue:`7212`) + +Bug fixes +~~~~~~~~~ + +- Fixed custom stats collectors that require a ``spider`` argument in their + ``open_spider()`` and ``close_spider()`` methods not receiving the + argument when called by the engine. + + Note, however, that the ``spider`` argument is now deprecated and will stop + being passed in a future version of Scrapy. + + (:issue:`7213`) + +Quality assurance +~~~~~~~~~~~~~~~~~ + +- Replaced deprecated ``codecov/test-results-action@v1`` GitHub Action with + ``codecov/codecov-action@v5``. + (:issue:`7180`, :issue:`7215`) + +.. _release-2.14.0: + +Scrapy 2.14.0 (2026-01-05) +-------------------------- + +Highlights: + +- More coroutine-based replacements for Deferred-based APIs + +- The default priority queue is now ``DownloaderAwarePriorityQueue`` + +- Dropped support for Python 3.9 and PyPy 3.10 + +- Improved and documented the API for custom download handlers + +Modified requirements +~~~~~~~~~~~~~~~~~~~~~ + +- Dropped support for Python 3.9. + (:issue:`7121`) + +- Dropped support for PyPy 3.10. + (:issue:`7050`) + +- Increased the minimum versions of the following dependencies: + + - lxml_: 4.6.0 → 4.6.4 + + - Pillow_ (optional dependency): 8.0.0 → 8.3.2 + + - botocore_ (optional dependency): 1.4.87 → 1.13.45 + +- Restored support for ``brotlicffi`` dropped in Scrapy 2.13.4. Its minimum + supported version is now ``1.2.0.0``. + (:issue:`7160`) Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -14,6 +820,725 @@ Backward-incompatible changes may now need to set the :setting:`FORCE_CRAWLER_PROCESS` setting to ``True`` when running Scrapy via :ref:`its command-line tool ` to avoid a reactor mismatch exception. + (:issue:`6845`) + +- The ``log_count/*`` stats no longer count some of the early messages that + they counted before. While the earliest log messages, emitted before the + counter is initialized, were never counted, the counter initialization now + happens later than in previous Scrapy versions. You may need to adjust + expected values if you retrieve and compare values of these stats in your + code. + (:issue:`7046`) + +- The classes listed below are now :term:`abstract base classes `. They cannot be instantiated directly and their subclasses + need to override the abstract methods listed below to be able to be + instantiated. If you previously instantiated these classes directly, you + will now need to subclass them and provide trivial (e.g. empty) + implementations for the abstract methods. + + - :class:`scrapy.commands.ScrapyCommand` + + - :meth:`~scrapy.commands.ScrapyCommand.run` + + - :meth:`~scrapy.commands.ScrapyCommand.short_desc` + + - :class:`scrapy.exporters.BaseItemExporter` + + - :meth:`~scrapy.exporters.BaseItemExporter.export_item` + + - :class:`scrapy.extensions.feedexport.BlockingFeedStorage` + + - :meth:`~scrapy.extensions.feedexport.BlockingFeedStorage._store_in_thread` + + - :class:`scrapy.middleware.MiddlewareManager` + + - :meth:`~scrapy.middleware.MiddlewareManager._get_mwlist_from_settings` + + - :class:`scrapy.spidermiddlewares.referer.ReferrerPolicy` + + - :meth:`~scrapy.spidermiddlewares.referer.ReferrerPolicy.referrer` + + (:issue:`6930`) + +- Scrapy no longer passes a ``spider`` argument to any methods of the + :setting:`stats collector `. It wasn't passed in many of the + calls even in older Scrapy versions, so we don't expect existing custom + stats collector implementations to require a ``spider`` argument. If your + implementation needs a :class:`~scrapy.Spider` instance, you can get it + from the :class:`~scrapy.crawler.Crawler` instance passed to the + constructor. + (:issue:`7011`) + +- :class:`scrapy.middleware.MiddlewareManager` no longer includes code for + handling ``open_spider()`` and ``close_spider()`` component methods. As + this code was only used for pipelines it was moved into + :class:`scrapy.pipelines.ItemPipelineManager`. This change should only + affect custom subclasses of :class:`~scrapy.middleware.MiddlewareManager`. + The following code was moved: + + - ``scrapy.middleware.MiddlewareManager.open_spider()`` + + - ``scrapy.middleware.MiddlewareManager.close_spider()`` + + - Code in ``scrapy.middleware.MiddlewareManager._add_middleware()`` that + processes ``open_spider()`` and ``close_spider()`` component methods. + + (:issue:`7006`) + +- :meth:`scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware.process_request` + now returns a coroutine, previously it returned a + :class:`~twisted.internet.defer.Deferred` object or ``None``. The + ``robot_parser()`` method was also changed to return a coroutine. This + change only impacts code that subclasses + :class:`~scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware` or + calls its methods directly. + (:issue:`6802`) + +- The built-in :ref:`download handlers ` have been + refactored, changing the signatures of their methods. This change should + only affect user code that subclasses any of these handlers or calls their + methods directly. + (:issue:`6778`, :issue:`7164`) + +- :meth:`scrapy.pipelines.media.MediaPipeline.process_item` now returns a + coroutine, previously it returned a + :class:`~twisted.internet.defer.Deferred` object. This + change only impacts code that calls this method directly. + (:issue:`7177`) + +Deprecation removals +~~~~~~~~~~~~~~~~~~~~ + +- The ``from_settings()`` method of the following components, deprecated in + Scrapy 2.12.0, is removed. You should use ``from_crawler()`` instead. + + - :class:`scrapy.dupefilters.RFPDupeFilter` + - :class:`scrapy.mail.MailSender` + - :class:`scrapy.middleware.MiddlewareManager` + - :class:`scrapy.core.downloader.contextfactory.ScrapyClientContextFactory` + - :class:`scrapy.pipelines.files.FilesPipeline` + - :class:`scrapy.pipelines.images.ImagesPipeline` + + (:issue:`7126`) + +- Scrapy no longer calls ``from_settings()`` methods of 3rd-party + :ref:`components `, deprecated in Scrapy 2.12.0. You + should define a ``from_crawler()`` method instead. + (:issue:`7126`) + +- The initialization flow of :class:`scrapy.pipelines.media.MediaPipeline` + and its subclasses was simplified, it now mandates ``from_crawler()`` + methods and ``crawler`` arguments of ``__init__()`` methods. Not using + these was deprecated in Scrapy 2.12.0. + (:issue:`7126`) + +- The ``REQUEST_FINGERPRINTER_IMPLEMENTATION`` setting, deprecated in Scrapy + 2.12.0, is removed. + (:issue:`7126`) + +- The ``scrapy.utils.misc.create_instance()`` function, deprecated in Scrapy + 2.12.0, is removed. Use :func:`scrapy.utils.misc.build_from_crawler` + instead. + (:issue:`7126`) + +- The ``scrapy.core.downloader.Downloader._get_slot_key()`` function, + deprecated in Scrapy 2.12.0, is removed. Use + :meth:`scrapy.core.downloader.Downloader.get_slot_key` instead. + (:issue:`7126`) + +- The ``scrapy.twisted_version`` attribute, deprecated in Scrapy 2.12.0, is + removed. You should instead use the :attr:`twisted.version` attribute + directly. + (:issue:`7126`) + +- The following utility functions, deprecated in Scrapy 2.12.0, are removed: + + - ``scrapy.utils.defer.process_chain_both()`` + - ``scrapy.utils.python.equal_attributes()`` + - ``scrapy.utils.python.flatten()`` + - ``scrapy.utils.python.iflatten()`` + - ``scrapy.utils.request.request_authenticate()`` + - ``scrapy.utils.test.assert_samelines()`` + + (:issue:`7126`) + +- ``scrapy.utils.serialize.ScrapyJSONDecoder``, deprecated in Scrapy 2.12.0, + is removed. + (:issue:`7126`) + +- The ``scrapy.extensions.feedexport.build_storage()`` function, deprecated + in Scrapy 2.12.0, is removed, you can instead call the builder callable + directly. + (:issue:`7126`) + +- ``scrapy.spidermiddlewares.offsite.OffsiteMiddleware``, deprecated in + Scrapy 2.11.2, is removed. + :class:`scrapy.downloadermiddlewares.offsite.OffsiteMiddleware` should be + used instead. + (:issue:`6926`) + +Deprecations +~~~~~~~~~~~~ + +- The following methods that return a + :class:`~twisted.internet.defer.Deferred` are deprecated in favor of their + coroutine-based replacements: + + - :class:`scrapy.core.downloader.handlers.DownloadHandlers` + + - ``download_request()`` (use + :meth:`~scrapy.core.downloader.handlers.DownloadHandlers.download_request_async`) + + - :class:`scrapy.core.downloader.middleware.DownloaderMiddlewareManager` + + - ``download()`` (use + :meth:`~scrapy.core.downloader.middleware.DownloaderMiddlewareManager.download_async`) + + - :class:`scrapy.core.engine.ExecutionEngine` + + - ``start()`` (use + :meth:`~scrapy.core.engine.ExecutionEngine.start_async`) + + - ``stop()`` (use + :meth:`~scrapy.core.engine.ExecutionEngine.stop_async`) + + - ``close()`` (use + :meth:`~scrapy.core.engine.ExecutionEngine.close_async`) + + - ``open_spider()`` (use + :meth:`~scrapy.core.engine.ExecutionEngine.open_spider_async`) + + - ``close_spider()`` (use + :meth:`~scrapy.core.engine.ExecutionEngine.close_spider_async`) + + - ``download()`` (use + :meth:`~scrapy.core.engine.ExecutionEngine.download_async`) + + - :class:`scrapy.core.scraper.Scraper` + + - ``open_spider()`` (use + :meth:`~scrapy.core.scraper.Scraper.open_spider_async`) + + - ``call_spider()`` (use + :meth:`~scrapy.core.scraper.Scraper.call_spider_async`) + + - ``close_spider()`` (use + :meth:`~scrapy.core.scraper.Scraper.close_spider_async`) + + - ``handle_spider_output()`` (use + :meth:`~scrapy.core.scraper.Scraper.handle_spider_output_async`) + + - ``start_itemproc()`` (use + :meth:`~scrapy.core.scraper.Scraper.start_itemproc_async`) + + - :class:`scrapy.core.spidermw.SpiderMiddlewareManager` + + - ``scrape_response()`` (use + :meth:`~scrapy.core.spidermw.SpiderMiddlewareManager.scrape_response_async`) + + - :class:`scrapy.crawler.Crawler` + + - ``stop()`` (use :meth:`~scrapy.crawler.Crawler.stop_async`) + + - :class:`scrapy.pipelines.ItemPipelineManager` + + - ``process_item()`` (use + :meth:`~scrapy.pipelines.ItemPipelineManager.process_item_async`) + + - ``open_spider()`` (use + :meth:`~scrapy.pipelines.ItemPipelineManager.open_spider_async`) + + - ``close_spider()`` (use + :meth:`~scrapy.pipelines.ItemPipelineManager.close_spider_async`) + + - :class:`scrapy.signalmanager.SignalManager` + + - ``send_catch_log_deferred()`` (use + :meth:`~scrapy.signalmanager.SignalManager.send_catch_log_async`) + + - ``scrapy.utils.signal.send_catch_log_deferred()`` (use + :func:`scrapy.utils.signal.send_catch_log_async`) + + (:issue:`6791`, :issue:`6842`, :issue:`6979`, :issue:`6997`, :issue:`6999`, + :issue:`7005`, :issue:`7043`, :issue:`7069`, :issue:`7161`, :issue:`7164`) + +- The following spider attributes are deprecated in favor of settings: + + - ``download_maxsize`` (use :setting:`DOWNLOAD_MAXSIZE`) + + - ``download_timeout`` (use :setting:`DOWNLOAD_TIMEOUT`) + + - ``download_warnsize`` (use :setting:`DOWNLOAD_WARNSIZE`) + + - ``max_concurrent_requests`` (use :setting:`CONCURRENT_REQUESTS`) + + - ``user_agent`` (use :setting:`USER_AGENT`) + + (:issue:`6988`, :issue:`6994`, :issue:`7038`, :issue:`7039`, :issue:`7117`, + :issue:`7176`) + +- Returning a :class:`~twisted.internet.defer.Deferred` from the following + user-defined functions is deprecated in favor of defining them as coroutine + functions: + + - spider callbacks and errbacks (which was never officially supported and + may work incorrectly) + + - the ``process_request()``, ``process_response()`` and + ``process_exception()`` methods of custom downloader middlewares + + - the ``process_item()``, ``open_spider()`` and ``close_spider()`` methods + of custom pipelines + + - signal handlers + + - the ``download_request()`` and ``close()`` methods of custom download + handlers + + (:issue:`6718`, :issue:`6778`, :issue:`7069`, :issue:`7147`, :issue:`7148`, + :issue:`7149`, :issue:`7150`, :issue:`7151`, :issue:`7161`, :issue:`7164`, + :issue:`7179`) + +- Passing a ``spider`` argument to the following methods is deprecated: + + - :meth:`scrapy.core.spidermw.SpiderMiddlewareManager.process_start` + + - :meth:`scrapy.core.downloader.Downloader.fetch` + + - :meth:`scrapy.core.downloader.Downloader._get_slot` + + - :meth:`scrapy.core.downloader.handlers.DownloadHandlers.download_request` + + - all public methods of :class:`scrapy.statscollectors.StatsCollector` + + - :meth:`scrapy.spidermiddlewares.base.BaseSpiderMiddleware.process_spider_output` + + - :meth:`scrapy.spidermiddlewares.base.BaseSpiderMiddleware.process_spider_output_async` + + - all ``process_*()`` methods of built-in downloader middlewares + + - all ``process_*()`` methods of built-in spider middlewares + + - :meth:`scrapy.pipelines.media.MediaPipeline.open_spider` + + - :meth:`scrapy.pipelines.media.MediaPipeline.process_item` + + (:issue:`6750`, :issue:`6927`, :issue:`6984`, :issue:`7006`, :issue:`7011`, + :issue:`7033`, :issue:`7037`, :issue:`7045`, :issue:`7178`) + +- Instantiating subclasses of :class:`scrapy.middleware.MiddlewareManager` + without a :class:`~scrapy.crawler.Crawler` instance is deprecated. + (:issue:`6984`) + +- For the following user-defined functions and methods requiring a ``spider`` + argument is deprecated, if you need a :class:`~scrapy.Spider` instance + inside them you should get it from the :class:`~scrapy.crawler.Crawler` + instance (you may need to refactor your code to save that instance in e.g. + the ``from_crawler()`` method): + + - the ``process_request()``, ``process_response()`` and + ``process_exception()`` methods of custom downloader middlewares + + - the ``process_spider_input()``, ``process_spider_output()``, + ``process_spider_output_async()`` and ``process_spider_exception()`` + methods of custom spider middlewares + + - the ``process_item()`` method of custom pipelines + + - the ``fetch()`` method of a custom :setting:`DOWNLOADER` + + (:issue:`6927`, :issue:`6984`, :issue:`7006`, :issue:`7037`) + +- The following things in custom download handlers are deprecated: + + - not having a ``lazy`` attribute (you should define it as ``True`` if you + want to keep the current behavior) + + - returning a :class:`~twisted.internet.defer.Deferred` from the + ``download_request()`` method (you should refactor it to return a + coroutine; you also need to remove the ``spider`` argument when doing + this) + + - not having a ``close()`` method, having a synchronous one or one that + returns a :class:`~twisted.internet.defer.Deferred` (you should refactor + it to return a coroutine or add an empty one if you don't have it) + + (:issue:`6778`, :issue:`7164`) + +- Custom implementations of :setting:`ITEM_PROCESSOR` should now define + ``process_item_async()``, ``open_spider_async()`` and + ``close_spider_async()`` methods instead of, or in addition to, + ``process_item()``, ``open_spider()`` and ``close_spider()``. + (:issue:`7005`, :issue:`7043`) + +- The ``CONCURRENT_REQUESTS_PER_IP`` setting is deprecated, use + :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` instead. + (:issue:`6917`, :issue:`6921`) + +- The ``scrapy.core.downloader.handlers.http`` module is deprecated. You + should import + :class:`scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler` + directly instead of importing the + ``scrapy.core.downloader.handlers.http.HTTPDownloadHandler`` alias. + (:issue:`7079`) + +- The ``scrapy.utils.decorators.defers()`` decorator is deprecated, you can + use :func:`twisted.internet.defer.maybeDeferred` directly or reimplement + this decorator in your code. + (:issue:`7164`) + +- ``scrapy.spiders.CrawlSpider._parse_response()`` is deprecated, use + :meth:`scrapy.spiders.CrawlSpider.parse_with_rules` instead. + (:issue:`4463`, :issue:`6804`) + +- The functions that add a delay to a Deferred are deprecated, their + underlying Twisted functions can be used instead, either directly if a + delay isn't needed, or with some explicit way to add a delay if it's + needed: + + - ``scrapy.utils.defer.mustbe_deferred()`` (you can use + :func:`twisted.internet.defer.maybeDeferred`) + + - ``scrapy.utils.defer.defer_succeed()`` (you can use + :func:`twisted.internet.defer.succeed`) + + - ``scrapy.utils.defer.defer_fail()`` (you can use + :func:`twisted.internet.defer.fail`) + + - ``scrapy.utils.defer.defer_result()`` (you can use + :func:`twisted.internet.defer.succeed` and + :func:`twisted.internet.defer.fail`) + + (:issue:`6937`) + +New features +~~~~~~~~~~~~ + +- Added :class:`scrapy.crawler.AsyncCrawlerProcess` and + :class:`scrapy.crawler.AsyncCrawlerRunner` as counterparts to + :class:`~scrapy.crawler.CrawlerProcess` and + :class:`~scrapy.crawler.CrawlerRunner` that offer coroutine-based APIs. + (:issue:`6789`, :issue:`6790`, :issue:`6796`, :issue:`6817`, :issue:`6845`, + :issue:`7034`) + +- Added coroutine counterparts to some of the Deferred-based APIs: + + - :class:`scrapy.core.downloader.handlers.DownloadHandlers` + + - :meth:`~scrapy.core.downloader.handlers.DownloadHandlers.download_request_async` + (to ``download_request()``) + + - :class:`scrapy.core.downloader.middleware.DownloaderMiddlewareManager` + + - :meth:`~scrapy.core.downloader.middleware.DownloaderMiddlewareManager.download_async` + (to ``download()``) + + - :class:`scrapy.core.engine.ExecutionEngine` + + - :meth:`~scrapy.core.engine.ExecutionEngine.start_async` (to + ``start()``) + + - :meth:`~scrapy.core.engine.ExecutionEngine.stop_async` (to + ``stop()``) + + - :meth:`~scrapy.core.engine.ExecutionEngine.close_async` (to + ``close()``) + + - :meth:`~scrapy.core.engine.ExecutionEngine.open_spider_async` (to + ``open_spider()``) + + - :meth:`~scrapy.core.engine.ExecutionEngine.close_spider_async` (to + ``close_spider()``) + + - :meth:`~scrapy.core.engine.ExecutionEngine.download_async` (to + ``download()``) + + - :class:`scrapy.core.scraper.Scraper` + + - :meth:`~scrapy.core.scraper.Scraper.open_spider_async` (to + ``open_spider()``) + + - :meth:`~scrapy.core.scraper.Scraper.close_spider_async` (to + ``close_spider()``) + + - :meth:`~scrapy.core.scraper.Scraper.start_itemproc_async` (to + ``start_itemproc()``) + + - :class:`scrapy.crawler.Crawler` + + - :meth:`~scrapy.crawler.Crawler.crawl_async` (to ``crawl()``) + + - :meth:`~scrapy.crawler.Crawler.stop_async` (to ``stop()``) + + - :class:`scrapy.pipelines.ItemPipelineManager` + + - :meth:`~scrapy.pipelines.ItemPipelineManager.process_item_async` (to + ``process_item()``) + + - :meth:`~scrapy.pipelines.ItemPipelineManager.open_spider_async` (to + ``open_spider()``) + + - :meth:`~scrapy.pipelines.ItemPipelineManager.close_spider_async` (to + ``close_spider()``) + + - :class:`scrapy.signalmanager.SignalManager` + + - :meth:`~scrapy.signalmanager.SignalManager.send_catch_log_async` (to + ``send_catch_log_deferred()``) + + (:issue:`6781`, :issue:`6791`, :issue:`6792`, :issue:`6795`, :issue:`6801`, + :issue:`6817`, :issue:`6842`, :issue:`6997`, :issue:`7005`, :issue:`7043`, + :issue:`7069`,:issue:`7164`, :issue:`7202`) + +- The default value of the :setting:`SCHEDULER_PRIORITY_QUEUE` setting is now + ``'scrapy.pqueues.DownloaderAwarePriorityQueue'``. + (:issue:`6924`, :issue:`6940`) + +- Added :class:`scrapy.extensions.logcount.LogCount`, an enabled-by-default + extension that is responsible for the ``log_count/*`` stats. Previously, + this code was in :class:`scrapy.crawler.Crawler` and couldn't be disabled. + (:issue:`7046`) + +- Added :meth:`scrapy.spiders.CrawlSpider.parse_with_rules` as a public + replacement for ``_parse_response()``. + (:issue:`4463`, :issue:`6804`) + +- Added :func:`scrapy.utils.asyncio.is_asyncio_available` as an alternative + to :func:`scrapy.utils.reactor.is_asyncio_reactor_installed` with a + future-proof name and semantics. + (:issue:`6827`) + +- The API for :ref:`download handlers `, previously + undocumented, has been modernized and documented. An optional base class, + :class:`scrapy.core.downloader.handlers.base.BaseDownloadHandler`, has been + added to simplify writing custom download handlers that conform to the + current API. + (:issue:`4944`, :issue:`6778`, :issue:`7164`) + +- Added :func:`scrapy.utils.defer.ensure_awaitable`, which can be helpful to + call user-defined functions that can return coroutines, Deferreds or + values directly. + (:issue:`7005`) + +- The ``requests.seen`` file, written by + :class:`~scrapy.dupefilters.RFPDupeFilter` when :ref:`job persistence + ` is enabled, now uses line buffering to reduce data loss in + spider crashes. + (:issue:`6019`, :issue:`7094`) + +- Images downloaded by :class:`~scrapy.pipelines.images.ImagesPipeline` are + now automatically transposed based on EXIF data. + (:issue:`6525`, :issue:`6975`) + +Improvements +~~~~~~~~~~~~ + +- Refactored internal functions to use coroutines instead of Deferreds. + (:issue:`6795`, :issue:`6852`, :issue:`6855`, :issue:`6858`, :issue:`7159`) + +- Commands that don't need a :class:`~scrapy.crawler.CrawlerProcess` instance + no longer create it. + (:issue:`6824`) + +- Improved :command:`shell` help formatting when using IPython 9+. + (:issue:`6915`, :issue:`6980`) + +Bug fixes +~~~~~~~~~ + +- Setting :setting:`FILES_STORE` or :setting:`IMAGES_STORE` to ``None`` now + correctly disables the respective pipeline. + (:issue:`6964`, :issue:`6969`) + +- :class:`~scrapy.downloadermiddlewares.redirect.MetaRefreshMiddleware` now + uses the URL set in the ```` tag as the base URL when redirecting to + a relative URL. + (:issue:`7042`, :issue:`7047`) + +- Passing ``None`` as a value of the :reqmeta:`download_slot` request meta + key is now handled in the same way as not setting this meta key at all. + (:issue:`7172`) + +- Fixed parsing of the first line of ``robots.txt`` files that have a BOM. + (:issue:`6195`, :issue:`7095`) + +Documentation +~~~~~~~~~~~~~ + +- Added :ref:`documentation ` about download + handlers, their API and built-in handlers. + (:issue:`4944`, :issue:`7164`) + +- Added a section about the `scrapy-spider-metadata`_ library to the + :ref:`spider argument docs `. + (:issue:`6676`, :issue:`6957`, :issue:`7116`) + + .. _scrapy-spider-metadata: https://scrapy-spider-metadata.readthedocs.io/en/latest/ + +- Improved :ref:`the docs ` about coroutine-based + and Deferred-based APIs. + (:issue:`6800`, :issue:`7146`) + +- Other documentation improvements and fixes. + (:issue:`7058`, :issue:`7076`, :issue:`7109`, :issue:`7195`, :issue:`7198`) + +Quality assurance +~~~~~~~~~~~~~~~~~ + +- Switched from ``twisted.trial`` to ``pytest-twisted`` and replaced + remaining ``unittest`` and ``twisted.trial`` features with ``pytest`` ones. + (:issue:`6658`, :issue:`6873`, :issue:`6884`, :issue:`6938`) + +- Enabled fancy ``pytest`` asserts. + (:issue:`6888`) + +- Added `Sphinx Lint`_ to the ``pre-commit`` configuration. + (:issue:`6920`) + + .. _Sphinx Lint: https://github.com/sphinx-contrib/sphinx-lint + +- CI and test improvements and fixes. + (:issue:`6649`, + :issue:`6769`, + :issue:`6821`, + :issue:`6835`, + :issue:`6836`, + :issue:`6846`, + :issue:`6883`, + :issue:`6885`, + :issue:`6889`, + :issue:`6905`, + :issue:`6928`, + :issue:`6933`, + :issue:`6941`, + :issue:`6942`, + :issue:`6945`, + :issue:`6947`, + :issue:`6960`, + :issue:`6968`, + :issue:`6972`, + :issue:`6974`, + :issue:`6996`, + :issue:`7003`, + :issue:`7012`, + :issue:`7013`, + :issue:`7050`, + :issue:`7059`, + :issue:`7070`, + :issue:`7073`, + :issue:`7118`, + :issue:`7127`, + :issue:`7141`, + :issue:`7143`, + :issue:`7145`, + :issue:`7173`) + +- Code cleanups. + (:issue:`6803`, + :issue:`6838`, + :issue:`6849`, + :issue:`6875`, + :issue:`6876`, + :issue:`6892`, + :issue:`6930`, + :issue:`6949`, + :issue:`6970`, + :issue:`6977`, + :issue:`6986`, + :issue:`7008`, + :issue:`7177`) + +.. _release-2.13.4: + +Scrapy 2.13.4 (2025-11-17) +-------------------------- + +Security bug fixes +~~~~~~~~~~~~~~~~~~ + +- Improved protection against decompression bombs in + :class:`~scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware` + for responses compressed using the ``br`` and ``deflate`` methods: if a + single compressed chunk would be larger than the response size limit (see + :setting:`DOWNLOAD_MAXSIZE`) when decompressed, decompression is no longer + carried out. This is especially important for the ``br`` (Brotli) method + that can provide a very high compression ratio. Please, see the + `CVE-2025-6176`_ and `GHSA-2qfp-q593-8484`_ security advisories for more + information. + (:issue:`7134`) + + .. _CVE-2025-6176: https://nvd.nist.gov/vuln/detail/CVE-2025-6176 + .. _GHSA-2qfp-q593-8484: https://github.com/advisories/GHSA-2qfp-q593-8484 + +Modified requirements +~~~~~~~~~~~~~~~~~~~~~ + +- The minimum supported version of the optional ``brotli`` package is now + ``1.2.0``. + (:issue:`7134`) + +- The ``brotlicffi`` and ``brotlipy`` packages can no longer be used to + decompress Brotli-compressed responses. Please install the ``brotli`` + package instead. + (:issue:`7134`) + +Other changes +~~~~~~~~~~~~~ + +- Restricted the maximum supported Twisted version to ``25.5.0``, as Scrapy + currently uses some private APIs changed in later Twisted versions. + (:issue:`7142`) + +- Stopped setting the ``COVERAGE_CORE`` environment variable in tests, it + didn't have an effect but caused the ``coverage`` module to produce a + warning or an error. + (:issue:`7137`) + +- Removed the documentation build dependency on the deprecated + ``sphinx-hoverxref`` module. + (:issue:`6786`, :issue:`6922`) + +.. _release-2.13.3: + +Scrapy 2.13.3 (2025-07-02) +-------------------------- + +- Changed the values for :setting:`DOWNLOAD_DELAY` (from ``0`` to ``1``) and + :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` (from ``8`` to ``1``) in the + default project template. + (:issue:`6597`, :issue:`6918`, :issue:`6923`) + +- Improved :class:`scrapy.core.engine.ExecutionEngine` logic related to + initialization and exception handling, fixing several cases where the + spider would crash, hang or log an unhandled exception. + (:issue:`6783`, :issue:`6784`, :issue:`6900`, :issue:`6908`, :issue:`6910`, + :issue:`6911`) + +- Fixed a Windows issue with :ref:`feed exports ` using + :class:`scrapy.extensions.feedexport.FileFeedStorage` that caused the file + to be created on the wrong drive. + (:issue:`6894`, :issue:`6897`) + +- Allowed running tests with Twisted 25.5.0+ again. Pytest 8.4.1+ is now + required for running tests in non-pinned envs as support for the new + Twisted version was added in that version. + (:issue:`6893`) + +- Fixed running tests with lxml 6.0.0+. + (:issue:`6919`) + +- Added a deprecation notice for + ``scrapy.spidermiddlewares.offsite.OffsiteMiddleware`` to :ref:`the Scrapy + 2.11.2 release notes `. + (:issue:`6926`) + +- Updated :ref:`contribution docs ` to refer to ruff_ + instead of black_. + (:issue:`6903`) + +- Added ``.venv/`` and ``.vscode/`` to ``.gitignore``. + (:issue:`6901`, :issue:`6907`) .. _release-2.13.2: @@ -104,12 +1629,12 @@ Highlights: - The asyncio reactor is now enabled by default - Replaced ``start_requests()`` (sync) with :meth:`~scrapy.Spider.start` - (async) and changed how it is iterated. + (async) and changed how it is iterated - Added the :reqmeta:`allow_offsite` request meta key -- :ref:`Spider middlewares that don't support asynchronous spider output - ` are deprecated +- Spider middlewares that don't support asynchronous spider output are + deprecated - Added a base class for :ref:`universal spider middlewares ` @@ -247,13 +1772,11 @@ Deprecations ``start_queue_cls`` parameter. (:issue:`6752`) -- :ref:`Spider middlewares that don't support asynchronous spider output - ` are deprecated. The async iterable - downgrading feature, needed for using such middlewares with asynchronous - callbacks and with other spider middlewares that produce asynchronous - iterables, is also deprecated. Please update all such middlewares to - support asynchronous spider output. - (:issue:`6664`) +- Spider middlewares that don't support asynchronous spider output are + deprecated. The async iterable downgrading feature, needed for using such + middlewares with asynchronous callbacks and with other spider middlewares + that produce asynchronous iterables, is also deprecated. Please update all + such middlewares to support asynchronous spider output. (:issue:`6664`) - Functions that were imported from :mod:`w3lib.url` and re-exported in :mod:`scrapy.utils.url` are now deprecated, you should import them from @@ -305,9 +1828,9 @@ Deprecations - The following modules and functions used only in tests are deprecated: - - the ``scrapy/utils/testproc`` module + - the ``scrapy.utils.testproc`` module - - the ``scrapy/utils/testsite`` module + - the ``scrapy.utils.testsite`` module - ``scrapy.utils.test.assert_gcs_environ()`` @@ -512,9 +2035,8 @@ Documentation - Documented the setting values set in the default project template. (:issue:`6762`, :issue:`6775`) -- Improved the :ref:`docs ` about asynchronous - iterable support in spider middlewares. - (:issue:`6688`) +- Improved the docs about asynchronous iterable support in spider + middlewares. (:issue:`6688`) - Improved the :ref:`docs ` about using :class:`~twisted.internet.defer.Deferred`-based APIs in coroutine-based @@ -678,7 +2200,7 @@ Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - User-defined cookies for HTTPS requests will have the ``secure`` flag set - to ``True`` unless it's set to ``False`` explictly. This is important when + to ``True`` unless it's set to ``False`` explicitly. This is important when these cookies are reused in HTTP requests, e.g. after a redirect to an HTTP URL. (:issue:`6357`) @@ -713,7 +2235,7 @@ Backward-incompatible changes ``crawler.settings`` instead. When they call ``__init__()`` of the base class they should pass the ``crawler`` argument to it too. - A ``from_settings()`` method shouldn't be defined. Class-specific - initialization code should go into either an overriden ``from_crawler()`` + initialization code should go into either an overridden ``from_crawler()`` method or into ``__init__()``. - It's now possible to override ``from_crawler()`` and it's not necessary to call ``MediaPipeline.from_crawler()`` in it if other recommendations @@ -1232,6 +2754,17 @@ Security bug fixes .. _defusedxml: https://github.com/tiran/defusedxml +Deprecations +~~~~~~~~~~~~ + +- ``scrapy.spidermiddlewares.offsite.OffsiteMiddleware`` (a spider + middleware) is now deprecated and not enabled by default. The new + downloader middleware with the same functionality, + :class:`scrapy.downloadermiddlewares.offsite.OffsiteMiddleware`, is enabled + instead. + (:issue:`2241`, :issue:`6358`) + + Bug fixes ~~~~~~~~~ @@ -2204,7 +3737,7 @@ Bug fixes that does not match the asyncio event loop actually installed (:issue:`5529`). -- Fixed :meth:`Headers.getlist ` +- Fixed :meth:`Headers.getlist() ` returning only the last header (:issue:`5515`, :issue:`5526`). - Fixed :class:`LinkExtractor @@ -2449,7 +3982,7 @@ Modified requirements ~~~~~~~~~~~~~~~~~~~~~ - The h2_ dependency is now optional, only needed to - :ref:`enable HTTP/2 support `. (:issue:`5113`) + :ref:`enable HTTP/2 support `. (:issue:`5113`) .. _h2: https://pypi.org/project/h2/ @@ -2831,7 +4364,7 @@ Highlights: - Official Python 3.9 support -- Experimental :ref:`HTTP/2 support ` +- Experimental :ref:`HTTP/2 support ` - New :func:`~scrapy.downloadermiddlewares.retry.get_retry_request` function to retry requests from spider callbacks @@ -2862,7 +4395,7 @@ Deprecations New features ~~~~~~~~~~~~ -- Experimental :ref:`HTTP/2 support ` through a new download handler +- Experimental :ref:`HTTP/2 support ` through a new download handler that can be assigned to the ``https`` protocol in the :setting:`DOWNLOAD_HANDLERS` setting. (:issue:`1854`, :issue:`4769`, :issue:`5058`, :issue:`5059`, :issue:`5066`) @@ -3836,7 +5369,7 @@ Highlights: * :ref:`FTP support ` for media pipelines * New :attr:`Response.certificate ` attribute -* IPv6 support through :setting:`DNS_RESOLVER` +* IPv6 support through ``DNS_RESOLVER`` Backward-incompatible changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -3944,7 +5477,7 @@ New features :class:`twisted.internet.ssl.Certificate` object for HTTPS responses (:issue:`2726`, :issue:`4054`) -* A new :setting:`DNS_RESOLVER` setting allows enabling IPv6 support +* A new ``DNS_RESOLVER`` setting allows enabling IPv6 support (:issue:`1031`, :issue:`4227`) * A new :setting:`SCRAPER_SLOT_MAX_ACTIVE_SIZE` setting allows configuring @@ -4024,7 +5557,7 @@ New features components already supported (:issue:`4126`) * :class:`scrapy.utils.python.MutableChain.__iter__` now returns ``self``, - `allowing it to be used as a sequence `_ + allowing it to be used as a sequence. (:issue:`4153`) @@ -4474,7 +6007,7 @@ Backward-incompatible changes consistency with similar classes (:issue:`3929`, :issue:`3982`) * If you are using a custom context factory - (:setting:`DOWNLOADER_CLIENTCONTEXTFACTORY`), its ``__init__`` method must + (``DOWNLOADER_CLIENTCONTEXTFACTORY``), its ``__init__`` method must accept two new parameters: ``tls_verbose_logging`` and ``tls_ciphers`` (:issue:`2111`, :issue:`3392`, :issue:`3442`, :issue:`3450`) @@ -5929,7 +7462,7 @@ This 1.1 release brings a lot of interesting features and bug fixes: selectors engine without needing to upgrade Scrapy. - HTTPS downloader now does TLS protocol negotiation by default, instead of forcing TLS 1.0. You can also set the SSL/TLS method - using the new :setting:`DOWNLOADER_CLIENT_TLS_METHOD`. + using the new ``DOWNLOADER_CLIENT_TLS_METHOD`` setting. - These bug fixes may require your attention: @@ -5964,8 +7497,7 @@ Keep reading for more details on other improvements and bug fixes. Beta Python 3 Support ~~~~~~~~~~~~~~~~~~~~~ -We have been `hard at work to make Scrapy run on Python 3 -`_. As a result, now +We have been hard at work to make Scrapy run on Python 3. As a result, now you can run spiders on Python 3.3, 3.4 and 3.5 (Twisted >= 15.5 required). Some features are still missing (and some may never be ported). @@ -6033,7 +7565,7 @@ Additional New Features and Enhancements - Other refactoring, optimizations and cleanup (:issue:`1476`, :issue:`1481`, :issue:`1477`, :issue:`1315`, :issue:`1290`, :issue:`1750`, :issue:`1881`). -.. _`Code of Conduct`: https://github.com/scrapy/scrapy/blob/master/CODE_OF_CONDUCT.md +.. _Code of Conduct: https://github.com/scrapy/scrapy/blob/master/CODE_OF_CONDUCT.md Deprecations and Removals @@ -6795,7 +8327,7 @@ Enhancements - Make ``RFPDupeFilter`` class easily subclassable (:issue:`533`) - Improve test coverage and forthcoming Python 3 support (:issue:`525`) - Promote startup info on settings and middleware to INFO level (:issue:`520`) -- Support partials in ``get_func_args`` util (:issue:`506`, issue:`504`) +- Support partials in ``get_func_args`` util (:issue:`506`, :issue:`504`) - Allow running individual tests via tox (:issue:`503`) - Update extensions ignored by link extractors (:issue:`498`) - Add middleware methods to get files/images/thumbs paths (:issue:`490`) @@ -7363,7 +8895,7 @@ API changes - ``scrapy.core.manager.ScrapyManager`` class renamed to ``scrapy.crawler.Crawler`` - ``scrapy.core.manager.scrapymanager`` singleton moved to ``scrapy.project.crawler`` - Moved module: ``scrapy.contrib.spidermanager`` to ``scrapy.spidermanager`` -- Spider Manager singleton moved from ``scrapy.spider.spiders`` to the ``spiders` attribute of ``scrapy.project.crawler`` singleton. +- Spider Manager singleton moved from ``scrapy.spider.spiders`` to the ``spiders`` attribute of ``scrapy.project.crawler`` singleton. - moved Stats Collector classes: (#204) - ``scrapy.stats.collector.StatsCollector`` to ``scrapy.statscol.StatsCollector`` - ``scrapy.stats.collector.SimpledbStatsCollector`` to ``scrapy.contrib.statscol.SimpledbStatsCollector`` diff --git a/docs/requirements.in b/docs/requirements.in new file mode 100644 index 000000000..a964d6498 --- /dev/null +++ b/docs/requirements.in @@ -0,0 +1,9 @@ +h2 +pydantic +scrapy-spider-metadata +sphinx +sphinx-notfound-page +sphinx-reredirects +sphinx-rtd-theme +sphinx-rtd-dark-mode +sphinx-scrapy @ git+https://github.com/scrapy/sphinx-scrapy.git@0.8.8 diff --git a/docs/requirements.txt b/docs/requirements.txt index f828cdf9c..eb0436771 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,6 +1,199 @@ -sphinx==8.1.3 -sphinx-hoverxref==1.4.2 -sphinx-notfound-page==1.0.4 +# 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-reredirects==1.0.0 -sphinx-rtd-theme==3.0.2 + # 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@c0b2ac815afc3cb8857d575cecb5d55c05e6b737 + # 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 diff --git a/docs/topics/addons.rst b/docs/topics/addons.rst index 815501e66..01e4bcac1 100644 --- a/docs/topics/addons.rst +++ b/docs/topics/addons.rst @@ -88,7 +88,7 @@ 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.http.HTTPDownloadHandler``), but instead + ``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. @@ -98,9 +98,9 @@ recommend that such custom components should be written in the following way: (``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, - they shouldn't change it. + 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 fallback to the component from the previous one and then to + 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. @@ -166,8 +166,7 @@ Use a fallback component: .. code-block:: python - from scrapy.core.downloader.handlers.http import HTTPDownloadHandler - from scrapy.utils.misc import build_from_crawler + from scrapy.utils.misc import build_from_crawler, load_object FALLBACK_SETTING = "MY_FALLBACK_DOWNLOAD_HANDLER" @@ -176,16 +175,19 @@ Use a fallback component: class MyHandler: lazy = False - def __init__(self, settings, crawler): - dhcls = load_object(settings.get(FALLBACK_SETTING)) + def __init__(self, crawler): + dhcls = load_object(crawler.settings.get(FALLBACK_SETTING)) self._fallback_handler = build_from_crawler(dhcls, crawler) - def download_request(self, request, spider): + async def download_request(self, request): if request.meta.get("my_params"): # handle the request ... else: - return self._fallback_handler.download_request(request, spider) + return await self._fallback_handler.download_request(request) + + async def close(self): + pass class MyAddon: diff --git a/docs/topics/api.rst b/docs/topics/api.rst index d90eb0bad..19082d9d7 100644 --- a/docs/topics/api.rst +++ b/docs/topics/api.rst @@ -280,13 +280,13 @@ 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 diff --git a/docs/topics/architecture.rst b/docs/topics/architecture.rst index e8c510ea5..c60c43f3c 100644 --- a/docs/topics/architecture.rst +++ b/docs/topics/architecture.rst @@ -63,7 +63,7 @@ this: :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output`). 8. The :ref:`Engine ` sends processed items to - :ref:`Item Pipelines `, then send processed Requests to + :ref:`Item Pipelines `, then sends processed Requests to the :ref:`Scheduler ` and asks for possible next Requests to crawl. diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index ad5c71fbf..1a151044f 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -4,21 +4,27 @@ asyncio ======= -.. versionadded:: 2.0 +Scrapy supports :mod:`asyncio` natively. New projects created with +:command:`scrapy startproject` have asyncio enabled by default, and you can use +:mod:`asyncio` and :mod:`asyncio`-powered libraries in any :doc:`coroutine +`. -Scrapy has partial support for :mod:`asyncio`. After you :ref:`install the -asyncio reactor `, you may use :mod:`asyncio` and -:mod:`asyncio`-powered libraries in any :doc:`coroutine `. +The rest of this page covers advanced topics. If you are starting a new project, +no additional setup is needed. .. _install-asyncio: -Installing the asyncio reactor -============================== +Configuring the asyncio reactor +=============================== -To enable :mod:`asyncio` support, your :setting:`TWISTED_REACTOR` setting needs -to be set to ``'twisted.internet.asyncioreactor.AsyncioSelectorReactor'``, -which is the default value. +New projects generated with :command:`scrapy startproject` have the asyncio +reactor configured by default. No manual setup is needed. + +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 @@ -49,6 +55,7 @@ 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 @@ -98,6 +105,7 @@ 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 +.. autofunction:: scrapy.utils.defer.ensure_awaitable .. _enforce-asyncio-requirement: @@ -129,6 +137,173 @@ example: .. 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. + +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:`DNS_RESOLVER` setting) +* User and 3rd-party code that requires a reactor (see :ref:`below + ` 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. + +.. _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() + ` for sleeping or delayed calls. + You can use :meth:`asyncio.loop.call_later` instead. +* Using :func:`twisted.internet.threads.deferToThread`, + :meth:`reactor.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() + `, + :meth:`reactor.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.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 +`, 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 +`, it's currently unsupported. + +**RuntimeError: 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 +` or the documentation of the affected class. + + .. _asyncio-windows: Windows-specific notes @@ -149,6 +324,9 @@ automatically when you change the :setting:`TWISTED_REACTOR` setting or call 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 diff --git a/docs/topics/broad-crawls.rst b/docs/topics/broad-crawls.rst index 248e38b61..cace1f883 100644 --- a/docs/topics/broad-crawls.rst +++ b/docs/topics/broad-crawls.rst @@ -41,19 +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: - -.. code-block:: python - - SCHEDULER_PRIORITY_QUEUE = "scrapy.pqueues.DownloaderAwarePriorityQueue" - .. _broad-crawls-concurrency: Increase concurrency @@ -61,12 +48,7 @@ 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 - ` 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 @@ -143,7 +125,7 @@ To disable cookies use: 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. diff --git a/docs/topics/commands.rst b/docs/topics/commands.rst index 4994fe1d6..8d1351eb9 100644 --- a/docs/topics/commands.rst +++ b/docs/topics/commands.rst @@ -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. @@ -233,9 +233,6 @@ genspider * Syntax: ``scrapy genspider [-t template] `` * Requires project: *no* -.. versionadded:: 2.6.0 - The ability to pass a URL instead of a domain. - Creates a new spider in the current folder or in the current project's ``spiders`` folder, if called from inside a project. The ```` parameter is set as the spider's ``name``, while ```` is used to generate the ``allowed_domains`` and ``start_urls`` spider's attributes. Usage example:: @@ -509,8 +506,6 @@ Supported options: * ``--output`` or ``-o``: dump scraped items to a file - .. versionadded:: 2.3 - .. skip: start Usage example:: diff --git a/docs/topics/components.rst b/docs/topics/components.rst index 617c668c2..025956e5e 100644 --- a/docs/topics/components.rst +++ b/docs/topics/components.rst @@ -10,9 +10,8 @@ A Scrapy component is any class whose objects are built using That includes the classes that you may assign to the following settings: - :setting:`ADDONS` -- :setting:`DNS_RESOLVER` +- :setting:`TWISTED_DNS_RESOLVER` - :setting:`DOWNLOAD_HANDLERS` -- :setting:`DOWNLOADER_CLIENTCONTEXTFACTORY` - :setting:`DOWNLOADER_MIDDLEWARES` - :setting:`DUPEFILTER_CLASS` - :setting:`EXTENSIONS` diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index 2c0df5e0f..116aac323 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -4,8 +4,6 @@ Coroutines ========== -.. versionadded:: 2.0 - Scrapy :ref:`supports ` the :ref:`coroutine syntax ` (i.e. ``async def``). @@ -25,13 +23,6 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): - :class:`~scrapy.Request` callbacks. - If you are using any custom or third-party :ref:`spider middleware - `, see :ref:`sync-async-spider-middleware`. - - .. versionchanged:: 2.7 - Output of async callbacks is now processed asynchronously instead of - collecting all of it first. - - The :meth:`process_item` method of :ref:`item pipelines `. @@ -45,15 +36,9 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): - The :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` - method of :ref:`spider middlewares `. - - If defined as a coroutine, it must be an :term:`asynchronous generator`. - The input ``result`` parameter is an :term:`asynchronous iterable`. - - See also :ref:`sync-async-spider-middleware` and - :ref:`universal-spider-middleware`. - - .. versionadded:: 2.7 + method of :ref:`spider middlewares `, which + *must* be defined as an :term:`asynchronous generator` except in + :ref:`universal spider middlewares `. - The :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_start` method of :ref:`spider middlewares `, which *must* be @@ -63,6 +48,10 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): - :ref:`Signal handlers that support deferreds `. +- Methods of :ref:`download handlers `. + + .. versionadded:: 2.14 + .. _coroutine-deferred-apis: @@ -74,50 +63,29 @@ In addition to native coroutine APIs Scrapy has some APIs that return a 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 is +or replace them with other APIs where changing the existing ones isn't possible. -The following Scrapy methods return :class:`~twisted.internet.defer.Deferred` -objects (this list is not complete as it only includes methods that we think -may be useful for user code): +These APIs have a coroutine-based implementation and a Deferred-based one: - :class:`scrapy.crawler.Crawler`: - - :meth:`~scrapy.crawler.Crawler.crawl` + - :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. - - :meth:`~scrapy.crawler.Crawler.stop` - -- :class:`scrapy.crawler.CrawlerRunner` (also inherited by - :class:`scrapy.crawler.CrawlerProcess`): - - - :meth:`~scrapy.crawler.CrawlerRunner.crawl` - - - :meth:`~scrapy.crawler.CrawlerRunner.stop` - - - :meth:`~scrapy.crawler.CrawlerRunner.join` - -- :class:`scrapy.core.engine.ExecutionEngine`: - - - :meth:`~scrapy.core.engine.ExecutionEngine.download` - -- :class:`scrapy.signalmanager.SignalManager`: - - - :meth:`~scrapy.signalmanager.SignalManager.send_catch_log_deferred` - -- :class:`~scrapy.mail.MailSender` - - - :meth:`~scrapy.mail.MailSender.send` +- :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 download handlers (see :setting:`DOWNLOAD_HANDLERS`): - - - ``download_request()`` - - - ``close()`` - - Custom downloader implementations (see :setting:`DOWNLOADER`): - ``fetch()`` @@ -156,19 +124,11 @@ 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: - -- The :meth:`ExecutionEngine.download() - ` method returns a - :class:`~twisted.internet.defer.Deferred` object that fires with the - downloaded response. You can use this object directly in Deferred-based - code or convert it into a :class:`~asyncio.Future` object with - :func:`~scrapy.utils.defer.maybe_deferred_to_future`. -- A custom download handler needs to define a ``download_request()`` method - that returns 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`. +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 @@ -191,7 +151,7 @@ shorter and cleaner: 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.addCallback(self._update_item, item) @@ -205,7 +165,7 @@ becomes: 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"]) return item @@ -266,7 +226,6 @@ within a spider callback: .. code-block:: python from scrapy import Spider, Request - from scrapy.utils.defer import maybe_deferred_to_future class SingleRequestSpider(Spider): @@ -275,8 +234,9 @@ within a spider callback: async def parse(self, response, **kwargs): additional_request = Request("https://example.org/price") - deferred = self.crawler.engine.download(additional_request) - additional_response = await maybe_deferred_to_future(deferred) + additional_response = await self.crawler.engine.download_async( + additional_request + ) yield { "h1": response.css("h1").get(), "price": additional_response.css("#price").get(), @@ -286,9 +246,9 @@ You can also send multiple requests in parallel: .. code-block:: python + import asyncio + from scrapy import Spider, Request - from scrapy.utils.defer import maybe_deferred_to_future - from twisted.internet.defer import DeferredList class MultipleRequestsSpider(Spider): @@ -300,150 +260,13 @@ You can also send multiple requests in parallel: Request("https://example.com/price"), Request("https://example.com/color"), ] - deferreds = [] + tasks = [] for r in additional_requests: - deferred = self.crawler.engine.download(r) - deferreds.append(deferred) - responses = await maybe_deferred_to_future(DeferredList(deferreds)) + 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][1].css(".price::text").get(), - "price2": responses[1][1].css(".color::text").get(), + "price": responses[0].css(".price::text").get(), + "price2": responses[1].css(".color::text").get(), } - - -.. _sync-async-spider-middleware: - -Mixing synchronous and asynchronous spider middlewares -====================================================== - -.. versionadded:: 2.7 - -The output of a :class:`~scrapy.Request` callback is passed as the ``result`` -parameter to the -:meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` method -of the first :ref:`spider middleware ` from the -:ref:`list of active spider middlewares `. -Then the output of that ``process_spider_output`` method is passed to the -``process_spider_output`` method of the next spider middleware, and so on for -every active spider middleware. - -Scrapy supports mixing :ref:`coroutine methods ` and synchronous methods -in this chain of calls. - -However, if any of the ``process_spider_output`` methods is defined as a -synchronous method, and the previous ``Request`` callback or -``process_spider_output`` method is a coroutine, there are some drawbacks to -the asynchronous-to-synchronous conversion that Scrapy does so that the -synchronous ``process_spider_output`` method gets a synchronous iterable as its -``result`` parameter: - -- The whole output of the previous ``Request`` callback or - ``process_spider_output`` method is awaited at this point. - -- If an exception raises while awaiting the output of the previous - ``Request`` callback or ``process_spider_output`` method, none of that - output will be processed. - - This contrasts with the regular behavior, where all items yielded before - an exception raises are processed. - -Asynchronous-to-synchronous conversions are supported for backward -compatibility, but they are deprecated and will stop working in a future -version of Scrapy. - -To avoid asynchronous-to-synchronous conversions, when defining ``Request`` -callbacks as coroutine methods or when using spider middlewares whose -``process_spider_output`` method is an :term:`asynchronous generator`, all -active spider middlewares must either have their ``process_spider_output`` -method defined as an asynchronous generator or :ref:`define a -process_spider_output_async method `. - -.. _sync-async-spider-middleware-users: - -For middleware users --------------------- - -If you have asynchronous callbacks or use asynchronous-only spider middlewares -you should make sure the asynchronous-to-synchronous conversions -:ref:`described above ` don't happen. To do this, -make sure all spider middlewares you use support asynchronous spider output. -Even if you don't have asynchronous callbacks and don't use asynchronous-only -spider middlewares in your project, it's still a good idea to make sure all -middlewares you use support asynchronous spider output, so that it will be easy -to start using asynchronous callbacks in the future. Because of this, Scrapy -logs a warning when it detects a synchronous-only spider middleware. - -If you want to update middlewares you wrote, see the :ref:`following section -`. If you have 3rd-party middlewares that -aren't yet updated by their authors, you can :ref:`subclass ` -them to make them :ref:`universal ` and use the -subclasses in your projects. - -.. _sync-async-spider-middleware-authors: - -For middleware authors ----------------------- - -If you have a spider middleware that defines a synchronous -``process_spider_output`` method, you should update it to support asynchronous -spider output for :ref:`better compatibility `, -even if you don't yet use it with asynchronous callbacks, especially if you -publish this middleware for other people to use. You have two options for this: - -1. Make the middleware asynchronous, by making the ``process_spider_output`` - method an :term:`asynchronous generator`. -2. Make the middleware universal, as described in the :ref:`next section - `. - -If your middleware won't be used in projects with synchronous-only middlewares, -e.g. because it's an internal middleware and you know that all other -middlewares in your projects are already updated, it's safe to choose the first -option. Otherwise, it's better to choose the second option. - -.. _universal-spider-middleware: - -Universal spider middlewares ----------------------------- - -.. versionadded:: 2.7 - -To allow writing a spider middleware that supports asynchronous execution of -its ``process_spider_output`` method in Scrapy 2.7 and later (avoiding -:ref:`asynchronous-to-synchronous conversions `) -while maintaining support for older Scrapy versions, you may define -``process_spider_output`` as a synchronous method and define an -:term:`asynchronous generator` version of that method with an alternative name: -``process_spider_output_async``. - -For example: - -.. code-block:: python - - class UniversalSpiderMiddleware: - def process_spider_output(self, response, result, spider): - for r in result: - # ... do something with r - yield r - - async def process_spider_output_async(self, response, result, spider): - async for r in result: - # ... do something with r - yield r - -.. note:: This is an interim measure to allow, for a time, to write code that - works in Scrapy 2.7 and later without requiring - asynchronous-to-synchronous conversions, and works in earlier Scrapy - versions as well. - - In some future version of Scrapy, however, this feature will be - deprecated and, eventually, in a later version of Scrapy, this - feature will be removed, and all spider middlewares will be expected - to define their ``process_spider_output`` method as an asynchronous - generator. - -Since 2.13.0, Scrapy provides a base class, -:class:`~scrapy.spidermiddlewares.base.BaseSpiderMiddleware`, which implements -the ``process_spider_output()`` and ``process_spider_output_async()`` methods, -so instead of duplicating the processing code you can override the -``get_processed_request()`` and/or the ``get_processed_item()`` method. diff --git a/docs/topics/developer-tools.rst b/docs/topics/developer-tools.rst index 3d3f04793..05dffcdda 100644 --- a/docs/topics/developer-tools.rst +++ b/docs/topics/developer-tools.rst @@ -317,4 +317,3 @@ to identifying the correct request and replicating it in your spider. .. _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 - diff --git a/docs/topics/download-handlers.rst b/docs/topics/download-handlers.rst new file mode 100644 index 000000000..888bfaf08 --- /dev/null +++ b/docs/topics/download-handlers.rst @@ -0,0 +1,389 @@ +.. _topics-download-handlers: + +================= +Download handlers +================= + +Download handlers are Scrapy :ref:`components ` used to +download :ref:`requests ` 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 `) 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", + } + +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 ` that defines +the following API: + +.. class:: SampleDownloadHandler + + .. attribute:: lazy + :type: bool + + If ``False``, the handler will be instantiated when Scrapy is + initialized. + + If ``True``, the handler will only be instantiated when the first + request handled by it needs to be downloaded. + + .. method:: download_request(request: Request) -> Response: + :async: + + Download the given request and return a response. + + .. method:: close() -> None + :async: + + Clean up any resources used by the handler. + +An optional base class for custom handlers is provided: + +.. autoclass:: scrapy.core.downloader.handlers.base.BaseDownloadHandler + :members: + :undoc-members: + :member-order: bysource + +.. _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 +----------------- + +.. autoclass:: scrapy.core.downloader.handlers.http2.H2DownloadHandler + +| Supported scheme: ``https``. +| :ref:`Lazy `: yes. +| :ref:`Requires asyncio support `: no. +| :ref:`Requires a Twisted 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. + +For this handler to work you need to install the ``Twisted[http2]`` extra +dependency. + +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 `: no. +| :ref:`Requires asyncio support `: no. +| :ref:`Requires a Twisted 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. + +HttpxDownloadHandler +-------------------- + +.. versionadded:: 2.15.0 + +.. autoclass:: scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler + +| Supported schemes: ``http``, ``https``. +| :ref:`Lazy `: no. +| :ref:`Requires asyncio support `: yes. +| :ref:`Requires a Twisted 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 ``httpx`` library and needs it to be installed. + +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; requires ``httpx[socks]``) +HTTP/2 Yes (requires ``httpx[http2]``) +``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 +^^^^^^^^^^^^^^^^^^^ + +Default: ``False`` + +Whether to enable HTTP/2 support in this handler. The ``httpx[http2]`` extra +needs to be installed if you want to enable this setting. + +.. versionadded:: VERSION + +Built-in non-HTTP download handlers reference +============================================= + +DataURIDownloadHandler +---------------------- + +.. autoclass:: scrapy.core.downloader.handlers.datauri.DataURIDownloadHandler + +| Supported scheme: ``data``. +| :ref:`Lazy `: no. +| :ref:`Requires asyncio support `: no. +| :ref:`Requires a Twisted 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 `: no. +| :ref:`Requires asyncio support `: no. +| :ref:`Requires a Twisted 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 `: no. +| :ref:`Requires asyncio support `: no. +| :ref:`Requires a Twisted reactor `: yes. + +This handler supports ``ftp://host/path`` FTP URIs. + +It's implemented using :mod:`twisted.protocols.ftp`. + +S3DownloadHandler +----------------- + +.. autoclass:: scrapy.core.downloader.handlers.s3.S3DownloadHandler + +| Supported scheme: ``s3``. +| :ref:`Lazy `: yes. +| :ref:`Requires asyncio support `: no. +| :ref:`Requires a Twisted reactor `: no. + +This handler supports ``s3://bucket/path`` S3 URIs. + +It's implemented using the ``botocore`` library and needs it to be installed. diff --git a/docs/topics/downloader-middleware.rst b/docs/topics/downloader-middleware.rst index 6bd58e27e..d9527490a 100644 --- a/docs/topics/downloader-middleware.rst +++ b/docs/topics/downloader-middleware.rst @@ -68,9 +68,10 @@ defines one or more of these methods: .. 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. @@ -102,10 +103,7 @@ defines one or more of these methods: :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 @@ defines one or more of these methods: :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 + ` 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,9 +156,6 @@ defines one or more of these methods: :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 - .. _topics-downloader-middleware-ref: Built-in downloader middleware reference @@ -298,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 @@ -315,26 +307,15 @@ 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: + Example using settings (e.g. in :attr:`~scrapy.Spider.custom_settings`): .. code-block:: python @@ -342,13 +323,62 @@ HttpAuthMiddleware class SomeIntranetSiteSpider(CrawlSpider): - http_user = "someuser" - http_pass = "somepass" - http_auth_domain = "intranet.example.com" 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 +~~~~~~~~~~~~~ + +Default: ``""`` + +The username to use for HTTP basic authentication, applied to all requests +whose URL matches :setting:`HTTPAUTH_DOMAIN`. + +.. setting:: HTTPAUTH_PASS + +HTTPAUTH_PASS +~~~~~~~~~~~~~ + +Default: ``""`` + +The password to use for HTTP basic authentication. + +.. setting:: HTTPAUTH_DOMAIN + +HTTPAUTH_DOMAIN +~~~~~~~~~~~~~~~ + +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. + .. _Basic access authentication: https://en.wikipedia.org/wiki/Basic_access_authentication @@ -734,7 +764,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: @@ -743,11 +773,35 @@ 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 `, 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -942,10 +996,6 @@ Default: ``[]`` Meta tags within these tags are ignored. -.. versionchanged:: 2.0 - The default value of :setting:`METAREFRESH_IGNORE_TAGS` changed from - ``["script", "noscript"]`` to ``[]``. - .. versionchanged:: 2.11.2 The default value of :setting:`METAREFRESH_IGNORE_TAGS` changed from ``[]`` to ``["noscript"]``. @@ -1041,15 +1091,14 @@ RETRY_EXCEPTIONS Default:: [ - 'twisted.internet.defer.TimeoutError', - 'twisted.internet.error.TimeoutError', - 'twisted.internet.error.DNSLookupError', - 'twisted.internet.error.ConnectionRefusedError', + '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', - 'twisted.internet.error.TCPTimedOutError', - 'twisted.web.client.ResponseFailed', IOError, 'scrapy.core.downloader.handlers.http11.TunnelError', ] @@ -1064,6 +1113,21 @@ 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 +^^^^^^^^^^^^^^^^^^^^^^^ + +Default: ``"ERROR"`` + +:ref:`Logging level ` 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 @@ -1125,7 +1189,7 @@ Parsers vary in several aspects: * Support for wildcard matching -* Usage of `length based rule `_: +* Usage of `length based rule `_: 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 @@ -1143,7 +1207,7 @@ Based on `Protego `_: * implemented in Python * is compliant with `Google's Robots.txt Specification - `_ + `_ * supports wildcard matching @@ -1163,9 +1227,9 @@ Based on :class:`~urllib.robotparser.RobotFileParser`: * is compliant with `Martijn Koster's 1996 draft specification `_ -* 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. @@ -1236,9 +1300,8 @@ UserAgentMiddleware .. class:: UserAgentMiddleware - Middleware that allows spiders to override the default user agent. + Middleware that sets the ``User-Agent`` header. - In order for a spider to override the default user agent, its ``user_agent`` - attribute must be set. + The header value is taken from the :setting:`USER_AGENT` setting. .. _DBM: https://en.wikipedia.org/wiki/Dbm diff --git a/docs/topics/dynamic-content.rst b/docs/topics/dynamic-content.rst index 18b3ce244..5a399e094 100644 --- a/docs/topics/dynamic-content.rst +++ b/docs/topics/dynamic-content.rst @@ -83,7 +83,7 @@ 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_ format, Scrapy incorporates the method :meth:`~scrapy.Request.from_curl` to generate an equivalent @@ -274,16 +274,13 @@ 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 .. _chompjs: https://github.com/Nykakin/chompjs .. _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 .. _tabula-py: https://github.com/chezou/tabula-py diff --git a/docs/topics/email.rst b/docs/topics/email.rst deleted file mode 100644 index 1d7bad787..000000000 --- a/docs/topics/email.rst +++ /dev/null @@ -1,185 +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 -`, 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 -`. - -Quick example -============= - -There are two ways to instantiate the mail sender. You can instantiate it using -the standard ``__init__`` method: - -.. code-block:: python - - from scrapy.mail import MailSender - - mailer = MailSender() - -Or you can instantiate it passing a :class:`scrapy.Crawler` instance, which -will respect the :ref:`settings `: - -.. skip: start -.. code-block:: python - - mailer = MailSender.from_crawler(crawler) - -And here is how to use it to send an e-mail (without attachments): - -.. code-block:: python - - mailer.send( - to=["someone@example.com"], - subject="Some subject", - body="Some body", - cc=["another@example.com"], - ) -.. skip: end - -MailSender class reference -========================== - -The MailSender :ref:`components ` is the preferred class to -use for sending emails from Scrapy, as it uses :doc:`Twisted non-blocking IO -`, 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 - - .. 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 diff --git a/docs/topics/exceptions.rst b/docs/topics/exceptions.rst index 0b572ff95..cc690d609 100644 --- a/docs/topics/exceptions.rst +++ b/docs/topics/exceptions.rst @@ -83,8 +83,6 @@ 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` diff --git a/docs/topics/exporters.rst b/docs/topics/exporters.rst index 2fbe3f75d..c4cd05683 100644 --- a/docs/topics/exporters.rst +++ b/docs/topics/exporters.rst @@ -67,7 +67,7 @@ value of one of their fields: 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 @@ -93,24 +93,25 @@ 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 `. The serializer must be -a callable which receives a value and returns its serialized form. +Every :ref:`item type ` except :class:`dict` lets you declare a +serializer in the :ref:`field metadata `. The serializer +must be a callable which receives a value and returns its serialized form. Example: .. code-block:: python - import scrapy + from dataclasses import dataclass, field def serialize_price(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 @@ -163,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. diff --git a/docs/topics/extensions.rst b/docs/topics/extensions.rst index e1e3dd6b4..5a05f67d9 100644 --- a/docs/topics/extensions.rst +++ b/docs/topics/extensions.rst @@ -136,6 +136,27 @@ Core Stats extension Enable the collection of core statistics, provided the stats collection is enabled (see :ref:`topics-stats`). +The following stats are collected: + +* ``start_time``: start date/time of the crawl (:class:`~datetime.datetime`). +* ``finish_time``: end date/time of the crawl (:class:`~datetime.datetime`). +* ``elapsed_time_seconds``: total crawl duration in seconds (:class:`float`). +* ``finish_reason``: the closing reason string (e.g. ``"finished"``, + ``"closespider_timeout"``). +* ``item_scraped_count``: total number of items that passed all pipelines. +* ``item_dropped_count``: total number of items dropped by a pipeline. +* ``item_dropped_reasons_count/``: per-exception drop count + (e.g. ``item_dropped_reasons_count/DropItem``). +* ``response_received_count``: total number of HTTP responses received. + +Log Count extension +~~~~~~~~~~~~~~~~~~~ + +.. module:: scrapy.extensions.logcount + :synopsis: Basic stats logging + +.. autoclass:: LogCount + .. _topics-extensions-ref-telnetconsole: Telnet console extension @@ -167,20 +188,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 @@ -243,6 +260,7 @@ settings: * :setting:`CLOSESPIDER_TIMEOUT_NO_ITEM` * :setting:`CLOSESPIDER_ITEMCOUNT` * :setting:`CLOSESPIDER_PAGECOUNT` +* :setting:`CLOSESPIDER_PAGECOUNT_NO_ITEM` * :setting:`CLOSESPIDER_ERRORCOUNT` .. note:: @@ -256,12 +274,11 @@ settings: CLOSESPIDER_TIMEOUT """"""""""""""""""" -Default: ``0`` +Default: ``0.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. +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 @@ -324,24 +341,6 @@ 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.statsmailer - :synopsis: StatsMailer extension - -.. class:: StatsMailer - -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. - -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`. - .. module:: scrapy.extensions.debug :synopsis: Extensions for debugging Scrapy diff --git a/docs/topics/feed-exports.rst b/docs/topics/feed-exports.rst index 2184f2d0e..6ce5255b9 100644 --- a/docs/topics/feed-exports.rst +++ b/docs/topics/feed-exports.rst @@ -236,8 +236,6 @@ This storage backend uses :ref:`delayed file delivery `. Google Cloud Storage (GCS) -------------------------- -.. versionadded:: 2.3 - The feeds are stored on `Google Cloud Storage`_. - URI scheme: ``gs`` @@ -248,7 +246,7 @@ The feeds are stored on `Google Cloud Storage`_. - Required external libraries: `google-cloud-storage`_. -For more information about authentication, please refer to `Google Cloud documentation `_. +For more information about authentication, please refer to `Google Cloud documentation `_. You can set a *Project ID* and *Access Control List (ACL)* through the following settings: @@ -263,7 +261,7 @@ storage backend is: ``True``. This storage backend uses :ref:`delayed file delivery `. -.. _google-cloud-storage: https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python +.. _google-cloud-storage: https://docs.cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python .. _topics-feed-storage-stdout: @@ -303,8 +301,6 @@ feed URI, allowing item delivery to start way before the end of the crawl. Item filtering ============== -.. versionadded:: 2.6.0 - You can filter items that you want to allow for a particular feed by using the ``item_classes`` option in :ref:`feeds options `. Only items of the specified types will be added to the feed. @@ -344,8 +340,6 @@ ItemFilter Post-Processing =============== -.. versionadded:: 2.6.0 - 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 `, you can create your own :ref:`plugins `. @@ -425,8 +419,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` @@ -479,8 +471,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`. @@ -489,20 +479,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:: 2.6.0 - - ``item_filter``: a :ref:`filter class ` to filter items to export. :class:`~scrapy.extensions.feedexport.ItemFilter` is used be default. - .. versionadded:: 2.6.0 - - ``indent``: falls back to :setting:`FEED_EXPORT_INDENT`. - ``item_export_kwargs``: :class:`dict` with keyword arguments for the corresponding :ref:`item exporter class `. - .. versionadded:: 2.4.0 - - ``overwrite``: whether to overwrite the file if it already exists (``True``) or append to its content (``False``). @@ -522,8 +506,6 @@ as a fallback value if that key is not provided for a specific feed definition: - :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`. @@ -532,8 +514,6 @@ 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:: 2.6.0 - .. setting:: FEED_EXPORT_ENCODING FEED_EXPORT_ENCODING @@ -700,8 +680,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 @@ -771,15 +749,11 @@ 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 diff --git a/docs/topics/item-pipeline.rst b/docs/topics/item-pipeline.rst index dc27ce6ca..9a53f88fb 100644 --- a/docs/topics/item-pipeline.rst +++ b/docs/topics/item-pipeline.rst @@ -26,40 +26,32 @@ Writing your own item pipeline Each item pipeline is a :ref:`component ` 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 `, see :ref:`supporting-item-types`. - :meth:`process_item` must either: return an :ref:`item object `, - 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 ` + 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 ` - :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 +Any of these methods may be defined as a coroutine function (``async def``). Item pipeline example @@ -82,7 +74,7 @@ contain a price: 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"): @@ -107,13 +99,13 @@ format: class JsonWriterPipeline: - def open_spider(self, spider): + def open_spider(self): self.file = open("items.jsonl", "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 @@ -153,14 +145,14 @@ The main point of this example is to show how to :ref:`get the crawler 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 @@ -190,7 +182,6 @@ item. import scrapy from itemadapter import ItemAdapter from scrapy.http.request import NO_CALLBACK - from scrapy.utils.defer import maybe_deferred_to_future class ScreenshotPipeline: @@ -199,14 +190,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, callback=NO_CALLBACK) - response = await maybe_deferred_to_future( - spider.crawler.engine.download(request) - ) + response = await self.crawler.engine.download_async(request) if response.status != 200: # Error happened, return item. @@ -241,7 +237,7 @@ returns multiples items with the same id: 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"Item ID already seen: {adapter['id']}") diff --git a/docs/topics/items.rst b/docs/topics/items.rst index 3588d033e..7a1c1f907 100644 --- a/docs/topics/items.rst +++ b/docs/topics/items.rst @@ -80,8 +80,6 @@ Example: Dataclass objects ----------------- -.. versionadded:: 2.2 - :func:`~dataclasses.dataclass` allows the defining of item classes with field names, so that :ref:`item exporters ` can export all fields by default even if the first scraped object does not have values for all of them. @@ -112,8 +110,6 @@ Example: attr.s objects -------------- -.. versionadded:: 2.2 - :func:`attr.s` allows the defining of item classes with field names, so that :ref:`item exporters ` can export all fields by default even if the first scraped object does not have values for all of them. @@ -140,6 +136,45 @@ Example: another_field = attr.ib() +.. _pydantic-items: + +Pydantic models +--------------- + +`Pydantic `_ models allow the defining of item +classes with field names, so that :ref:`item 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 + `_, which can be used to + :ref:`customize serialization `. + +* benefit from automatic data validation and conversion based on type + annotations. + +In order to use this type, the `pydantic package `_ +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 ========================= diff --git a/docs/topics/jobs.rst b/docs/topics/jobs.rst index 50bcaa6d6..8d6b2458b 100644 --- a/docs/topics/jobs.rst +++ b/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 ============= @@ -65,6 +75,14 @@ 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. + Cookies expiration ------------------ @@ -72,7 +90,6 @@ 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 @@ -86,3 +103,61 @@ running :class:`~scrapy.Spider` class. 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 +` 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() + ` 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.PickleLifoDiskQueue`, a subclass of + :class:`queuelib.LifoDiskQueue` 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. diff --git a/docs/topics/leaks.rst b/docs/topics/leaks.rst index e61f33aed..0913a3310 100644 --- a/docs/topics/leaks.rst +++ b/docs/topics/leaks.rst @@ -68,19 +68,21 @@ 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 +.. code-block:: pycon - >>> prefs() - Live References + >>> prefs() + Live References - ExampleSpider 1 oldest: 15s ago - HtmlResponse 10 oldest: 1s ago - Selector 2 oldest: 0s ago - FormRequest 878 oldest: 7s ago + ExampleSpider 1 oldest: 15s ago + HtmlResponse 10 oldest: 1s ago + Selector 2 oldest: 0s 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 diff --git a/docs/topics/link-extractors.rst b/docs/topics/link-extractors.rst index f9744ed16..613e175da 100644 --- a/docs/topics/link-extractors.rst +++ b/docs/topics/link-extractors.rst @@ -76,10 +76,6 @@ LxmlLinkExtractor 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 @@ -163,5 +159,3 @@ Link :synopsis: Link from link extractors .. autoclass:: Link - -.. _scrapy.linkextractors: https://github.com/scrapy/scrapy/blob/master/scrapy/linkextractors/__init__.py diff --git a/docs/topics/loaders.rst b/docs/topics/loaders.rst index b7ce33616..3ccc90bf9 100644 --- a/docs/topics/loaders.rst +++ b/docs/topics/loaders.rst @@ -102,14 +102,13 @@ One approach to overcome this is to define items using the .. 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: @@ -174,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) @@ -231,7 +227,8 @@ metadata. Here is an example: .. code-block:: python - import scrapy + from dataclasses import dataclass, field + from itemloaders.processors import Join, MapCompose, TakeFirst from w3lib.html import remove_tags @@ -241,14 +238,21 @@ metadata. Here is an example: 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(), + }, ) @@ -455,4 +459,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 diff --git a/docs/topics/logging.rst b/docs/topics/logging.rst index a398d6c83..bbb5d0458 100644 --- a/docs/topics/logging.rst +++ b/docs/topics/logging.rst @@ -194,6 +194,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 -------------------- diff --git a/docs/topics/media-pipeline.rst b/docs/topics/media-pipeline.rst index 01da53342..c67d2d627 100644 --- a/docs/topics/media-pipeline.rst +++ b/docs/topics/media-pipeline.rst @@ -70,7 +70,7 @@ 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_ 8.0.0 or greater. It is used for +The Images Pipeline requires Pillow_ 8.3.2 or greater. It is used for thumbnailing and normalizing images to JPEG/RGB format. .. _Pillow: https://github.com/python-pillow/Pillow @@ -81,9 +81,6 @@ thumbnailing and normalizing images to JPEG/RGB format. 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. @@ -102,6 +99,8 @@ For Files Pipeline, use: .. 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, @@ -212,8 +211,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. @@ -238,7 +235,7 @@ Amazon S3 storage .. setting:: FILES_STORE_S3_ACL .. setting:: IMAGES_STORE_S3_ACL -If botocore_ >= 1.4.87 is installed, :setting:`FILES_STORE` and +If botocore_ >= 1.13.45 is installed, :setting:`FILES_STORE` and :setting:`IMAGES_STORE` can represent an Amazon S3 bucket. Scrapy will automatically upload the files to the bucket. @@ -292,7 +289,7 @@ 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. (requires `google-cloud-storage`_ ) -.. _google-cloud-storage: https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python +.. _google-cloud-storage: https://docs.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: @@ -303,7 +300,7 @@ For example, these are valid :setting:`IMAGES_STORE` and :setting:`GCS_PROJECT_I For information about authentication, see this `documentation`_. -.. _documentation: https://cloud.google.com/docs/authentication +.. _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 @@ -318,7 +315,7 @@ policy: 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 ============= @@ -339,17 +336,18 @@ respectively), the pipeline will put the results under the respective field When using :ref:`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: .. code-block:: python - import scrapy + from dataclasses import dataclass, field - class MyItem(scrapy.Item): + @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. @@ -547,9 +545,6 @@ See here the methods that you can override in your custom Files Pipeline: By default the :meth:`file_path` method returns ``full/.``. - .. 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 @@ -590,8 +585,6 @@ 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. @@ -705,9 +698,6 @@ See here the methods that you can override in your custom Images Pipeline: By default the :meth:`file_path` method returns ``full/.``. - .. 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 @@ -784,4 +774,28 @@ To enable your custom media pipeline component you must add its class import pat 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 + + .. _MD5 hash: https://en.wikipedia.org/wiki/MD5 +.. _TensorFlow: https://tensorflow.org diff --git a/docs/topics/practices.rst b/docs/topics/practices.rst index 56177ba4e..8a04f7ada 100644 --- a/docs/topics/practices.rst +++ b/docs/topics/practices.rst @@ -166,6 +166,86 @@ with :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor`): .. 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-multiple-spiders: Running multiple spiders in the same process @@ -281,7 +361,7 @@ finishes before starting the next one: 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. @@ -289,10 +369,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 @@ -307,6 +387,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 @@ -319,7 +419,7 @@ 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 @@ -329,6 +429,10 @@ Here are some tips to keep in mind when dealing with these kinds of sites: * 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. +* 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 `__ and additional features, like `AI web scraping `__ @@ -336,8 +440,16 @@ Here are some tips to keep in mind when dealing with these kinds of sites: If you are still unable to prevent your bot getting banned, consider contacting `commercial support`_. +.. _static-analysis: + +Static analysis +=============== + +Consider using :doc:`scrapy-lint `, 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/ .. _Common Crawl: https://commoncrawl.org/ .. _testspiders: https://github.com/scrapinghub/testspiders diff --git a/docs/topics/request-response.rst b/docs/topics/request-response.rst index 78a09f2c3..7b927e48e 100644 --- a/docs/topics/request-response.rst +++ b/docs/topics/request-response.rst @@ -32,10 +32,6 @@ Request objects :type url: str :param callback: sets :attr:`callback`, defaults to ``None``. - - .. versionchanged:: 2.0 - The *callback* parameter is no longer required when the *errback* - parameter is specified. :type callback: Callable[Concatenate[Response, ...], Any] | None :param method: the HTTP method of this request. Defaults to ``'GET'``. @@ -116,15 +112,14 @@ Request objects :class:`scrapy.Request.cookies ` parameter. This is a known current limitation that is being worked on. - .. versionadded:: 2.6.0 - Cookie values that are :class:`bool`, :class:`float` or :class:`int` - are casted to :class:`str`. - :type cookies: dict or list :param encoding: the encoding of this request (defaults to ``'utf-8'``). This encoding will be used to percent-encode the URL and to convert the body to bytes (if given as a string). + + To disable URL percent-encoding for a request, use the + :reqmeta:`verbatim_url` request meta key. :type encoding: str :param priority: sets :attr:`priority`, defaults to ``0``. @@ -134,10 +129,6 @@ Request objects :type dont_filter: bool :param errback: sets :attr:`errback`, defaults to ``None``. - - .. versionchanged:: 2.0 - The *callback* parameter is no longer required when the *errback* - parameter is specified. :type errback: Callable[[Failure], Any] | None :param flags: Flags sent to the request, can be used for logging or similar purposes. @@ -148,9 +139,13 @@ Request objects .. attribute:: Request.url - A string containing the URL of this request. Keep in mind that this - attribute contains the escaped URL, so it can differ from the URL passed in - the ``__init__()`` method. + A string containing the URL of this request. + + Keep in mind that this attribute contains the escaped URL, so it can + differ from the URL passed in the ``__init__()`` method. + + If :reqmeta:`verbatim_url` is set to ``True``, the URL is kept as + passed to ``__init__()``. This attribute is read-only. To change the URL of a Request use :meth:`replace`. @@ -193,6 +188,13 @@ Request objects ``failure.request.cb_kwargs`` in the request's errback. For more information, see :ref:`errback-cb_kwargs`. + .. note:: When :setting:`JOBDIR` is set, requests are serialized to disk + with :mod:`pickle` (see :ref:`request-serialization`). As a result, + the callback receives a deep copy of any object stored in + ``cb_kwargs``, so mutating such an object in the callback does not + affect the original. Avoid relying on shared mutable state passed + through ``cb_kwargs`` in that case. + .. attribute:: Request.meta :value: {} @@ -258,6 +260,78 @@ Request objects .. automethod:: to_dict +.. _form: + +Creating requests that submit HTML forms +---------------------------------------- + +Use :doc:`form2request ` to build request data from an HTML +``
`` element and convert it to a :class:`~scrapy.Request`. + +Install it with pip: + +.. code-block:: bash + + pip install form2request + +Select the desired form with CSS or XPath, then build and convert request +data: + +.. code-block:: python + + from form2request import form2request + + + def parse(self, response): + form = response.css("form#search") + request_data = form2request(form, data={"q": "scrapy"}) + yield request_data.to_scrapy(callback=self.parse_results) + +Use ``data`` to override field values. To drop a field from the resulting +request, set its value to ``None``. + +By default, form2request simulates clicking the first submit button. To submit +without clicking any button, pass ``click=False``. To click a specific submit +button, pass its element: + +.. code-block:: python + + def parse(self, response): + form = response.css("form#checkout") + submit = form.css('button[name="pay"]') + request_data = form2request(form, click=submit) + +.. _topics-request-response-ref-request-userlogin: + +Using form2request to simulate a user login +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +It is usual for web sites to provide pre-populated form fields through ```` elements, such as session related data or authentication +tokens (for login pages). Build the request from the form and only override the +credentials: + +.. code-block:: python + + import scrapy + from form2request import form2request + + + class LoginSpider(scrapy.Spider): + name = "example.com" + start_urls = ["http://www.example.com/users/login.php"] + + def parse(self, response): + form = response.css("form") + request_data = form2request( + form, + data={"username": "john", "password": "secret"}, + ) + yield request_data.to_scrapy(callback=self.after_login) + + def after_login(self, response): ... + + Other functions related to requests ----------------------------------- @@ -448,8 +522,6 @@ To change how request fingerprints are built for your requests, use the REQUEST_FINGERPRINTER_CLASS ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. versionadded:: 2.7 - Default: :class:`scrapy.utils.request.RequestFingerprinter` A :ref:`request fingerprinter class ` or its @@ -483,6 +555,11 @@ in your :meth:`fingerprint` method implementation: .. autofunction:: scrapy.utils.request.fingerprint +By default, request fingerprinting canonicalizes the request URL. If +:reqmeta:`verbatim_url` is set to ``True``, fingerprinting does not +canonicalize the URL, and the ``keep_fragments`` parameter is ignored (it is +effectively true). + For example, to take the value of a request header named ``X-ID`` into account: @@ -643,8 +720,12 @@ Those are: * :reqmeta:`download_timeout` * ``ftp_password`` (See :setting:`FTP_PASSWORD` for more info) * ``ftp_user`` (See :setting:`FTP_USER` for more info) +* :reqmeta:`give_up_log_level` * :reqmeta:`handle_httpstatus_all` * :reqmeta:`handle_httpstatus_list` +* :reqmeta:`http_auth_domain` +* :reqmeta:`http_pass` +* :reqmeta:`http_user` * :reqmeta:`is_start_request` * :reqmeta:`max_retry_times` * :reqmeta:`proxy` @@ -652,13 +733,47 @@ Those are: * :reqmeta:`redirect_urls` * :reqmeta:`referrer_policy` * :reqmeta:`throttling_scopes` +* :reqmeta:`verbatim_url` .. reqmeta:: bindaddress bindaddress ----------- -The IP of the outgoing IP address to use for the performing the request. +The default local outgoing address for download-handler connections. + +This meta value can be either: + +- a host address as a string (e.g. ``"127.0.0.2"``), in which case the local + port is chosen automatically, or + +- a ``(host, port)`` tuple (e.g. ``("127.0.0.2", 50000)``) to bind to both a + specific local interface and a specific local port. + +For example: + +.. code-block:: python + + Request( + "https://example.org", + meta={"bindaddress": "127.0.0.2"}, + ) + +.. code-block:: python + + Request( + "https://example.org", + meta={"bindaddress": ("127.0.0.2", 50000)}, + ) + +If not set, built-in HTTP download handlers use the value of +:setting:`DOWNLOAD_BIND_ADDRESS` as the default bind address. +Set the :reqmeta:`bindaddress` request meta key to override it for a +specific request. + +This meta key is not supported by +:class:`~scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler`, but the +:setting:`DOWNLOAD_BIND_ADDRESS` is supported by it. .. reqmeta:: download_timeout @@ -686,15 +801,59 @@ download_fail_on_dataloss Whether or not to fail on broken responses. See: :setting:`DOWNLOAD_FAIL_ON_DATALOSS`. +.. reqmeta:: give_up_log_level + +give_up_log_level +----------------- + +:ref:`Logging level ` used for the message logged when a request +exceeds its retries. See :setting:`RETRY_GIVE_UP_LOG_LEVEL` for details. + +.. reqmeta:: http_auth_domain + +http_auth_domain +---------------- + +Overrides :setting:`HTTPAUTH_DOMAIN` for this request. + +.. reqmeta:: http_pass + +http_pass +--------- + +Overrides :setting:`HTTPAUTH_PASS` for this request. + +.. reqmeta:: http_user + +http_user +--------- + +Overrides :setting:`HTTPAUTH_USER` for this request. + .. reqmeta:: max_retry_times max_retry_times --------------- -The meta key is used set retry times per request. When initialized, the +The meta key is used set retry times per request. When set, the :reqmeta:`max_retry_times` meta key takes higher precedence over the :setting:`RETRY_TIMES` setting. +.. reqmeta:: verbatim_url + +verbatim_url +------------ + +Set this key to ``True`` to keep the request URL as passed to +:class:`~scrapy.Request`, without URL percent-encoding. + +When this key is enabled, :func:`~scrapy.utils.request.fingerprint` does not +canonicalize the request URL, so requests whose URLs differ only in +characters that would otherwise be canonicalized get different fingerprints. + +In this mode, the ``keep_fragments`` parameter is ignored, and it is +effectively true. + .. _topics-stop-response-download: @@ -752,159 +911,6 @@ Request subclasses Here is the list of built-in :class:`~scrapy.Request` subclasses. You can also subclass it to implement your own custom functionality. -FormRequest objects -------------------- - -The FormRequest class extends the base :class:`~scrapy.Request` with functionality for -dealing with HTML forms. It uses `lxml.html forms`_ to pre-populate form -fields with form data from :class:`Response` objects. - -.. _lxml.html forms: https://lxml.de/lxmlhtml.html#forms - -.. currentmodule:: None - -.. class:: scrapy.FormRequest(url, [formdata, ...]) - :canonical: scrapy.http.request.form.FormRequest - - The :class:`~scrapy.FormRequest` class adds a new keyword parameter to the ``__init__()`` method. The - remaining arguments are the same as for the :class:`~scrapy.Request` class and are - not documented here. - - :param formdata: is a dictionary (or iterable of (key, value) tuples) - containing HTML Form data which will be url-encoded and assigned to the - body of the request. - :type formdata: dict or collections.abc.Iterable - - The :class:`~scrapy.FormRequest` objects support the following class method in - addition to the standard :class:`~scrapy.Request` methods: - - .. classmethod:: from_response(response, [formname=None, formid=None, formnumber=0, formdata=None, formxpath=None, formcss=None, clickdata=None, dont_click=False, ...]) - - Returns a new :class:`~scrapy.FormRequest` object with its form field values - pre-populated with those found in the HTML ```` element contained - in the given response. For an example see - :ref:`topics-request-response-ref-request-userlogin`. - - The policy is to automatically simulate a click, by default, on any form - control that looks clickable, like a ````. Even - though this is quite convenient, and often the desired behaviour, - sometimes it can cause problems which could be hard to debug. For - example, when working with forms that are filled and/or submitted using - javascript, the default :meth:`from_response` behaviour may not be the - most appropriate. To disable this behaviour you can set the - ``dont_click`` argument to ``True``. Also, if you want to change the - control clicked (instead of disabling it) you can also use the - ``clickdata`` argument. - - .. caution:: Using this method with select elements which have leading - or trailing whitespace in the option values will not work due to a - `bug in lxml`_, which should be fixed in lxml 3.8 and above. - - :param response: the response containing a HTML form which will be used - to pre-populate the form fields - :type response: :class:`~scrapy.http.Response` object - - :param formname: if given, the form with name attribute set to this value will be used. - :type formname: str - - :param formid: if given, the form with id attribute set to this value will be used. - :type formid: str - - :param formxpath: if given, the first form that matches the xpath will be used. - :type formxpath: str - - :param formcss: if given, the first form that matches the css selector will be used. - :type formcss: str - - :param formnumber: the number of form to use, when the response contains - multiple forms. The first one (and also the default) is ``0``. - :type formnumber: int - - :param formdata: fields to override in the form data. If a field was - already present in the response ```` element, its value is - overridden by the one passed in this parameter. If a value passed in - this parameter is ``None``, the field will not be included in the - request, even if it was present in the response ```` element. - :type formdata: dict - - :param clickdata: attributes to lookup the control clicked. If it's not - given, the form data will be submitted simulating a click on the - first clickable element. In addition to html attributes, the control - can be identified by its zero-based index relative to other - submittable inputs inside the form, via the ``nr`` attribute. - :type clickdata: dict - - :param dont_click: If True, the form data will be submitted without - clicking in any element. - :type dont_click: bool - - The other parameters of this class method are passed directly to the - :class:`~scrapy.FormRequest` ``__init__()`` method. - -.. currentmodule:: scrapy.http - -Request usage examples ----------------------- - -Using FormRequest to send data via HTTP POST -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you want to simulate a HTML Form POST in your spider and send a couple of -key-value fields, you can return a :class:`~scrapy.FormRequest` object (from your -spider) like this: - -.. skip: next -.. code-block:: python - - return [ - FormRequest( - url="http://www.example.com/post/action", - formdata={"name": "John Doe", "age": "27"}, - callback=self.after_post, - ) - ] - -.. _topics-request-response-ref-request-userlogin: - -Using FormRequest.from_response() to simulate a user login -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -It is usual for web sites to provide pre-populated form fields through ```` elements, such as session related data or authentication -tokens (for login pages). When scraping, you'll want these fields to be -automatically pre-populated and only override a couple of them, such as the -user name and password. You can use the :meth:`.FormRequest.from_response` -method for this job. Here's an example spider which uses it: - -.. code-block:: python - - import scrapy - - - def authentication_failed(response): - # TODO: Check the contents of the response and return True if it failed - # or False if it succeeded. - pass - - - class LoginSpider(scrapy.Spider): - name = "example.com" - start_urls = ["http://www.example.com/users/login.php"] - - def parse(self, response): - return scrapy.FormRequest.from_response( - response, - formdata={"username": "john", "password": "secret"}, - callback=self.after_login, - ) - - def after_login(self, response): - if authentication_failed(response): - self.logger.error("Login failed") - return - - # continue scraping with authenticated session... - JsonRequest ----------- @@ -979,7 +985,7 @@ Response objects :type request: scrapy.Request :param certificate: an object representing the server's SSL certificate. - :type certificate: twisted.internet.ssl.Certificate + :type certificate: typing.Any :param ip_address: The IP address of the server from which the Response originated. :type ip_address: :class:`ipaddress.IPv4Address` or :class:`ipaddress.IPv6Address` @@ -988,15 +994,6 @@ Response objects For instance: "HTTP/1.0", "HTTP/1.1", "h2" :type protocol: :class:`str` - .. versionadded:: 2.0.0 - The ``certificate`` parameter. - - .. versionadded:: 2.1.0 - The ``ip_address`` parameter. - - .. versionadded:: 2.5.0 - The ``protocol`` parameter. - .. attribute:: Response.url A string containing the URL of the response. @@ -1013,7 +1010,7 @@ Response objects A dictionary-like (:class:`scrapy.http.headers.Headers`) object which contains the response headers. Values can be accessed using - :meth:`~scrapy.http.headers.Headers.get` to return the first header value with + :meth:`~scrapy.http.headers.Headers.get` to return the last header value with the specified name or :meth:`~scrapy.http.headers.Headers.getlist` to return all header values with the specified name. For example, this call will give you all cookies in the headers:: @@ -1062,8 +1059,6 @@ Response objects .. attribute:: Response.cb_kwargs - .. versionadded:: 2.0 - A shortcut to the :attr:`~scrapy.Request.cb_kwargs` attribute of the :attr:`Response.request` object (i.e. ``self.request.cb_kwargs``). @@ -1082,17 +1077,13 @@ Response objects .. attribute:: Response.certificate - .. versionadded:: 2.0.0 - - A :class:`twisted.internet.ssl.Certificate` object representing - the server's SSL certificate. + An object representing the server's SSL certificate. Its type and + contents depend on the download handler that produced the response. Only populated for ``https`` responses, ``None`` otherwise. .. attribute:: Response.ip_address - .. versionadded:: 2.1.0 - The IP address of the server from which the Response originated. This attribute is currently only populated by the HTTP 1.1 download @@ -1101,8 +1092,6 @@ Response objects .. attribute:: Response.protocol - .. versionadded:: 2.5.0 - The protocol that was used to download the response. For instance: "HTTP/1.0", "HTTP/1.1" diff --git a/docs/topics/scheduler.rst b/docs/topics/scheduler.rst index b6e54ebd7..b79d6de1f 100644 --- a/docs/topics/scheduler.rst +++ b/docs/topics/scheduler.rst @@ -32,3 +32,10 @@ Default scheduler .. autoclass:: Scheduler() :members: :special-members: __init__, __len__ + + +Priority queues +=============== + +.. autoclass:: scrapy.pqueues.DownloaderAwarePriorityQueue +.. autoclass:: scrapy.pqueues.ScrapyPriorityQueue diff --git a/docs/topics/selectors.rst b/docs/topics/selectors.rst index 40a85201a..35ea2a200 100644 --- a/docs/topics/selectors.rst +++ b/docs/topics/selectors.rst @@ -543,7 +543,7 @@ you may want to take a look first at this `XPath tutorial`_. .. note:: Some of the tips are based on `this post from Zyte's blog`_. -.. _`XPath tutorial`: http://www.zvon.org/comp/r/tut-XPath_1.html +.. _XPath tutorial: http://www.zvon.org/comp/r/tut-XPath_1.html .. _this post from Zyte's blog: https://www.zyte.com/blog/xpath-tips-from-the-web-scraping-trenches/ @@ -728,7 +728,7 @@ But using the ``.`` to mean the node, works: >>> sel.xpath("//a[contains(., 'Next Page')]").getall() ['Click here to go to the Next Page'] -.. _`XPath string function`: https://www.w3.org/TR/xpath-10/#section-String-Functions +.. _XPath string function: https://www.w3.org/TR/xpath-10/#section-String-Functions .. _topics-selectors-xpath-variables: @@ -983,9 +983,9 @@ Here we first iterate over ``itemscope`` elements, and for each one, we look for all ``itemprops`` elements and exclude those that are themselves inside another ``itemscope``. -.. _EXSLT: http://exslt.org/ -.. _regular expressions: http://exslt.org/regexp/index.html -.. _set manipulation: http://exslt.org/set/index.html +.. _EXSLT: https://exslt.github.io/ +.. _regular expressions: https://exslt.github.io/regexp/index.html +.. _set manipulation: https://exslt.github.io/set/index.html Other XPath extensions ---------------------- @@ -1190,4 +1190,4 @@ instantiated with an :class:`~scrapy.http.XmlResponse` object: .. skip: end -.. _Google Base XML feed: https://support.google.com/merchants/answer/160589?hl=en&ref_topic=2473799 +.. _Google Base XML feed: https://support.google.com/merchants/answer/14987622 diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index 6ea336458..405805133 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -182,8 +182,6 @@ Setting values must be :ref:`picklable `. Import paths and classes ======================== -.. versionadded:: 2.4.0 - When a setting references a callable object to be imported by Scrapy, such as a class or a function, there are two different ways you can specify that object: @@ -305,11 +303,12 @@ Pre-crawler settings These settings cannot be :ref:`set from a spider `. -These settings are :setting:`SPIDER_LOADER_CLASS` and settings used by the -corresponding :ref:`component `, e.g. -:setting:`SPIDER_MODULES` and :setting:`SPIDER_LOADER_WARN_ONLY` for the -default component. +These settings are: +- :setting:`TWISTED_REACTOR_ENABLED` +- :setting:`SPIDER_LOADER_CLASS` and settings used by the corresponding + spider loader class, e.g. :setting:`SPIDER_MODULES` and + :setting:`SPIDER_LOADER_WARN_ONLY` for the default spider loader class. .. _reactor-settings: @@ -333,7 +332,7 @@ These settings are: - :setting:`ASYNCIO_EVENT_LOOP` (not possible to set per-spider when using :class:`~scrapy.crawler.AsyncCrawlerProcess`, see below) -- :setting:`DNS_RESOLVER` and settings used by the corresponding +- :setting:`TWISTED_DNS_RESOLVER` and settings used by the corresponding component, e.g. :setting:`DNSCACHE_ENABLED`, :setting:`DNSCACHE_SIZE` and :setting:`DNS_TIMEOUT` for the default one. @@ -358,6 +357,9 @@ ignoring the value of :setting:`TWISTED_REACTOR` and using the value of e.g. in :ref:`per-spider settings `, an exception will be raised. +All of these settings, except for :setting:`ASYNCIO_EVENT_LOOP`, are only used +when the Twisted reactor is used, i.e. when :setting:`TWISTED_REACTOR_ENABLED` +is ``True``. .. _topics-settings-ref: @@ -513,6 +515,7 @@ Maximum number of total concurrent requests allowed. .. seealso:: :ref:`throttling` + .. setting:: DEFAULT_DROPITEM_LOG_LEVEL DEFAULT_DROPITEM_LOG_LEVEL @@ -541,7 +544,7 @@ When writing an item pipeline, you can force a different log level by setting class MyPipeline: - def process_item(self, item, spider): + def process_item(self, item): if not item.get("price"): raise DropItem("Missing price data", log_level="INFO") return item @@ -640,6 +643,13 @@ Default: ``True`` Whether to enable DNS in-memory cache. +.. note:: + This setting is only used by + :class:`~scrapy.resolver.CachingThreadedResolver` and + :class:`~scrapy.resolver.CachingHostnameResolver`. It has no effect when + :setting:`TWISTED_REACTOR_ENABLED` is ``False``, and may have no effect + either when :setting:`DNS_RESOLVER` is set to a different resolver. + .. setting:: DNSCACHE_SIZE DNSCACHE_SIZE @@ -647,23 +657,25 @@ DNSCACHE_SIZE Default: ``10000`` -DNS in-memory cache size. +DNS in-memory cache size, see :setting:`DNSCACHE_ENABLED`. -.. setting:: DNS_RESOLVER +.. setting:: TWISTED_DNS_RESOLVER -DNS_RESOLVER ------------- - -.. versionadded:: 2.0 +TWISTED_DNS_RESOLVER +-------------------- Default: ``'scrapy.resolver.CachingThreadedResolver'`` -The class to be used to resolve DNS names. The default ``scrapy.resolver.CachingThreadedResolver`` -supports specifying a timeout for DNS requests via the :setting:`DNS_TIMEOUT` setting, -but works only with IPv4 addresses. Scrapy provides an alternative resolver, +The class to be used by Twisted to resolve DNS names. The default +``scrapy.resolver.CachingThreadedResolver`` supports specifying a timeout for +DNS requests via the :setting:`DNS_TIMEOUT` setting, but works only with IPv4 +addresses. Scrapy provides an alternative resolver, ``scrapy.resolver.CachingHostnameResolver``, which supports IPv4/IPv6 addresses but does not take the :setting:`DNS_TIMEOUT` setting into account. +.. note:: + This setting has no effect when :setting:`TWISTED_REACTOR_ENABLED` is ``False``. + .. setting:: DNS_TIMEOUT DNS_TIMEOUT @@ -673,6 +685,12 @@ Default: ``60`` Timeout for processing of DNS queries in seconds. Float is supported. +.. note:: + This setting is only used by + :class:`~scrapy.resolver.CachingThreadedResolver`. It has no effect when + :setting:`TWISTED_REACTOR_ENABLED` is ``False``, and may have no effect + either when :setting:`DNS_RESOLVER` is set to a different resolver. + .. setting:: DOWNLOADER DOWNLOADER @@ -682,53 +700,6 @@ Default: ``'scrapy.core.downloader.Downloader'`` The downloader to use for crawling. -.. setting:: DOWNLOADER_HTTPCLIENTFACTORY - -DOWNLOADER_HTTPCLIENTFACTORY ----------------------------- - -Default: ``'scrapy.core.downloader.webclient.ScrapyHTTPClientFactory'`` - -Defines a Twisted ``protocol.ClientFactory`` class to use for HTTP/1.0 -connections (for ``HTTP10DownloadHandler``). - -.. note:: - - HTTP/1.0 is rarely used nowadays and its Scrapy support is deprecated, - so you can safely ignore this setting, - unless you really want to use HTTP/1.0 and override - :setting:`DOWNLOAD_HANDLERS` for ``http(s)`` scheme accordingly, - i.e. to ``'scrapy.core.downloader.handlers.http.HTTP10DownloadHandler'``. - -.. setting:: DOWNLOADER_CLIENTCONTEXTFACTORY - -DOWNLOADER_CLIENTCONTEXTFACTORY -------------------------------- - -Default: ``'scrapy.core.downloader.contextfactory.ScrapyClientContextFactory'`` - -Represents the classpath to the ContextFactory to use. - -Here, "ContextFactory" is a Twisted term for SSL/TLS contexts, defining -the TLS/SSL protocol version to use, whether to do certificate verification, -or even enable client-side authentication (and various other things). - -.. note:: - - Scrapy default context factory **does NOT perform remote server - certificate verification**. This is usually fine for web scraping. - - If you do need remote server certificate verification enabled, - Scrapy also has another context factory class that you can set, - ``'scrapy.core.downloader.contextfactory.BrowserLikeContextFactory'``, - which uses the platform's certificates to validate remote endpoints. - -If you do use a custom ContextFactory, make sure its ``__init__`` method -accepts a ``method`` parameter (this is the ``OpenSSL.SSL`` method mapping -:setting:`DOWNLOADER_CLIENT_TLS_METHOD`), a ``tls_verbose_logging`` -parameter (``bool``) and a ``tls_ciphers`` parameter (see -:setting:`DOWNLOADER_CLIENT_TLS_CIPHERS`). - .. setting:: DOWNLOADER_CLIENT_TLS_CIPHERS DOWNLOADER_CLIENT_TLS_CIPHERS @@ -736,8 +707,8 @@ DOWNLOADER_CLIENT_TLS_CIPHERS Default: ``'DEFAULT'`` -Use this setting to customize the TLS/SSL ciphers used by the default -HTTP/1.1 downloader. +Use this setting to customize the TLS/SSL ciphers used by the HTTPS download +handler. The setting should contain a string in the `OpenSSL cipher list format`_, these ciphers will be used as client ciphers. Changing this setting may be @@ -747,26 +718,56 @@ specific cipher that is not included in ``DEFAULT`` if a website requires it. .. _OpenSSL cipher list format: https://docs.openssl.org/master/man1/openssl-ciphers/#cipher-list-format -.. setting:: DOWNLOADER_CLIENT_TLS_METHOD +.. note:: -DOWNLOADER_CLIENT_TLS_METHOD ----------------------------- + Handling of this setting needs to be implemented inside the :ref:`download + handler `, so it's not guaranteed to be supported + by all 3rd-party handlers. -Default: ``'TLS'`` +.. setting:: DOWNLOAD_TLS_MAX_VERSION -Use this setting to customize the TLS/SSL method used by the default -HTTP/1.1 downloader. +DOWNLOAD_TLS_MAX_VERSION +------------------------ -This setting must be one of these string values: +Default: ``None`` -- ``'TLS'``: maps to OpenSSL's ``TLS_method()`` (a.k.a ``SSLv23_method()``), - which allows protocol negotiation, starting from the highest supported - by the platform; **default, recommended** -- ``'TLSv1.0'``: this value forces HTTPS connections to use TLS version 1.0 ; - set this if you want the behavior of Scrapy<1.1 -- ``'TLSv1.1'``: forces TLS version 1.1 -- ``'TLSv1.2'``: forces TLS version 1.2 +Use this setting to change the maximum version of the TLS protocol allowed to +be used by Scrapy. +This setting must be either ``None``, in which case it doesn't affect the +version selection, or one of these string values: + +- ``'TLSv1.0'`` +- ``'TLSv1.1'`` +- ``'TLSv1.2'`` +- ``'TLSv1.3'`` + +The range of allowed TLS versions advertised by Scrapy when making TLS +connections will depend on the TLS implementation defaults and the values of +:setting:`DOWNLOAD_TLS_MIN_VERSION` and :setting:`DOWNLOAD_TLS_MAX_VERSION`. +It's possible to re-enable versions that are supported by the TLS +implementation but disabled by default by adjusting these settings, but it's +impossible to enable unsupported ones, such as any versions below 1.2 in many +modern environments. + +.. note:: + + Handling of this setting needs to be implemented inside the :ref:`download + handler `, so it's not guaranteed to be supported + by all 3rd-party handlers. Additionally, the set of supported TLS versions + depends on the TLS implementation being used by the handler. + +.. setting:: DOWNLOAD_TLS_MIN_VERSION + +DOWNLOAD_TLS_MIN_VERSION +------------------------ + +Default: ``None`` + +Use this setting to change the minimum version of the TLS protocol allowed to +be used by Scrapy. + +See :setting:`DOWNLOAD_TLS_MAX_VERSION` for the details and limitations. .. setting:: DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING @@ -777,17 +778,21 @@ Default: ``False`` Setting this to ``True`` will enable DEBUG level messages about TLS connection parameters after establishing HTTPS connections. The kind of information logged -depends on the versions of OpenSSL and pyOpenSSL. +depends on the implementation of the download handler and the versions of +the TLS-related libraries. -This setting is only used for the default -:setting:`DOWNLOADER_CLIENTCONTEXTFACTORY`. +.. note:: + + Handling of this setting needs to be implemented inside the :ref:`download + handler `, so it's not guaranteed to be supported + by all 3rd-party handlers. .. setting:: DOWNLOADER_MIDDLEWARES DOWNLOADER_MIDDLEWARES ---------------------- -Default:: ``{}`` +Default: ``{}`` A dict containing the downloader middlewares enabled in your project, and their orders. For more info see :ref:`topics-downloader-middleware-setting`. @@ -809,7 +814,6 @@ Default: "scrapy.downloadermiddlewares.defaultheaders.DefaultHeadersMiddleware": 400, "scrapy.downloadermiddlewares.useragent.UserAgentMiddleware": 500, "scrapy.downloadermiddlewares.retry.RetryMiddleware": 550, - "scrapy.downloadermiddlewares.ajaxcrawl.AjaxCrawlMiddleware": 560, "scrapy.downloadermiddlewares.redirect.MetaRefreshMiddleware": 580, "scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware": 590, "scrapy.downloadermiddlewares.redirect.RedirectMiddleware": 600, @@ -841,7 +845,9 @@ DOWNLOAD_HANDLERS Default: ``{}`` -A dict containing the request downloader handlers enabled in your project. +A dict containing the :ref:`download handlers ` +enabled in your project. + See :setting:`DOWNLOAD_HANDLERS_BASE` for example format. .. setting:: DOWNLOAD_HANDLERS_BASE @@ -856,16 +862,30 @@ Default: { "data": "scrapy.core.downloader.handlers.datauri.DataURIDownloadHandler", "file": "scrapy.core.downloader.handlers.file.FileDownloadHandler", - "http": "scrapy.core.downloader.handlers.http.HTTPDownloadHandler", - "https": "scrapy.core.downloader.handlers.http.HTTPDownloadHandler", + "http": "scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler", + "https": "scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler", "s3": "scrapy.core.downloader.handlers.s3.S3DownloadHandler", "ftp": "scrapy.core.downloader.handlers.ftp.FTPDownloadHandler", } +(when :setting:`TWISTED_REACTOR_ENABLED` is ``True``) -A dict containing the request download handlers enabled by default in Scrapy. -You should never modify this setting in your project, modify -:setting:`DOWNLOAD_HANDLERS` instead. +.. code-block:: python + + { + "data": "scrapy.core.downloader.handlers.datauri.DataURIDownloadHandler", + "file": "scrapy.core.downloader.handlers.file.FileDownloadHandler", + "http": "scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler", + "https": "scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler", + "s3": "scrapy.core.downloader.handlers.s3.S3DownloadHandler", + "ftp": None, + } + +(when :setting:`TWISTED_REACTOR_ENABLED` is ``False``) + +A dict containing the :ref:`download handlers ` +enabled by default in Scrapy. You should never modify this setting in your +project, modify :setting:`DOWNLOAD_HANDLERS` instead. You can disable any of these download handlers by assigning ``None`` to their URI scheme in :setting:`DOWNLOAD_HANDLERS`. E.g., to disable the built-in FTP @@ -877,46 +897,6 @@ handler (without replacement), place this in your ``settings.py``: "ftp": None, } -.. _http2: - -The default HTTPS handler uses HTTP/1.1. To use HTTP/2: - -#. Install ``Twisted[http2]>=17.9.0`` to install the packages required to - enable HTTP/2 support in Twisted. - -#. Update :setting:`DOWNLOAD_HANDLERS` as follows: - - .. code-block:: python - - DOWNLOAD_HANDLERS = { - "https": "scrapy.core.downloader.handlers.http2.H2DownloadHandler", - } - -.. warning:: - - HTTP/2 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. - -.. note:: - - Known limitations of the current HTTP/2 implementation of Scrapy include: - - - 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. - - - No support for the :signal:`bytes_received` and - :signal:`headers_received` signals. - -.. _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 .. setting:: DOWNLOAD_TIMEOUT @@ -930,9 +910,14 @@ The amount of time (in secs) that the downloader will wait before timing out. .. note:: - This timeout can be set per spider using :attr:`download_timeout` - spider attribute and per-request using :reqmeta:`download_timeout` - Request.meta key. + This timeout can be per-request using the :reqmeta:`download_timeout` + :attr:`.Request.meta` key. + +.. note:: + + Handling of this setting needs to be implemented inside the :ref:`download + handler `, so it's not guaranteed to be supported + by all 3rd-party handlers. .. setting:: DOWNLOAD_MAXSIZE .. reqmeta:: download_maxsize @@ -951,9 +936,16 @@ ignored. Use ``0`` to disable this limit. -This limit can be set per spider using the :attr:`download_maxsize` spider -attribute and per request using the :reqmeta:`download_maxsize` Request.meta -key. +.. note:: + + This limit can be set per-request using the :reqmeta:`download_maxsize` + :attr:`.Request.meta` key. + +.. note:: + + Checking responses before decompressing them needs to be implemented inside + the :ref:`download handler `, so it's not + guaranteed to be supported by all 3rd-party handlers. .. setting:: DOWNLOAD_WARNSIZE .. reqmeta:: download_warnsize @@ -968,9 +960,16 @@ warning will be logged about it. Use ``0`` to disable this limit. -This limit can be set per spider using the :attr:`download_warnsize` spider -attribute and per request using the :reqmeta:`download_warnsize` Request.meta -key. +.. note:: + + This limit can be set per-request using the :reqmeta:`download_warnsize` + :attr:`.Request.meta` key. + +.. note:: + + Checking responses before decompressing them needs to be implemented inside + the :ref:`download handler `, so it's not + guaranteed to be supported by all 3rd-party handlers. .. setting:: DOWNLOAD_FAIL_ON_DATALOSS @@ -979,12 +978,12 @@ DOWNLOAD_FAIL_ON_DATALOSS Default: ``True`` -Whether or not to fail on broken responses, that is, declared -``Content-Length`` does not match content sent by the server or chunked -response was not properly finish. If ``True``, these responses raise a -``ResponseFailed([_DataLoss])`` error. If ``False``, these responses -are passed through and the flag ``dataloss`` is added to the response, i.e.: -``'dataloss' in response.flags`` is ``True``. +Whether or not to fail on broken responses, that is, when the declared +``Content-Length`` does not match content sent by the server or a chunked +response was not properly finished. If ``True``, these responses raise a +:exc:`~scrapy.exceptions.ResponseDataLossError` exception. If ``False``, these +responses are passed through and the flag ``dataloss`` is added to the +response, i.e.: ``'dataloss' in response.flags`` is ``True``. Optionally, this can be set per-request basis by using the :reqmeta:`download_fail_on_dataloss` Request.meta key to ``False``. @@ -996,17 +995,42 @@ Optionally, this can be set per-request basis by using the corruption. It is up to the user to decide if it makes sense to process broken responses considering they may contain partial or incomplete content. If :setting:`RETRY_ENABLED` is ``True`` and this setting is set to ``True``, - the ``ResponseFailed([_DataLoss])`` failure will be retried as usual. + the :exc:`~scrapy.exceptions.ResponseDataLossError` failure will be retried + as usual. + +.. note:: + + Handling of this setting needs to be implemented inside the :ref:`download + handler `, so it's not guaranteed to be supported + by all 3rd-party handlers. .. warning:: This setting is ignored by the :class:`~scrapy.core.downloader.handlers.http2.H2DownloadHandler` - download handler (see :setting:`DOWNLOAD_HANDLERS`). In case of a data loss + :ref:`download handler `. In case of a data loss error, the corresponding HTTP/2 connection may be corrupted, affecting other requests that use the same connection; hence, a ``ResponseFailed([InvalidBodyLengthError])`` failure is always raised for every request that was using that connection. +.. setting:: DOWNLOAD_VERIFY_CERTIFICATES + +DOWNLOAD_VERIFY_CERTIFICATES +---------------------------- + +Default: ``False`` + +Whether the HTTPS download handlers should verify the server TLS certificate +when making a request and abort the request if the verification fails. + +.. note:: + + Handling of this setting needs to be implemented inside the :ref:`download + handler `, so it's not guaranteed to be supported + by all 3rd-party handlers. The exact behavior of a handler (e.g. whether + certificate problems are logged when this setting is set to ``False``) + depends on its implementation. + .. setting:: DUPEFILTER_CLASS DUPEFILTER_CLASS @@ -1054,9 +1078,9 @@ interface:: class MyDupeFilter: @classmethod - def from_settings(cls, settings): + def from_crawler(cls, crawler): """Returns an instance of this duplicate request filtering class - based on the current crawl settings.""" + based on the current Crawler instance.""" return cls() def request_seen(self, request): @@ -1116,7 +1140,7 @@ command will prefer it over the default setting. EXTENSIONS ---------- -Default:: ``{}`` +Default: ``{}`` :ref:`Component priority dictionary ` of enabled extensions. See :ref:`topics-extensions`. @@ -1163,7 +1187,7 @@ FEED_STORAGE_GCS_ACL -------------------- The Access Control List (ACL) used when storing items to :ref:`Google Cloud Storage `. -For more information on how to set this value, please refer to the column *JSON API* in `Google Cloud documentation `_. +For more information on how to set this value, please refer to the column *JSON API* in `Google Cloud documentation `_. .. setting:: FORCE_CRAWLER_PROCESS @@ -1194,6 +1218,12 @@ Default: ``True`` Whether or not to use passive mode when initiating FTP transfers. +.. note:: + + Handling of this setting needs to be implemented inside the :ref:`download + handler `, so it's not guaranteed to be supported + by all 3rd-party handlers. + .. reqmeta:: ftp_password .. setting:: FTP_PASSWORD @@ -1213,6 +1243,12 @@ in ``Request`` meta. .. _RFC 1635: https://datatracker.ietf.org/doc/html/rfc1635 +.. note:: + + Handling of this setting needs to be implemented inside the :ref:`download + handler `, so it's not guaranteed to be supported + by all 3rd-party handlers. + .. reqmeta:: ftp_user .. setting:: FTP_USER @@ -1224,6 +1260,12 @@ Default: ``"anonymous"`` The username to use for FTP connections when there is no ``"ftp_user"`` in ``Request`` meta. +.. note:: + + Handling of this setting needs to be implemented inside the :ref:`download + handler `, so it's not guaranteed to be supported + by all 3rd-party handlers. + .. setting:: GCS_PROJECT_ID GCS_PROJECT_ID @@ -1435,13 +1477,12 @@ MEMUSAGE_ENABLED Default: ``True`` -Scope: ``scrapy.extensions.memusage`` +Scope: ``scrapy.extensions.memusage.MemoryUsage`` Whether to enable the memory usage extension. This extension keeps track of a peak memory used by the process (it writes it to stats). It can also optionally shutdown the Scrapy process when it exceeds a memory limit -(see :setting:`MEMUSAGE_LIMIT_MB`), and notify by email when that happened -(see :setting:`MEMUSAGE_NOTIFY_MAIL`). +(see :setting:`MEMUSAGE_LIMIT_MB`). See :ref:`topics-extensions-ref-memusage`. @@ -1452,10 +1493,11 @@ MEMUSAGE_LIMIT_MB Default: ``0`` -Scope: ``scrapy.extensions.memusage`` +Scope: ``scrapy.extensions.memusage.MemoryUsage`` The maximum amount of memory to allow (in megabytes) before shutting down -Scrapy (if MEMUSAGE_ENABLED is True). If zero, no check will be performed. +Scrapy (if :setting:`MEMUSAGE_ENABLED` is ``True``). If zero, no check will be +performed. See :ref:`topics-extensions-ref-memusage`. @@ -1466,7 +1508,7 @@ MEMUSAGE_CHECK_INTERVAL_SECONDS Default: ``60.0`` -Scope: ``scrapy.extensions.memusage`` +Scope: ``scrapy.extensions.memusage.MemoryUsage`` The :ref:`Memory usage extension ` checks the current memory usage, versus the limits set by @@ -1477,23 +1519,6 @@ This sets the length of these intervals, in seconds. See :ref:`topics-extensions-ref-memusage`. -.. setting:: MEMUSAGE_NOTIFY_MAIL - -MEMUSAGE_NOTIFY_MAIL --------------------- - -Default: ``False`` - -Scope: ``scrapy.extensions.memusage`` - -A list of emails to notify if the memory limit has been reached. - -Example:: - - MEMUSAGE_NOTIFY_MAIL = ['user@example.com'] - -See :ref:`topics-extensions-ref-memusage`. - .. setting:: MEMUSAGE_WARNING_MB MEMUSAGE_WARNING_MB @@ -1501,10 +1526,13 @@ MEMUSAGE_WARNING_MB Default: ``0`` -Scope: ``scrapy.extensions.memusage`` +Scope: ``scrapy.extensions.memusage.MemoryUsage`` -The maximum amount of memory to allow (in megabytes) before sending a warning -email notifying about it. If zero, no warning will be produced. +The maximum amount of memory to allow (in megabytes) before sending a +:signal:`memusage_warning_reached` signal (if :setting:`MEMUSAGE_ENABLED` is +``True``). If zero, no signal will be sent. + +See :ref:`topics-extensions-ref-memusage`. .. setting:: NEWSPIDER_MODULE @@ -1588,10 +1616,10 @@ the user agent to use in the robots.txt file. SCHEDULER --------- -Default: ``'scrapy.core.scheduler.Scheduler'`` +Default: :class:`~scrapy.core.scheduler.Scheduler` -The scheduler class to be used for crawling. -See the :ref:`topics-scheduler` topic for details. +The scheduler class to be used for crawling. See :ref:`topics-scheduler` for +details. .. setting:: SCHEDULER_DEBUG @@ -1641,14 +1669,15 @@ Type of in-memory queue used by the scheduler. Other available type is: SCHEDULER_PRIORITY_QUEUE ------------------------ -Default: ``'scrapy.pqueues.ScrapyPriorityQueue'`` +Default: :class:`~scrapy.pqueues.DownloaderAwarePriorityQueue` -Type of priority queue used by the scheduler. Another available type is -``scrapy.pqueues.DownloaderAwarePriorityQueue``. -``scrapy.pqueues.DownloaderAwarePriorityQueue`` works better than -``scrapy.pqueues.ScrapyPriorityQueue`` when you crawl many different -domains in parallel. But currently ``scrapy.pqueues.DownloaderAwarePriorityQueue`` -does not work together with :setting:`CONCURRENT_REQUESTS_PER_IP`. +Type of priority queue used by the scheduler. + +Another available type is :class:`~scrapy.pqueues.ScrapyPriorityQueue`. + +:class:`~scrapy.pqueues.DownloaderAwarePriorityQueue` works better than +:class:`~scrapy.pqueues.ScrapyPriorityQueue` when you crawl many different +domains in parallel. .. setting:: SCHEDULER_START_DISK_QUEUE @@ -1700,8 +1729,6 @@ For available choices, see :setting:`SCHEDULER_MEMORY_QUEUE`. SCRAPER_SLOT_MAX_ACTIVE_SIZE ---------------------------- -.. versionadded:: 2.0 - Default: ``5_000_000`` Soft limit (in bytes) for response data being processed. @@ -1714,7 +1741,7 @@ Scrapy does not process new requests. SPIDER_CONTRACTS ---------------- -Default:: ``{}`` +Default: ``{}`` A dict containing the spider contracts enabled in your project, used for testing spiders. For more info see :ref:`topics-contracts`. @@ -1775,7 +1802,7 @@ warning by setting ``SPIDER_LOADER_WARN_ONLY = True``. SPIDER_MIDDLEWARES ------------------ -Default:: ``{}`` +Default: ``{}`` A dict containing the spider middlewares enabled in your project, and their orders. For more info see :ref:`topics-spider-middleware-setting`. @@ -1837,22 +1864,12 @@ finishes. For more info see: :ref:`topics-stats`. -.. setting:: STATSMAILER_RCPTS - -STATSMAILER_RCPTS ------------------ - -Default: ``[]`` (empty list) - -Send Scrapy stats after spiders finish scraping. See -:class:`~scrapy.extensions.statsmailer.StatsMailer` for more info. - .. setting:: TELNETCONSOLE_ENABLED TELNETCONSOLE_ENABLED --------------------- -Default: ``True`` +Default: ``True`` (``False`` when :setting:`TWISTED_REACTOR_ENABLED` is ``False``) A boolean which specifies if the :ref:`telnet console ` will be enabled (provided its extension is also enabled). @@ -1871,13 +1888,40 @@ command. The project name must not conflict with the name of custom files or directories in the ``project`` subdirectory. +.. setting:: TWISTED_REACTOR_ENABLED + +TWISTED_REACTOR_ENABLED +----------------------- + +Default: ``True`` + +Whether to install and use the Twisted reactor. + +If this is set to ``True``, Scrapy will use the Twisted reactor and will +install one according to the :setting:`TWISTED_REACTOR` setting value when +appropriate (e.g. when running via :ref:`the command-line tool +`). This is the traditional mode of using Scrapy. + +If this is set to ``False``, Scrapy will use the asyncio event loop directly +and will not attempt to install or use a reactor. Features that require a +reactor won't be available, but Twisted APIs that don't require a reactor, +including :class:`~twisted.internet.defer.Deferred` and +:class:`~twisted.python.failure.Failure`, will still be available. On the other +hand, limitations related to Twisted reactors (such as not being able to start +a reactor in the same process where a reactor was previously started and +stopped) will not apply. This mode is currently experimental and may not be +suitable for production use. It may also not be supported by 3rd-party code. +See :ref:`asyncio-without-reactor` for more information about this mode. + +.. note:: This setting can't be set :ref:`per-spider `. + +.. versionadded:: 2.15.0 + .. setting:: TWISTED_REACTOR TWISTED_REACTOR --------------- -.. versionadded:: 2.0 - Default: ``"twisted.internet.asyncioreactor.AsyncioSelectorReactor"`` Import path of a given :mod:`~twisted.internet.reactor`. @@ -1906,6 +1950,7 @@ reactor is installed. In order to use the reactor installed by Scrapy: +.. skip: next .. code-block:: python import scrapy @@ -1969,11 +2014,6 @@ If this setting is set ``None``, Scrapy will use the existing reactor if one is already installed, or install the default reactor defined by Twisted for the current platform. -.. versionchanged:: 2.7 - The :command:`startproject` command now sets this setting to - ``twisted.internet.asyncioreactor.AsyncioSelectorReactor`` in the generated - ``settings.py`` file. - .. versionchanged:: 2.13 The default value was changed from ``None`` to ``"twisted.internet.asyncioreactor.AsyncioSelectorReactor"``. @@ -2002,7 +2042,7 @@ Use ``0`` to allow URLs of any length. The default value is copied from the `Microsoft Internet Explorer maximum URL length`_, even though this setting exists for different reasons. -.. _Microsoft Internet Explorer maximum URL length: https://support.microsoft.com/en-us/topic/maximum-url-length-is-2-083-characters-in-internet-explorer-174e7c8a-6666-f4e0-6fd6-908b53c12246 +.. _Microsoft Internet Explorer maximum URL length: https://web.archive.org/web/20250206050143/https://support.microsoft.com/en-us/topic/maximum-url-length-is-2-083-characters-in-internet-explorer-174e7c8a-6666-f4e0-6fd6-908b53c12246 .. setting:: USER_AGENT @@ -2041,6 +2081,4 @@ case to see how to enable and use them. .. settingslist:: .. _Amazon web services: https://aws.amazon.com/ -.. _breadth-first order: https://en.wikipedia.org/wiki/Breadth-first_search -.. _depth-first order: https://en.wikipedia.org/wiki/Depth-first_search .. _Google Cloud Storage: https://cloud.google.com/storage/ diff --git a/docs/topics/shell.rst b/docs/topics/shell.rst index 85a08cebd..5b826ed18 100644 --- a/docs/topics/shell.rst +++ b/docs/topics/shell.rst @@ -24,7 +24,7 @@ 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. -We highly recommend you install `IPython`_, specially if you're working on +We highly recommend you install `IPython`_, especially if you're working on Unix systems (where `IPython`_ excels). See the `IPython installation guide`_ for more info. @@ -40,7 +40,7 @@ variable; or by defining it in your :ref:`scrapy.cfg `:: shell = bpython .. _IPython: https://ipython.org/ -.. _IPython installation guide: https://ipython.org/install.html +.. _IPython installation guide: https://ipython.org/install/ .. _bpython: https://bpython-interpreter.org/ Launch the shell @@ -111,7 +111,7 @@ Available Shortcuts Note, however, that this will create a temporary file in your computer, which won't be removed automatically. -.. _ tag: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/base +.. _ tag: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/base Available Scrapy objects ------------------------ @@ -145,7 +145,7 @@ 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. diff --git a/docs/topics/signals.rst b/docs/topics/signals.rst index aa27e62dd..d13733623 100644 --- a/docs/topics/signals.rst +++ b/docs/topics/signals.rst @@ -356,6 +356,18 @@ feed_exporter_closed This signal supports :ref:`asynchronous handlers `. +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 `. + Request signals --------------- @@ -423,8 +435,6 @@ 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. @@ -442,8 +452,6 @@ bytes_received .. signal:: bytes_received .. function:: bytes_received(data, request, spider) - .. versionadded:: 2.2 - Sent by the HTTP 1.1 and S3 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, @@ -472,8 +480,6 @@ headers_received .. signal:: headers_received .. function:: headers_received(headers, body_length, request, spider) - .. versionadded:: 2.5 - Sent by the HTTP 1.1 and S3 download handlers when the response headers are available for a given request, before downloading any additional content. diff --git a/docs/topics/spider-middleware.rst b/docs/topics/spider-middleware.rst index 67178b8fd..99bbdf292 100644 --- a/docs/topics/spider-middleware.rst +++ b/docs/topics/spider-middleware.rst @@ -94,7 +94,7 @@ one or more of these methods: def process_start_requests(self, start, spider): yield from start - .. method:: process_spider_input(response, spider) + .. method:: process_spider_input(response) This method is called for each response that goes through the spider middleware and into the spider, for processing. @@ -116,52 +116,31 @@ one or more of these methods: :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 objects - `. - - .. versionchanged:: 2.7 - This method may be defined as an :term:`asynchronous generator`, in - which case ``result`` is an :term:`asynchronous iterable`. - - Consider defining this method as an :term:`asynchronous generator`, - which will be a requirement in a future version of Scrapy. However, if - you plan on sharing your spider middleware with other people, consider - either :ref:`enforcing Scrapy 2.7 ` - as a minimum requirement of your spider middleware, or :ref:`making - your spider middleware universal ` so that - it works with Scrapy versions earlier than Scrapy 2.7. + .. 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 objects ` + :param result: the results from the spider + :type result: an :term:`asynchronous iterable` of + :class:`~scrapy.Request` objects and :ref:`item objects + ` - :param spider: the spider whose result is being processed - :type spider: :class:`~scrapy.Spider` object - - .. method:: process_spider_output_async(response, result, spider) + .. method:: process_spider_output_async(response, result) :async: - .. versionadded:: 2.7 + Alternative name for :meth:`process_spider_output` used when + implementing a :ref:`universal spider middleware + `. - If defined, this method must be an :term:`asynchronous generator`, - which will be called instead of :meth:`process_spider_output` if - ``result`` is an :term:`asynchronous iterable`. - - .. method:: process_spider_exception(response, exception, spider) + .. 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. @@ -186,16 +165,41 @@ one or more of these methods: :param exception: the exception raised :type exception: :exc:`Exception` object - :param spider: the spider which raised the exception - :type spider: :class:`~scrapy.Spider` object + +.. _universal-spider-middleware: + +Universal spider middlewares +---------------------------- + +In Scrapy 2.6.3 and lower, ``process_spider_output()`` must be a *synchronous* +generator. + +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. + +For example: + +.. code-block:: python + + class UniversalSpiderMiddleware: + async def process_spider_output_async(self, response, result): + async for r in result: + # ... do something with r + yield r + + def process_spider_output(self, response, result): + for r in result: + # ... do something with r + yield r 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 and -reducing the amount of boilerplate code in :ref:`universal middlewares -`. +to use it but it can help with simplifying middleware implementations. .. module:: scrapy.spidermiddlewares.base @@ -354,7 +358,7 @@ Default: ``'scrapy.spidermiddlewares.referer.DefaultReferrerPolicy'`` 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 or more comma-separated standard W3C-defined string values, - or the special ``"scrapy-default"``. @@ -373,6 +377,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"`_, @@ -416,6 +422,25 @@ 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 +`__. + StartSpiderMiddleware --------------------- diff --git a/docs/topics/spiders.rst b/docs/topics/spiders.rst index 8240d5d4b..506daf930 100644 --- a/docs/topics/spiders.rst +++ b/docs/topics/spiders.rst @@ -198,7 +198,7 @@ scrapy.Spider 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. + the same requirements as the :class:`~scrapy.Spider` class. This method, as well as any other Request callback, must return a :class:`~scrapy.Request` object, an :ref:`item object `, an @@ -354,16 +354,57 @@ 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 @@ -411,13 +452,14 @@ with a ``TestItem`` declared in a ``myproject.items`` module: .. code-block:: python - import scrapy + from dataclasses import dataclass - class TestItem(scrapy.Item): - id = scrapy.Field() - name = scrapy.Field() - description = scrapy.Field() + @dataclass + class TestItem: + id: str | None = None + name: str | None = None + description: str | None = None .. currentmodule:: scrapy.spiders @@ -503,9 +545,6 @@ 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 ~~~~~~~~~~~~~~~~~~~ @@ -513,7 +552,6 @@ 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 @@ -533,7 +571,7 @@ Let's now take a look at an example CrawlSpider with rules: def parse_item(self, response): self.logger.info("Hi, this is an item page! %s", response.url) - item = scrapy.Item() + 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( @@ -628,7 +666,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 `, a :class:`~scrapy.Request` object, or an iterable containing any of them. @@ -671,9 +709,9 @@ These spiders are pretty easy to use, let's have a look at one example: ) 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 @@ -735,9 +773,9 @@ Let's see an example similar to the previous one, but using a 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 @@ -938,6 +976,7 @@ Combine SitemapSpider with other sources of urls: def parse_other(self, response): 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/ diff --git a/docs/topics/stats.rst b/docs/topics/stats.rst index e34999b58..ac714eacb 100644 --- a/docs/topics/stats.rst +++ b/docs/topics/stats.rst @@ -121,4 +121,3 @@ DummyStatsCollector 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. - diff --git a/docs/topics/telnetconsole.rst b/docs/topics/telnetconsole.rst index ae9cb634c..e274edc9b 100644 --- a/docs/topics/telnetconsole.rst +++ b/docs/topics/telnetconsole.rst @@ -26,6 +26,9 @@ 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``. + .. highlight:: none How to access the telnet console @@ -43,12 +46,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:: @@ -91,8 +94,6 @@ convenience: +----------------+-------------------------------------------------------------------+ | ``p`` | a shortcut to the :func:`pprint.pprint` function | +----------------+-------------------------------------------------------------------+ -| ``hpy`` | for memory debugging (see :ref:`topics-leaks`) | -+----------------+-------------------------------------------------------------------+ Telnet console usage examples ============================= diff --git a/docs/versioning.rst b/docs/versioning.rst index 9d02757b0..0c6498244 100644 --- a/docs/versioning.rst +++ b/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. @@ -63,7 +63,3 @@ feature. All deprecated features removed in a Scrapy release are explicitly mentioned in the :ref:`release notes `. - - -.. _odd-numbered versions for development releases: https://en.wikipedia.org/wiki/Software_versioning#Odd-numbered_versions_for_development_releases - diff --git a/extras/qps-bench-server.py b/extras/qps-bench-server.py index 734614aa5..569438574 100755 --- a/extras/qps-bench-server.py +++ b/extras/qps-bench-server.py @@ -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): diff --git a/extras/qpsclient.py b/extras/qpsclient.py index 269b27336..8e5001c1d 100644 --- a/extras/qpsclient.py +++ b/extras/qpsclient.py @@ -35,10 +35,6 @@ class QPSSpider(Spider): self.download_delay = float(self.download_delay) async def start(self): - for item_or_request in self.start_requests(): - yield item_or_request - - def start_requests(self): url = self.benchurl if self.latency is not None: url += f"?latency={self.latency}" diff --git a/pyproject.toml b/pyproject.toml index bc809a7b1..6b0c561f8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,13 +13,13 @@ dependencies = [ "defusedxml>=0.7.1", "itemadapter>=0.1.0", "itemloaders>=1.0.1", - "lxml>=4.6.0", + "lxml>=4.6.4", "packaging", "parsel>=1.5.0", "protego>=0.1.15", "pyOpenSSL>=22.0.0", "queuelib>=1.4.2", - "service_identity>=18.1.0", + "service_identity>=23.1.0", "tldextract", "w3lib>=1.17.0", "zope.interface>=5.1.0", @@ -35,11 +35,11 @@ classifiers = [ "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Internet :: WWW/HTTP", @@ -49,7 +49,7 @@ classifiers = [ license = "BSD-3-Clause" license-files = ["LICENSE", "AUTHORS"] readme = "README.rst" -requires-python = ">=3.9" +requires-python = ">=3.10" authors = [{ name = "Scrapy developers", email = "pablo@pablohoffman.com" }] maintainers = [{ name = "Pablo Hoffman", email = "pablo@pablohoffman.com" }] @@ -85,8 +85,17 @@ path = "scrapy/VERSION" pattern = "^(?P.+)$" [tool.mypy] -ignore_missing_imports = true -implicit_reexport = false +strict = true +extra_checks = false # weird addErrback() errors +untyped_calls_exclude = [ + "twisted", +] + +[[tool.mypy.overrides]] +module = "tests.*" +allow_untyped_defs = true +allow_incomplete_defs = true # 48 errors +check_untyped_defs = false # Interface classes are hard to support [[tool.mypy.overrides]] @@ -101,21 +110,34 @@ ignore_errors = true module = "twisted.internet.reactor" follow_imports = "skip" -# FIXME: remove the following section once the issues are solved -[[tool.mypy.overrides]] -module = "scrapy.settings.default_settings" -ignore_errors = true - -[[tool.mypy.overrides]] -module = "itemadapter" -implicit_reexport = true - +# just for twisted.version [[tool.mypy.overrides]] module = "twisted" implicit_reexport = true +# TODO +[[tool.mypy.overrides]] +module = "scrapy.settings.default_settings" +ignore_errors = true + +# usually no type hints +[[tool.mypy.overrides]] +module = [ + "bpython", + "brotli", + "brotlicffi", + "google.*", + "pydispatch.*", + "pyftpdlib.*", + "pytest_twisted", + "robotexclusionrulesparser", + "testfixtures", + "zope.interface.*", +] +ignore_missing_imports = true + [tool.bumpversion] -current_version = "2.13.2" +current_version = "2.16.0" commit = true tag = true tag_name = "{new_version}" @@ -135,10 +157,15 @@ parse = """(?P0|[1-9]\\d*)\\.(?P0|[1-9]\\d*)""" serialize = ["{major}.{minor}"] [tool.coverage.run] +# sysmon, default on 3.14, is too slow: https://github.com/coveragepy/coveragepy/issues/2172 +core = "ctrace" branch = true include = ["scrapy/*"] omit = ["tests/*"] disable_warnings = ["include-ignored"] +patch = [ + "subprocess", +] [tool.coverage.paths] source = [ @@ -148,8 +175,8 @@ source = [ [tool.coverage.report] exclude_also = [ - "if TYPE_CHECKING:", "@(abc\\.)?abstractmethod", + '\A(?s:.*# pragma: no file cover.*)\Z', ] [tool.pylint.MASTER] @@ -158,6 +185,7 @@ jobs = 1 # >1 hides results extension-pkg-allow-list=[ "lxml", ] +load-plugins = ["pylint_per_file_ignores"] [tool.pylint."MESSAGES CONTROL"] enable = [ @@ -175,7 +203,6 @@ disable = [ "disallowed-name", "duplicate-code", # https://github.com/pylint-dev/pylint/issues/214 "fixme", - "import-outside-toplevel", "inherit-non-class", # false positives with create_deprecated_class() "invalid-name", "invalid-overridden-method", @@ -189,12 +216,10 @@ disable = [ "no-value-for-parameter", # https://github.com/pylint-dev/pylint/issues/3268 "not-callable", "protected-access", - "redefined-builtin", "redefined-outer-name", "too-few-public-methods", "too-many-ancestors", "too-many-arguments", - "too-many-branches", "too-many-function-args", "too-many-instance-attributes", "too-many-lines", @@ -202,46 +227,67 @@ disable = [ "too-many-positional-arguments", "too-many-public-methods", "too-many-return-statements", + "undefined-variable", "unused-argument", - "unused-import", "unused-variable", + "use-implicit-booleaness-not-comparison", "useless-import-alias", # used as a hint to mypy "useless-return", # https://github.com/pylint-dev/pylint/issues/6530 "wrong-import-position", + # Ones that are implemented in ruff and need to be disabled for some lines (listed here to avoid two disable comments) + "bare-except", + "eval-used", + "global-statement", + "import-outside-toplevel", + "import-self", + "inconsistent-return-statements", + "redefined-builtin", + "too-many-branches", + "unused-import", + # Ones that we may want to address (fix, ignore per-line or move to "don't want to fix") - "abstract-method", "arguments-differ", - "arguments-renamed", - "dangerous-default-value", "keyword-arg-before-vararg", - "pointless-statement", - "raise-missing-from", - "unbalanced-tuple-unpacking", - "unnecessary-dunder-call", - "used-before-assignment", +] +# requires `pylint_per_file_ignores` plugin +per-file-ignores = [ + # Extended list of ones that we may want to address, only for tests + "./tests/*:abstract-method,arguments-renamed,dangerous-default-value,pointless-statement,raise-missing-from,unnecessary-dunder-call,used-before-assignment", ] [tool.pytest.ini_options] +addopts = [ + "--reactor=asyncio", +] xfail_strict = true python_files = ["test_*.py", "test_*/__init__.py"] markers = [ - "only_asyncio: marks tests as only enabled when --reactor=asyncio is passed", - "only_not_asyncio: marks tests as only enabled when --reactor=asyncio is not passed", + "only_asyncio: marks tests that require the asyncio loop to be used", + "only_not_asyncio: marks tests that require the asyncio loop to not be used", + "requires_reactor: marks tests that require a reactor", "requires_uvloop: marks tests as only enabled when uvloop is known to be working", "requires_botocore: marks tests that need botocore (but not boto3)", "requires_boto3: marks tests that need botocore and boto3", + "requires_mitmproxy: marks tests that need mitmproxy", + "requires_internet: marks tests that need real Internet access", ] filterwarnings = [ - "ignore::DeprecationWarning:twisted.web.static" + "ignore::DeprecationWarning:twisted.web.static", ] [tool.ruff.lint] extend-select = [ + # flake8-builtins + "A", + # flake8-async + "ASYNC", # flake8-bugbear "B", # flake8-comprehensions "C4", + # flake8-commas + "COM", # pydocstyle "D", # flake8-future-annotations @@ -300,6 +346,8 @@ extend-select = [ ignore = [ # Ones we want to ignore + # Trailing comma missing + "COM812", # Missing docstring in public module "D100", # Missing docstring in public class @@ -334,73 +382,67 @@ ignore = [ "D403", # `try`-`except` within a loop incurs performance overhead "PERF203", - # Import alias does not rename original package - "PLC0414", # Too many return statements "PLR0911", - # Too many branches - "PLR0912", # Too many arguments in function definition "PLR0913", - # Too many statements - "PLR0915", # Magic value used in comparison "PLR2004", - # `for` loop variable overwritten by assignment target - "PLW2901", # String contains ambiguous {}. "RUF001", # Docstring contains ambiguous {}. "RUF002", # Comment contains ambiguous {}. "RUF003", - # Mutable class attributes should be annotated with `typing.ClassVar` - "RUF012", # Use of `assert` detected; needed for mypy "S101", # FTP-related functions are being called; https://github.com/scrapy/scrapy/issues/4180 "S321", - # Argument default set to insecure SSL protocol - "S503", # Use a context manager for opening files "SIM115", # Yoda condition detected "SIM300", - - # Ones that we may want to address (fix, ignore per-line or move to "don't want to fix") - - # Assigning to `os.environ` doesn't clear the environment. - "B003", - # Do not use mutable data structures for argument defaults. - "B006", - # Loop control variable not used within the loop body. - "B007", - # Do not perform function calls in argument defaults. - "B008", - # Found useless expression. - "B018", - # Star-arg unpacking after a keyword argument is strongly discouraged. - "B026", - # No explicit stacklevel argument found. - "B028", - # Within an `except` clause, raise exceptions with `raise ... from` - "B904", - # Use capitalized environment variable - "SIM112", ] [tool.ruff.lint.flake8-tidy-imports] banned-module-level-imports = [ "twisted.internet.reactor", + # indirectly imports twisted.conch.insults.helper which imports twisted.internet.reactor + "twisted.conch.manhole", + # directly imports twisted.internet.reactor + "twisted.protocols.ftp", ] +[tool.ruff.lint.isort] +split-on-trailing-comma = false + [tool.ruff.lint.per-file-ignores] # Circular import workarounds "scrapy/linkextractors/__init__.py" = ["E402"] "scrapy/spiders/__init__.py" = ["E402"] -# Skip bandit in tests -"tests/**" = ["S"] +"tests/**" = [ + # Skip bandit and allow blocking file I/O in tests + "ASYNC240", + "S", + # Ones that we may want to address (fix, ignore per-line or move to "don't want to fix") + # Assigning to `os.environ` doesn't clear the environment. + "B003", + # Do not use mutable data structures for argument defaults. + "B006", + # Found useless expression. + "B018", + # No explicit stacklevel argument found. + "B028", + # Within an `except` clause, raise exceptions with `raise ... from` + "B904", + # `for` loop variable overwritten by assignment target + "PLW2901", + # Mutable class attributes should be annotated with `typing.ClassVar` + "RUF012", + # Use capitalized environment variable + "SIM112", +] # Issues pending a review: "docs/conf.py" = ["E402"] @@ -409,3 +451,6 @@ banned-module-level-imports = [ [tool.ruff.lint.pydocstyle] convention = "pep257" + +[tool.sphinx-scrapy] +python-version = "3.14" # Keep in sync with .github/workflows/checks.yml. diff --git a/scrapy/VERSION b/scrapy/VERSION index 0e83a9a9c..752490696 100644 --- a/scrapy/VERSION +++ b/scrapy/VERSION @@ -1 +1 @@ -2.13.2 +2.16.0 diff --git a/scrapy/__init__.py b/scrapy/__init__.py index 256504c9c..c5b6483e3 100644 --- a/scrapy/__init__.py +++ b/scrapy/__init__.py @@ -29,23 +29,6 @@ __version__ = (pkgutil.get_data(__package__, "VERSION") or b"").decode("ascii"). version_info = tuple(int(v) if v.isdigit() else v for v in __version__.split(".")) -def __getattr__(name: str): - if name == "twisted_version": - import warnings # pylint: disable=reimported - - from twisted import version as _txv - - from scrapy.exceptions import ScrapyDeprecationWarning - - warnings.warn( - "The scrapy.twisted_version attribute is deprecated, use twisted.version instead", - ScrapyDeprecationWarning, - ) - return _txv.major, _txv.minor, _txv.micro - - raise AttributeError - - # Ignore noisy twisted deprecation warnings warnings.filterwarnings("ignore", category=DeprecationWarning, module="twisted") diff --git a/scrapy/__main__.py b/scrapy/__main__.py index 697b9b1e9..17b1aa538 100644 --- a/scrapy/__main__.py +++ b/scrapy/__main__.py @@ -1,3 +1,4 @@ +# pragma: no file cover from scrapy.cmdline import execute if __name__ == "__main__": diff --git a/scrapy/addons.py b/scrapy/addons.py index 1024d2dcd..2e12f8c8a 100644 --- a/scrapy/addons.py +++ b/scrapy/addons.py @@ -55,7 +55,7 @@ class AddonManager: ) @classmethod - def load_pre_crawler_settings(cls, settings: BaseSettings): + def load_pre_crawler_settings(cls, settings: BaseSettings) -> None: """Update early settings that do not require a crawler instance, such as SPIDER_MODULES. Similar to the load_settings method, this loads each add-on configured in the diff --git a/scrapy/cmdline.py b/scrapy/cmdline.py index 2b0204071..6c306afdb 100644 --- a/scrapy/cmdline.py +++ b/scrapy/cmdline.py @@ -6,13 +6,13 @@ import inspect import os import sys from importlib.metadata import entry_points -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, ParamSpec import scrapy from scrapy.commands import BaseRunSpiderCommand, ScrapyCommand, ScrapyHelpFormatter from scrapy.crawler import AsyncCrawlerProcess, CrawlerProcess from scrapy.exceptions import UsageError -from scrapy.utils.misc import walk_modules +from scrapy.utils.misc import walk_modules_iter from scrapy.utils.project import get_project_settings, inside_project from scrapy.utils.python import garbage_collect from scrapy.utils.reactor import _asyncio_reactor_path @@ -20,12 +20,9 @@ from scrapy.utils.reactor import _asyncio_reactor_path if TYPE_CHECKING: from collections.abc import Callable, Iterable - # typing.ParamSpec requires Python 3.10 - from typing_extensions import ParamSpec - from scrapy.settings import BaseSettings, Settings - _P = ParamSpec("_P") +_P = ParamSpec("_P") class ScrapyArgumentParser(argparse.ArgumentParser): @@ -43,13 +40,13 @@ class ScrapyArgumentParser(argparse.ArgumentParser): def _iter_command_classes(module_name: str) -> Iterable[type[ScrapyCommand]]: # TODO: add `name` attribute to commands and merge this function with # scrapy.utils.spider.iter_spider_classes - for module in walk_modules(module_name): + for module in walk_modules_iter(module_name): for obj in vars(module).values(): if ( inspect.isclass(obj) and issubclass(obj, ScrapyCommand) and obj.__module__ == module.__name__ - and obj not in (ScrapyCommand, BaseRunSpiderCommand) + and obj not in {ScrapyCommand, BaseRunSpiderCommand} ): yield obj @@ -67,11 +64,7 @@ def _get_commands_from_entry_points( inproject: bool, group: str = "scrapy.commands" ) -> dict[str, ScrapyCommand]: cmds: dict[str, ScrapyCommand] = {} - if sys.version_info >= (3, 10): - eps = entry_points(group=group) - else: - eps = entry_points().get(group, ()) - for entry_point in eps: + for entry_point in entry_points(group=group): obj = entry_point.load() if inspect.isclass(obj): cmds[entry_point.name] = obj() @@ -115,17 +108,24 @@ def _print_header(settings: BaseSettings, inproject: bool) -> None: def _print_commands(settings: BaseSettings, inproject: bool) -> None: _print_header(settings, inproject) - print("Usage:") - print(" scrapy [options] [args]\n") - print("Available commands:") + print( + "Usage:\n", + " scrapy [options] [args]\n", + "Available commands:\n", + ) cmds = _get_commands_dict(settings, inproject) - for cmdname, cmdclass in sorted(cmds.items()): - print(f" {cmdname:<13} {cmdclass.short_desc()}") + print( + "\n".join( + f" {cmdname:<13} {cmdclass.short_desc()}" + for cmdname, cmdclass in sorted(cmds.items()) + ) + ) if not inproject: - print() - print(" [ more ] More commands available when run from project directory") - print() - print('Use "scrapy -h" to see more info about a command') + print( + "\n", + " [ more ] More commands available when run from project directory", + ) + print("\n", 'Use "scrapy -h" to see more info about a command') def _print_unknown_command_msg( @@ -204,9 +204,10 @@ def execute(argv: list[str] | None = None, settings: Settings | None = None) -> _run_print_help(parser, cmd.process_options, args, opts) if cmd.requires_crawler_process: - if settings[ - "TWISTED_REACTOR" - ] == _asyncio_reactor_path and not settings.getbool("FORCE_CRAWLER_PROCESS"): + if ( + settings["TWISTED_REACTOR"] == _asyncio_reactor_path + and not settings.getbool("FORCE_CRAWLER_PROCESS") + ) or not settings.getbool("TWISTED_REACTOR_ENABLED"): cmd.crawler_process = AsyncCrawlerProcess(settings) else: cmd.crawler_process = CrawlerProcess(settings) diff --git a/scrapy/commands/__init__.py b/scrapy/commands/__init__.py index 4ce070e6e..598e8060e 100644 --- a/scrapy/commands/__init__.py +++ b/scrapy/commands/__init__.py @@ -7,13 +7,17 @@ from __future__ import annotations import argparse import builtins import os +import warnings +from abc import ABC, abstractmethod from pathlib import Path -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, ClassVar from twisted.python import failure -from scrapy.exceptions import UsageError +from scrapy.exceptions import ScrapyDeprecationWarning, UsageError from scrapy.utils.conf import arglist_to_dict, feed_process_params_from_cli +from scrapy.utils.deprecate import method_is_overridden +from scrapy.utils.python import global_object_name if TYPE_CHECKING: from collections.abc import Iterable @@ -22,20 +26,33 @@ if TYPE_CHECKING: from scrapy.settings import Settings -class ScrapyCommand: +class ScrapyCommand(ABC): requires_project: bool = False requires_crawler_process: bool = True crawler_process: CrawlerProcessBase | None = None # set in scrapy.cmdline # default settings to be used for this command instead of global defaults - default_settings: dict[str, Any] = {} + default_settings: ClassVar[dict[str, Any]] = {} exitcode: int = 0 def __init__(self) -> None: self.settings: Settings | None = None # set in scrapy.cmdline + if method_is_overridden(self.__class__, ScrapyCommand, "help"): + warnings.warn( + "The ScrapyCommand.help() method is deprecated and overriding " + f"it, as the {global_object_name(self.__class__)} class does, " + "has no effect; override long_desc() instead.", + ScrapyDeprecationWarning, + stacklevel=2, + ) - def set_crawler(self, crawler: Crawler) -> None: + def set_crawler(self, crawler: Crawler) -> None: # pragma: no cover + warnings.warn( + "ScrapyCommand.set_crawler() is deprecated", + ScrapyDeprecationWarning, + stacklevel=2, + ) if hasattr(self, "_crawler"): raise RuntimeError("crawler already set") self._crawler: Crawler = crawler @@ -46,6 +63,7 @@ class ScrapyCommand: """ return "" + @abstractmethod def short_desc(self) -> str: """ A short description of the command @@ -60,10 +78,11 @@ class ScrapyCommand: return self.short_desc() def help(self) -> str: - """An extensive help for the command. It will be shown when using the - "help" command. It can contain newlines since no post-formatting will - be applied to its contents. - """ + warnings.warn( + "ScrapyCommand.help() is deprecated, use long_desc() instead.", + ScrapyDeprecationWarning, + stacklevel=2, + ) return self.long_desc() def add_options(self, parser: argparse.ArgumentParser) -> None: @@ -107,7 +126,9 @@ class ScrapyCommand: try: self.settings.setdict(arglist_to_dict(opts.set), priority="cmdline") except ValueError: - raise UsageError("Invalid -s value, use -s NAME=VALUE", print_help=False) + raise UsageError( + "Invalid -s value, use -s NAME=VALUE", print_help=False + ) from None if opts.logfile: self.settings.set("LOG_ENABLED", True, priority="cmdline") @@ -128,6 +149,7 @@ class ScrapyCommand: if opts.pdb: failure.startDebugMode() + @abstractmethod def run(self, args: list[str], opts: argparse.Namespace) -> None: """ Entry point for running commands @@ -172,7 +194,9 @@ class BaseRunSpiderCommand(ScrapyCommand): try: opts.spargs = arglist_to_dict(opts.spargs) except ValueError: - raise UsageError("Invalid -a value, use -a NAME=VALUE", print_help=False) + raise UsageError( + "Invalid -a value, use -a NAME=VALUE", print_help=False + ) from None if opts.output or opts.overwrite_output: assert self.settings is not None feeds = feed_process_params_from_cli( @@ -216,7 +240,7 @@ class ScrapyHelpFormatter(argparse.HelpFormatter): headings = [ i for i in range(len(part_strings)) if part_strings[i].endswith(":\n") ] - for index in headings[::-1]: + for index in reversed(headings): char = "-" if "Global Options" in part_strings[index] else "=" part_strings[index] = part_strings[index][:-2].title() underline = "".join(["\n", (char * len(part_strings[index])), "\n"]) diff --git a/scrapy/commands/bench.py b/scrapy/commands/bench.py index 96bb1ae84..0a5b431a2 100644 --- a/scrapy/commands/bench.py +++ b/scrapy/commands/bench.py @@ -3,13 +3,14 @@ from __future__ import annotations import subprocess import sys import time -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, ClassVar from urllib.parse import urlencode import scrapy from scrapy.commands import ScrapyCommand from scrapy.http import Response, TextResponse from scrapy.linkextractors import LinkExtractor +from scrapy.utils.test import get_testenv if TYPE_CHECKING: import argparse @@ -17,7 +18,7 @@ if TYPE_CHECKING: class Command(ScrapyCommand): - default_settings = { + default_settings: ClassVar[dict[str, Any]] = { "LOG_LEVEL": "INFO", "LOGSTATS_INTERVAL": 1, "CLOSESPIDER_TIMEOUT": 10, @@ -35,8 +36,6 @@ class Command(ScrapyCommand): class _BenchServer: def __enter__(self) -> None: - from scrapy.utils.test import get_testenv - pargs = [sys.executable, "-u", "-m", "scrapy.utils.benchserver"] self.proc = subprocess.Popen( # noqa: S603 pargs, stdout=subprocess.PIPE, env=get_testenv() @@ -44,7 +43,7 @@ class _BenchServer: assert self.proc.stdout self.proc.stdout.readline() - def __exit__(self, exc_type, exc_value, traceback) -> None: + def __exit__(self, exc_type, exc_value, traceback) -> None: # type: ignore[no-untyped-def] self.proc.kill() self.proc.wait() time.sleep(0.2) diff --git a/scrapy/commands/check.py b/scrapy/commands/check.py index e9ada0fb6..2113c19d2 100644 --- a/scrapy/commands/check.py +++ b/scrapy/commands/check.py @@ -1,9 +1,12 @@ import argparse import time from collections import defaultdict +from collections.abc import AsyncIterator +from typing import Any, ClassVar from unittest import TextTestResult as _TextTestResult from unittest import TextTestRunner +from scrapy import Spider from scrapy.commands import ScrapyCommand from scrapy.contracts import ContractsManager from scrapy.utils.conf import build_component_list @@ -41,7 +44,7 @@ class TextTestResult(_TextTestResult): class Command(ScrapyCommand): requires_project = True - default_settings = {"LOG_ENABLED": False} + default_settings: ClassVar[dict[str, Any]] = {"LOG_ENABLED": False} def syntax(self) -> str: return "[options] " @@ -70,7 +73,9 @@ class Command(ScrapyCommand): def run(self, args: list[str], opts: argparse.Namespace) -> None: # load contracts assert self.settings is not None - contracts = build_component_list(self.settings.getwithbase("SPIDER_CONTRACTS")) + contracts = build_component_list( + self.settings.get_component_priority_dict_with_base("SPIDER_CONTRACTS") + ) conman = ContractsManager(load_object(c) for c in contracts) runner = TextTestRunner(verbosity=2 if opts.verbose else 1) result = TextTestResult(runner.stream, runner.descriptions, runner.verbosity) @@ -81,14 +86,14 @@ class Command(ScrapyCommand): assert self.crawler_process spider_loader = self.crawler_process.spider_loader - async def start(self): + async def start(self: Spider) -> AsyncIterator[Any]: for request in conman.from_spider(self, result): yield request with set_environ(SCRAPY_CHECK="true"): for spidername in args or spider_loader.list(): spidercls = spider_loader.load(spidername) - spidercls.start = start # type: ignore[assignment,method-assign,return-value] + spidercls.start = start # type: ignore[method-assign] tested_methods = conman.tested_methods_from_spidercls(spidercls) if opts.list: @@ -99,16 +104,18 @@ class Command(ScrapyCommand): # start checks if opts.list: - for spider, methods in sorted(contract_reqs.items()): - if not methods and not opts.verbose: - continue - print(spider) - for method in sorted(methods): - print(f" * {method}") + print( + "\n".join( + f"{spider}\n" + + "\n".join(f" * {method}" for method in sorted(methods)) + for spider, methods in sorted(contract_reqs.items()) + if methods or opts.verbose + ) + ) else: - start_time = time.time() + start_time = time.monotonic() self.crawler_process.start() - stop = time.time() + stop = time.monotonic() result.printErrors() result.printSummary(start_time, stop) diff --git a/scrapy/commands/edit.py b/scrapy/commands/edit.py index f2d52673a..cd7c57f28 100644 --- a/scrapy/commands/edit.py +++ b/scrapy/commands/edit.py @@ -1,6 +1,7 @@ import argparse import os import sys +from typing import Any, ClassVar from scrapy.commands import ScrapyCommand from scrapy.exceptions import UsageError @@ -10,7 +11,7 @@ from scrapy.spiderloader import get_spider_loader class Command(ScrapyCommand): requires_project = True requires_crawler_process = False - default_settings = {"LOG_ENABLED": False} + default_settings: ClassVar[dict[str, Any]] = {"LOG_ENABLED": False} def syntax(self) -> str: return "" diff --git a/scrapy/commands/fetch.py b/scrapy/commands/fetch.py index 1b1d2442f..0b8311efb 100644 --- a/scrapy/commands/fetch.py +++ b/scrapy/commands/fetch.py @@ -2,7 +2,7 @@ from __future__ import annotations import sys from argparse import Namespace # noqa: TC003 -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, Any from w3lib.url import is_url @@ -14,6 +14,7 @@ from scrapy.utils.spider import DefaultSpider, spidercls_for_request if TYPE_CHECKING: from argparse import ArgumentParser + from collections.abc import AsyncIterator from scrapy import Spider @@ -89,10 +90,10 @@ class Command(ScrapyCommand): else: spidercls = spidercls_for_request(spider_loader, request, spidercls) - async def start(self): + async def start(self: Spider) -> AsyncIterator[Any]: yield request - spidercls.start = start # type: ignore[method-assign,attr-defined] + spidercls.start = start # type: ignore[method-assign] self.crawler_process.crawl(spidercls) self.crawler_process.start() diff --git a/scrapy/commands/genspider.py b/scrapy/commands/genspider.py index 0e90c3188..cc8624fa1 100644 --- a/scrapy/commands/genspider.py +++ b/scrapy/commands/genspider.py @@ -5,7 +5,7 @@ import shutil import string from importlib import import_module from pathlib import Path -from typing import TYPE_CHECKING, Any, cast +from typing import TYPE_CHECKING, Any, ClassVar, cast from urllib.parse import urlparse import scrapy @@ -47,7 +47,7 @@ def verify_url_scheme(url: str) -> str: class Command(ScrapyCommand): requires_crawler_process = False - default_settings = {"LOG_ENABLED": False} + default_settings: ClassVar[dict[str, Any]] = {"LOG_ENABLED": False} def syntax(self) -> str: return "[options] " @@ -147,7 +147,7 @@ class Command(ScrapyCommand): name: str, url: str, template_name: str, - template_file: str | os.PathLike, + template_file: str | os.PathLike[str], ) -> None: """Generate the spider module, based on the given template""" assert self.settings is not None @@ -173,15 +173,21 @@ class Command(ScrapyCommand): template_file = Path(self.templates_dir, f"{template}.tmpl") if template_file.exists(): return template_file - print(f"Unable to find template: {template}\n") - print('Use "scrapy genspider --list" to see all available templates.') + print( + f"Unable to find template: {template}\n", + 'Use "scrapy genspider --list" to see all available templates.', + ) return None def _list_templates(self) -> None: - print("Available templates:") - for file in sorted(Path(self.templates_dir).iterdir()): - if file.suffix == ".tmpl": - print(f" {file.stem}") + print( + "Available templates:\n", + "\n".join( + f" {file.stem}" + for file in sorted(Path(self.templates_dir).iterdir()) + if file.suffix == ".tmpl" + ), + ) def _spider_exists(self, name: str) -> bool: assert self.settings is not None @@ -200,13 +206,15 @@ class Command(ScrapyCommand): pass else: # if spider with same name exists - print(f"Spider {name!r} already exists in module:") - print(f" {spidercls.__module__}") + print( + f"Spider {name!r} already exists in module:\n", + f" {spidercls.__module__}", + ) return True # a file with the same name exists in the target directory spiders_module = import_module(self.settings["NEWSPIDER_MODULE"]) - spiders_dir = Path(cast(str, spiders_module.__file__)).parent + spiders_dir = Path(cast("str", spiders_module.__file__)).parent spiders_dir_abs = spiders_dir.resolve() path = spiders_dir_abs / (name + ".py") if path.exists(): diff --git a/scrapy/commands/list.py b/scrapy/commands/list.py index b4dc97f3d..a037f5c9b 100644 --- a/scrapy/commands/list.py +++ b/scrapy/commands/list.py @@ -1,6 +1,6 @@ from __future__ import annotations -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, Any, ClassVar from scrapy.commands import ScrapyCommand from scrapy.spiderloader import get_spider_loader @@ -12,7 +12,7 @@ if TYPE_CHECKING: class Command(ScrapyCommand): requires_project = True requires_crawler_process = False - default_settings = {"LOG_ENABLED": False} + default_settings: ClassVar[dict[str, Any]] = {"LOG_ENABLED": False} def short_desc(self) -> str: return "List available spiders" @@ -20,5 +20,4 @@ class Command(ScrapyCommand): def run(self, args: list[str], opts: argparse.Namespace) -> None: assert self.settings is not None spider_loader = get_spider_loader(self.settings) - for s in sorted(spider_loader.list()): - print(s) + print("\n".join(sorted(spider_loader.list()))) diff --git a/scrapy/commands/parse.py b/scrapy/commands/parse.py index c4b3d2af9..2ac65bf3f 100644 --- a/scrapy/commands/parse.py +++ b/scrapy/commands/parse.py @@ -4,7 +4,7 @@ import functools import inspect import json import logging -from typing import TYPE_CHECKING, Any, TypeVar, overload +from typing import TYPE_CHECKING, Any, ClassVar, TypeVar, overload from itemadapter import ItemAdapter from twisted.internet.defer import Deferred, maybeDeferred @@ -15,7 +15,7 @@ from scrapy.exceptions import UsageError from scrapy.http import Request, Response from scrapy.utils import display from scrapy.utils.asyncgen import collect_asyncgen -from scrapy.utils.defer import aiter_errback, deferred_from_coro +from scrapy.utils.defer import _schedule_coro, aiter_errback, deferred_from_coro from scrapy.utils.log import failure_to_exc_info from scrapy.utils.misc import arg_to_iter from scrapy.utils.spider import spidercls_for_request @@ -39,8 +39,8 @@ class Command(BaseRunSpiderCommand): requires_project = True spider: Spider | None = None - items: dict[int, list[Any]] = {} - requests: dict[int, list[Request]] = {} + items: ClassVar[dict[int, list[Any]]] = {} + requests: ClassVar[dict[int, list[Request]]] = {} spidercls: type[Spider] | None first_response = None @@ -144,17 +144,16 @@ class Command(BaseRunSpiderCommand): def iterate_spider_output(self, result: _T) -> Iterable[Any]: ... def iterate_spider_output(self, result: Any) -> Iterable[Any] | Deferred[Any]: + d: Deferred[Any] if inspect.isasyncgen(result): d = deferred_from_coro( collect_asyncgen(aiter_errback(result, self.handle_exception)) ) - d.addCallback(self.iterate_spider_output) - return d + return d.addCallback(self.iterate_spider_output) + d = deferred_from_coro(result) if inspect.iscoroutine(result): - d = deferred_from_coro(result) - d.addCallback(self.iterate_spider_output) - return d - return arg_to_iter(deferred_from_coro(result)) + return d.addCallback(self.iterate_spider_output) + return arg_to_iter(d) def add_items(self, lvl: int, new_items: list[Any]) -> None: old_items = self.items.get(lvl, []) @@ -284,8 +283,12 @@ class Command(BaseRunSpiderCommand): if opts.pipelines: assert self.pcrawler.engine itemproc = self.pcrawler.engine.scraper.itemproc - for item in items: - itemproc.process_item(item, spider) + if hasattr(itemproc, "process_item_async"): + for item in items: + _schedule_coro(itemproc.process_item_async(item)) + else: + for item in items: + itemproc.process_item(item, spider) self.add_items(depth, items) self.add_requests(depth, requests) @@ -383,7 +386,7 @@ class Command(BaseRunSpiderCommand): "Invalid -m/--meta value, pass a valid json string to -m or --meta. " 'Example: --meta=\'{"foo" : "bar"}\'', print_help=False, - ) + ) from None def process_request_cb_kwargs(self, opts: argparse.Namespace) -> None: if opts.cbkwargs: @@ -394,7 +397,7 @@ class Command(BaseRunSpiderCommand): "Invalid --cbkwargs value, pass a valid json string to --cbkwargs. " 'Example: --cbkwargs=\'{"foo" : "bar"}\'', print_help=False, - ) + ) from None def run(self, args: list[str], opts: argparse.Namespace) -> None: # parse arguments diff --git a/scrapy/commands/runspider.py b/scrapy/commands/runspider.py index eeb1303e2..0b9036457 100644 --- a/scrapy/commands/runspider.py +++ b/scrapy/commands/runspider.py @@ -3,7 +3,7 @@ from __future__ import annotations import sys from importlib import import_module from pathlib import Path -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, Any, ClassVar from scrapy.commands import BaseRunSpiderCommand from scrapy.exceptions import UsageError @@ -18,7 +18,7 @@ if TYPE_CHECKING: def _import_file(filepath: str | PathLike[str]) -> ModuleType: abspath = Path(filepath).resolve() - if abspath.suffix not in (".py", ".pyw"): + if abspath.suffix not in {".py", ".pyw"}: raise ValueError(f"Not a Python source file: {abspath}") dirname = str(abspath.parent) sys.path = [dirname, *sys.path] @@ -30,7 +30,9 @@ def _import_file(filepath: str | PathLike[str]) -> ModuleType: class Command(BaseRunSpiderCommand): - default_settings = {"SPIDER_LOADER_CLASS": DummySpiderLoader} + default_settings: ClassVar[dict[str, Any]] = { + "SPIDER_LOADER_CLASS": DummySpiderLoader + } def syntax(self) -> str: return "[options] " @@ -50,7 +52,7 @@ class Command(BaseRunSpiderCommand): try: module = _import_file(filename) except (ImportError, ValueError) as e: - raise UsageError(f"Unable to load {str(filename)!r}: {e}\n") + raise UsageError(f"Unable to load {str(filename)!r}: {e}\n") from e spclasses = list(iter_spider_classes(module)) if not spclasses: raise UsageError(f"No spider found in file: {filename}\n") diff --git a/scrapy/commands/settings.py b/scrapy/commands/settings.py index 704cc500d..26a97ccbb 100644 --- a/scrapy/commands/settings.py +++ b/scrapy/commands/settings.py @@ -1,5 +1,6 @@ import argparse import json +from typing import Any, ClassVar from scrapy.commands import ScrapyCommand from scrapy.settings import BaseSettings @@ -7,7 +8,7 @@ from scrapy.settings import BaseSettings class Command(ScrapyCommand): requires_crawler_process = False - default_settings = {"LOG_ENABLED": False} + default_settings: ClassVar[dict[str, Any]] = {"LOG_ENABLED": False} def syntax(self) -> str: return "[options]" diff --git a/scrapy/commands/shell.py b/scrapy/commands/shell.py index eedaeb263..19138ffd0 100644 --- a/scrapy/commands/shell.py +++ b/scrapy/commands/shell.py @@ -6,12 +6,15 @@ See documentation in docs/topics/shell.rst from __future__ import annotations +import asyncio from threading import Thread -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, ClassVar from scrapy.commands import ScrapyCommand +from scrapy.crawler import AsyncCrawlerProcess, Crawler from scrapy.http import Request from scrapy.shell import Shell +from scrapy.utils.defer import _schedule_coro from scrapy.utils.spider import DefaultSpider, spidercls_for_request from scrapy.utils.url import guess_scheme @@ -22,7 +25,7 @@ if TYPE_CHECKING: class Command(ScrapyCommand): - default_settings = { + default_settings: ClassVar[dict[str, Any]] = { "DUPEFILTER_CLASS": "scrapy.dupefilters.BaseDupeFilter", "KEEP_ALIVE": True, "LOGSTATS_INTERVAL": 0, @@ -56,7 +59,7 @@ class Command(ScrapyCommand): help="do not handle HTTP 3xx status codes and print response as-is", ) - def update_vars(self, vars: dict[str, Any]) -> None: + def update_vars(self, vars: dict[str, Any]) -> None: # noqa: A002 """You can use this function to update the Scrapy objects that will be available in the shell """ @@ -82,16 +85,47 @@ class Command(ScrapyCommand): # crawling engine, so the set up in the crawl method won't work crawler = self.crawler_process._create_crawler(spidercls) crawler._apply_settings() - # The Shell class needs a persistent engine in the crawler - crawler.engine = crawler._create_engine() - crawler.engine.start(_start_request_processing=False) - - self._start_crawler_thread() - - shell = Shell(crawler, update_vars=self.update_vars, code=opts.code) + loop: asyncio.AbstractEventLoop | None = None + if crawler.settings.getbool("TWISTED_REACTOR_ENABLED"): + self._init_with_reactor(crawler) + else: + self._init_without_reactor(crawler) + loop = self._get_reactorless_loop() + shell = Shell(crawler, update_vars=self.update_vars, code=opts.code, loop=loop) shell.start(url=url, redirect=not opts.no_redirect) + def _init_with_reactor(self, crawler: Crawler) -> None: + # Create the engine and run start_async() in the main thread + crawler.engine = crawler._create_engine() + _schedule_coro(crawler.engine.start_async(_start_request_processing=False)) + self._start_crawler_thread() + + def _init_without_reactor(self, crawler: Crawler) -> None: + # Create the engine and run start_async() in the event loop thread + loop = self._get_reactorless_loop() + self._start_crawler_thread() + + async def _init_engine() -> None: + # We may need to wait until some parts of start_async() have + # finished, which may need a special event in the engine and may + # wait until https://github.com/scrapy/scrapy/issues/6916 + crawler.engine = crawler._create_engine() + loop.create_task( + crawler.engine.start_async(_start_request_processing=False) + ) + + future = asyncio.run_coroutine_threadsafe(_init_engine(), loop) + future.result() + + def _get_reactorless_loop(self) -> asyncio.AbstractEventLoop: + assert self.crawler_process + assert isinstance(self.crawler_process, AsyncCrawlerProcess) + loop = self.crawler_process._reactorless_loop + assert loop + return loop + def _start_crawler_thread(self) -> None: + """Run self.crawler_process.start() in a separate thread.""" assert self.crawler_process t = Thread( target=self.crawler_process.start, diff --git a/scrapy/commands/startproject.py b/scrapy/commands/startproject.py index 8f4427580..5661a0a48 100644 --- a/scrapy/commands/startproject.py +++ b/scrapy/commands/startproject.py @@ -6,7 +6,7 @@ from importlib.util import find_spec from pathlib import Path from shutil import copy2, copystat, ignore_patterns, move from stat import S_IWUSR as OWNER_WRITE_PERMISSION -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, Any, ClassVar import scrapy from scrapy.commands import ScrapyCommand @@ -34,7 +34,7 @@ def _make_writable(path: Path) -> None: class Command(ScrapyCommand): requires_crawler_process = False - default_settings = {"LOG_ENABLED": False} + default_settings: ClassVar[dict[str, Any]] = {"LOG_ENABLED": False} def syntax(self) -> str: return " [project_dir]" @@ -90,7 +90,7 @@ class Command(ScrapyCommand): _make_writable(dst) def run(self, args: list[str], opts: argparse.Namespace) -> None: - if len(args) not in (1, 2): + if len(args) not in {1, 2}: raise UsageError project_name = args[0] @@ -123,12 +123,12 @@ class Command(ScrapyCommand): ) print( f"New Scrapy project '{project_name}', using template directory " - f"'{self.templates_dir}', created in:" + f"'{self.templates_dir}', created in:\n", + f" {project_dir.resolve()}\n\n", + "You can start your first spider with:\n", + f" cd {project_dir}\n", + " scrapy genspider example example.com", ) - print(f" {project_dir.resolve()}\n") - print("You can start your first spider with:") - print(f" cd {project_dir}") - print(" scrapy genspider example example.com") @property def templates_dir(self) -> str: diff --git a/scrapy/commands/version.py b/scrapy/commands/version.py index 30b0e9fd7..1d1985d4e 100644 --- a/scrapy/commands/version.py +++ b/scrapy/commands/version.py @@ -1,4 +1,5 @@ import argparse +from typing import Any, ClassVar import scrapy from scrapy.commands import ScrapyCommand @@ -7,7 +8,7 @@ from scrapy.utils.versions import get_versions class Command(ScrapyCommand): requires_crawler_process = False - default_settings = {"LOG_ENABLED": False} + default_settings: ClassVar[dict[str, Any]] = {"LOG_ENABLED": False} def syntax(self) -> str: return "[-v]" diff --git a/scrapy/contracts/__init__.py b/scrapy/contracts/__init__.py index bdb68c4ad..ebbdf1b98 100644 --- a/scrapy/contracts/__init__.py +++ b/scrapy/contracts/__init__.py @@ -6,7 +6,7 @@ from collections.abc import AsyncGenerator, Iterable from functools import wraps from inspect import getmembers from types import CoroutineType -from typing import TYPE_CHECKING, Any, cast +from typing import TYPE_CHECKING, Any, ClassVar, cast from unittest import TestCase, TestResult from scrapy.http import Request, Response @@ -27,7 +27,7 @@ class Contract: request_cls: type[Request] | None = None name: str - def __init__(self, method: Callable, *args: Any): + def __init__(self, method: Callable[..., Any], *args: Any): self.testcase_pre = _create_testcase(method, f"@{self.name} pre-hook") self.testcase_post = _create_testcase(method, f"@{self.name} post-hook") self.args: tuple[Any, ...] = args @@ -51,8 +51,10 @@ class Contract: results.addSuccess(self.testcase_pre) cb_result = cb(response, **cb_kwargs) if isinstance(cb_result, (AsyncGenerator, CoroutineType)): + if isinstance(cb_result, CoroutineType): + cb_result.close() raise TypeError("Contracts don't support async callbacks") - return list(cast(Iterable[Any], iterate_spider_output(cb_result))) + return list(cast("Iterable[Any]", iterate_spider_output(cb_result))) request.callback = wrapper @@ -67,8 +69,10 @@ class Contract: def wrapper(response: Response, **cb_kwargs: Any) -> list[Any]: cb_result = cb(response, **cb_kwargs) if isinstance(cb_result, (AsyncGenerator, CoroutineType)): + if isinstance(cb_result, CoroutineType): + cb_result.close() raise TypeError("Contracts don't support async callbacks") - output = list(cast(Iterable[Any], iterate_spider_output(cb_result))) + output = list(cast("Iterable[Any]", iterate_spider_output(cb_result))) try: results.startTest(self.testcase_post) self.post_process(output) @@ -90,7 +94,7 @@ class Contract: class ContractsManager: - contracts: dict[str, type[Contract]] = {} + contracts: ClassVar[dict[str, type[Contract]]] = {} def __init__(self, contracts: Iterable[type[Contract]]): for contract in contracts: @@ -105,11 +109,11 @@ class ContractsManager: return methods - def extract_contracts(self, method: Callable) -> list[Contract]: + def extract_contracts(self, method: Callable[..., Any]) -> list[Contract]: contracts: list[Contract] = [] assert method.__doc__ is not None - for line in method.__doc__.split("\n"): - line = line.strip() + for line_ in method.__doc__.split("\n"): + line = line_.strip() if line.startswith("@"): m = re.match(r"@(\w+)\s*(.*)", line) @@ -125,7 +129,7 @@ class ContractsManager: def from_spider(self, spider: Spider, results: TestResult) -> list[Request | None]: requests: list[Request | None] = [] for method in self.tested_methods_from_spidercls(type(spider)): - bound_method = spider.__getattribute__(method) + bound_method = getattr(spider, method) try: requests.append(self.from_method(bound_method, results)) except Exception: @@ -134,7 +138,9 @@ class ContractsManager: return requests - def from_method(self, method: Callable, results: TestResult) -> Request | None: + def from_method( + self, method: Callable[..., Any], results: TestResult + ) -> Request | None: contracts = self.extract_contracts(method) if contracts: request_cls = Request @@ -170,7 +176,7 @@ class ContractsManager: return None def _clean_req( - self, request: Request, method: Callable, results: TestResult + self, request: Request, method: Callable[..., Any], results: TestResult ) -> None: """stop the request from returning objects and records any errors""" @@ -181,7 +187,7 @@ class ContractsManager: def cb_wrapper(response: Response, **cb_kwargs: Any) -> None: try: output = cb(response, **cb_kwargs) - output = list(cast(Iterable[Any], iterate_spider_output(output))) + output = list(cast("Iterable[Any]", iterate_spider_output(output))) except Exception: case = _create_testcase(method, "callback") results.addError(case, sys.exc_info()) @@ -189,13 +195,13 @@ class ContractsManager: def eb_wrapper(failure: Failure) -> None: case = _create_testcase(method, "errback") exc_info = failure.type, failure.value, failure.getTracebackObject() - results.addError(case, exc_info) + results.addError(case, exc_info) # type: ignore[arg-type] request.callback = cb_wrapper request.errback = eb_wrapper -def _create_testcase(method: Callable, desc: str) -> TestCase: +def _create_testcase(method: Callable[..., Any], desc: str) -> TestCase: spider = method.__self__.name # type: ignore[attr-defined] class ContractTestCase(TestCase): diff --git a/scrapy/contracts/default.py b/scrapy/contracts/default.py index 6f357ba20..9b42ca36f 100644 --- a/scrapy/contracts/default.py +++ b/scrapy/contracts/default.py @@ -1,7 +1,7 @@ from __future__ import annotations import json -from typing import Any, Callable +from typing import TYPE_CHECKING, Any, ClassVar from itemadapter import ItemAdapter, is_item @@ -9,6 +9,9 @@ from scrapy.contracts import Contract from scrapy.exceptions import ContractFail from scrapy.http import Request +if TYPE_CHECKING: + from collections.abc import Callable + # contracts class UrlContract(Contract): @@ -65,7 +68,7 @@ class ReturnsContract(Contract): """ name = "returns" - object_type_verifiers: dict[str | None, Callable[[Any], bool]] = { + object_type_verifiers: ClassVar[dict[str | None, Callable[[Any], bool]]] = { "request": lambda x: isinstance(x, Request), "requests": lambda x: isinstance(x, Request), "item": is_item, @@ -75,7 +78,7 @@ class ReturnsContract(Contract): def __init__(self, *args: Any, **kwargs: Any): super().__init__(*args, **kwargs) - if len(self.args) not in [1, 2, 3]: + if len(self.args) not in {1, 2, 3}: raise ValueError( f"Incorrect argument quantity: expected 1, 2 or 3, got {len(self.args)}" ) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 4b5654826..7c0ee0eec 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -1,18 +1,18 @@ from __future__ import annotations import random -import warnings from collections import deque +from dataclasses import dataclass, field from datetime import datetime -from time import time -from typing import TYPE_CHECKING, Any, cast +from time import monotonic +from typing import TYPE_CHECKING, Any from twisted.internet.defer import Deferred, inlineCallbacks +from twisted.python.failure import Failure from scrapy import Request, Spider, signals from scrapy.core.downloader.handlers import DownloadHandlers from scrapy.core.downloader.middleware import DownloaderMiddlewareManager -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.resolver import dnscache from scrapy.utils.asyncio import ( AsyncioLoopingCall, @@ -20,11 +20,14 @@ from scrapy.utils.asyncio import ( call_later, create_looping_call, ) +from scrapy.utils.decorators import _warn_spider_arg from scrapy.utils.defer import ( + _defer_sleep_async, + _schedule_coro, deferred_from_coro, maybe_deferred_to_future, - mustbe_deferred, ) +from scrapy.utils.deprecate import warn_on_deprecated_spider_attribute from scrapy.utils.httpobj import urlparse_cached if TYPE_CHECKING: @@ -38,24 +41,21 @@ if TYPE_CHECKING: from scrapy.signalmanager import SignalManager +@dataclass(slots=True, eq=False) class Slot: """Downloader slot""" - def __init__( - self, - concurrency: int, - delay: float, - randomize_delay: bool, - ): - self.concurrency: int = concurrency - self.delay: float = delay - self.randomize_delay: bool = randomize_delay + concurrency: int + delay: float + randomize_delay: bool - self.active: set[Request] = set() - self.queue: deque[tuple[Request, Deferred[Response]]] = deque() - self.transferring: set[Request] = set() - self.lastseen: float = 0 - self.latercall: CallLaterResult | None = None + active: set[Request] = field(default_factory=set, init=False, repr=False) + queue: deque[tuple[Request, Deferred[Response]]] = field( + default_factory=deque, init=False, repr=False + ) + transferring: set[Request] = field(default_factory=set, init=False, repr=False) + lastseen: float = field(default=0, init=False, repr=False) + latercall: CallLaterResult | None = field(default=None, init=False, repr=False) def free_transfer_slots(self) -> int: return self.concurrency - len(self.transferring) @@ -70,14 +70,6 @@ class Slot: self.latercall.cancel() self.latercall = None - def __repr__(self) -> str: - cls_name = self.__class__.__name__ - return ( - f"{cls_name}(concurrency={self.concurrency!r}, " - f"delay={self.delay:.2f}, " - f"randomize_delay={self.randomize_delay!r})" - ) - def __str__(self) -> str: return ( f" Generator[Deferred[Any], Any, Response | Request]: self.active.add(request) try: - return ( - yield self.middleware.download(self._enqueue_request, request, spider) + result: Response | Request = yield ( + deferred_from_coro( + self.middleware.download_async(self._enqueue_request, request) + ) ) + return result finally: self.active.remove(request) def needs_backout(self) -> bool: return len(self.active) >= self.total_concurrency - def _get_slot(self, request: Request, spider: Spider) -> tuple[str, Slot]: + @_warn_spider_arg + def _get_slot( + self, request: Request, spider: Spider | None = None + ) -> tuple[str, Slot]: key = self.get_slot_key(request) if key not in self.slots: + assert self.crawler.spider slot_settings = self.per_slot_settings.get(key, {}) - conc = ( - self.ip_concurrency if self.ip_concurrency else self.domain_concurrency + conc = self.ip_concurrency or self.domain_concurrency + conc, delay = _get_concurrency_delay( + conc, self.crawler.spider, self.settings ) - conc, delay = _get_concurrency_delay(conc, spider, self.settings) conc, delay = ( slot_settings.get("concurrency", conc), slot_settings.get("delay", delay), @@ -157,12 +159,14 @@ class Downloader: randomize_delay = slot_settings.get("randomize_delay", self.randomize_delay) new_slot = Slot(conc, delay, randomize_delay) self.slots[key] = new_slot + self._start_slot_gc() return key, self.slots[key] def get_slot_key(self, request: Request) -> str: - if self.DOWNLOAD_SLOT in request.meta: - return cast(str, request.meta[self.DOWNLOAD_SLOT]) + meta_slot: str | None = request.meta.get(self.DOWNLOAD_SLOT) + if meta_slot is not None: + return meta_slot key = urlparse_cached(request).hostname or "" if self.ip_concurrency: @@ -170,96 +174,111 @@ class Downloader: return key - def _get_slot_key(self, request: Request, spider: Spider | None) -> str: - warnings.warn( - "Use of this protected method is deprecated. Consider using its corresponding public method get_slot_key() instead.", - ScrapyDeprecationWarning, - stacklevel=2, - ) - return self.get_slot_key(request) - - @inlineCallbacks - def _enqueue_request( - self, request: Request, spider: Spider - ) -> Generator[Deferred[Any], Any, Response]: - key, slot = self._get_slot(request, spider) + # passed as download_func into self.middleware.download() in self.fetch() + async def _enqueue_request(self, request: Request) -> Response: + key, slot = self._get_slot(request) request.meta[self.DOWNLOAD_SLOT] = key slot.active.add(request) self.signals.send_catch_log( - signal=signals.request_reached_downloader, request=request, spider=spider + signal=signals.request_reached_downloader, + request=request, + spider=self.crawler.spider, ) d: Deferred[Response] = Deferred() slot.queue.append((request, d)) - self._process_queue(spider, slot) + self._process_queue(slot) try: - return (yield d) + return await maybe_deferred_to_future(d) # fired in _wait_for_download() finally: slot.active.remove(request) - def _process_queue(self, spider: Spider, slot: Slot) -> None: + def _process_queue(self, slot: Slot) -> None: if slot.latercall: # block processing until slot.latercall is called return # Delay queue processing if a download_delay is configured - now = time() + now = monotonic() delay = slot.download_delay() if delay: penalty = delay - now + slot.lastseen if penalty > 0: - slot.latercall = call_later(penalty, self._latercall, spider, slot) + slot.latercall = call_later(penalty, self._latercall, slot) return # Process enqueued requests if there are free slots to transfer for this slot while slot.queue and slot.free_transfer_slots() > 0: slot.lastseen = now - request, deferred = slot.queue.popleft() - dfd = deferred_from_coro(self._download(slot, request, spider)) - dfd.chainDeferred(deferred) + request, queue_dfd = slot.queue.popleft() + _schedule_coro(self._wait_for_download(slot, request, queue_dfd)) # prevent burst if inter-request delays were configured if delay: - self._process_queue(spider, slot) + self._process_queue(slot) break - def _latercall(self, spider: Spider, slot: Slot) -> None: + def _latercall(self, slot: Slot) -> None: slot.latercall = None - self._process_queue(spider, slot) + self._process_queue(slot) - async def _download(self, slot: Slot, request: Request, spider: Spider) -> Response: + async def _download(self, slot: Slot, request: Request) -> Response: # The order is very important for the following logic. Do not change! slot.transferring.add(request) try: # 1. Download the response - response: Response = await maybe_deferred_to_future( - mustbe_deferred(self.handlers.download_request, request, spider) - ) + response: Response = await self.handlers.download_request_async(request) # 2. Notify response_downloaded listeners about the recent download # before querying queue for next request self.signals.send_catch_log( signal=signals.response_downloaded, response=response, request=request, - spider=spider, + spider=self.crawler.spider, ) return response + except Exception: + await _defer_sleep_async() + raise finally: # 3. After response arrives, remove the request from transferring # state to free up the transferring slot so it can be used by the # following requests (perhaps those which came from the downloader # middleware itself) slot.transferring.remove(request) - self._process_queue(spider, slot) + self._process_queue(slot) self.signals.send_catch_log( - signal=signals.request_left_downloader, request=request, spider=spider + signal=signals.request_left_downloader, + request=request, + spider=self.crawler.spider, ) + async def _wait_for_download( + self, slot: Slot, request: Request, queue_dfd: Deferred[Response] + ) -> None: + try: + response = await self._download(slot, request) + except Exception: + queue_dfd.errback(Failure()) + else: + queue_dfd.callback(response) # awaited in _enqueue_request() + def close(self) -> None: - self._slot_gc_loop.stop() + self._stop_slot_gc() for slot in self.slots.values(): slot.close() def _slot_gc(self, age: float = 60) -> None: - mintime = time() - age + mintime = monotonic() - age for key, slot in list(self.slots.items()): if not slot.active and slot.lastseen + slot.delay < mintime: self.slots.pop(key).close() + + def _start_slot_gc(self) -> None: + if self._slot_gc_loop: + return + self._slot_gc_loop = create_looping_call(self._slot_gc) + self._slot_gc_loop.start(self._SLOT_GC_INTERVAL, now=False) + + def _stop_slot_gc(self) -> None: + if self._slot_gc_loop: + self._slot_gc_loop.stop() + self._slot_gc_loop = None diff --git a/scrapy/core/downloader/contextfactory.py b/scrapy/core/downloader/contextfactory.py index d1ba6208a..40f09ffb2 100644 --- a/scrapy/core/downloader/contextfactory.py +++ b/scrapy/core/downloader/contextfactory.py @@ -1,15 +1,14 @@ from __future__ import annotations import warnings -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, cast from OpenSSL import SSL -from twisted.internet._sslverify import _setAcceptableProtocols from twisted.internet.ssl import ( AcceptableCiphers, CertificateOptions, + TLSVersion, optionsForClientTLS, - platformTrust, ) from twisted.web.client import BrowserLikePolicyForHTTPS from twisted.web.iweb import IPolicyForHTTPS @@ -17,13 +16,17 @@ from zope.interface.declarations import implementer from zope.interface.verify import verifyObject from scrapy.core.downloader.tls import ( + _TWISTED_VERSION_MAP, DEFAULT_CIPHERS, - ScrapyClientTLSOptions, - openssl_methods, + _openssl_methods, + _ScrapyClientTLSOptions, + _ScrapyClientTLSOptions26, ) from scrapy.exceptions import ScrapyDeprecationWarning -from scrapy.utils.deprecate import method_is_overridden +from scrapy.utils._deps_compat import TWISTED_TLS_NEW_IMPL +from scrapy.utils.deprecate import create_deprecated_class from scrapy.utils.misc import build_from_crawler, load_object +from scrapy.utils.ssl import _get_cert_options_version_kwargs, _get_tls_version_limits if TYPE_CHECKING: from twisted.internet._sslverify import ClientTLSOptions @@ -36,113 +39,134 @@ if TYPE_CHECKING: @implementer(IPolicyForHTTPS) -class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): - """ - Non-peer-certificate verifying HTTPS context factory +class _ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): + """Non-peer-certificate verifying HTTPS context factory. - Default OpenSSL method is TLS_METHOD (also called SSLv23_METHOD) - which allows TLS protocol negotiation + Uses :setting:`DOWNLOADER_CLIENT_TLS_CIPHERS`, + :setting:`DOWNLOAD_TLS_MIN_VERSION` and :setting:`DOWNLOAD_TLS_MAX_VERSION` + to configure the :class:`~twisted.internet.ssl.CertificateOptions` + instance. - 'A TLS/SSL connection established with [this method] may - understand the TLSv1, TLSv1.1 and TLSv1.2 protocols.' + The purpose of this custom class is to provide a ``creatorForNetloc()`` + method that returns a ``_ScrapyClientTLSOptions`` instance configured based + on TLS settings provided to the factory. """ def __init__( self, - method: int = SSL.SSLv23_METHOD, + method: int | None = SSL.SSLv23_METHOD, # noqa: S503 tls_verbose_logging: bool = False, tls_ciphers: str | None = None, *args: Any, + verify_certificates: bool = False, + tls_min_version: TLSVersion | None = None, + tls_max_version: TLSVersion | None = None, **kwargs: Any, ): - super().__init__(*args, **kwargs) - self._ssl_method: int = method - self.tls_verbose_logging: bool = tls_verbose_logging + super().__init__(*args, **kwargs) # type: ignore[no-untyped-call] + self._ssl_method: int | None = method + self.tls_min_version: TLSVersion | None = tls_min_version + self.tls_max_version: TLSVersion | None = tls_max_version + self.tls_verbose_logging: bool = tls_verbose_logging # unused self.tls_ciphers: AcceptableCiphers if tls_ciphers: self.tls_ciphers = AcceptableCiphers.fromOpenSSLCipherString(tls_ciphers) else: self.tls_ciphers = DEFAULT_CIPHERS - if method_is_overridden(type(self), ScrapyClientContextFactory, "getContext"): - warnings.warn( - "Overriding ScrapyClientContextFactory.getContext() is deprecated and that method" - " will be removed in a future Scrapy version. Override creatorForNetloc() instead.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - - @classmethod - def from_settings( - cls, - settings: BaseSettings, - method: int = SSL.SSLv23_METHOD, - *args: Any, - **kwargs: Any, - ) -> Self: - warnings.warn( - f"{cls.__name__}.from_settings() is deprecated, use from_crawler() instead.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - return cls._from_settings(settings, method, *args, **kwargs) + self._verify_certificates = verify_certificates @classmethod def from_crawler( cls, crawler: Crawler, - method: int = SSL.SSLv23_METHOD, + method: int | None = SSL.SSLv23_METHOD, # noqa: S503 *args: Any, **kwargs: Any, ) -> Self: - return cls._from_settings(crawler.settings, method, *args, **kwargs) - - @classmethod - def _from_settings( - cls, - settings: BaseSettings, - method: int = SSL.SSLv23_METHOD, - *args: Any, - **kwargs: Any, - ) -> Self: - tls_verbose_logging: bool = settings.getbool( + tls_verbose_logging: bool = crawler.settings.getbool( "DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING" ) - tls_ciphers: str | None = settings["DOWNLOADER_CLIENT_TLS_CIPHERS"] + tls_ciphers: str | None = crawler.settings["DOWNLOADER_CLIENT_TLS_CIPHERS"] + # DOWNLOADER_CLIENT_TLS_METHOD reading and handling should be also moved here + # when the deprecated load_context_factory_from_settings() is removed + tls_min_ver, tls_max_ver = _get_tls_version_limits( + crawler.settings, _TWISTED_VERSION_MAP.__getitem__ + ) + if tls_min_ver or tls_max_ver: + method = None + verify_certificates = crawler.settings.getbool("DOWNLOAD_VERIFY_CERTIFICATES") return cls( # type: ignore[misc] + *args, method=method, tls_verbose_logging=tls_verbose_logging, tls_ciphers=tls_ciphers, - *args, + tls_min_version=tls_min_ver, + tls_max_version=tls_max_ver, + verify_certificates=verify_certificates, **kwargs, ) - def getCertificateOptions(self) -> CertificateOptions: - # setting verify=True will require you to provide CAs - # to verify against; in other words: it's not that simple - return CertificateOptions( - verify=False, - method=self._ssl_method, - fixBrokenPeers=True, - acceptableCiphers=self.tls_ciphers, - ) + # should be removed together with ScrapyClientContextFactory + def getCertificateOptions(self) -> CertificateOptions: # pragma: no cover + return self._get_cert_options() - # kept for old-style HTTP/1.0 downloader context twisted calls, - # e.g. connectSSL() - def getContext(self, hostname: Any = None, port: Any = None) -> SSL.Context: - ctx: SSL.Context = self.getCertificateOptions().getContext() - ctx.set_options(0x4) # OP_LEGACY_SERVER_CONNECT - return ctx + def _get_cert_options(self) -> CertificateOptions: + return _ScrapyCertificateOptions(**self._get_cert_options_kwargs()) + + def _get_cert_options_kwargs(self) -> dict[str, Any]: + kwargs: dict[str, Any] = { + "fixBrokenPeers": True, + "acceptableCiphers": self.tls_ciphers, + } + if self.tls_min_version or self.tls_max_version: + kwargs.update( + _get_cert_options_version_kwargs( + self.tls_min_version, self.tls_max_version + ) + ) + # when ScrapyClientContextFactory is removed self._ssl_method can just be None by default + elif self._ssl_method != SSL.SSLv23_METHOD: + kwargs["method"] = self._ssl_method + return kwargs + + # should be removed together with ScrapyClientContextFactory + def getContext( + self, hostname: Any = None, port: Any = None + ) -> SSL.Context: # pragma: no cover + return self._get_context() + + def _get_context(self) -> SSL.Context: + return self._get_cert_options().getContext() def creatorForNetloc(self, hostname: bytes, port: int) -> ClientTLSOptions: - return ScrapyClientTLSOptions( - hostname.decode("ascii"), - self.getContext(), - verbose_logging=self.tls_verbose_logging, + if not self._verify_certificates: + # Our options class is needed to skip verification errors + if TWISTED_TLS_NEW_IMPL: + return _ScrapyClientTLSOptions26( + self._get_cert_options()._makeTLSConnection, + hostname.decode("ascii"), + ) + return _ScrapyClientTLSOptions( + hostname.decode("ascii"), # type: ignore[arg-type] + self._get_context(), # type: ignore[arg-type] + ) + # Otherwise use the normal Twisted function. + return optionsForClientTLS( # type: ignore[no-any-return] + hostname=hostname.decode("ascii"), + extraCertificateOptions=self._get_cert_options_kwargs(), ) +ScrapyClientContextFactory = create_deprecated_class( + "ScrapyClientContextFactory", + _ScrapyClientContextFactory, + subclass_warn_message="{old} is deprecated.", + instance_warn_message="{cls} is deprecated.", +) + + @implementer(IPolicyForHTTPS) -class BrowserLikeContextFactory(ScrapyClientContextFactory): +class BrowserLikeContextFactory(_ScrapyClientContextFactory): """ Twisted-recommended context factory for web clients. @@ -155,30 +179,54 @@ class BrowserLikeContextFactory(ScrapyClientContextFactory): :meth:`creatorForNetloc` is the same as :class:`~twisted.web.client.BrowserLikePolicyForHTTPS` except this context factory allows setting the TLS/SSL method to use. - - The default OpenSSL method is ``TLS_METHOD`` (also called - ``SSLv23_METHOD``) which allows TLS protocol negotiation. """ + def __init__(self, *args: Any, **kwargs: Any): + warnings.warn( + "BrowserLikeContextFactory is deprecated." + " You can set DOWNLOAD_VERIFY_CERTIFICATES=True to enable" + " certificate verification instead of using it.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + super().__init__(*args, **kwargs) + def creatorForNetloc(self, hostname: bytes, port: int) -> ClientTLSOptions: - # trustRoot set to platformTrust() will use the platform's root CAs. - # - # This means that a website like https://www.cacert.org will be rejected - # by default, since CAcert.org CA certificate is seldom shipped. - return optionsForClientTLS( + return optionsForClientTLS( # type: ignore[no-any-return] hostname=hostname.decode("ascii"), - trustRoot=platformTrust(), - extraCertificateOptions={"method": self._ssl_method}, + extraCertificateOptions=self._get_cert_options_kwargs(), ) @implementer(IPolicyForHTTPS) -class AcceptableProtocolsContextFactory: +class _AcceptableProtocolsContextFactory: """Context factory to used to override the acceptable protocols - to set up the [OpenSSL.SSL.Context] for doing NPN and/or ALPN - negotiation. + to set up the :class:`OpenSSL.SSL.Context` for doing ALPN negotiation. + It's a private class for :class:`~.H2DownloadHandler`. + + This class wraps ``creatorForNetloc()`` of another factory class, setting + the acceptable protocols on the :class:`.ClientTLSOptions` instance + returned by it. It's only needed because we support custom factories via + :setting:`DOWNLOADER_CLIENTCONTEXTFACTORY`. + + It's a no-op on Twisted 26.4.0+, though using it with custom + factories on those Twisted versions may be not enough for HTTP/2 support. """ + # Something needs to call set_alpn_protos() for ALPN to work. + # + # Twisted < 26.4.0 does it in OpenSSLCertificateOptions._makeContext() + # (requires passing acceptableProtocols from the factory to + # OpenSSLCertificateOptions) and in TLSMemoryBIOFactory._createConnection() + # based on H2ClientFactory.acceptableProtocols (too late, it seems). + # + # Newer Twisted does it in OpenSSLCertificateOptions._makeContext() as + # well, and in OpenSSLCertificateOptions._makeTLSConnection() based on + # H2ClientFactory.acceptableProtocols (which now works). + # + # When we drop DOWNLOADER_CLIENTCONTEXTFACTORY it looks like we can replace + # all of this with _ScrapyClientContextFactory.acceptableProtocols. + def __init__(self, context_factory: Any, acceptable_protocols: list[bytes]): verifyObject(IPolicyForHTTPS, context_factory) self._wrapped_context_factory: Any = context_factory @@ -188,35 +236,77 @@ class AcceptableProtocolsContextFactory: options: ClientTLSOptions = self._wrapped_context_factory.creatorForNetloc( hostname, port ) - _setAcceptableProtocols(options._ctx, self._acceptable_protocols) + if not TWISTED_TLS_NEW_IMPL: + from twisted.internet._sslverify import ( # type: ignore[attr-defined] # noqa: PLC0415 # pylint: disable=no-name-in-module + _setAcceptableProtocols, + ) + + _setAcceptableProtocols(options._ctx, self._acceptable_protocols) # type: ignore[attr-defined] return options +AcceptableProtocolsContextFactory = create_deprecated_class( + "AcceptableProtocolsContextFactory", + _AcceptableProtocolsContextFactory, + subclass_warn_message="{old} is deprecated.", + instance_warn_message="{cls} is deprecated.", +) + + +class _ScrapyCertificateOptions(CertificateOptions): + """A wrapper needed to add flags to the SSL context before it's used.""" + + def _makeContext(self, skipCiphers: bool = False) -> SSL.Context: + if TWISTED_TLS_NEW_IMPL: + ctx = super()._makeContext(skipCiphers) + else: + ctx = super()._makeContext() + ctx.set_options(0x4) # OP_LEGACY_SERVER_CONNECT + return ctx + + +def _load_context_factory_from_settings(crawler: Crawler) -> IPolicyForHTTPS: + """Create an instance of :setting:`DOWNLOADER_CLIENTCONTEXTFACTORY`. + + Also passes values of other relevant settings to the factory class. + """ + tls_method_setting: str = crawler.settings["DOWNLOADER_CLIENT_TLS_METHOD"] + if tls_method_setting != "TLS": + warnings.warn( + "Setting DOWNLOADER_CLIENT_TLS_METHOD to a non-default value is" + " deprecated, please use DOWNLOAD_TLS_MIN_VERSION and/or" + " DOWNLOAD_TLS_MAX_VERSION instead.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + tls_method = _openssl_methods[tls_method_setting] + if crawler.settings["DOWNLOADER_CLIENTCONTEXTFACTORY"] == "SENTINEL": + context_factory_cls = _ScrapyClientContextFactory + else: # pragma: no cover + warnings.warn( + "The 'DOWNLOADER_CLIENTCONTEXTFACTORY' setting is deprecated.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + context_factory_cls = load_object( + crawler.settings["DOWNLOADER_CLIENTCONTEXTFACTORY"] + ) + return cast( + "IPolicyForHTTPS", + build_from_crawler( + context_factory_cls, + crawler, + method=tls_method, + ), + ) + + def load_context_factory_from_settings( settings: BaseSettings, crawler: Crawler -) -> IPolicyForHTTPS: - ssl_method = openssl_methods[settings.get("DOWNLOADER_CLIENT_TLS_METHOD")] - context_factory_cls = load_object(settings["DOWNLOADER_CLIENTCONTEXTFACTORY"]) - # try method-aware context factory - try: - context_factory = build_from_crawler( - context_factory_cls, - crawler, - method=ssl_method, - ) - except TypeError: - # use context factory defaults - context_factory = build_from_crawler( - context_factory_cls, - crawler, - ) - msg = ( - f"{settings['DOWNLOADER_CLIENTCONTEXTFACTORY']} does not accept " - "a `method` argument (type OpenSSL.SSL method, e.g. " - "OpenSSL.SSL.SSLv23_METHOD) and/or a `tls_verbose_logging` " - "argument and/or a `tls_ciphers` argument. Please, upgrade your " - "context factory class to handle them or ignore them." - ) - warnings.warn(msg) - - return context_factory +) -> IPolicyForHTTPS: # pragma: no cover + warnings.warn( + "load_context_factory_from_settings() is deprecated.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return _load_context_factory_from_settings(crawler) diff --git a/scrapy/core/downloader/handlers/__init__.py b/scrapy/core/downloader/handlers/__init__.py index 902f200b8..fb27cdb8b 100644 --- a/scrapy/core/downloader/handlers/__init__.py +++ b/scrapy/core/downloader/handlers/__init__.py @@ -2,19 +2,24 @@ from __future__ import annotations +import inspect import logging +import warnings from typing import TYPE_CHECKING, Any, Protocol, cast -from twisted.internet import defer - from scrapy import Request, Spider, signals -from scrapy.exceptions import NotConfigured, NotSupported +from scrapy.exceptions import NotConfigured, NotSupported, ScrapyDeprecationWarning +from scrapy.utils.defer import ( + deferred_from_coro, + ensure_awaitable, + maybe_deferred_to_future, +) from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.misc import build_from_crawler, load_object -from scrapy.utils.python import without_none_values +from scrapy.utils.python import global_object_name, without_none_values if TYPE_CHECKING: - from collections.abc import Callable, Generator + from collections.abc import Callable from twisted.internet.defer import Deferred @@ -25,10 +30,20 @@ if TYPE_CHECKING: logger = logging.getLogger(__name__) +# This is the official API but we temporarily support the old deprecated one: +# * lazy is not mandatory (defaults to True). +# * download_request() can return a Deferred[Response] instead of a coroutine, +# and takes a spider argument in this case. +# * close() can return None or Deferred[None] instead of a coroutine. +# * close() is not mandatory. + + class DownloadHandlerProtocol(Protocol): - def download_request( - self, request: Request, spider: Spider - ) -> Deferred[Response]: ... + lazy: bool + + async def download_request(self, request: Request) -> Response: ... + + async def close(self) -> None: ... class DownloadHandlers: @@ -40,6 +55,8 @@ class DownloadHandlers: self._handlers: dict[str, DownloadHandlerProtocol] = {} # remembers failed handlers self._notconfigured: dict[str, str] = {} + # remembers handlers with Deferred-based download_request() + self._old_style_handlers: set[str] = set() handlers: dict[str, str | Callable[..., Any]] = without_none_values( cast( "dict[str, str | Callable[..., Any]]", @@ -72,8 +89,17 @@ class DownloadHandlers: path = self._schemes[scheme] try: dhcls: type[DownloadHandlerProtocol] = load_object(path) - if skip_lazy and getattr(dhcls, "lazy", True): - return None + if skip_lazy: + if not hasattr(dhcls, "lazy"): + warnings.warn( + f"{global_object_name(dhcls)} doesn't define a 'lazy' attribute." + f" This is deprecated, please add 'lazy = True' (which is the current" + f" default value) to the class definition.", + category=ScrapyDeprecationWarning, + stacklevel=1, + ) + if getattr(dhcls, "lazy", True): + return None dh = build_from_crawler( dhcls, self._crawler, @@ -91,19 +117,62 @@ class DownloadHandlers: self._notconfigured[scheme] = str(ex) return None self._handlers[scheme] = dh + if not inspect.iscoroutinefunction(dh.download_request): # pragma: no cover + warnings.warn( + f"{global_object_name(dh.download_request)} is not a coroutine function." + f" This is deprecated, please rewrite it to return a coroutine and remove" + f" the 'spider' argument.", + category=ScrapyDeprecationWarning, + stacklevel=1, + ) + self._old_style_handlers.add(scheme) return dh - def download_request(self, request: Request, spider: Spider) -> Deferred[Response]: + def download_request( + self, request: Request, spider: Spider | None = None + ) -> Deferred[Response]: # pragma: no cover + warnings.warn( + "DownloadHandlers.download_request() is deprecated, use download_request_async() instead", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + return deferred_from_coro(self.download_request_async(request)) + + async def download_request_async(self, request: Request) -> Response: scheme = urlparse_cached(request).scheme handler = self._get_handler(scheme) if not handler: raise NotSupported( f"Unsupported URL scheme '{scheme}': {self._notconfigured[scheme]}" ) - return handler.download_request(request, spider) + assert self._crawler.spider + if scheme in self._old_style_handlers: # pragma: no cover + return await maybe_deferred_to_future( + cast( + "Deferred[Response]", + handler.download_request(request, self._crawler.spider), # type: ignore[call-arg] + ) + ) + return await handler.download_request(request) - @defer.inlineCallbacks - def _close(self, *_a: Any, **_kw: Any) -> Generator[Deferred[Any], Any, None]: + async def _close(self) -> None: for dh in self._handlers.values(): - if hasattr(dh, "close"): - yield dh.close() + if not hasattr(dh, "close"): # pragma: no cover + warnings.warn( + f"{global_object_name(dh)} doesn't define a close() method." + f" This is deprecated, please add an empty 'async def close()' method.", + category=ScrapyDeprecationWarning, + stacklevel=1, + ) + continue + + if inspect.iscoroutinefunction(dh.close): + await dh.close() + else: # pragma: no cover + warnings.warn( + f"{global_object_name(dh.close)} is not a coroutine function." + f" This is deprecated, please rewrite it to return a coroutine.", + category=ScrapyDeprecationWarning, + stacklevel=1, + ) + await ensure_awaitable(dh.close()) diff --git a/scrapy/core/downloader/handlers/_base_http.py b/scrapy/core/downloader/handlers/_base_http.py new file mode 100644 index 000000000..83d130462 --- /dev/null +++ b/scrapy/core/downloader/handlers/_base_http.py @@ -0,0 +1,25 @@ +from __future__ import annotations + +from abc import ABC +from typing import TYPE_CHECKING + +from .base import BaseDownloadHandler + +if TYPE_CHECKING: + from scrapy.crawler import Crawler + + +class BaseHttpDownloadHandler(BaseDownloadHandler, ABC): + """Base class for built-in HTTP download handlers.""" + + def __init__(self, crawler: Crawler): + super().__init__(crawler) + self._default_maxsize: int = crawler.settings.getint("DOWNLOAD_MAXSIZE") + self._default_warnsize: int = crawler.settings.getint("DOWNLOAD_WARNSIZE") + self._fail_on_dataloss: bool = crawler.settings.getbool( + "DOWNLOAD_FAIL_ON_DATALOSS" + ) + self._tls_verbose_logging: bool = crawler.settings.getbool( + "DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING" + ) + self._fail_on_dataloss_warned: bool = False diff --git a/scrapy/core/downloader/handlers/_base_streaming.py b/scrapy/core/downloader/handlers/_base_streaming.py new file mode 100644 index 000000000..5a669c732 --- /dev/null +++ b/scrapy/core/downloader/handlers/_base_streaming.py @@ -0,0 +1,315 @@ +from __future__ import annotations + +import base64 +import logging +import time +from abc import ABC, abstractmethod +from io import BytesIO +from typing import TYPE_CHECKING, Any, ClassVar, Generic, NoReturn, TypedDict, TypeVar +from urllib.parse import quote, urlsplit + +from scrapy import Request, signals +from scrapy.exceptions import ( + DownloadCancelledError, + NotConfigured, + ResponseDataLossError, +) +from scrapy.utils._download_handlers import ( + check_stop_download, + get_dataloss_msg, + get_maxsize_msg, + get_warnsize_msg, + make_response, + normalize_bind_address, +) +from scrapy.utils.asyncio import is_asyncio_available +from scrapy.utils.url import add_http_if_no_scheme + +from ._base_http import BaseHttpDownloadHandler + +if TYPE_CHECKING: + from collections.abc import AsyncIterable + from contextlib import AbstractAsyncContextManager + from ipaddress import IPv4Address, IPv6Address + + from _typeshed import SizedBuffer + + # typing.NotRequired requires Python 3.11 + from typing_extensions import NotRequired + + from scrapy.crawler import Crawler + from scrapy.http import Headers, Response + + +logger = logging.getLogger(__name__) + +_ResponseT = TypeVar("_ResponseT") + + +class _BaseResponseArgs(TypedDict): + status: int + url: str + headers: Headers + certificate: NotRequired[Any] + ip_address: NotRequired[IPv4Address | IPv6Address | None] + protocol: str | None + + +class BaseStreamingDownloadHandler(BaseHttpDownloadHandler, ABC, Generic[_ResponseT]): + """A base class for HTTP download handlers that follow the streaming logic flow.""" + + _DEFAULT_CONNECT_TIMEOUT: ClassVar[float] = 10 + experimental: ClassVar[bool] = False + requires_asyncio: ClassVar[bool] = True + # require subclasses to disable proxies explicitly with an explanation + supports_proxies: ClassVar[bool] = True + supports_per_request_bindaddress: ClassVar[bool] = False + + def __init__(self, crawler: Crawler): + if self.requires_asyncio and not is_asyncio_available(): # pragma: no cover + raise NotConfigured( + f"{type(self).__name__} requires the asyncio support. Make" + f" sure that you have either enabled the asyncio Twisted" + f" reactor in the TWISTED_REACTOR setting or disabled the" + f" TWISTED_REACTOR_ENABLED setting. See the asyncio documentation" + f" of Scrapy for more information." + ) + self._check_deps_installed() + super().__init__(crawler) + if self.experimental: + logger.warning( + f"{type(self).__name__} is experimental and is not recommended for production use." + ) + self._bind_address = normalize_bind_address( + crawler.settings.get("DOWNLOAD_BIND_ADDRESS") + ) + self._proxy_auth_encoding: str = crawler.settings.get("HTTPPROXY_AUTH_ENCODING") + # these are useful for many handlers but used in different ways by them + self._pool_size_total: int = crawler.settings.getint("CONCURRENT_REQUESTS") + self._pool_size_per_host: int = crawler.settings.getint( + "CONCURRENT_REQUESTS_PER_DOMAIN" + ) + + @staticmethod + @abstractmethod + def _check_deps_installed() -> None: + """Raise NotConfigured if the required deps are not installed.""" + raise NotImplementedError + + @abstractmethod + def _make_request( + self, request: Request, timeout: float + ) -> AbstractAsyncContextManager[_ResponseT]: + """Return an async context manager yielding the library-specific response. + + Exceptions raised by the library should be reraised as Scrapy-specific ones. + """ + raise NotImplementedError + + @staticmethod + @abstractmethod + def _extract_headers(response: _ResponseT) -> Headers: + """Convert library-specific response headers to a + :class:`~scrapy.http.headers.Headers` object.""" + raise NotImplementedError + + @staticmethod + @abstractmethod + def _build_base_response_args( + response: _ResponseT, request: Request, headers: Headers + ) -> _BaseResponseArgs: + """Build kwargs for :func:`scrapy.utils._download_handlers.make_response`.""" + raise NotImplementedError + + @staticmethod + @abstractmethod + def _iter_body_chunks(response: _ResponseT) -> AsyncIterable[SizedBuffer]: + """Return an async iterable yielding body chunks from the response.""" + raise NotImplementedError + + @staticmethod + @abstractmethod + def _is_dataloss_exception(exc: Exception) -> bool: + """Return True if ``exc`` represents dataloss.""" + raise NotImplementedError + + def _log_tls_info(self, response: _ResponseT, request: Request) -> None: + """Log TLS connection details, if possible.""" + + async def download_request(self, request: Request) -> Response: + if not self.supports_proxies and request.meta.get("proxy"): + raise NotImplementedError(f"{type(self).__name__} doesn't support proxies.") + if not self.supports_per_request_bindaddress and request.meta.get( + "bindaddress" + ): + logger.error( + f"The 'bindaddress' request meta key is not supported by" + f" {type(self).__name__} and will be ignored." + ) + timeout: float = request.meta.get( + "download_timeout", self._DEFAULT_CONNECT_TIMEOUT + ) + start_time = time.monotonic() + async with self._make_request(request, timeout) as response: + request.meta["download_latency"] = time.monotonic() - start_time + return await self._read_response(response, request) + + async def _read_response(self, response: _ResponseT, request: Request) -> Response: + maxsize: int = request.meta.get("download_maxsize", self._default_maxsize) + warnsize: int = request.meta.get("download_warnsize", self._default_warnsize) + + headers = self._extract_headers(response) + content_length = headers.get("Content-Length") + expected_size = int(content_length) if content_length is not None else None + if maxsize and expected_size and expected_size > maxsize: + self._cancel_maxsize(expected_size, maxsize, request, expected=True) + + reached_warnsize = False + if warnsize and expected_size and expected_size > warnsize: + reached_warnsize = True + logger.warning( + get_warnsize_msg(expected_size, warnsize, request, expected=True) + ) + + make_response_base_args = self._build_base_response_args( + response, request, headers + ) + + if self._tls_verbose_logging: + self._log_tls_info(response, request) + + if stop_download := check_stop_download( + signals.headers_received, + self.crawler, + request, + headers=headers, + body_length=expected_size, + ): + return make_response( + **make_response_base_args, + stop_download=stop_download, + ) + + response_body = BytesIO() + bytes_received = 0 + try: + async for chunk in self._iter_body_chunks(response): + response_body.write(chunk) + bytes_received += len(chunk) + + if stop_download := check_stop_download( + signals.bytes_received, self.crawler, request, data=chunk + ): + return make_response( + **make_response_base_args, + body=response_body.getvalue(), + stop_download=stop_download, + ) + + if maxsize and bytes_received > maxsize: + response_body.truncate(0) + self._cancel_maxsize( + bytes_received, maxsize, request, expected=False + ) + + if warnsize and bytes_received > warnsize and not reached_warnsize: + reached_warnsize = True + logger.warning( + get_warnsize_msg( + bytes_received, warnsize, request, expected=False + ) + ) + except Exception as e: + if not self._is_dataloss_exception(e): + raise + fail_on_dataloss: bool = request.meta.get( + "download_fail_on_dataloss", self._fail_on_dataloss + ) + if not fail_on_dataloss: + return make_response( + **make_response_base_args, + body=response_body.getvalue(), + flags=["dataloss"], + ) + if not self._fail_on_dataloss_warned: + logger.warning(get_dataloss_msg(request.url)) + self._fail_on_dataloss_warned = True + raise ResponseDataLossError(str(e)) from e + + return make_response( + **make_response_base_args, + body=response_body.getvalue(), + ) + + @staticmethod + def _request_headers(request: Request) -> Headers: + """Get a prepared copy of the request headers. + + This removes the Proxy-Authorization header. + """ + headers = request.headers.copy() + headers.pop(b"Proxy-Authorization", None) + return headers + + def _get_bind_address_host(self) -> str | None: + """Return the host portion of the bind address. + + Needed for handlers that don't support the bind port. + """ + if self._bind_address is None: + return None + host, port = self._bind_address + if port != 0: + logger.warning( + "DOWNLOAD_BIND_ADDRESS specifies a port (%s), but %s does not " + "support binding to a specific local port. Ignoring the port " + "and binding only to %r.", + port, + type(self).__name__, + host, + ) + return host + + @staticmethod + def _cancel_maxsize( + size: int, limit: int, request: Request, *, expected: bool + ) -> NoReturn: + warning_msg = get_maxsize_msg(size, limit, request, expected=expected) + logger.warning(warning_msg) + raise DownloadCancelledError(warning_msg) + + @staticmethod + def _extract_proxy(request: Request) -> tuple[str | None, str | None]: + """Return a tuple of the proxy URL with a scheme and the value of the + Proxy-Authorization header. + + This is useful for handlers that take the proxy headers separately. + """ + proxy: str | None = request.meta.get("proxy") + if not proxy: + return None, None + proxy = add_http_if_no_scheme(proxy) + auth_header: bytes | None = request.headers.get(b"Proxy-Authorization") + return proxy, auth_header.decode("ascii") if auth_header else None + + def _extract_proxy_url_with_creds(self, request: Request) -> str | None: + """Return the proxy URL with the userinfo added based on the + Proxy-Authorization header. + + This is useful for handlers that cannot take the proxy headers + separately. + """ + proxy_url, auth_header = self._extract_proxy(request) + if proxy_url is None or auth_header is None: + return proxy_url + scheme, token = auth_header.split(" ", 1) + if scheme != "Basic": + raise ValueError( + f"Expected Basic auth in Proxy-Authorization, got {scheme}" + ) + user, password = ( + base64.b64decode(token).decode(self._proxy_auth_encoding).split(":", 1) + ) + parts = urlsplit(proxy_url) + netloc = f"{quote(user)}:{quote(password)}@{parts.netloc}" + return parts._replace(netloc=netloc).geturl() diff --git a/scrapy/core/downloader/handlers/_httpx.py b/scrapy/core/downloader/handlers/_httpx.py new file mode 100644 index 000000000..9b54b44d8 --- /dev/null +++ b/scrapy/core/downloader/handlers/_httpx.py @@ -0,0 +1,227 @@ +"""``httpx``-based HTTP(S) download handler. Currently not recommended for production use.""" + +from __future__ import annotations + +import ipaddress +import ssl +from contextlib import asynccontextmanager +from socket import gaierror +from typing import TYPE_CHECKING, ClassVar + +from scrapy.exceptions import ( + CannotResolveHostError, + DownloadConnectionRefusedError, + DownloadFailedError, + DownloadTimeoutError, + NotConfigured, + UnsupportedURLSchemeError, +) +from scrapy.http import Headers +from scrapy.utils._download_handlers import NullCookieJar +from scrapy.utils.python import _iter_exc_causes +from scrapy.utils.ssl import ( + _log_sslobj_debug_info, + _make_insecure_ssl_ctx, + _make_ssl_context, +) + +from ._base_streaming import BaseStreamingDownloadHandler, _BaseResponseArgs + +if TYPE_CHECKING: + from collections.abc import AsyncIterator + + from httpcore import AsyncNetworkStream + + from scrapy import Request + from scrapy.crawler import Crawler + + +HAS_SOCKS = HAS_HTTP2 = False + +try: + import httpx +except ImportError: + httpx = None # type: ignore[assignment] +else: + # a small hack to avoid importing these optional extras unconditionally + + DOWNLOAD_FAILED_EXCEPTIONS: tuple[type[BaseException], ...] = ( + httpx.RequestError, + httpx.InvalidURL, + ) + + try: + import h2.exceptions + + HAS_HTTP2 = True + DOWNLOAD_FAILED_EXCEPTIONS += (h2.exceptions.InvalidBodyLengthError,) + except ImportError: # pragma: no cover + pass + + try: + import socksio.exceptions + + HAS_SOCKS = True + DOWNLOAD_FAILED_EXCEPTIONS += (socksio.exceptions.ProtocolError,) + except ImportError: # pragma: no cover + pass + + +if TYPE_CHECKING: + _Base = BaseStreamingDownloadHandler[httpx.Response] +else: + _Base = BaseStreamingDownloadHandler + + +class HttpxDownloadHandler(_Base): + experimental: ClassVar[bool] = True + + def __init__(self, crawler: Crawler): + super().__init__(crawler) + self._verify_certificates: bool = crawler.settings.getbool( + "DOWNLOAD_VERIFY_CERTIFICATES" + ) + self._enable_h2: bool = crawler.settings.getbool("HTTPX_HTTP2_ENABLED") + if self._enable_h2 and not HAS_HTTP2: # pragma: no cover + raise NotConfigured( + f"HTTP/2 support in {type(self).__name__} requires the 'httpx[http2]' extra to be installed." + ) + self._ssl_context: ssl.SSLContext = _make_ssl_context(crawler.settings) + self._bind_host: str | None = self._get_bind_address_host() + self._limits: httpx.Limits = httpx.Limits( + # hard limit on simultaneous connections + max_connections=self._pool_size_total, + # total number of idle connections in the pool (extra ones are closed) + max_keepalive_connections=self._pool_size_total, + ) + + self._default_client: httpx.AsyncClient = self._make_client() + # httpx doesn't support per-request proxies: https://github.com/encode/httpx/discussions/3183, + # so we keep a pool of clients per proxy URL. LRU eviction can be added here if needed. + self._proxy_clients: dict[str, httpx.AsyncClient] = {} + + @staticmethod + def _check_deps_installed() -> None: + if httpx is None: # pragma: no cover + raise NotConfigured( + "HttpxDownloadHandler requires the httpx library to be installed." + ) + + def _make_client(self, proxy_url: str | None = None) -> httpx.AsyncClient: + if proxy_url: + if proxy_url.startswith("https:") and not self._verify_certificates: + proxy_ssl_context = _make_insecure_ssl_ctx() + else: + proxy_ssl_context = None + proxy = httpx.Proxy(proxy_url, ssl_context=proxy_ssl_context) + else: + proxy = None + + client = httpx.AsyncClient( + cookies=NullCookieJar(), + transport=httpx.AsyncHTTPTransport( + verify=self._ssl_context, + local_address=self._bind_host, + http2=self._enable_h2, + limits=self._limits, + trust_env=False, + proxy=proxy, + ), + ) + # https://github.com/encode/httpx/discussions/1566 + for header_name in ("accept", "accept-encoding", "user-agent"): + client.headers.pop(header_name, None) + return client + + def _get_client(self, proxy_url: str | None) -> httpx.AsyncClient: + if proxy_url is None: + return self._default_client + if cached := self._proxy_clients.get(proxy_url): + return cached + client = self._make_client(proxy_url) + self._proxy_clients[proxy_url] = client + return client + + @asynccontextmanager + async def _make_request( + self, request: Request, timeout: float + ) -> AsyncIterator[httpx.Response]: + proxy = self._extract_proxy_url_with_creds(request) + if proxy and proxy.startswith("socks") and not HAS_SOCKS: # pragma: no cover + raise ValueError( + f"SOCKS proxy support in {type(self).__name__} requires the 'httpx[socks]' extra to be installed." + ) + client = self._get_client(proxy) + headers = self._request_headers(request).to_tuple_list() + + try: + async with client.stream( + request.method, + request.url, + content=request.body, + headers=headers, + timeout=timeout, + ) as response: + yield response + except httpx.TimeoutException as e: + raise DownloadTimeoutError( + f"Getting {request.url} took longer than {timeout} seconds." + ) from e + except httpx.UnsupportedProtocol as e: + raise UnsupportedURLSchemeError(str(e)) from e + except httpx.ConnectError as e: + if any(isinstance(c, gaierror) for c in _iter_exc_causes(e)): + raise CannotResolveHostError(str(e)) from e + raise DownloadConnectionRefusedError(str(e)) from e + except httpx.ProxyError as e: + raise DownloadConnectionRefusedError(str(e)) from e + except DOWNLOAD_FAILED_EXCEPTIONS as e: + raise DownloadFailedError(str(e)) from e + + @staticmethod + def _extract_headers(response: httpx.Response) -> Headers: + return Headers(response.headers.multi_items()) + + @staticmethod + def _build_base_response_args( + response: httpx.Response, + request: Request, + headers: Headers, + ) -> _BaseResponseArgs: + network_stream: AsyncNetworkStream = response.extensions["network_stream"] + server_addr = network_stream.get_extra_info("server_addr") + ip_address = ipaddress.ip_address(server_addr[0]) + ssl_object = network_stream.get_extra_info("ssl_object") + if isinstance(ssl_object, ssl.SSLObject): + cert = ssl_object.getpeercert(binary_form=True) + else: + cert = None + return { + "status": response.status_code, + "url": request.url, + "headers": headers, + "certificate": cert, + "ip_address": ip_address, + "protocol": response.http_version, + } + + @staticmethod + def _iter_body_chunks(response: httpx.Response) -> AsyncIterator[bytes]: + return response.aiter_raw() + + @staticmethod + def _is_dataloss_exception(exc: Exception) -> bool: + return isinstance( + exc, httpx.RemoteProtocolError + ) and "peer closed connection without sending complete message body" in str(exc) + + def _log_tls_info(self, response: httpx.Response, request: Request) -> None: + network_stream: AsyncNetworkStream = response.extensions["network_stream"] + extra_ssl_object = network_stream.get_extra_info("ssl_object") + if isinstance(extra_ssl_object, ssl.SSLObject): + _log_sslobj_debug_info(extra_ssl_object) + + async def close(self) -> None: + await self._default_client.aclose() + for client in self._proxy_clients.values(): + await client.aclose() diff --git a/scrapy/core/downloader/handlers/base.py b/scrapy/core/downloader/handlers/base.py new file mode 100644 index 000000000..999c003b4 --- /dev/null +++ b/scrapy/core/downloader/handlers/base.py @@ -0,0 +1,32 @@ +from __future__ import annotations + +from abc import ABC, abstractmethod +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + # typing.Self requires Python 3.11 + from typing_extensions import Self + + from scrapy import Request + from scrapy.crawler import Crawler + from scrapy.http import Response + + +class BaseDownloadHandler(ABC): + """Optional base class for download handlers.""" + + lazy: bool = False + + def __init__(self, crawler: Crawler): + self.crawler = crawler + + @classmethod + def from_crawler(cls, crawler: Crawler) -> Self: + return cls(crawler) + + @abstractmethod + async def download_request(self, request: Request) -> Response: + raise NotImplementedError + + async def close(self) -> None: # noqa: B027 + pass diff --git a/scrapy/core/downloader/handlers/datauri.py b/scrapy/core/downloader/handlers/datauri.py index b3f286d87..d0f32216c 100644 --- a/scrapy/core/downloader/handlers/datauri.py +++ b/scrapy/core/downloader/handlers/datauri.py @@ -1,28 +1,24 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING from w3lib.url import parse_data_uri +from scrapy.core.downloader.handlers.base import BaseDownloadHandler from scrapy.http import Response, TextResponse from scrapy.responsetypes import responsetypes -from scrapy.utils.decorators import defers if TYPE_CHECKING: - from scrapy import Request, Spider + from scrapy import Request -class DataURIDownloadHandler: - lazy = False - - @defers - def download_request(self, request: Request, spider: Spider) -> Response: +class DataURIDownloadHandler(BaseDownloadHandler): + async def download_request(self, request: Request) -> Response: uri = parse_data_uri(request.url) respcls = responsetypes.from_mimetype(uri.media_type) - resp_kwargs: dict[str, Any] = {} if issubclass(respcls, TextResponse) and uri.media_type.split("/")[0] == "text": charset = uri.media_type_parameters.get("charset") - resp_kwargs["encoding"] = charset + return respcls(url=request.url, body=uri.data, encoding=charset) - return respcls(url=request.url, body=uri.data, **resp_kwargs) + return respcls(url=request.url, body=uri.data) diff --git a/scrapy/core/downloader/handlers/file.py b/scrapy/core/downloader/handlers/file.py index d55c516f0..f080cce48 100644 --- a/scrapy/core/downloader/handlers/file.py +++ b/scrapy/core/downloader/handlers/file.py @@ -5,20 +5,18 @@ from typing import TYPE_CHECKING from w3lib.url import file_uri_to_path +from scrapy.core.downloader.handlers.base import BaseDownloadHandler from scrapy.responsetypes import responsetypes -from scrapy.utils.decorators import defers +from scrapy.utils.asyncio import run_in_thread if TYPE_CHECKING: - from scrapy import Request, Spider + from scrapy import Request from scrapy.http import Response -class FileDownloadHandler: - lazy = False - - @defers - def download_request(self, request: Request, spider: Spider) -> Response: +class FileDownloadHandler(BaseDownloadHandler): + async def download_request(self, request: Request) -> Response: filepath = file_uri_to_path(request.url) - body = Path(filepath).read_bytes() + body = await run_in_thread(Path(filepath).read_bytes) respcls = responsetypes.from_args(filename=filepath, body=body) return respcls(url=request.url, body=body) diff --git a/scrapy/core/downloader/handlers/ftp.py b/scrapy/core/downloader/handlers/ftp.py index 0ad10baff..6258067c1 100644 --- a/scrapy/core/downloader/handlers/ftp.py +++ b/scrapy/core/downloader/handlers/ftp.py @@ -33,27 +33,23 @@ from __future__ import annotations import re from io import BytesIO from pathlib import Path -from typing import TYPE_CHECKING, Any, BinaryIO +from typing import TYPE_CHECKING, BinaryIO, ClassVar from urllib.parse import unquote from twisted.internet.protocol import ClientCreator, Protocol -from twisted.protocols.ftp import CommandFailed, FTPClient +from scrapy.core.downloader.handlers.base import BaseDownloadHandler +from scrapy.exceptions import NotConfigured from scrapy.http import Response from scrapy.responsetypes import responsetypes +from scrapy.utils.defer import maybe_deferred_to_future from scrapy.utils.httpobj import urlparse_cached -from scrapy.utils.python import to_bytes if TYPE_CHECKING: - from twisted.internet.defer import Deferred - from twisted.python.failure import Failure + from twisted.protocols.ftp import FTPClient - # typing.Self requires Python 3.11 - from typing_extensions import Self - - from scrapy import Request, Spider + from scrapy import Request from scrapy.crawler import Crawler - from scrapy.settings import BaseSettings class ReceivedDataProtocol(Protocol): @@ -82,25 +78,23 @@ class ReceivedDataProtocol(Protocol): _CODE_RE = re.compile(r"\d+") -class FTPDownloadHandler: - lazy = False - - CODE_MAPPING: dict[str, int] = { +class FTPDownloadHandler(BaseDownloadHandler): + CODE_MAPPING: ClassVar[dict[str, int]] = { "550": 404, "default": 503, } - def __init__(self, settings: BaseSettings): - self.default_user = settings["FTP_USER"] - self.default_password = settings["FTP_PASSWORD"] - self.passive_mode = settings["FTP_PASSIVE_MODE"] + def __init__(self, crawler: Crawler): + if not crawler.settings.getbool("TWISTED_REACTOR_ENABLED"): + raise NotConfigured(f"{type(self).__name__} requires a Twisted reactor.") + super().__init__(crawler) + self.default_user = crawler.settings["FTP_USER"] + self.default_password = crawler.settings["FTP_PASSWORD"] + self.passive_mode = crawler.settings["FTP_PASSIVE_MODE"] - @classmethod - def from_crawler(cls, crawler: Crawler) -> Self: - return cls(crawler.settings) - - def download_request(self, request: Request, spider: Spider) -> Deferred[Response]: + async def download_request(self, request: Request) -> Response: from twisted.internet import reactor + from twisted.protocols.ftp import CommandFailed, FTPClient parsed_url = urlparse_cached(request) user = request.meta.get("ftp_user", self.default_user) @@ -111,41 +105,23 @@ class FTPDownloadHandler: creator = ClientCreator( reactor, FTPClient, user, password, passive=passive_mode ) - dfd: Deferred[FTPClient] = creator.connectTCP( - parsed_url.hostname, parsed_url.port or 21 + client: FTPClient = await maybe_deferred_to_future( + creator.connectTCP(parsed_url.hostname, parsed_url.port or 21) ) - return dfd.addCallback(self.gotClient, request, unquote(parsed_url.path)) - - def gotClient( - self, client: FTPClient, request: Request, filepath: str - ) -> Deferred[Response]: - self.client = client + filepath = unquote(parsed_url.path) protocol = ReceivedDataProtocol(request.meta.get("ftp_local_filename")) - d = client.retrieveFile(filepath, protocol) - d.addCallback(self._build_response, request, protocol) - d.addErrback(self._failed, request) - return d - - def _build_response( - self, result: Any, request: Request, protocol: ReceivedDataProtocol - ) -> Response: - self.result = result + try: + await maybe_deferred_to_future(client.retrieveFile(filepath, protocol)) + except CommandFailed as e: + message = str(e) + if m := _CODE_RE.search(message): + ftpcode = m.group() + httpcode = self.CODE_MAPPING.get(ftpcode, self.CODE_MAPPING["default"]) + return Response(url=request.url, status=httpcode, body=message.encode()) + raise protocol.close() headers = {"local filename": protocol.filename or b"", "size": protocol.size} body = protocol.filename or protocol.body.read() respcls = responsetypes.from_args(url=request.url, body=body) # hints for Headers-related types may need to be fixed to not use AnyStr return respcls(url=request.url, status=200, body=body, headers=headers) # type: ignore[arg-type] - - def _failed(self, result: Failure, request: Request) -> Response: - message = result.getErrorMessage() - if result.type == CommandFailed: - m = _CODE_RE.search(message) - if m: - ftpcode = m.group() - httpcode = self.CODE_MAPPING.get(ftpcode, self.CODE_MAPPING["default"]) - return Response( - url=request.url, status=httpcode, body=to_bytes(message) - ) - assert result.type - raise result.type(result.value) diff --git a/scrapy/core/downloader/handlers/http.py b/scrapy/core/downloader/handlers/http.py index 93b96c779..dc1b1e375 100644 --- a/scrapy/core/downloader/handlers/http.py +++ b/scrapy/core/downloader/handlers/http.py @@ -1,9 +1,19 @@ -from scrapy.core.downloader.handlers.http10 import HTTP10DownloadHandler +# pragma: no file cover +import warnings + from scrapy.core.downloader.handlers.http11 import ( HTTP11DownloadHandler as HTTPDownloadHandler, ) +from scrapy.exceptions import ScrapyDeprecationWarning + +warnings.warn( + "The scrapy.core.downloader.handlers.http module is deprecated," + " please import scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler" + " instead of its deprecated alias scrapy.core.downloader.handlers.http.HTTPDownloadHandler", + ScrapyDeprecationWarning, + stacklevel=2, +) __all__ = [ - "HTTP10DownloadHandler", "HTTPDownloadHandler", ] diff --git a/scrapy/core/downloader/handlers/http10.py b/scrapy/core/downloader/handlers/http10.py deleted file mode 100644 index 0fbe5fc23..000000000 --- a/scrapy/core/downloader/handlers/http10.py +++ /dev/null @@ -1,65 +0,0 @@ -"""Download handlers for http and https schemes""" - -from __future__ import annotations - -import warnings -from typing import TYPE_CHECKING - -from scrapy.exceptions import ScrapyDeprecationWarning -from scrapy.utils.misc import build_from_crawler, load_object -from scrapy.utils.python import to_unicode - -if TYPE_CHECKING: - from twisted.internet.defer import Deferred - from twisted.internet.interfaces import IConnector - - # typing.Self requires Python 3.11 - from typing_extensions import Self - - from scrapy import Request, Spider - from scrapy.core.downloader.contextfactory import ScrapyClientContextFactory - from scrapy.core.downloader.webclient import ScrapyHTTPClientFactory - from scrapy.crawler import Crawler - from scrapy.http import Response - from scrapy.settings import BaseSettings - - -class HTTP10DownloadHandler: - lazy = False - - def __init__(self, settings: BaseSettings, crawler: Crawler): - warnings.warn( - "HTTP10DownloadHandler is deprecated and will be removed in a future Scrapy version.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - self.HTTPClientFactory: type[ScrapyHTTPClientFactory] = load_object( - settings["DOWNLOADER_HTTPCLIENTFACTORY"] - ) - self.ClientContextFactory: type[ScrapyClientContextFactory] = load_object( - settings["DOWNLOADER_CLIENTCONTEXTFACTORY"] - ) - self._settings: BaseSettings = settings - self._crawler: Crawler = crawler - - @classmethod - def from_crawler(cls, crawler: Crawler) -> Self: - return cls(crawler.settings, crawler) - - def download_request(self, request: Request, spider: Spider) -> Deferred[Response]: - """Return a deferred for the HTTP download""" - factory = self.HTTPClientFactory(request) - self._connect(factory) - return factory.deferred - - def _connect(self, factory: ScrapyHTTPClientFactory) -> IConnector: - from twisted.internet import reactor - - host, port = to_unicode(factory.host), factory.port - if factory.scheme == b"https": - client_context_factory = build_from_crawler( - self.ClientContextFactory, - self._crawler, - ) - return reactor.connectSSL(host, port, factory, client_context_factory) - return reactor.connectTCP(host, port, factory) diff --git a/scrapy/core/downloader/handlers/http11.py b/scrapy/core/downloader/handlers/http11.py index 54fef48b6..85a5ae0d7 100644 --- a/scrapy/core/downloader/handlers/http11.py +++ b/scrapy/core/downloader/handlers/http11.py @@ -6,15 +6,15 @@ import ipaddress import logging import re from contextlib import suppress +from functools import partial from io import BytesIO -from time import time +from time import monotonic from typing import TYPE_CHECKING, Any, TypedDict, TypeVar, cast from urllib.parse import urldefrag, urlparse from twisted.internet import ssl -from twisted.internet.defer import CancelledError, Deferred, succeed +from twisted.internet.defer import Deferred, succeed from twisted.internet.endpoints import TCP4ClientEndpoint -from twisted.internet.error import TimeoutError from twisted.internet.protocol import Factory, Protocol, connectionDone from twisted.python.failure import Failure from twisted.web.client import ( @@ -30,24 +30,42 @@ from twisted.web.http_headers import Headers as TxHeaders from twisted.web.iweb import UNKNOWN_LENGTH, IBodyProducer, IPolicyForHTTPS, IResponse from zope.interface import implementer -from scrapy import Request, Spider, signals -from scrapy.core.downloader.contextfactory import load_context_factory_from_settings -from scrapy.exceptions import StopDownload +from scrapy import Request, signals +from scrapy.core.downloader.contextfactory import _load_context_factory_from_settings +from scrapy.exceptions import ( + DownloadCancelledError, + DownloadTimeoutError, + NotConfigured, + ResponseDataLossError, + StopDownload, +) from scrapy.http import Headers, Response -from scrapy.responsetypes import responsetypes +from scrapy.utils._download_handlers import ( + check_stop_download, + get_dataloss_msg, + get_maxsize_msg, + get_warnsize_msg, + make_response, + normalize_bind_address, + wrap_twisted_exceptions, +) +from scrapy.utils.defer import maybe_deferred_to_future +from scrapy.utils.deprecate import warn_on_deprecated_spider_attribute from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.python import to_bytes, to_unicode +from scrapy.utils.ssl import _log_ssl_conn_debug_info from scrapy.utils.url import add_http_if_no_scheme +from ._base_http import BaseHttpDownloadHandler + if TYPE_CHECKING: from twisted.internet.base import ReactorBase from twisted.internet.interfaces import IConsumer - # typing.NotRequired and typing.Self require Python 3.11 - from typing_extensions import NotRequired, Self + # typing.NotRequired requires Python 3.11 + from typing_extensions import NotRequired from scrapy.crawler import Crawler - from scrapy.settings import BaseSettings logger = logging.getLogger(__name__) @@ -57,52 +75,67 @@ _T = TypeVar("_T") class _ResultT(TypedDict): txresponse: TxResponse - body: bytes - flags: list[str] | None - certificate: ssl.Certificate | None - ip_address: ipaddress.IPv4Address | ipaddress.IPv6Address | None - failure: NotRequired[Failure | None] + body: NotRequired[bytes] + flags: NotRequired[list[str] | None] + certificate: NotRequired[ssl.Certificate | None] + ip_address: NotRequired[ipaddress.IPv4Address | ipaddress.IPv6Address | None] + stop_download: NotRequired[StopDownload | None] -class HTTP11DownloadHandler: - lazy = False - - def __init__(self, settings: BaseSettings, crawler: Crawler): +class HTTP11DownloadHandler(BaseHttpDownloadHandler): + def __init__(self, crawler: Crawler): + if not crawler.settings.getbool("TWISTED_REACTOR_ENABLED"): + raise NotConfigured(f"{type(self).__name__} requires a Twisted reactor.") + super().__init__(crawler) self._crawler = crawler from twisted.internet import reactor self._pool: HTTPConnectionPool = HTTPConnectionPool(reactor, persistent=True) - self._pool.maxPersistentPerHost = settings.getint( + self._pool.maxPersistentPerHost = crawler.settings.getint( "CONCURRENT_REQUESTS_PER_DOMAIN" ) self._pool._factory.noisy = False - self._contextFactory: IPolicyForHTTPS = load_context_factory_from_settings( - settings, crawler + self._contextFactory: IPolicyForHTTPS = _load_context_factory_from_settings( + crawler ) - self._default_maxsize: int = settings.getint("DOWNLOAD_MAXSIZE") - self._default_warnsize: int = settings.getint("DOWNLOAD_WARNSIZE") - self._fail_on_dataloss: bool = settings.getbool("DOWNLOAD_FAIL_ON_DATALOSS") + self._bind_address = crawler.settings.get("DOWNLOAD_BIND_ADDRESS") self._disconnect_timeout: int = 1 - @classmethod - def from_crawler(cls, crawler: Crawler) -> Self: - return cls(crawler.settings, crawler) - - def download_request(self, request: Request, spider: Spider) -> Deferred[Response]: + async def download_request(self, request: Request) -> Response: """Return a deferred for the HTTP download""" - agent = ScrapyAgent( + if hasattr(self._crawler.spider, "download_maxsize"): # pragma: no cover + warn_on_deprecated_spider_attribute("download_maxsize", "DOWNLOAD_MAXSIZE") + if hasattr(self._crawler.spider, "download_warnsize"): # pragma: no cover + warn_on_deprecated_spider_attribute( + "download_warnsize", "DOWNLOAD_WARNSIZE" + ) + + agent = _ScrapyAgent( contextFactory=self._contextFactory, + bindAddress=self._bind_address, pool=self._pool, - maxsize=getattr(spider, "download_maxsize", self._default_maxsize), - warnsize=getattr(spider, "download_warnsize", self._default_warnsize), + maxsize=getattr( + self._crawler.spider, "download_maxsize", self._default_maxsize + ), + warnsize=getattr( + self._crawler.spider, "download_warnsize", self._default_warnsize + ), fail_on_dataloss=self._fail_on_dataloss, crawler=self._crawler, + tls_verbose_logging=self._tls_verbose_logging, ) - return agent.download_request(request) + try: + with wrap_twisted_exceptions(): + return await maybe_deferred_to_future(agent.download_request(request)) + except ResponseDataLossError: + if not self._fail_on_dataloss_warned: + logger.warning(get_dataloss_msg(request.url)) + self._fail_on_dataloss_warned = True + raise - def close(self) -> Deferred[None]: + async def close(self) -> None: from twisted.internet import reactor d: Deferred[None] = self._pool.closeCachedConnections() @@ -110,26 +143,26 @@ class HTTP11DownloadHandler: # we'll manually timeout the deferred. # # Twisted issue addressing this problem can be found here: - # https://twistedmatrix.com/trac/ticket/7738. + # https://github.com/twisted/twisted/issues/7738 # # closeCachedConnections doesn't handle external errbacks, so we'll # issue a callback after `_disconnect_timeout` seconds. - delayed_call = reactor.callLater(self._disconnect_timeout, d.callback, []) + # + # See also https://github.com/scrapy/scrapy/issues/2653 + delayed_call = reactor.callLater(self._disconnect_timeout, d.callback, ()) - def cancel_delayed_call(result: _T) -> _T: + try: + await maybe_deferred_to_future(d) + finally: if delayed_call.active(): delayed_call.cancel() - return result - - d.addBoth(cancel_delayed_call) - return d class TunnelError(Exception): """An HTTP CONNECT tunnel could not be established by the proxy.""" -class TunnelingTCP4ClientEndpoint(TCP4ClientEndpoint): +class _TunnelingTCP4ClientEndpoint(TCP4ClientEndpoint): """An endpoint that tunnels through proxies to allow HTTPS downloads. To accomplish that, this endpoint sends an HTTP CONNECT to the proxy. The HTTP CONNECT is always sent when using this endpoint, I think this could @@ -165,7 +198,7 @@ class TunnelingTCP4ClientEndpoint(TCP4ClientEndpoint): def requestTunnel(self, protocol: Protocol) -> Protocol: """Asks the proxy to open a tunnel.""" assert protocol.transport - tunnelReq = tunnel_request_data( + tunnelReq = _tunnel_request_data( self._tunneledHost, self._tunneledPort, self._proxyAuthHeader ) protocol.transport.write(tunnelReq) @@ -189,11 +222,12 @@ class TunnelingTCP4ClientEndpoint(TCP4ClientEndpoint): if b"\r\n\r\n" not in self._connectBuffer: return self._protocol.dataReceived = self._protocolDataReceived # type: ignore[method-assign] - respm = TunnelingTCP4ClientEndpoint._responseMatcher.match(self._connectBuffer) + respm = _TunnelingTCP4ClientEndpoint._responseMatcher.match(self._connectBuffer) if respm and int(respm.group("status")) == 200: # set proper Server Name Indication extension sslOptions = self._contextFactory.creatorForNetloc( # type: ignore[call-arg,misc] - self._tunneledHost, self._tunneledPort + self._tunneledHost, # type: ignore[arg-type] + self._tunneledPort, ) self._protocol.transport.startTLS(sslOptions, self._protocolFactory) self._tunnelReadyDeferred.callback(self._protocol) @@ -225,18 +259,18 @@ class TunnelingTCP4ClientEndpoint(TCP4ClientEndpoint): return self._tunnelReadyDeferred -def tunnel_request_data( +def _tunnel_request_data( host: str, port: int, proxy_auth_header: bytes | None = None ) -> bytes: r""" Return binary content of a CONNECT request. >>> from scrapy.utils.python import to_unicode as s - >>> s(tunnel_request_data("example.com", 8080)) + >>> s(_tunnel_request_data("example.com", 8080)) 'CONNECT example.com:8080 HTTP/1.1\r\nHost: example.com:8080\r\n\r\n' - >>> s(tunnel_request_data("example.com", 8080, b"123")) + >>> s(_tunnel_request_data("example.com", 8080, b"123")) 'CONNECT example.com:8080 HTTP/1.1\r\nHost: example.com:8080\r\nProxy-Authorization: 123\r\n\r\n' - >>> s(tunnel_request_data(b"example.com", "8090")) + >>> s(_tunnel_request_data(b"example.com", "8090")) 'CONNECT example.com:8090 HTTP/1.1\r\nHost: example.com:8090\r\n\r\n' """ host_value = to_bytes(host, encoding="ascii") + b":" + to_bytes(str(port)) @@ -248,7 +282,7 @@ def tunnel_request_data( return tunnel_req -class TunnelingAgent(Agent): +class _TunnelingAgent(Agent): """An agent that uses a L{TunnelingTCP4ClientEndpoint} to make HTTPS downloads. It may look strange that we have chosen to subclass Agent and not ProxyAgent but consider that after the tunnel is opened the proxy is @@ -263,15 +297,15 @@ class TunnelingAgent(Agent): proxyConf: tuple[str, int, bytes | None], contextFactory: IPolicyForHTTPS, connectTimeout: float | None = None, - bindAddress: bytes | None = None, + bindAddress: tuple[str, int] | None = None, pool: HTTPConnectionPool | None = None, ): - super().__init__(reactor, contextFactory, connectTimeout, bindAddress, pool) + super().__init__(reactor, contextFactory, connectTimeout, bindAddress, pool) # type: ignore[no-untyped-call] self._proxyConf: tuple[str, int, bytes | None] = proxyConf self._contextFactory: IPolicyForHTTPS = contextFactory - def _getEndpoint(self, uri: URI) -> TunnelingTCP4ClientEndpoint: - return TunnelingTCP4ClientEndpoint( + def _getEndpoint(self, uri: URI) -> _TunnelingTCP4ClientEndpoint: + return _TunnelingTCP4ClientEndpoint( reactor=self._reactor, host=uri.host, port=uri.port, @@ -306,17 +340,19 @@ class TunnelingAgent(Agent): ) -class ScrapyProxyAgent(Agent): +class _ScrapyProxyAgent(Agent): def __init__( self, reactor: ReactorBase, proxyURI: bytes, + contextFactory: IPolicyForHTTPS, connectTimeout: float | None = None, - bindAddress: bytes | None = None, + bindAddress: tuple[str, int] | None = None, pool: HTTPConnectionPool | None = None, ): - super().__init__( + super().__init__( # type: ignore[no-untyped-call] reactor=reactor, + contextFactory=contextFactory, connectTimeout=connectTimeout, bindAddress=bindAddress, pool=pool, @@ -337,7 +373,7 @@ class ScrapyProxyAgent(Agent): # connecting to a single destination, the proxy: return self._requestWithEndpoint( key=(b"http-proxy", self._proxyURI.host, self._proxyURI.port), - endpoint=self._getEndpoint(self._proxyURI), + endpoint=self._getEndpoint(self._proxyURI), # type: ignore[no-untyped-call] method=method, parsedURI=URI.fromBytes(uri), headers=headers, @@ -346,37 +382,36 @@ class ScrapyProxyAgent(Agent): ) -class ScrapyAgent: - _Agent = Agent - _ProxyAgent = ScrapyProxyAgent - _TunnelingAgent = TunnelingAgent - +class _ScrapyAgent: def __init__( self, *, contextFactory: IPolicyForHTTPS, connectTimeout: float = 10, - bindAddress: bytes | None = None, + bindAddress: str | tuple[str, int] | None = None, pool: HTTPConnectionPool | None = None, maxsize: int = 0, warnsize: int = 0, fail_on_dataloss: bool = True, crawler: Crawler, + tls_verbose_logging: bool = False, ): self._contextFactory: IPolicyForHTTPS = contextFactory self._connectTimeout: float = connectTimeout - self._bindAddress: bytes | None = bindAddress + self._bindAddress: str | tuple[str, int] | None = bindAddress self._pool: HTTPConnectionPool | None = pool self._maxsize: int = maxsize self._warnsize: int = warnsize self._fail_on_dataloss: bool = fail_on_dataloss self._txresponse: TxResponse | None = None self._crawler: Crawler = crawler + self._tls_verbose_logging: bool = tls_verbose_logging def _get_agent(self, request: Request, timeout: float) -> Agent: from twisted.internet import reactor bindaddress = request.meta.get("bindaddress") or self._bindAddress + bindaddress = normalize_bind_address(bindaddress) proxy = request.meta.get("proxy") if proxy: proxy = add_http_if_no_scheme(proxy) @@ -386,9 +421,14 @@ class ScrapyAgent: if not proxy_port: proxy_port = 443 if proxy_parsed.scheme == "https" else 80 if urlparse_cached(request).scheme == "https": + if proxy_parsed.scheme == "https": # pragma: no cover + raise NotImplementedError( + "HTTPS proxies for HTTPS destinations are not supported" + ) + assert proxy_host is not None proxyAuth = request.headers.get(b"Proxy-Authorization", None) proxyConf = (proxy_host, proxy_port, proxyAuth) - return self._TunnelingAgent( + return _TunnelingAgent( reactor=reactor, proxyConf=proxyConf, contextFactory=self._contextFactory, @@ -396,15 +436,16 @@ class ScrapyAgent: bindAddress=bindaddress, pool=self._pool, ) - return self._ProxyAgent( + return _ScrapyProxyAgent( reactor=reactor, proxyURI=to_bytes(proxy, encoding="ascii"), + contextFactory=self._contextFactory, connectTimeout=timeout, bindAddress=bindaddress, pool=self._pool, ) - return self._Agent( + return Agent( reactor=reactor, contextFactory=self._contextFactory, connectTimeout=timeout, @@ -422,21 +463,21 @@ class ScrapyAgent: url = urldefrag(request.url)[0] method = to_bytes(request.method) headers = TxHeaders(request.headers) - if isinstance(agent, self._TunnelingAgent): + if isinstance(agent, _TunnelingAgent): headers.removeHeader(b"Proxy-Authorization") bodyproducer = _RequestBodyProducer(request.body) if request.body else None - start_time = time() + start_time = monotonic() d: Deferred[IResponse] = agent.request( method, to_bytes(url, encoding="ascii"), headers, - cast(IBodyProducer, bodyproducer), + cast("IBodyProducer", bodyproducer), ) # set download latency d.addCallback(self._cb_latency, request, start_time) # response body is ready to be consumed d2: Deferred[_ResultT] = d.addCallback(self._cb_bodyready, request) - d3: Deferred[Response] = d2.addCallback(self._cb_bodydone, request, url) + d3: Deferred[Response] = d2.addCallback(self._cb_bodydone, url) # check download timeout self._timeout_cl = reactor.callLater(timeout, d3.cancel) d3.addBoth(self._cb_timeout, request, url, timeout) @@ -451,10 +492,10 @@ class ScrapyAgent: if self._txresponse: self._txresponse._transport.stopProducing() - raise TimeoutError(f"Getting {url} took longer than {timeout} seconds.") + raise DownloadTimeoutError(f"Getting {url} took longer than {timeout} seconds.") def _cb_latency(self, result: _T, request: Request, start_time: float) -> _T: - request.meta["download_latency"] = time() - start_time + request.meta["download_latency"] = monotonic() - start_time return result @staticmethod @@ -468,75 +509,51 @@ class ScrapyAgent: def _cb_bodyready( self, txresponse: TxResponse, request: Request ) -> _ResultT | Deferred[_ResultT]: - headers_received_result = self._crawler.signals.send_catch_log( - signal=signals.headers_received, + if stop_download := check_stop_download( + signals.headers_received, + self._crawler, + request, headers=self._headers_from_twisted_response(txresponse), body_length=txresponse.length, - request=request, - spider=self._crawler.spider, - ) - for handler, result in headers_received_result: - if isinstance(result, Failure) and isinstance(result.value, StopDownload): - logger.debug( - "Download stopped for %(request)s from signal handler %(handler)s", - {"request": request, "handler": handler.__qualname__}, - ) - txresponse._transport.stopProducing() - txresponse._transport.loseConnection() - return { - "txresponse": txresponse, - "body": b"", - "flags": ["download_stopped"], - "certificate": None, - "ip_address": None, - "failure": result if result.value.fail else None, - } - - # deliverBody hangs for responses without body - if txresponse.length == 0: + ): + txresponse._transport.stopProducing() + txresponse._transport.loseConnection() + return { + "txresponse": txresponse, + "stop_download": stop_download, + } + + # deliverBody hangs for responses without body + if cast("int", txresponse.length) == 0: return { "txresponse": txresponse, - "body": b"", - "flags": None, - "certificate": None, - "ip_address": None, } maxsize = request.meta.get("download_maxsize", self._maxsize) warnsize = request.meta.get("download_warnsize", self._warnsize) - expected_size = txresponse.length if txresponse.length != UNKNOWN_LENGTH else -1 + expected_size = ( + cast("int", txresponse.length) + if txresponse.length != UNKNOWN_LENGTH + else -1 + ) fail_on_dataloss = request.meta.get( "download_fail_on_dataloss", self._fail_on_dataloss ) if maxsize and expected_size > maxsize: - warning_msg = ( - "Cancelling download of %(url)s: expected response " - "size (%(size)s) larger than download max size (%(maxsize)s)." + warning_msg = get_maxsize_msg( + expected_size, maxsize, request, expected=True ) - warning_args = { - "url": request.url, - "size": expected_size, - "maxsize": maxsize, - } - - logger.warning(warning_msg, warning_args) - + logger.warning(warning_msg) txresponse._transport.loseConnection() - raise CancelledError(warning_msg % warning_args) + raise DownloadCancelledError(warning_msg) if warnsize and expected_size > warnsize: logger.warning( - "Expected response size (%(size)s) larger than " - "download warn size (%(warnsize)s) in request %(request)s.", - {"size": expected_size, "warnsize": warnsize, "request": request}, + get_warnsize_msg(expected_size, warnsize, request, expected=True) ) - def _cancel(_: Any) -> None: - # Abort connection immediately. - txresponse._transport._producer.abortConnection() - - d: Deferred[_ResultT] = Deferred(_cancel) + d: Deferred[_ResultT] = Deferred(partial(self._cancel, txresponse=txresponse)) txresponse.deliverBody( _ResponseReader( finished=d, @@ -546,6 +563,7 @@ class ScrapyAgent: warnsize=warnsize, fail_on_dataloss=fail_on_dataloss, crawler=self._crawler, + tls_verbose_logging=self._tls_verbose_logging, ) ) @@ -554,31 +572,29 @@ class ScrapyAgent: return d - def _cb_bodydone( - self, result: _ResultT, request: Request, url: str - ) -> Response | Failure: + @staticmethod + def _cancel(_: Any, txresponse: TxResponse) -> None: + # Abort connection immediately. + txresponse._transport._producer.abortConnection() + + def _cb_bodydone(self, result: _ResultT, url: str) -> Response: headers = self._headers_from_twisted_response(result["txresponse"]) - respcls = responsetypes.from_args(headers=headers, url=url, body=result["body"]) try: version = result["txresponse"].version protocol = f"{to_unicode(version[0])}/{version[1]}.{version[2]}" except (AttributeError, TypeError, IndexError): protocol = None - response = respcls( + return make_response( url=url, status=int(result["txresponse"].code), headers=headers, - body=result["body"], - flags=result["flags"], - certificate=result["certificate"], - ip_address=result["ip_address"], + body=result.get("body", b""), + flags=result.get("flags"), + certificate=result.get("certificate"), + ip_address=result.get("ip_address"), protocol=protocol, + stop_download=result.get("stop_download"), ) - if result.get("failure"): - assert result["failure"] - result["failure"].value.response = response - return result["failure"] - return response @implementer(IBodyProducer) @@ -608,6 +624,8 @@ class _ResponseReader(Protocol): warnsize: int, fail_on_dataloss: bool, crawler: Crawler, + *, + tls_verbose_logging: bool = False, ): self._finished: Deferred[_ResultT] = finished self._txresponse: TxResponse = txresponse @@ -616,15 +634,15 @@ class _ResponseReader(Protocol): self._maxsize: int = maxsize self._warnsize: int = warnsize self._fail_on_dataloss: bool = fail_on_dataloss - self._fail_on_dataloss_warned: bool = False self._reached_warnsize: bool = False self._bytes_received: int = 0 self._certificate: ssl.Certificate | None = None self._ip_address: ipaddress.IPv4Address | ipaddress.IPv6Address | None = None self._crawler: Crawler = crawler + self._tls_verbose_logging: bool = tls_verbose_logging def _finish_response( - self, flags: list[str] | None = None, failure: Failure | None = None + self, flags: list[str] | None = None, stop_download: StopDownload | None = None ) -> None: self._finished.callback( { @@ -633,7 +651,7 @@ class _ResponseReader(Protocol): "flags": flags, "certificate": self._certificate, "ip_address": self._ip_address, - "failure": failure, + "stop_download": stop_download, } ) @@ -650,41 +668,33 @@ class _ResponseReader(Protocol): self.transport._producer.getPeer().host ) - def dataReceived(self, bodyBytes: bytes) -> None: + if self._tls_verbose_logging: + connection = self.transport._producer.getHandle() + hostname = urlparse_cached(self._request).hostname + assert hostname is not None + _log_ssl_conn_debug_info(hostname, connection) + + def dataReceived(self, data: bytes) -> None: # This maybe called several times after cancel was called with buffered data. if self._finished.called: return assert self.transport - self._bodybuf.write(bodyBytes) - self._bytes_received += len(bodyBytes) + self._bodybuf.write(data) + self._bytes_received += len(data) - bytes_received_result = self._crawler.signals.send_catch_log( - signal=signals.bytes_received, - data=bodyBytes, - request=self._request, - spider=self._crawler.spider, - ) - for handler, result in bytes_received_result: - if isinstance(result, Failure) and isinstance(result.value, StopDownload): - logger.debug( - "Download stopped for %(request)s from signal handler %(handler)s", - {"request": self._request, "handler": handler.__qualname__}, - ) - self.transport.stopProducing() - self.transport.loseConnection() - failure = result if result.value.fail else None - self._finish_response(flags=["download_stopped"], failure=failure) + if stop_download := check_stop_download( + signals.bytes_received, self._crawler, self._request, data=data + ): + self.transport.stopProducing() + self.transport.loseConnection() + self._finish_response(stop_download=stop_download) if self._maxsize and self._bytes_received > self._maxsize: logger.warning( - "Received (%(bytes)s) bytes larger than download " - "max size (%(maxsize)s) in request %(request)s.", - { - "bytes": self._bytes_received, - "maxsize": self._maxsize, - "request": self._request, - }, + get_maxsize_msg( + self._bytes_received, self._maxsize, self._request, expected=False + ) ) # Clear buffer earlier to avoid keeping data in memory for a long time. self._bodybuf.truncate(0) @@ -697,9 +707,9 @@ class _ResponseReader(Protocol): ): self._reached_warnsize = True logger.warning( - "Received more bytes than download " - "warn size (%(warnsize)s) in request %(request)s.", - {"warnsize": self._warnsize, "request": self._request}, + get_warnsize_msg( + self._bytes_received, self._warnsize, self._request, expected=False + ) ) def connectionLost(self, reason: Failure = connectionDone) -> None: @@ -715,19 +725,15 @@ class _ResponseReader(Protocol): return if reason.check(ResponseFailed) and any( - r.check(_DataLoss) for r in reason.value.reasons + r.check(_DataLoss) + for r in reason.value.reasons # type: ignore[union-attr] ): if not self._fail_on_dataloss: self._finish_response(flags=["dataloss"]) return - if not self._fail_on_dataloss_warned: - logger.warning( - "Got data loss in %s. If you want to process broken " - "responses set the setting DOWNLOAD_FAIL_ON_DATALOSS = False" - " -- This message won't be shown in further requests", - self._txresponse.request.absoluteURI.decode(), - ) - self._fail_on_dataloss_warned = True + exc = ResponseDataLossError() + exc.__cause__ = reason.value + reason = Failure(exc) self._finished.errback(reason) diff --git a/scrapy/core/downloader/handlers/http2.py b/scrapy/core/downloader/handlers/http2.py index d0a95ee9d..f60c58d1b 100644 --- a/scrapy/core/downloader/handlers/http2.py +++ b/scrapy/core/downloader/handlers/http2.py @@ -1,66 +1,77 @@ from __future__ import annotations -from time import time +from time import monotonic from typing import TYPE_CHECKING from urllib.parse import urldefrag -from twisted.internet.error import TimeoutError -from twisted.web.client import URI - -from scrapy.core.downloader.contextfactory import load_context_factory_from_settings -from scrapy.core.http2.agent import H2Agent, H2ConnectionPool, ScrapyProxyH2Agent +from scrapy.core.downloader.contextfactory import _load_context_factory_from_settings +from scrapy.core.downloader.handlers.base import BaseDownloadHandler +from scrapy.core.http2.agent import H2Agent, H2ConnectionPool +from scrapy.exceptions import ( + DownloadTimeoutError, + NotConfigured, + UnsupportedURLSchemeError, +) +from scrapy.utils._download_handlers import ( + normalize_bind_address, + wrap_twisted_exceptions, +) +from scrapy.utils.defer import maybe_deferred_to_future from scrapy.utils.httpobj import urlparse_cached -from scrapy.utils.python import to_bytes if TYPE_CHECKING: from twisted.internet.base import DelayedCall from twisted.internet.defer import Deferred from twisted.web.iweb import IPolicyForHTTPS - # typing.Self requires Python 3.11 - from typing_extensions import Self - from scrapy.crawler import Crawler from scrapy.http import Request, Response - from scrapy.settings import Settings from scrapy.spiders import Spider -class H2DownloadHandler: - def __init__(self, settings: Settings, crawler: Crawler): +class H2DownloadHandler(BaseDownloadHandler): + lazy = True + + def __init__(self, crawler: Crawler): + if not crawler.settings.getbool("TWISTED_REACTOR_ENABLED"): + raise NotConfigured(f"{type(self).__name__} requires a Twisted reactor.") + super().__init__(crawler) self._crawler = crawler from twisted.internet import reactor - self._pool = H2ConnectionPool(reactor, settings) - self._context_factory = load_context_factory_from_settings(settings, crawler) + self._pool = H2ConnectionPool(reactor, crawler.settings) + self._context_factory = _load_context_factory_from_settings(crawler) + self._bind_address = crawler.settings.get("DOWNLOAD_BIND_ADDRESS") - @classmethod - def from_crawler(cls, crawler: Crawler) -> Self: - return cls(crawler.settings, crawler) - - def download_request(self, request: Request, spider: Spider) -> Deferred[Response]: - agent = ScrapyH2Agent( + async def download_request(self, request: Request) -> Response: + if urlparse_cached(request).scheme == "http": # pragma: no cover + raise UnsupportedURLSchemeError( + f"{type(self).__name__} doesn't support plain HTTP." + ) + agent = _ScrapyH2Agent( context_factory=self._context_factory, pool=self._pool, + bind_address=self._bind_address, crawler=self._crawler, ) - return agent.download_request(request, spider) + assert self._crawler.spider + with wrap_twisted_exceptions(): + return await maybe_deferred_to_future( + agent.download_request(request, self._crawler.spider) + ) - def close(self) -> None: + async def close(self) -> None: self._pool.close_connections() -class ScrapyH2Agent: - _Agent = H2Agent - _ProxyAgent = ScrapyProxyH2Agent - +class _ScrapyH2Agent: def __init__( self, context_factory: IPolicyForHTTPS, pool: H2ConnectionPool, connect_timeout: int = 10, - bind_address: bytes | None = None, + bind_address: str | tuple[str, int] | None = None, crawler: Crawler | None = None, ) -> None: self._context_factory = context_factory @@ -72,24 +83,11 @@ class ScrapyH2Agent: def _get_agent(self, request: Request, timeout: float | None) -> H2Agent: from twisted.internet import reactor + if request.meta.get("proxy"): # pragma: no cover + raise NotImplementedError(f"{type(self).__name__} doesn't support proxies.") bind_address = request.meta.get("bindaddress") or self._bind_address - proxy = request.meta.get("proxy") - if proxy: - if urlparse_cached(request).scheme == "https": - # ToDo - raise NotImplementedError( - "Tunneling via CONNECT method using HTTP/2.0 is not yet supported" - ) - return self._ProxyAgent( - reactor=reactor, - context_factory=self._context_factory, - proxy_uri=URI.fromBytes(to_bytes(proxy, encoding="ascii")), - connect_timeout=timeout, - bind_address=bind_address, - pool=self._pool, - ) - - return self._Agent( + bind_address = normalize_bind_address(bind_address) + return H2Agent( reactor=reactor, context_factory=self._context_factory, connect_timeout=timeout, @@ -103,7 +101,7 @@ class ScrapyH2Agent: timeout = request.meta.get("download_timeout") or self._connect_timeout agent = self._get_agent(request, timeout) - start_time = time() + start_time = monotonic() d = agent.request(request, spider) d.addCallback(self._cb_latency, request, start_time) @@ -115,7 +113,7 @@ class ScrapyH2Agent: def _cb_latency( response: Response, request: Request, start_time: float ) -> Response: - request.meta["download_latency"] = time() - start_time + request.meta["download_latency"] = monotonic() - start_time return response @staticmethod @@ -127,4 +125,4 @@ class ScrapyH2Agent: return response url = urldefrag(request.url)[0] - raise TimeoutError(f"Getting {url} took longer than {timeout} seconds.") + raise DownloadTimeoutError(f"Getting {url} took longer than {timeout} seconds.") diff --git a/scrapy/core/downloader/handlers/s3.py b/scrapy/core/downloader/handlers/s3.py index 870a26f04..c6660ff48 100644 --- a/scrapy/core/downloader/handlers/s3.py +++ b/scrapy/core/downloader/handlers/s3.py @@ -1,65 +1,38 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, cast -from scrapy.core.downloader.handlers.http import HTTPDownloadHandler +from scrapy.core.downloader.handlers.base import BaseDownloadHandler from scrapy.exceptions import NotConfigured from scrapy.utils.boto import is_botocore_available from scrapy.utils.httpobj import urlparse_cached -from scrapy.utils.misc import build_from_crawler +from scrapy.utils.misc import build_from_crawler, load_object if TYPE_CHECKING: - from twisted.internet.defer import Deferred + from collections.abc import Mapping - # typing.Self requires Python 3.11 - from typing_extensions import Self - - from scrapy import Request, Spider + from scrapy import Request from scrapy.crawler import Crawler from scrapy.http import Response - from scrapy.settings import BaseSettings -class S3DownloadHandler: - def __init__( - self, - settings: BaseSettings, - *, - crawler: Crawler, - aws_access_key_id: str | None = None, - aws_secret_access_key: str | None = None, - aws_session_token: str | None = None, - httpdownloadhandler: type[HTTPDownloadHandler] = HTTPDownloadHandler, - **kw: Any, - ): +class S3DownloadHandler(BaseDownloadHandler): + lazy = True + + def __init__(self, crawler: Crawler): if not is_botocore_available(): raise NotConfigured("missing botocore library") - if not aws_access_key_id: - aws_access_key_id = settings["AWS_ACCESS_KEY_ID"] - if not aws_secret_access_key: - aws_secret_access_key = settings["AWS_SECRET_ACCESS_KEY"] - if not aws_session_token: - aws_session_token = settings["AWS_SESSION_TOKEN"] - - # If no credentials could be found anywhere, - # consider this an anonymous connection request by default; - # unless 'anon' was set explicitly (True/False). - anon = kw.get("anon") - if anon is None and not aws_access_key_id and not aws_secret_access_key: - kw["anon"] = True - self.anon = kw.get("anon") - + super().__init__(crawler) + aws_access_key_id = crawler.settings["AWS_ACCESS_KEY_ID"] + aws_secret_access_key = crawler.settings["AWS_SECRET_ACCESS_KEY"] + aws_session_token = crawler.settings["AWS_SESSION_TOKEN"] + self.anon = not aws_access_key_id and not aws_secret_access_key self._signer = None - import botocore.auth - import botocore.credentials - - kw.pop("anon", None) - if kw: - raise TypeError(f"Unexpected keyword arguments: {kw}") if not self.anon: - assert aws_access_key_id is not None - assert aws_secret_access_key is not None + import botocore.auth # noqa: PLC0415 + import botocore.credentials # noqa: PLC0415 + SignerCls = botocore.auth.AUTH_TYPE_MAPS["s3"] # botocore.auth.BaseSigner doesn't have an __init__() with args, only subclasses do self._signer = SignerCls( # type: ignore[call-arg] @@ -68,17 +41,13 @@ class S3DownloadHandler: ) ) - _http_handler = build_from_crawler( - httpdownloadhandler, + _http_handler: BaseDownloadHandler = build_from_crawler( + load_object(crawler.settings.getwithbase("DOWNLOAD_HANDLERS")["https"]), crawler, ) self._download_http = _http_handler.download_request - @classmethod - def from_crawler(cls, crawler: Crawler, **kwargs: Any) -> Self: - return cls(crawler.settings, crawler=crawler, **kwargs) - - def download_request(self, request: Request, spider: Spider) -> Deferred[Response]: + async def download_request(self, request: Request) -> Response: p = urlparse_cached(request) scheme = "https" if request.meta.get("is_secure") else "http" bucket = p.hostname @@ -87,15 +56,15 @@ class S3DownloadHandler: if self.anon: request = request.replace(url=url) else: - import botocore.awsrequest + import botocore.awsrequest # noqa: PLC0415 awsrequest = botocore.awsrequest.AWSRequest( method=request.method, url=f"{scheme}://s3.amazonaws.com/{bucket}{path}", - headers=request.headers.to_unicode_dict(), + headers=cast("Mapping[str, Any]", request.headers.to_unicode_dict()), data=request.body, ) assert self._signer self._signer.add_auth(awsrequest) request = request.replace(url=url, headers=awsrequest.headers.items()) - return self._download_http(request, spider) + return await self._download_http(request) diff --git a/scrapy/core/downloader/middleware.py b/scrapy/core/downloader/middleware.py index a4055849d..ab74e22a4 100644 --- a/scrapy/core/downloader/middleware.py +++ b/scrapy/core/downloader/middleware.py @@ -6,19 +6,26 @@ See documentation in docs/topics/downloader-middleware.rst from __future__ import annotations -from collections.abc import Callable -from typing import TYPE_CHECKING, Any, cast +import warnings +from functools import wraps +from typing import TYPE_CHECKING, Any -from twisted.internet.defer import Deferred, inlineCallbacks - -from scrapy.exceptions import _InvalidOutput +from scrapy.exceptions import ScrapyDeprecationWarning, _InvalidOutput from scrapy.http import Request, Response from scrapy.middleware import MiddlewareManager from scrapy.utils.conf import build_component_list -from scrapy.utils.defer import deferred_from_coro, mustbe_deferred +from scrapy.utils.defer import ( + _defer_sleep_async, + deferred_from_coro, + ensure_awaitable, + maybe_deferred_to_future, +) +from scrapy.utils.python import global_object_name if TYPE_CHECKING: - from collections.abc import Generator + from collections.abc import Callable, Coroutine + + from twisted.internet.defer import Deferred from scrapy import Spider from scrapy.settings import BaseSettings @@ -29,90 +36,121 @@ class DownloaderMiddlewareManager(MiddlewareManager): @classmethod def _get_mwlist_from_settings(cls, settings: BaseSettings) -> list[Any]: - return build_component_list(settings.getwithbase("DOWNLOADER_MIDDLEWARES")) + return build_component_list( + settings.get_component_priority_dict_with_base("DOWNLOADER_MIDDLEWARES") + ) def _add_middleware(self, mw: Any) -> None: if hasattr(mw, "process_request"): self.methods["process_request"].append(mw.process_request) + self._check_mw_method_spider_arg(mw.process_request) if hasattr(mw, "process_response"): self.methods["process_response"].appendleft(mw.process_response) + self._check_mw_method_spider_arg(mw.process_response) if hasattr(mw, "process_exception"): self.methods["process_exception"].appendleft(mw.process_exception) + self._check_mw_method_spider_arg(mw.process_exception) - @inlineCallbacks def download( self, download_func: Callable[[Request, Spider], Deferred[Response]], request: Request, spider: Spider, - ) -> Generator[Deferred[Any], Any, Response | Request]: - @inlineCallbacks - def process_request( - request: Request, - ) -> Generator[Deferred[Any], Any, Response | Request]: - for method in self.methods["process_request"]: - method = cast(Callable, method) - response = yield deferred_from_coro( - method(request=request, spider=spider) - ) - if response is not None and not isinstance( - response, (Response, Request) - ): - raise _InvalidOutput( - f"Middleware {method.__qualname__} must return None, Response or " - f"Request, got {response.__class__.__name__}" - ) - if response: - return response - return (yield download_func(request, spider)) + ) -> Deferred[Response | Request]: + warnings.warn( + "DownloaderMiddlewareManager.download() is deprecated, use download_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) - @inlineCallbacks - def process_response( - response: Response | Request, - ) -> Generator[Deferred[Any], Any, Response | Request]: - if response is None: - raise TypeError("Received None in process_response") - if isinstance(response, Request): - return response + @wraps(download_func) + async def download_func_wrapped(request: Request) -> Response: + return await maybe_deferred_to_future(download_func(request, spider)) - for method in self.methods["process_response"]: - method = cast(Callable, method) - response = yield deferred_from_coro( - method(request=request, response=response, spider=spider) - ) - if not isinstance(response, (Response, Request)): - raise _InvalidOutput( - f"Middleware {method.__qualname__} must return Response or Request, " - f"got {type(response)}" - ) - if isinstance(response, Request): - return response - return response + self._set_compat_spider(spider) + return deferred_from_coro(self.download_async(download_func_wrapped, request)) - @inlineCallbacks - def process_exception( - exception: Exception, - ) -> Generator[Deferred[Any], Any, Response | Request]: - for method in self.methods["process_exception"]: - method = cast(Callable, method) - response = yield deferred_from_coro( - method(request=request, exception=exception, spider=spider) - ) - if response is not None and not isinstance( - response, (Response, Request) - ): - raise _InvalidOutput( - f"Middleware {method.__qualname__} must return None, Response or " - f"Request, got {type(response)}" - ) - if response: - return response - raise exception + async def download_async( + self, + download_func: Callable[[Request], Coroutine[Any, Any, Response]], + request: Request, + ) -> Response | Request: try: - result: Response | Request = yield mustbe_deferred(process_request, request) + result: Response | Request = await self._process_request( + request, download_func + ) except Exception as ex: + await _defer_sleep_async() # either returns a request or response (which we pass to process_response()) # or reraises the exception - result = yield process_exception(ex) - return (yield process_response(result)) + result = await self._process_exception(ex, request) + return await self._process_response(result, request) + + def _handle_mw_method(self, method: Callable[..., Any], **kwargs: Any) -> Any: + if method in self._mw_methods_requiring_spider: + kwargs["spider"] = self._spider + + return method(**kwargs) + + async def _process_request( + self, + request: Request, + download_func: Callable[[Request], Coroutine[Any, Any, Response]], + ) -> Response | Request: + for method in self.methods["process_request"]: + assert method is not None + response = await ensure_awaitable( + self._handle_mw_method(method, request=request), + _warn=global_object_name(method), + ) + if response is not None and not isinstance(response, (Response, Request)): + raise _InvalidOutput( + f"Middleware {method.__qualname__} must return None, Response or " + f"Request, got {response.__class__.__name__}" + ) + if response: + return response + return await download_func(request) + + async def _process_response( + self, response: Response | Request, request: Request + ) -> Response | Request: + if response is None: + raise TypeError("Received None in process_response") + if isinstance(response, Request): + return response + + for method in self.methods["process_response"]: + assert method is not None + response = await ensure_awaitable( + self._handle_mw_method(method, request=request, response=response), + _warn=global_object_name(method), + ) + + if not isinstance(response, (Response, Request)): + raise _InvalidOutput( + f"Middleware {method.__qualname__} must return Response or Request, " + f"got {type(response)}" + ) + if isinstance(response, Request): + return response + return response + + async def _process_exception( + self, exception: Exception, request: Request | Response + ) -> Response | Request: + for method in self.methods["process_exception"]: + assert method is not None + response = await ensure_awaitable( + self._handle_mw_method(method, request=request, exception=exception), + _warn=global_object_name(method), + ) + if response is not None and not isinstance(response, (Response, Request)): + raise _InvalidOutput( + f"Middleware {method.__qualname__} must return None, Response or " + f"Request, got {type(response)}" + ) + if response: + return response + raise exception diff --git a/scrapy/core/downloader/tls.py b/scrapy/core/downloader/tls.py index 1ae66f614..3b903b39d 100644 --- a/scrapy/core/downloader/tls.py +++ b/scrapy/core/downloader/tls.py @@ -1,35 +1,74 @@ +from __future__ import annotations + import logging -from typing import Any +import warnings +from typing import TYPE_CHECKING, Any from OpenSSL import SSL +from service_identity import VerificationError from service_identity.exceptions import CertificateError -from twisted.internet._sslverify import ( - ClientTLSOptions, - VerificationError, - verifyHostname, +from service_identity.hazmat import ( + DNS_ID, + IPAddress_ID, + ServiceID, + verify_service_identity, ) -from twisted.internet.ssl import AcceptableCiphers +from service_identity.pyopenssl import ( + extract_patterns, + verify_hostname, + verify_ip_address, +) +from twisted.internet._sslverify import ClientTLSOptions +from twisted.internet.ssl import AcceptableCiphers, TLSVersion + +from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.utils.deprecate import create_deprecated_class + +if TYPE_CHECKING: + from collections.abc import Callable + + from OpenSSL.crypto import X509 + from twisted.protocols.tls import TLSMemoryBIOProtocol -from scrapy.utils.ssl import get_temp_key_info, x509name_to_string logger = logging.getLogger(__name__) -METHOD_TLS = "TLS" -METHOD_TLSv10 = "TLSv1.0" -METHOD_TLSv11 = "TLSv1.1" -METHOD_TLSv12 = "TLSv1.2" - - -openssl_methods: dict[str, int] = { - METHOD_TLS: SSL.SSLv23_METHOD, # protocol negotiation (recommended) - METHOD_TLSv10: SSL.TLSv1_METHOD, # TLS 1.0 only - METHOD_TLSv11: SSL.TLSv1_1_METHOD, # TLS 1.1 only - METHOD_TLSv12: SSL.TLSv1_2_METHOD, # TLS 1.2 only +_openssl_methods: dict[str, int] = { + "TLS": SSL.SSLv23_METHOD, # protocol negotiation (recommended) + "TLSv1.0": SSL.TLSv1_METHOD, # TLS 1.0 only + "TLSv1.1": SSL.TLSv1_1_METHOD, # TLS 1.1 only + "TLSv1.2": SSL.TLSv1_2_METHOD, # TLS 1.2 only } -class ScrapyClientTLSOptions(ClientTLSOptions): +def __getattr__(name: str) -> Any: + deprecated = { + "METHOD_TLS": "TLS", + "METHOD_TLSv10": "TLSv1.0", + "METHOD_TLSv11": "TLSv1.1", + "METHOD_TLSv12": "TLSv1.2", + "openssl_methods": _openssl_methods, + } + if name in deprecated: + warnings.warn( + f"scrapy.core.downloader.tls.{name} is deprecated.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return deprecated[name] + raise AttributeError(f"module {__name__!r} has no attribute {name!r}") + + +_TWISTED_VERSION_MAP: dict[str, TLSVersion] = { + "TLSv1.0": TLSVersion.TLSv1_0, + "TLSv1.1": TLSVersion.TLSv1_1, + "TLSv1.2": TLSVersion.TLSv1_2, + "TLSv1.3": TLSVersion.TLSv1_3, +} + + +class _ScrapyClientTLSOptions(ClientTLSOptions): """ SSL Client connection creator ignoring certificate verification errors (for genuinely invalid certificates or bugs in verification code). @@ -37,46 +76,29 @@ class ScrapyClientTLSOptions(ClientTLSOptions): Same as Twisted's private _sslverify.ClientTLSOptions, except that VerificationError, CertificateError and ValueError exceptions are caught, so that the connection is not closed, only - logging warnings. Also, HTTPS connection parameters logging is added. - """ + logging warnings. - def __init__(self, hostname: str, ctx: SSL.Context, verbose_logging: bool = False): - super().__init__(hostname, ctx) - self.verbose_logging: bool = verbose_logging + Instances of this class are returned from + :class:`._ScrapyClientContextFactory`. + + This class is used on Twisted older than 26.4.0. + """ def _identityVerifyingInfoCallback( self, connection: SSL.Connection, where: int, ret: Any ) -> None: - if where & SSL.SSL_CB_HANDSHAKE_START: - connection.set_tlsext_host_name(self._hostnameBytes) - elif where & SSL.SSL_CB_HANDSHAKE_DONE: - if self.verbose_logging: - logger.debug( - "SSL connection to %s using protocol %s, cipher %s", - self._hostnameASCII, - connection.get_protocol_version_name(), - connection.get_cipher_name(), - ) - server_cert = connection.get_peer_certificate() - if server_cert: - logger.debug( - 'SSL connection certificate: issuer "%s", subject "%s"', - x509name_to_string(server_cert.get_issuer()), - x509name_to_string(server_cert.get_subject()), - ) - key_info = get_temp_key_info(connection._ssl) - if key_info: - logger.debug("SSL temp key: %s", key_info) - + if where & SSL.SSL_CB_HANDSHAKE_DONE: try: - verifyHostname(connection, self._hostnameASCII) + if self._hostnameIsDnsName: + verify_hostname(connection, self._hostnameASCII) + else: + verify_ip_address(connection, self._hostnameASCII) except (CertificateError, VerificationError) as e: logger.warning( 'Remote certificate is not valid for hostname "%s"; %s', self._hostnameASCII, e, ) - except ValueError as e: logger.warning( "Ignoring error while verifying certificate " @@ -84,6 +106,77 @@ class ScrapyClientTLSOptions(ClientTLSOptions): self._hostnameASCII, e, ) + else: + super()._identityVerifyingInfoCallback(connection, where, ret) # type: ignore[misc] + + +ScrapyClientTLSOptions = create_deprecated_class( + "ScrapyClientTLSOptions", + _ScrapyClientTLSOptions, + subclass_warn_message="{old} is deprecated.", + instance_warn_message="{cls} is deprecated.", +) + + +class _ScrapyClientTLSOptions26(ClientTLSOptions): + """ + SSL Client connection creator ignoring certificate verification errors + (for genuinely invalid certificates or bugs in verification code). + + Same as Twisted's private _sslverify.ClientTLSOptions, + except that VerificationError, CertificateError and ValueError + exceptions are caught, so that the connection is not closed, only + logging warnings. + + Instances of this class are returned from + :class:`._ScrapyClientContextFactory`. + + This class is used on Twisted 26.4.0 and newer. + """ + + def clientConnectionForTLS( + self, tlsProtocol: TLSMemoryBIOProtocol + ) -> SSL.Connection: + """This method is needed to override the verify callback.""" + conn = super().clientConnectionForTLS(tlsProtocol) + callback = self._verifyCB(self._hostnameIsDnsName, self._hostnameASCII) + conn.set_verify(SSL.VERIFY_PEER | SSL.VERIFY_FAIL_IF_NO_PEER_CERT, callback) + return conn + + @staticmethod + def _verifyCB( + hostIsDNS: bool, hostnameASCII: str + ) -> Callable[[SSL.Connection, X509, int, int, int], bool]: + svcid: ServiceID = ( + DNS_ID(hostnameASCII) if hostIsDNS else IPAddress_ID(hostnameASCII) + ) + + def verifyCallback( + conn: SSL.Connection, cert: X509, err: int, depth: int, ok: int + ) -> bool: + if depth != 0: + # We are only verifying the leaf certificate. + return True + + try: + verify_service_identity(extract_patterns(cert), [svcid], []) + except (CertificateError, VerificationError) as e: + logger.warning( + 'Remote certificate is not valid for hostname "%s"; %s', + hostnameASCII, + e, + ) + except ValueError as e: + logger.warning( + "Ignoring error while verifying certificate " + 'from host "%s" (exception: %r)', + hostnameASCII, + e, + ) + + return True + + return verifyCallback DEFAULT_CIPHERS: AcceptableCiphers = AcceptableCiphers.fromOpenSSLCipherString( diff --git a/scrapy/core/downloader/webclient.py b/scrapy/core/downloader/webclient.py deleted file mode 100644 index e5c2255af..000000000 --- a/scrapy/core/downloader/webclient.py +++ /dev/null @@ -1,239 +0,0 @@ -"""Deprecated HTTP/1.0 helper classes used by HTTP10DownloadHandler.""" - -from __future__ import annotations - -import warnings -from time import time -from typing import TYPE_CHECKING -from urllib.parse import urldefrag, urlparse, urlunparse - -from twisted.internet import defer -from twisted.internet.protocol import ClientFactory -from twisted.web.http import HTTPClient - -from scrapy.exceptions import ScrapyDeprecationWarning -from scrapy.http import Headers, Response -from scrapy.responsetypes import responsetypes -from scrapy.utils.httpobj import urlparse_cached -from scrapy.utils.python import to_bytes, to_unicode - -if TYPE_CHECKING: - from scrapy import Request - - -class ScrapyHTTPPageGetter(HTTPClient): - delimiter = b"\n" - - def __init__(self): - warnings.warn( - "ScrapyHTTPPageGetter is deprecated and will be removed in a future Scrapy version.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - super().__init__() - - def connectionMade(self): - self.headers = Headers() # bucket for response headers - - # Method command - self.sendCommand(self.factory.method, self.factory.path) - # Headers - for key, values in self.factory.headers.items(): - for value in values: - self.sendHeader(key, value) - self.endHeaders() - # Body - if self.factory.body is not None: - self.transport.write(self.factory.body) - - def lineReceived(self, line): - return HTTPClient.lineReceived(self, line.rstrip()) - - def handleHeader(self, key, value): - self.headers.appendlist(key, value) - - def handleStatus(self, version, status, message): - self.factory.gotStatus(version, status, message) - - def handleEndHeaders(self): - self.factory.gotHeaders(self.headers) - - def connectionLost(self, reason): - self._connection_lost_reason = reason - HTTPClient.connectionLost(self, reason) - self.factory.noPage(reason) - - def handleResponse(self, response): - if self.factory.method.upper() == b"HEAD": - self.factory.page(b"") - elif self.length is not None and self.length > 0: - self.factory.noPage(self._connection_lost_reason) - else: - self.factory.page(response) - self.transport.loseConnection() - - def timeout(self): - self.transport.loseConnection() - - # transport cleanup needed for HTTPS connections - if self.factory.url.startswith(b"https"): - self.transport.stopProducing() - - self.factory.noPage( - defer.TimeoutError( - f"Getting {self.factory.url} took longer " - f"than {self.factory.timeout} seconds." - ) - ) - - -# This class used to inherit from Twisted’s -# twisted.web.client.HTTPClientFactory. When that class was deprecated in -# Twisted (https://github.com/twisted/twisted/pull/643), we merged its -# non-overridden code into this class. -class ScrapyHTTPClientFactory(ClientFactory): - protocol = ScrapyHTTPPageGetter - - waiting = 1 - noisy = False - followRedirect = False - afterFoundGet = False - - def _build_response(self, body, request): - request.meta["download_latency"] = self.headers_time - self.start_time - status = int(self.status) - headers = Headers(self.response_headers) - respcls = responsetypes.from_args(headers=headers, url=self._url, body=body) - return respcls( - url=self._url, - status=status, - headers=headers, - body=body, - protocol=to_unicode(self.version), - ) - - def _set_connection_attributes(self, request): - proxy = request.meta.get("proxy") - if proxy: - proxy_parsed = urlparse(to_bytes(proxy, encoding="ascii")) - self.scheme = proxy_parsed.scheme - self.host = proxy_parsed.hostname - self.port = proxy_parsed.port - self.netloc = proxy_parsed.netloc - if self.port is None: - self.port = 443 if proxy_parsed.scheme == b"https" else 80 - self.path = self.url - else: - parsed = urlparse_cached(request) - path_str = urlunparse( - ("", "", parsed.path or "/", parsed.params, parsed.query, "") - ) - self.path = to_bytes(path_str, encoding="ascii") - assert parsed.hostname is not None - self.host = to_bytes(parsed.hostname, encoding="ascii") - self.port = parsed.port - self.scheme = to_bytes(parsed.scheme, encoding="ascii") - self.netloc = to_bytes(parsed.netloc, encoding="ascii") - if self.port is None: - self.port = 443 if self.scheme == b"https" else 80 - - def __init__(self, request: Request, timeout: float = 180): - warnings.warn( - "ScrapyHTTPClientFactory is deprecated and will be removed in a future Scrapy version.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - - self._url: str = urldefrag(request.url)[0] - # converting to bytes to comply to Twisted interface - self.url: bytes = to_bytes(self._url, encoding="ascii") - self.method: bytes = to_bytes(request.method, encoding="ascii") - self.body: bytes | None = request.body or None - self.headers: Headers = Headers(request.headers) - self.response_headers: Headers | None = None - self.timeout: float = request.meta.get("download_timeout") or timeout - self.start_time: float = time() - self.deferred: defer.Deferred[Response] = defer.Deferred().addCallback( - self._build_response, request - ) - - # Fixes Twisted 11.1.0+ support as HTTPClientFactory is expected - # to have _disconnectedDeferred. See Twisted r32329. - # As Scrapy implements it's own logic to handle redirects is not - # needed to add the callback _waitForDisconnect. - # Specifically this avoids the AttributeError exception when - # clientConnectionFailed method is called. - self._disconnectedDeferred: defer.Deferred[None] = defer.Deferred() - - self._set_connection_attributes(request) - - # set Host header based on url - self.headers.setdefault("Host", self.netloc) - - # set Content-Length based len of body - if self.body is not None: - self.headers["Content-Length"] = len(self.body) - # just in case a broken http/1.1 decides to keep connection alive - self.headers.setdefault("Connection", "close") - # Content-Length must be specified in POST method even with no body - elif self.method == b"POST": - self.headers["Content-Length"] = 0 - - def __repr__(self) -> str: - return f"<{self.__class__.__name__}: {self._url}>" - - def _cancelTimeout(self, result, timeoutCall): - if timeoutCall.active(): - timeoutCall.cancel() - return result - - def buildProtocol(self, addr): - p = ClientFactory.buildProtocol(self, addr) - p.followRedirect = self.followRedirect - p.afterFoundGet = self.afterFoundGet - if self.timeout: - from twisted.internet import reactor - - timeoutCall = reactor.callLater(self.timeout, p.timeout) - self.deferred.addBoth(self._cancelTimeout, timeoutCall) - return p - - def gotHeaders(self, headers): - self.headers_time = time() - self.response_headers = headers - - def gotStatus(self, version, status, message): - """ - Set the status of the request on us. - @param version: The HTTP version. - @type version: L{bytes} - @param status: The HTTP status code, an integer represented as a - bytestring. - @type status: L{bytes} - @param message: The HTTP status message. - @type message: L{bytes} - """ - self.version, self.status, self.message = version, status, message - - def page(self, page): - if self.waiting: - self.waiting = 0 - self.deferred.callback(page) - - def noPage(self, reason): - if self.waiting: - self.waiting = 0 - self.deferred.errback(reason) - - def clientConnectionFailed(self, _, reason): - """ - When a connection attempt fails, the request cannot be issued. If no - result has yet been provided to the result Deferred, provide the - connection failure reason as an error result. - """ - if self.waiting: - self.waiting = 0 - # If the connection attempt failed, there is nothing more to - # disconnect, so just fire that Deferred now. - self._disconnectedDeferred.callback(None) - self.deferred.errback(reason) diff --git a/scrapy/core/engine.py b/scrapy/core/engine.py index 0631f7feb..1033e874f 100644 --- a/scrapy/core/engine.py +++ b/scrapy/core/engine.py @@ -8,38 +8,50 @@ For more information see docs/topics/architecture.rst from __future__ import annotations import asyncio +import contextlib import logging +import warnings +from functools import partial from time import time from traceback import format_exc -from typing import TYPE_CHECKING, Any, cast +from typing import TYPE_CHECKING, Any -from twisted.internet.defer import CancelledError, Deferred, inlineCallbacks, succeed +from twisted.internet.defer import CancelledError, Deferred, inlineCallbacks from twisted.python.failure import Failure from scrapy import signals +from scrapy.core.scheduler import BaseScheduler from scrapy.core.scraper import Scraper -from scrapy.exceptions import CloseSpider, DontCloseSpider, IgnoreRequest +from scrapy.exceptions import ( + CloseSpider, + DontCloseSpider, + IgnoreRequest, + ScrapyDeprecationWarning, +) from scrapy.http import Request, Response from scrapy.utils.asyncio import ( AsyncioLoopingCall, create_looping_call, + is_asyncio_available, ) from scrapy.utils.defer import ( - deferred_f_from_coro_f, + _schedule_coro, deferred_from_coro, + ensure_awaitable, maybe_deferred_to_future, ) +from scrapy.utils.deprecate import argument_is_required from scrapy.utils.log import failure_to_exc_info, logformatter_adapter from scrapy.utils.misc import build_from_crawler, load_object +from scrapy.utils.python import global_object_name from scrapy.utils.reactor import CallLaterOnce if TYPE_CHECKING: - from collections.abc import AsyncIterator, Callable, Generator + from collections.abc import AsyncIterator, Callable, Coroutine, Generator from twisted.internet.task import LoopingCall from scrapy.core.downloader import Downloader - from scrapy.core.scheduler import BaseScheduler from scrapy.crawler import Crawler from scrapy.logformatter import LogFormatter from scrapy.settings import BaseSettings, Settings @@ -73,10 +85,10 @@ class _Slot: self.inprogress.remove(request) self._maybe_fire_closing() - def close(self) -> Deferred[None]: + async def close(self) -> None: self.closing = Deferred() self._maybe_fire_closing() - return self.closing + await maybe_deferred_to_future(self.closing) def _maybe_fire_closing(self) -> None: if self.closing is not None and not self.inprogress: @@ -93,7 +105,9 @@ class ExecutionEngine: def __init__( self, crawler: Crawler, - spider_closed_callback: Callable[[Spider], Deferred[None] | None], + spider_closed_callback: Callable[ + [Spider], Coroutine[Any, Any, None] | Deferred[None] | None + ], ) -> None: self.crawler: Crawler = crawler self.settings: Settings = crawler.settings @@ -103,28 +117,42 @@ class ExecutionEngine: self._slot: _Slot | None = None self.spider: Spider | None = None self.running: bool = False + self._starting: bool = False + self._stopping: bool = False self.paused: bool = False - self._spider_closed_callback: Callable[[Spider], Deferred[None] | None] = ( - spider_closed_callback - ) + self._spider_closed_callback: Callable[ + [Spider], Coroutine[Any, Any, None] | Deferred[None] | None + ] = spider_closed_callback self.start_time: float | None = None self._start: AsyncIterator[Any] | None = None self._closewait: Deferred[None] | None = None - self._start_request_processing_dfd: Deferred[None] | None = None + self._start_request_processing_awaitable: ( + asyncio.Future[None] | Deferred[None] | None + ) = None downloader_cls: type[Downloader] = load_object(self.settings["DOWNLOADER"]) try: self.scheduler_cls: type[BaseScheduler] = self._get_scheduler_class( crawler.settings ) self.downloader: Downloader = downloader_cls(crawler) + self._downloader_fetch_needs_spider: bool = argument_is_required( + self.downloader.fetch, "spider" + ) + if self._downloader_fetch_needs_spider: + warnings.warn( + f"The fetch() method of {global_object_name(downloader_cls)} requires a spider argument," + f" this is deprecated and the argument will not be passed in future Scrapy versions.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + self.scraper: Scraper = Scraper(crawler) except Exception: - self.close() + if hasattr(self, "downloader"): + self.downloader.close() raise def _get_scheduler_class(self, settings: BaseSettings) -> type[BaseScheduler]: - from scrapy.core.scheduler import BaseScheduler - scheduler_cls: type[BaseScheduler] = load_object(settings["SCHEDULER"]) if not issubclass(scheduler_cls, BaseScheduler): raise TypeError( @@ -133,57 +161,104 @@ class ExecutionEngine: ) return scheduler_cls - def start(self, _start_request_processing=True) -> Deferred[None]: - return deferred_from_coro(self.start_async(_start_request_processing)) + def start( + self, _start_request_processing: bool = True + ) -> Deferred[None]: # pragma: no cover + warnings.warn( + "ExecutionEngine.start() is deprecated, use start_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return deferred_from_coro( + self.start_async(_start_request_processing=_start_request_processing) + ) - async def start_async(self, _start_request_processing=True) -> None: - if self.running: + async def start_async(self, *, _start_request_processing: bool = True) -> None: + """Start the execution engine. + + .. versionadded:: 2.14 + """ + if self._starting: raise RuntimeError("Engine already running") self.start_time = time() + self._starting = True await self.signals.send_catch_log_async(signal=signals.engine_started) + if self._stopping: + # band-aid until https://github.com/scrapy/scrapy/issues/6916 + return + if _start_request_processing and self.spider is None: + # require an opened spider when not run in scrapy shell + return self.running = True self._closewait = Deferred() if _start_request_processing: - self._start_request_processing_dfd = self._start_request_processing() - await maybe_deferred_to_future(self._closewait) + coro = self._start_request_processing() + if is_asyncio_available(): + # not wrapping in a Deferred here to avoid https://github.com/twisted/twisted/issues/12470 + # (can happen when this is cancelled, e.g. in test_close_during_start_iteration()) + self._start_request_processing_awaitable = asyncio.ensure_future(coro) + else: + self._start_request_processing_awaitable = Deferred.fromCoroutine(coro) + with contextlib.suppress(asyncio.exceptions.CancelledError): + await maybe_deferred_to_future(self._closewait) - def stop(self) -> Deferred[None]: - """Gracefully stop the execution engine""" + def stop(self) -> Deferred[None]: # pragma: no cover + warnings.warn( + "ExecutionEngine.stop() is deprecated, use stop_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return deferred_from_coro(self.stop_async()) - @deferred_f_from_coro_f - async def _finish_stopping_engine(_: Any) -> None: - await self.signals.send_catch_log_async(signal=signals.engine_stopped) - if self._closewait: - self._closewait.callback(None) + async def stop_async(self) -> None: + """Gracefully stop the execution engine. - if not self.running: + .. versionadded:: 2.14 + """ + + if not self._starting: raise RuntimeError("Engine not running") - self.running = False - if self._start_request_processing_dfd is not None: - self._start_request_processing_dfd.cancel() - self._start_request_processing_dfd = None - dfd = ( - self.close_spider(self.spider, reason="shutdown") - if self.spider is not None - else succeed(None) - ) - return dfd.addBoth(_finish_stopping_engine) + self.running = self._starting = False + self._stopping = True + if self._start_request_processing_awaitable is not None: + if ( + not is_asyncio_available() + or self._start_request_processing_awaitable + is not asyncio.current_task() + ): + # If using the asyncio loop and stop_async() was called from + # start() itself, we can't cancel it, and _start_request_processing() + # will exit via the self.running check. + self._start_request_processing_awaitable.cancel() + self._start_request_processing_awaitable = None + if self.spider is not None: + await self.close_spider_async(reason="shutdown") + await self.signals.send_catch_log_async(signal=signals.engine_stopped) + if self._closewait: + self._closewait.callback(None) - def close(self) -> Deferred[None]: + def close(self) -> Deferred[None]: # pragma: no cover + warnings.warn( + "ExecutionEngine.close() is deprecated, use close_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return deferred_from_coro(self.close_async()) + + async def close_async(self) -> None: """ Gracefully close the execution engine. If it has already been started, stop it. In all cases, close the spider and the downloader. """ if self.running: - return self.stop() # will also close spider and downloader - if self.spider is not None: - return self.close_spider( - self.spider, reason="shutdown" + await self.stop_async() # will also close spider and downloader + elif self.spider is not None: + await self.close_spider_async( + reason="shutdown" ) # will also close downloader - if hasattr(self, "downloader"): + elif hasattr(self, "downloader"): self.downloader.close() - return succeed(None) def pause(self) -> None: self.paused = True @@ -191,14 +266,15 @@ class ExecutionEngine: def unpause(self) -> None: self.paused = False - async def _process_start_next(self): + async def _process_start_next(self) -> None: """Processes the next item or request from Spider.start(). If a request, it is scheduled. If an item, it is sent to item pipelines. """ + assert self._start is not None try: - item_or_request = await self._start.__anext__() + item_or_request = await anext(self._start) except StopAsyncIteration: self._start = None except Exception as exception: @@ -214,10 +290,12 @@ class ExecutionEngine: if isinstance(item_or_request, Request): self.crawl(item_or_request) else: - self.scraper.start_itemproc(item_or_request, response=None) + assert self._slot is not None + _schedule_coro( + self.scraper.start_itemproc_async(item_or_request, response=None) + ) self._slot.nextcall.schedule() - @deferred_f_from_coro_f async def _start_request_processing(self) -> None: """Starts consuming Spider.start() output and sending scheduled requests.""" @@ -229,7 +307,7 @@ class ExecutionEngine: self._slot.nextcall.schedule() self._slot.heartbeat.start(self._SLOT_HEARTBEAT_INTERVAL) - while self._start and self.spider: + while self._start and self.spider and self.running: await self._process_start_next() if not self.needs_backout(): # Give room for the outcome of self._process_start_next() to be @@ -237,17 +315,17 @@ class ExecutionEngine: self._slot.nextcall.schedule() await self._slot.nextcall.wait() except (asyncio.exceptions.CancelledError, CancelledError): - # self.stop() has cancelled us, nothing to do + # self.stop_async() has cancelled us, nothing to do return except Exception: # an error happened, log it and stop the engine - self._start_request_processing_dfd = None + self._start_request_processing_awaitable = None logger.error( "Error while processing requests from start()", exc_info=True, extra={"spider": self.spider}, ) - await maybe_deferred_to_future(self.stop()) + await self.stop_async() def _start_scheduled_requests(self) -> None: if self._slot is None or self._slot.closing is not None or self.paused: @@ -275,6 +353,10 @@ class ExecutionEngine: or self.scraper.slot.needs_backout() ) + def _remove_request(self, _: Any, request: Request) -> None: + assert self._slot + self._slot.remove_request(request) + def _start_scheduled_request(self) -> bool: assert self._slot is not None # typing assert self.spider is not None # typing @@ -294,11 +376,7 @@ class ExecutionEngine: ) ) - def _remove_request(_: Any) -> None: - assert self._slot - self._slot.remove_request(request) - - d2: Deferred[None] = d.addBoth(_remove_request) + d2: Deferred[None] = d.addBoth(partial(self._remove_request, request=request)) d2.addErrback( lambda f: logger.info( "Error while removing request from slot", @@ -366,7 +444,7 @@ class ExecutionEngine: spider=self.spider, dont_log=IgnoreRequest, ) - for handler, result in request_scheduled_result: + for _, result in request_scheduled_result: if isinstance(result, Failure) and isinstance(result.value, IgnoreRequest): return if not self._slot.scheduler.enqueue_request(request): # type: ignore[union-attr] @@ -374,18 +452,33 @@ class ExecutionEngine: signals.request_dropped, request=request, spider=self.spider ) - @inlineCallbacks - def download(self, request: Request) -> Generator[Deferred[Any], Any, Response]: + def download(self, request: Request) -> Deferred[Response]: """Return a Deferred which fires with a Response as result, only downloader middlewares are applied""" + warnings.warn( + "ExecutionEngine.download() is deprecated, use download_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return deferred_from_coro(self.download_async(request)) + + async def download_async(self, request: Request) -> Response: + """Return a coroutine which fires with a Response as result. + + Only downloader middlewares are applied. + + .. versionadded:: 2.14 + """ if self.spider is None: raise RuntimeError(f"No open spider to crawl: {request}") try: - response_or_request = yield self._download(request) + response_or_request = await maybe_deferred_to_future( + self._download(request) + ) finally: assert self._slot is not None self._slot.remove_request(request) if isinstance(response_or_request, Request): - return (yield self.download(response_or_request)) + return await self.download_async(response_or_request) return response_or_request @inlineCallbacks @@ -397,9 +490,11 @@ class ExecutionEngine: self._slot.add_request(request) try: - result: Response | Request = yield self.downloader.fetch( - request, self.spider - ) + result: Response | Request + if self._downloader_fetch_needs_spider: + result = yield self.downloader.fetch(request, self.spider) + else: + result = yield self.downloader.fetch(request) if not isinstance(result, (Response, Request)): raise TypeError( f"Incorrect type: expected Response or Request, got {type(result)}: {result!r}" @@ -407,7 +502,6 @@ class ExecutionEngine: if isinstance(result, Response): if result.request is None: result.request = request - assert self.spider is not None logkws = self.logformatter.crawled(result.request, result, self.spider) if logkws is not None: logger.log( @@ -423,31 +517,45 @@ class ExecutionEngine: finally: self._slot.nextcall.schedule() - def open_spider(self, spider: Spider, close_if_idle: bool = True) -> Deferred[None]: - return deferred_from_coro( - self.open_spider_async(spider, close_if_idle=close_if_idle) + def open_spider( + self, spider: Spider, close_if_idle: bool = True + ) -> Deferred[None]: # pragma: no cover + warnings.warn( + "ExecutionEngine.open_spider() is deprecated, use open_spider_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, ) + return deferred_from_coro(self.open_spider_async(close_if_idle=close_if_idle)) - async def open_spider_async( - self, - spider: Spider, - *, - close_if_idle: bool = True, - ) -> None: + async def open_spider_async(self, *, close_if_idle: bool = True) -> None: + assert self.crawler.spider if self._slot is not None: - raise RuntimeError(f"No free spider slot when opening {spider.name!r}") - logger.info("Spider opened", extra={"spider": spider}) - self.spider = spider + raise RuntimeError( + f"No free spider slot when opening {self.crawler.spider.name!r}" + ) + logger.info("Spider opened", extra={"spider": self.crawler.spider}) + self.spider = self.crawler.spider nextcall = CallLaterOnce(self._start_scheduled_requests) scheduler = build_from_crawler(self.scheduler_cls, self.crawler) self._slot = _Slot(close_if_idle, nextcall, scheduler) - self._start = await self.scraper.spidermw.process_start(spider) - if hasattr(scheduler, "open") and (d := scheduler.open(spider)): + self._start = await self.scraper.spidermw.process_start() + if hasattr(scheduler, "open") and (d := scheduler.open(self.crawler.spider)): await maybe_deferred_to_future(d) - await maybe_deferred_to_future(self.scraper.open_spider(spider)) + await self.scraper.open_spider_async() assert self.crawler.stats - self.crawler.stats.open_spider(spider) - await self.signals.send_catch_log_async(signals.spider_opened, spider=spider) + if argument_is_required(self.crawler.stats.open_spider, "spider"): + warnings.warn( + f"The open_spider() method of {global_object_name(type(self.crawler.stats))} requires a spider argument," + f" this is deprecated and the argument will not be passed in future Scrapy versions.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + self.crawler.stats.open_spider(spider=self.crawler.spider) + else: + self.crawler.stats.open_spider() + await self.signals.send_catch_log_async( + signals.spider_opened, spider=self.crawler.spider + ) def _spider_idle(self) -> None: """ @@ -472,76 +580,107 @@ class ExecutionEngine: if self.spider_is_idle(): ex = detected_ex.get(CloseSpider, CloseSpider(reason="finished")) assert isinstance(ex, CloseSpider) # typing - self.close_spider(self.spider, reason=ex.reason) + _schedule_coro(self.close_spider_async(reason=ex.reason)) + + def close_spider( + self, spider: Spider, reason: str = "cancelled" + ) -> Deferred[None]: # pragma: no cover + warnings.warn( + "ExecutionEngine.close_spider() is deprecated, use close_spider_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return deferred_from_coro(self.close_spider_async(reason=reason)) + + async def close_spider_async(self, *, reason: str = "cancelled") -> None: # noqa: PLR0912 + """Close (cancel) spider and clear all its outstanding requests. + + .. versionadded:: 2.14 + """ + if self.spider is None: + raise RuntimeError("Spider not opened") - def close_spider(self, spider: Spider, reason: str = "cancelled") -> Deferred[None]: - """Close (cancel) spider and clear all its outstanding requests""" if self._slot is None: raise RuntimeError("Engine slot not assigned") if self._slot.closing is not None: - return self._slot.closing + await maybe_deferred_to_future(self._slot.closing) + return + + spider = self.spider logger.info( "Closing spider (%(reason)s)", {"reason": reason}, extra={"spider": spider} ) - dfd = self._slot.close() + try: + await self._slot.close() + except Exception: + logger.error("Slot close failure", exc_info=True, extra={"spider": spider}) - def log_failure(msg: str) -> Callable[[Failure], None]: - def errback(failure: Failure) -> None: - logger.error( - msg, exc_info=failure_to_exc_info(failure), extra={"spider": spider} - ) + try: + self.downloader.close() + except Exception: + logger.error( + "Downloader close failure", exc_info=True, extra={"spider": spider} + ) - return errback - - dfd.addBoth(lambda _: self.downloader.close()) - dfd.addErrback(log_failure("Downloader close failure")) - - dfd.addBoth(lambda _: self.scraper.close_spider()) - dfd.addErrback(log_failure("Scraper close failure")) + try: + await self.scraper.close_spider_async() + except Exception: + logger.error( + "Scraper close failure", exc_info=True, extra={"spider": spider} + ) if hasattr(self._slot.scheduler, "close"): - dfd.addBoth(lambda _: cast(_Slot, self._slot).scheduler.close(reason)) - dfd.addErrback(log_failure("Scheduler close failure")) + try: + if (d := self._slot.scheduler.close(reason)) is not None: + await maybe_deferred_to_future(d) + except Exception: + logger.error( + "Scheduler close failure", exc_info=True, extra={"spider": spider} + ) - dfd.addBoth( - lambda _: self.signals.send_catch_log_deferred( + try: + await self.signals.send_catch_log_async( signal=signals.spider_closed, spider=spider, reason=reason, ) - ) - dfd.addErrback(log_failure("Error while sending spider_close signal")) - - def close_stats(_: Any) -> None: - assert self.crawler.stats - self.crawler.stats.close_spider(spider, reason=reason) - - dfd.addBoth(close_stats) - dfd.addErrback(log_failure("Stats close failure")) - - dfd.addBoth( - lambda _: logger.info( - "Spider closed (%(reason)s)", - {"reason": reason}, + except Exception: + logger.error( + "Error while sending spider_close signal", + exc_info=True, extra={"spider": spider}, ) + + assert self.crawler.stats + try: + if argument_is_required(self.crawler.stats.close_spider, "spider"): + warnings.warn( + f"The close_spider() method of {global_object_name(type(self.crawler.stats))} requires a spider argument," + f" this is deprecated and the argument will not be passed in future Scrapy versions.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + self.crawler.stats.close_spider( + spider=self.crawler.spider, reason=reason + ) + else: + self.crawler.stats.close_spider(reason=reason) + except Exception: + logger.error("Stats close failure") + + logger.info( + "Spider closed (%(reason)s)", + {"reason": reason}, + extra={"spider": spider}, ) - def unassign_slot(_: Any) -> None: - self._slot = None + self._slot = None + self.spider = None - dfd.addBoth(unassign_slot) - dfd.addErrback(log_failure("Error while unassigning slot")) - - def unassign_spider(_: Any) -> None: - self.spider = None - - dfd.addBoth(unassign_spider) - dfd.addErrback(log_failure("Error while unassigning spider")) - - dfd.addBoth(lambda _: self._spider_closed_callback(spider)) - - return dfd + try: + await ensure_awaitable(self._spider_closed_callback(spider)) + except Exception: + logger.error("Error running spider_closed_callback") diff --git a/scrapy/core/http2/agent.py b/scrapy/core/http2/agent.py index 45f32daaa..7137a0f2b 100644 --- a/scrapy/core/http2/agent.py +++ b/scrapy/core/http2/agent.py @@ -14,7 +14,7 @@ from twisted.web.client import ( ) from twisted.web.error import SchemeNotSupported -from scrapy.core.downloader.contextfactory import AcceptableProtocolsContextFactory +from scrapy.core.downloader.contextfactory import _AcceptableProtocolsContextFactory from scrapy.core.http2.protocol import H2ClientFactory, H2ClientProtocol if TYPE_CHECKING: @@ -43,6 +43,10 @@ class H2ConnectionPool: ConnectionKeyT, deque[Deferred[H2ClientProtocol]] ] = {} + self._tls_verbose_logging: bool = settings.getbool( + "DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING" + ) + def get_connection( self, key: ConnectionKeyT, uri: URI, endpoint: HostnameEndpoint ) -> Deferred[H2ClientProtocol]: @@ -71,7 +75,12 @@ class H2ConnectionPool: conn_lost_deferred: Deferred[list[BaseException]] = Deferred() conn_lost_deferred.addCallback(self._remove_connection, key) - factory = H2ClientFactory(uri, self.settings, conn_lost_deferred) + factory = H2ClientFactory( + uri, + self.settings, + conn_lost_deferred, + tls_verbose_logging=self._tls_verbose_logging, + ) conn_d = endpoint.connect(factory) conn_d.addCallback(self.put_connection, key) @@ -120,13 +129,13 @@ class H2Agent: self, reactor: ReactorBase, pool: H2ConnectionPool, - context_factory: BrowserLikePolicyForHTTPS = BrowserLikePolicyForHTTPS(), + context_factory: BrowserLikePolicyForHTTPS = BrowserLikePolicyForHTTPS(), # noqa: B008 connect_timeout: float | None = None, - bind_address: bytes | None = None, + bind_address: tuple[str, int] | None = None, ) -> None: self._reactor = reactor self._pool = pool - self._context_factory = AcceptableProtocolsContextFactory( + self._context_factory = _AcceptableProtocolsContextFactory( context_factory, acceptable_protocols=[b"h2"] ) self.endpoint_factory = _StandardEndpointFactory( @@ -134,7 +143,7 @@ class H2Agent: ) def get_endpoint(self, uri: URI) -> HostnameEndpoint: - return self.endpoint_factory.endpointForURI(uri) + return self.endpoint_factory.endpointForURI(uri) # type: ignore[no-any-return] def get_key(self, uri: URI) -> ConnectionKeyT: """ @@ -156,30 +165,3 @@ class H2Agent: lambda conn: conn.request(request, spider) ) return d2 - - -class ScrapyProxyH2Agent(H2Agent): - def __init__( - self, - reactor: ReactorBase, - proxy_uri: URI, - pool: H2ConnectionPool, - context_factory: BrowserLikePolicyForHTTPS = BrowserLikePolicyForHTTPS(), - connect_timeout: float | None = None, - bind_address: bytes | None = None, - ) -> None: - super().__init__( - reactor=reactor, - pool=pool, - context_factory=context_factory, - connect_timeout=connect_timeout, - bind_address=bind_address, - ) - self._proxy_uri = proxy_uri - - def get_endpoint(self, uri: URI) -> HostnameEndpoint: - return self.endpoint_factory.endpointForURI(self._proxy_uri) - - def get_key(self, uri: URI) -> ConnectionKeyT: - """We use the proxy uri instead of uri obtained from request url""" - return b"http-proxy", self._proxy_uri.host, self._proxy_uri.port diff --git a/scrapy/core/http2/protocol.py b/scrapy/core/http2/protocol.py index 23335b7b2..39703f976 100644 --- a/scrapy/core/http2/protocol.py +++ b/scrapy/core/http2/protocol.py @@ -4,7 +4,7 @@ import ipaddress import itertools import logging from collections import deque -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, cast from h2.config import H2Configuration from h2.connection import H2Connection @@ -21,7 +21,6 @@ from h2.events import ( WindowUpdated, ) from h2.exceptions import FrameTooLargeError, H2Error -from twisted.internet.error import TimeoutError from twisted.internet.interfaces import ( IAddress, IHandshakeListener, @@ -33,7 +32,10 @@ from twisted.protocols.policies import TimeoutMixin from zope.interface import implementer from scrapy.core.http2.stream import Stream, StreamCloseReason +from scrapy.exceptions import DownloadTimeoutError from scrapy.http import Request, Response +from scrapy.utils.deprecate import warn_on_deprecated_spider_attribute +from scrapy.utils.ssl import _log_ssl_conn_debug_info if TYPE_CHECKING: from ipaddress import IPv4Address, IPv6Address @@ -90,6 +92,8 @@ class H2ClientProtocol(Protocol, TimeoutMixin): uri: URI, settings: Settings, conn_lost_deferred: Deferred[list[BaseException]], + *, + tls_verbose_logging: bool = False, ) -> None: """ Arguments: @@ -99,8 +103,10 @@ class H2ClientProtocol(Protocol, TimeoutMixin): settings -- Scrapy project settings conn_lost_deferred -- Deferred fires with the reason: Failure to notify that connection was lost + tls_verbose_logging -- Whether to log TLS details """ self._conn_lost_deferred: Deferred[list[BaseException]] = conn_lost_deferred + self._tls_verbose_logging: bool = tls_verbose_logging config = H2Configuration(client_side=True, header_encoding="utf-8") self.conn = H2Connection(config=config) @@ -191,6 +197,13 @@ class H2ClientProtocol(Protocol, TimeoutMixin): def _new_stream(self, request: Request, spider: Spider) -> Stream: """Instantiates a new Stream object""" + if hasattr(spider, "download_maxsize"): # pragma: no cover + warn_on_deprecated_spider_attribute("download_maxsize", "DOWNLOAD_MAXSIZE") + if hasattr(spider, "download_warnsize"): # pragma: no cover + warn_on_deprecated_spider_attribute( + "download_warnsize", "DOWNLOAD_WARNSIZE" + ) + stream = Stream( stream_id=next(self._stream_id_generator), request=request, @@ -211,7 +224,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): """ assert self.transport is not None # typing # Reset the idle timeout as connection is still actively sending data - self.resetTimeout() + self.resetTimeout() # type: ignore[no-untyped-call] data = self.conn.data_to_send() self.transport.write(data) @@ -238,7 +251,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): sending some data now: we should open with the connection preamble. """ # Initialize the timeout - self.setTimeout(self.IDLE_TIMEOUT) + self.setTimeout(self.IDLE_TIMEOUT) # type: ignore[no-untyped-call] assert self.transport is not None # typing destination = self.transport.getPeer() @@ -251,7 +264,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): def _lose_connection_with_error(self, errors: list[BaseException]) -> None: """Helper function to lose the connection with the error sent as a reason""" - self._conn_lost_errors += errors + self._conn_lost_errors.extend(errors) assert self.transport is not None # typing self.transport.loseConnection() @@ -269,6 +282,11 @@ class H2ClientProtocol(Protocol, TimeoutMixin): [InvalidNegotiatedProtocol(self.transport.negotiatedProtocol)] ) + if self._tls_verbose_logging: + connection = self.transport.getHandle() + hostname = self.metadata["uri"].host.decode("ascii") + _log_ssl_conn_debug_info(hostname, connection) + def _check_received_data(self, data: bytes) -> None: """Checks for edge cases where the connection to remote fails without raising an appropriate H2Error @@ -281,7 +299,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): def dataReceived(self, data: bytes) -> None: # Reset the idle timeout as connection is still actively receiving data - self.resetTimeout() + self.resetTimeout() # type: ignore[no-untyped-call] try: self._check_received_data(data) @@ -291,7 +309,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): if isinstance(e, FrameTooLargeError): # hyper-h2 does not drop the connection in this scenario, we # need to abort the connection manually. - self._conn_lost_errors += [e] + self._conn_lost_errors.append(e) assert self.transport is not None # typing self.transport.abortConnection() return @@ -305,7 +323,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): def timeoutConnection(self) -> None: """Called when the connection times out. - We lose the connection with TimeoutError""" + We lose the connection with DownloadTimeoutError""" # Check whether there are open streams. If there are, we're going to # want to use the error code PROTOCOL_ERROR. If there aren't, use @@ -322,7 +340,11 @@ class H2ClientProtocol(Protocol, TimeoutMixin): self._write_to_transport() self._lose_connection_with_error( - [TimeoutError(f"Connection was IDLE for more than {self.IDLE_TIMEOUT}s")] + [ + DownloadTimeoutError( + f"Connection was IDLE for more than {self.IDLE_TIMEOUT}s" + ) + ] ) def connectionLost(self, reason: Failure = connectionDone) -> None: @@ -330,7 +352,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): No need to write anything to transport here. """ # Cancel the timeout if not done yet - self.setTimeout(None) + self.setTimeout(None) # type: ignore[no-untyped-call] # Notify the connection pool instance such that no new requests are # sent over current connection @@ -396,7 +418,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): except KeyError: pass # We ignore server-initiated events else: - stream.receive_headers(event.headers) + stream.receive_headers(cast("list[tuple[str, str]]", event.headers)) def settings_acknowledged(self, event: SettingsAcknowledged) -> None: self.metadata["settings_acknowledged"] = True @@ -441,13 +463,21 @@ class H2ClientFactory(Factory): uri: URI, settings: Settings, conn_lost_deferred: Deferred[list[BaseException]], + *, + tls_verbose_logging: bool = False, ) -> None: self.uri = uri self.settings = settings self.conn_lost_deferred = conn_lost_deferred + self.tls_verbose_logging = tls_verbose_logging def buildProtocol(self, addr: IAddress) -> H2ClientProtocol: - return H2ClientProtocol(self.uri, self.settings, self.conn_lost_deferred) + return H2ClientProtocol( + self.uri, + self.settings, + self.conn_lost_deferred, + tls_verbose_logging=self.tls_verbose_logging, + ) def acceptableProtocols(self) -> list[bytes]: return [PROTOCOL_NAME] diff --git a/scrapy/core/http2/stream.py b/scrapy/core/http2/stream.py index afca99dcf..4d072c555 100644 --- a/scrapy/core/http2/stream.py +++ b/scrapy/core/http2/stream.py @@ -7,17 +7,22 @@ from typing import TYPE_CHECKING, Any from h2.errors import ErrorCodes from h2.exceptions import H2Error, ProtocolError, StreamClosedError -from twisted.internet.defer import CancelledError, Deferred +from twisted.internet.defer import Deferred from twisted.internet.error import ConnectionClosed from twisted.python.failure import Failure from twisted.web.client import ResponseFailed +from scrapy.exceptions import DownloadCancelledError from scrapy.http.headers import Headers -from scrapy.responsetypes import responsetypes +from scrapy.utils._download_handlers import ( + get_maxsize_msg, + get_warnsize_msg, + make_response, +) from scrapy.utils.httpobj import urlparse_cached if TYPE_CHECKING: - from hpack import HeaderTuple + from collections.abc import Sequence from scrapy.core.http2.protocol import H2ClientProtocol from scrapy.http import Request, Response @@ -74,6 +79,9 @@ class StreamCloseReason(Enum): # As a result sending this request will the end the connection INVALID_HOSTNAME = 7 + # Actual response body size is more than allowed limit + MAXSIZE_EXCEEDED_ACTUAL = 8 + class Stream: """Represents a single HTTP/2 Stream. @@ -142,19 +150,21 @@ class Stream: # flow control window "flow_controlled_size": 0, # Headers received after sending the request - "headers": Headers({}), + "headers": Headers(), + # Response status code + "status": None, } - def _cancel(_: Any) -> None: - # Close this stream as gracefully as possible - # If the associated request is initiated we reset this stream - # else we directly call close() method - if self.metadata["request_sent"]: - self.reset_stream(StreamCloseReason.CANCELLED) - else: - self.close(StreamCloseReason.CANCELLED) + self._deferred_response: Deferred[Response] = Deferred(self._cancel) - self._deferred_response: Deferred[Response] = Deferred(_cancel) + def _cancel(self, _: Any) -> None: + # Close this stream as gracefully as possible + # If the associated request is initiated we reset this stream + # else we directly call close() method + if self.metadata["request_sent"]: + self.reset_stream(StreamCloseReason.CANCELLED) + else: + self.close(StreamCloseReason.CANCELLED) def __repr__(self) -> str: return f"Stream(id={self.stream_id!r})" @@ -333,14 +343,16 @@ class Stream: self._download_maxsize and self._response["flow_controlled_size"] > self._download_maxsize ): - self.reset_stream(StreamCloseReason.MAXSIZE_EXCEEDED) + self.reset_stream(StreamCloseReason.MAXSIZE_EXCEEDED_ACTUAL) return if self._log_warnsize: self.metadata["reached_warnsize"] = True - warning_msg = ( - f"Received more ({self._response['flow_controlled_size']}) bytes than download " - f"warn size ({self._download_warnsize}) in request {self._request}" + warning_msg = get_warnsize_msg( + self._response["flow_controlled_size"], + self._download_warnsize, + self._request, + expected=False, ) logger.warning(warning_msg) @@ -349,9 +361,13 @@ class Stream: self._response["flow_controlled_size"], self.stream_id ) - def receive_headers(self, headers: list[HeaderTuple]) -> None: + def receive_headers(self, headers: list[tuple[str, str]]) -> None: for name, value in headers: - self._response["headers"].appendlist(name, value) + if name == ":status": + # it's a pseudo-header + self._response["status"] = int(value) + else: + self._response["headers"].appendlist(name, value) # Check if we exceed the allowed max data size which can be received expected_size = int(self._response["headers"].get(b"Content-Length", -1)) @@ -361,9 +377,8 @@ class Stream: if self._log_warnsize: self.metadata["reached_warnsize"] = True - warning_msg = ( - f"Expected response size ({expected_size}) larger than " - f"download warn size ({self._download_warnsize}) in request {self._request}" + warning_msg = get_warnsize_msg( + expected_size, self._download_warnsize, self._request, expected=True ) logger.warning(warning_msg) @@ -382,7 +397,7 @@ class Stream: def close( self, reason: StreamCloseReason, - errors: list[BaseException] | None = None, + errors: Sequence[BaseException] | None = None, from_protocol: bool = False, ) -> None: """Based on the reason sent we will handle each case.""" @@ -396,7 +411,7 @@ class Stream: # Have default value of errors as an empty list as # some cases can add a list of exceptions - errors = errors or [] + errors = errors or () if not from_protocol: self._protocol.pop_stream(self.stream_id) @@ -411,18 +426,23 @@ class Stream: # As we immediately cancel the request when maxsize is exceeded while # receiving DATA_FRAME's when we have received the headers (not # having Content-Length) - if reason is StreamCloseReason.MAXSIZE_EXCEEDED: + if reason in { + StreamCloseReason.MAXSIZE_EXCEEDED, + StreamCloseReason.MAXSIZE_EXCEEDED_ACTUAL, + }: expected_size = int( self._response["headers"].get( b"Content-Length", self._response["flow_controlled_size"] ) ) - error_msg = ( - f"Cancelling download of {self._request.url}: received response " - f"size ({expected_size}) larger than download max size ({self._download_maxsize})" + error_msg = get_maxsize_msg( + expected_size, + self._download_maxsize, + self._request, + expected=reason == StreamCloseReason.MAXSIZE_EXCEEDED, ) logger.error(error_msg) - self._deferred_response.errback(CancelledError(error_msg)) + self._deferred_response.errback(DownloadCancelledError(error_msg)) elif reason is StreamCloseReason.ENDED: self._fire_response_deferred() @@ -437,7 +457,8 @@ class Stream: # There maybe no :status in headers, we make # HTTP Status Code: 499 - Client Closed Request - self._response["headers"][":status"] = "499" + if self._response["status"] is None: + self._response["status"] = 499 self._fire_response_deferred() elif reason is StreamCloseReason.RESET: @@ -456,7 +477,7 @@ class Stream: self._deferred_response.errback(ResponseFailed(errors)) elif reason is StreamCloseReason.INACTIVE: - errors.insert(0, InactiveStreamClosed(self._request)) + errors = (InactiveStreamClosed(self._request), *errors) self._deferred_response.errback(ResponseFailed(errors)) else: @@ -474,22 +495,13 @@ class Stream: and fires the response deferred callback with the generated response instance""" - body = self._response["body"].getvalue() - response_cls = responsetypes.from_args( - headers=self._response["headers"], + response = make_response( url=self._request.url, - body=body, - ) - - response = response_cls( - url=self._request.url, - status=int(self._response["headers"][":status"]), + status=self._response["status"], headers=self._response["headers"], - body=body, - request=self._request, + body=self._response["body"].getvalue(), certificate=self._protocol.metadata["certificate"], ip_address=self._protocol.metadata["ip_address"], protocol="h2", ) - self._deferred_response.callback(response) diff --git a/scrapy/core/scheduler.py b/scrapy/core/scheduler.py index 9ac447289..7217da942 100644 --- a/scrapy/core/scheduler.py +++ b/scrapy/core/scheduler.py @@ -5,16 +5,13 @@ import logging from abc import abstractmethod from pathlib import Path from typing import TYPE_CHECKING, Any, cast -from warnings import warn # working around https://github.com/sphinx-doc/sphinx/issues/10400 from twisted.internet.defer import Deferred # noqa: TC002 -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.spiders import Spider # noqa: TC001 from scrapy.utils.job import job_dir from scrapy.utils.misc import build_from_crawler, load_object -from scrapy.utils.python import global_object_name if TYPE_CHECKING: # requires queuelib >= 1.6.2 @@ -128,7 +125,7 @@ class BaseScheduler(metaclass=BaseSchedulerMeta): class Scheduler(BaseScheduler): - """Default scheduler. + r"""Default scheduler. Requests are stored into priority queues (:setting:`SCHEDULER_PRIORITY_QUEUE`) that sort requests by @@ -190,7 +187,8 @@ class Scheduler(BaseScheduler): following :ref:`settings `: | :setting:`DEPTH_PRIORITY` = ``1`` - | :setting:`SCHEDULER_DISK_QUEUE` = ``"scrapy.squeues.PickleFifoDiskQueue"`` + | :setting:`SCHEDULER_DISK_QUEUE` = + ``"scrapy.squeues.PickleFifoDiskQueue"`` | :setting:`SCHEDULER_MEMORY_QUEUE` = ``"scrapy.squeues.FifoMemoryQueue"`` .. _BFO order: https://en.wikipedia.org/wiki/Breadth-first_search @@ -219,6 +217,37 @@ class Scheduler(BaseScheduler): order. Lowering those settings to ``1`` enforces the desired order except for the very first request, but it significantly slows down the crawl as a whole. + + Job directory contents + ====================== + + .. warning:: The files that this class generates in the :ref:`job directory + ` are an implementation detail, and may change without a + warning in a future version of Scrapy. Do not rely on the following + information for anything other than debugging purposes. + + When using :setting:`JOBDIR`, this scheduler class: + + - Creates a directory named ``requests.queue`` inside the :ref:`job + directory `, meant to keep track of all requests stored in + the scheduler (i.e. not downloaded yet). + + - Generates inside that directory an ``active.json`` file with a JSON + representation of the state (``startprios``) of + :setting:`SCHEDULER_PRIORITY_QUEUE`. + + The file is generated whenever the job stops (cleanly) and is loaded + when resuming the job. + + - Instantiates the configured :setting:`SCHEDULER_PRIORITY_QUEUE` with + ``requests.queue/`` as persistence directory (*key*) and + :setting:`SCHEDULER_DISK_QUEUE` as *downstream_queue_cls*. The priority + queue may create additional files and directories inside that + directory, directly or though instances of + :setting:`SCHEDULER_DISK_QUEUE`. + + This scheduler class also uses the configured :setting:`DUPEFILTER_CLASS`, + which may also write data inside the job directory. """ @classmethod @@ -305,7 +334,7 @@ class Scheduler(BaseScheduler): cls = crawler.settings[f"SCHEDULER_START_{queue}_QUEUE"] if not cls: return None - return load_object(cls) + return cast("type[BaseQueue]", load_object(cls)) def has_pending_requests(self) -> bool: return len(self) > 0 @@ -348,11 +377,11 @@ class Scheduler(BaseScheduler): dqok = self._dqpush(request) assert self.stats is not None if dqok: - self.stats.inc_value("scheduler/enqueued/disk", spider=self.spider) + self.stats.inc_value("scheduler/enqueued/disk") else: self._mqpush(request) - self.stats.inc_value("scheduler/enqueued/memory", spider=self.spider) - self.stats.inc_value("scheduler/enqueued", spider=self.spider) + self.stats.inc_value("scheduler/enqueued/memory") + self.stats.inc_value("scheduler/enqueued") return True def next_request(self) -> Request | None: @@ -367,13 +396,13 @@ class Scheduler(BaseScheduler): request: Request | None = self.mqs.pop() assert self.stats is not None if request is not None: - self.stats.inc_value("scheduler/dequeued/memory", spider=self.spider) + self.stats.inc_value("scheduler/dequeued/memory") else: request = self._dqpop() if request is not None: - self.stats.inc_value("scheduler/dequeued/disk", spider=self.spider) + self.stats.inc_value("scheduler/dequeued/disk") if request is not None: - self.stats.inc_value("scheduler/dequeued", spider=self.spider) + self.stats.inc_value("scheduler/dequeued") return request def __len__(self) -> int: @@ -402,7 +431,7 @@ class Scheduler(BaseScheduler): ) self.logunser = False assert self.stats is not None - self.stats.inc_value("scheduler/unserializable", spider=self.spider) + self.stats.inc_value("scheduler/unserializable") return False return True @@ -418,27 +447,13 @@ class Scheduler(BaseScheduler): """Create a new priority queue instance, with in-memory storage""" assert self.crawler assert self.pqclass - try: - return build_from_crawler( - self.pqclass, - self.crawler, - downstream_queue_cls=self.mqclass, - key="", - start_queue_cls=self._smqclass, - ) - except TypeError: - warn( - f"The __init__ method of {global_object_name(self.pqclass)} " - f"does not support a `start_queue_cls` keyword-only " - f"parameter.", - ScrapyDeprecationWarning, - ) - return build_from_crawler( - self.pqclass, - self.crawler, - downstream_queue_cls=self.mqclass, - key="", - ) + return build_from_crawler( + self.pqclass, + self.crawler, + downstream_queue_cls=self.mqclass, + key="", + start_queue_cls=self._smqclass, + ) def _dq(self) -> ScrapyPriorityQueue: """Create a new priority queue instance, with disk storage""" @@ -446,29 +461,14 @@ class Scheduler(BaseScheduler): assert self.dqdir assert self.pqclass state = self._read_dqs_state(self.dqdir) - try: - q = build_from_crawler( - self.pqclass, - self.crawler, - downstream_queue_cls=self.dqclass, - key=self.dqdir, - startprios=state, - start_queue_cls=self._sdqclass, - ) - except TypeError: - warn( - f"The __init__ method of {global_object_name(self.pqclass)} " - f"does not support a `start_queue_cls` keyword-only " - f"parameter.", - ScrapyDeprecationWarning, - ) - q = build_from_crawler( - self.pqclass, - self.crawler, - downstream_queue_cls=self.dqclass, - key=self.dqdir, - startprios=state, - ) + q = build_from_crawler( + self.pqclass, + self.crawler, + downstream_queue_cls=self.dqclass, + key=self.dqdir, + startprios=state, + start_queue_cls=self._sdqclass, + ) if q: logger.info( "Resuming crawl (%(queuesize)d requests scheduled)", @@ -486,13 +486,13 @@ class Scheduler(BaseScheduler): return str(dqdir) return None - def _read_dqs_state(self, dqdir: str) -> list[int]: + def _read_dqs_state(self, dqdir: str) -> Any: path = Path(dqdir, "active.json") if not path.exists(): - return [] + return () with path.open(encoding="utf-8") as f: - return cast(list[int], json.load(f)) + return json.load(f) - def _write_dqs_state(self, dqdir: str, state: list[int]) -> None: + def _write_dqs_state(self, dqdir: str, state: Any) -> None: with Path(dqdir, "active.json").open("w", encoding="utf-8") as f: json.dump(state, f) diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index dc3a287b4..466ce656d 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -7,9 +7,9 @@ import logging import warnings from collections import deque from collections.abc import AsyncIterator -from typing import TYPE_CHECKING, Any, TypeVar, Union +from typing import TYPE_CHECKING, Any, TypeAlias, TypeVar -from twisted.internet.defer import Deferred, inlineCallbacks, maybeDeferred +from twisted.internet.defer import Deferred, inlineCallbacks from twisted.python.failure import Failure from scrapy import Spider, signals @@ -21,19 +21,23 @@ from scrapy.exceptions import ( ScrapyDeprecationWarning, ) from scrapy.http import Request, Response +from scrapy.pipelines import ItemPipelineManager from scrapy.utils.asyncio import _parallel_asyncio, is_asyncio_available from scrapy.utils.defer import ( - _defer_sleep, + _defer_sleep_async, + _schedule_coro, aiter_errback, - deferred_f_from_coro_f, deferred_from_coro, + ensure_awaitable, iter_errback, maybe_deferred_to_future, parallel, parallel_async, ) +from scrapy.utils.deprecate import method_is_overridden from scrapy.utils.log import failure_to_exc_info, logformatter_adapter from scrapy.utils.misc import load_object, warn_on_generator_with_return_value +from scrapy.utils.python import global_object_name from scrapy.utils.spider import iterate_spider_output if TYPE_CHECKING: @@ -41,7 +45,6 @@ if TYPE_CHECKING: from scrapy.crawler import Crawler from scrapy.logformatter import LogFormatter - from scrapy.pipelines import ItemPipelineManager from scrapy.signalmanager import SignalManager @@ -49,7 +52,7 @@ logger = logging.getLogger(__name__) _T = TypeVar("_T") -QueueTuple = tuple[Union[Response, Failure], Request, Deferred[None]] +QueueTuple: TypeAlias = tuple[Response | Failure, Request, Deferred[None]] class Slot: @@ -62,7 +65,7 @@ class Slot: self.queue: deque[QueueTuple] = deque() self.active: set[Request] = set() self.active_size: int = 0 - self.itemproc_size: int = 0 + self.itemproc_size: int = 0 # just for scrapy.utils.engine.get_engine_status() self.closing: Deferred[Spider] | None = None def add_response_request( @@ -106,33 +109,99 @@ class Scraper: crawler.settings["ITEM_PROCESSOR"] ) self.itemproc: ItemPipelineManager = itemproc_cls.from_crawler(crawler) + self._itemproc_has_async: dict[str, bool] = {} + for method in [ + "open_spider", + "close_spider", + "process_item", + ]: + self._check_deprecated_itemproc_method(method) + self.concurrent_items: int = crawler.settings.getint("CONCURRENT_ITEMS") self.crawler: Crawler = crawler self.signals: SignalManager = crawler.signals assert crawler.logformatter self.logformatter: LogFormatter = crawler.logformatter - @deferred_f_from_coro_f - async def open_spider(self, spider: Spider) -> None: - """Open the given spider for scraping and allocate resources for it""" - self.slot = Slot(self.crawler.settings.getint("SCRAPER_SLOT_MAX_ACTIVE_SIZE")) - await maybe_deferred_to_future(self.itemproc.open_spider(spider)) - - def close_spider(self, spider: Spider | None = None) -> Deferred[Spider]: - """Close a spider being scraped and release its resources""" - if spider is not None: + def _check_deprecated_itemproc_method(self, method: str) -> None: + itemproc_cls = type(self.itemproc) + if not hasattr(self.itemproc, f"{method}_async"): warnings.warn( - "Passing a 'spider' argument to Scraper.close_spider() is deprecated.", - category=ScrapyDeprecationWarning, + f"{global_object_name(itemproc_cls)} doesn't define a {method}_async() method," + f" this is deprecated and the method will be required in future Scrapy versions.", + ScrapyDeprecationWarning, stacklevel=2, ) + self._itemproc_has_async[method] = False + elif ( + issubclass(itemproc_cls, ItemPipelineManager) + and method_is_overridden(itemproc_cls, ItemPipelineManager, method) + and not method_is_overridden( + itemproc_cls, ItemPipelineManager, f"{method}_async" + ) + ): + warnings.warn( + f"{global_object_name(itemproc_cls)} overrides {method}() but doesn't override {method}_async()." + f" This is deprecated. {method}() will be used, but in future Scrapy versions {method}_async() will be used instead.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + self._itemproc_has_async[method] = False + else: + self._itemproc_has_async[method] = True + def open_spider( + self, spider: Spider | None = None + ) -> Deferred[None]: # pragma: no cover + warnings.warn( + "Scraper.open_spider() is deprecated, use open_spider_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return deferred_from_coro(self.open_spider_async()) + + async def open_spider_async(self) -> None: + """Open the spider for scraping and allocate resources for it. + + .. versionadded:: 2.14 + """ + self.slot = Slot(self.crawler.settings.getint("SCRAPER_SLOT_MAX_ACTIVE_SIZE")) + if not self.crawler.spider: + raise RuntimeError( + "Scraper.open_spider() called before Crawler.spider is set." + ) + if self._itemproc_has_async["open_spider"]: + await self.itemproc.open_spider_async() + else: + await maybe_deferred_to_future( + self.itemproc.open_spider(self.crawler.spider) + ) + + def close_spider(self) -> Deferred[None]: # pragma: no cover + warnings.warn( + "Scraper.close_spider() is deprecated, use close_spider_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return deferred_from_coro(self.close_spider_async()) + + async def close_spider_async(self) -> None: + """Close the spider being scraped and release its resources. + + .. versionadded:: 2.14 + """ if self.slot is None: raise RuntimeError("Scraper slot not assigned") self.slot.closing = Deferred() - self.slot.closing.addCallback(self.itemproc.close_spider) self._check_if_closing() - return self.slot.closing + await maybe_deferred_to_future(self.slot.closing) + if self._itemproc_has_async["close_spider"]: + await self.itemproc.close_spider_async() + else: + assert self.crawler.spider + await maybe_deferred_to_future( + self.itemproc.close_spider(self.crawler.spider) + ) def is_idle(self) -> bool: """Return True if there isn't any more spiders to process""" @@ -146,21 +215,14 @@ class Scraper: @inlineCallbacks def enqueue_scrape( - self, result: Response | Failure, request: Request, spider: Spider | None = None + self, result: Response | Failure, request: Request ) -> Generator[Deferred[Any], Any, None]: - if spider is not None: - warnings.warn( - "Passing a 'spider' argument to Scraper.enqueue_scrape() is deprecated.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - if self.slot is None: raise RuntimeError("Scraper slot not assigned") dfd = self.slot.add_response_request(result, request) self._scrape_next() try: - yield dfd + yield dfd # fired in _wait_for_processing() except Exception: logger.error( "Scraper bug processing %(request)s", @@ -176,10 +238,9 @@ class Scraper: def _scrape_next(self) -> None: assert self.slot is not None # typing while self.slot.queue: - result, request, deferred = self.slot.next_response_request_deferred() - self._scrape(result, request).chainDeferred(deferred) + result, request, queue_dfd = self.slot.next_response_request_deferred() + _schedule_coro(self._wait_for_processing(result, request, queue_dfd)) - @deferred_f_from_coro_f async def _scrape(self, result: Response | Failure, request: Request) -> None: """Handle the downloaded response or failure through the spider callback/errback.""" if not isinstance(result, (Response, Failure)): @@ -187,13 +248,12 @@ class Scraper: f"Incorrect type: expected Response or Failure, got {type(result)}: {result!r}" ) - assert self.crawler.spider output: Iterable[Any] | AsyncIterator[Any] if isinstance(result, Response): try: # call the spider middlewares and the request callback with the response output = await self.spidermw.scrape_response_async( - self.call_spider, result, request, self.crawler.spider + self.call_spider_async, result, request ) except Exception: self.handle_spider_error(Failure(), request, result) @@ -206,6 +266,7 @@ class Scraper: output = await self.call_spider_async(result, request) except Exception as spider_exc: # the errback didn't silence the exception + assert self.crawler.spider if not result.check(IgnoreRequest): logkws = self.logformatter.download_error( result, request, self.crawler.spider @@ -221,22 +282,34 @@ class Scraper: else: await self.handle_spider_output_async(output, request, result) + async def _wait_for_processing( + self, result: Response | Failure, request: Request, queue_dfd: Deferred[None] + ) -> None: + try: + await self._scrape(result, request) + except Exception: + queue_dfd.errback(Failure()) + else: + queue_dfd.callback(None) # awaited in enqueue_scrape() + def call_spider( self, result: Response | Failure, request: Request, spider: Spider | None = None - ) -> Deferred[Iterable[Any] | AsyncIterator[Any]]: - if spider is not None: - warnings.warn( - "Passing a 'spider' argument to Scraper.call_spider() is deprecated.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) + ) -> Deferred[Iterable[Any] | AsyncIterator[Any]]: # pragma: no cover + warnings.warn( + "Scraper.call_spider() is deprecated, use call_spider_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) return deferred_from_coro(self.call_spider_async(result, request)) async def call_spider_async( self, result: Response | Failure, request: Request ) -> Iterable[Any] | AsyncIterator[Any]: - """Call the request callback or errback with the response or failure.""" - await maybe_deferred_to_future(_defer_sleep()) + """Call the request callback or errback with the response or failure. + + .. versionadded:: 2.13 + """ + await _defer_sleep_async() assert self.crawler.spider if isinstance(result, Response): if getattr(result, "request", None) is None: @@ -245,6 +318,13 @@ class Scraper: callback = result.request.callback or self.crawler.spider._parse warn_on_generator_with_return_value(self.crawler.spider, callback) output = callback(result, **result.request.cb_kwargs) + if isinstance(output, Deferred): + warnings.warn( + f"{callback} returned a Deferred." + f" Returning Deferreds from spider callbacks is deprecated.", + ScrapyDeprecationWarning, + stacklevel=2, + ) else: # result is a Failure # TODO: properly type adding this attribute to a Failure result.request = request # type: ignore[attr-defined] @@ -256,31 +336,28 @@ class Scraper: output.raiseException() # else the errback returned actual output (like a callback), # which needs to be passed to iterate_spider_output() - return await maybe_deferred_to_future( - maybeDeferred(iterate_spider_output, output) - ) + if isinstance(output, Deferred): + warnings.warn( + f"{request.errback} returned a Deferred." + f" Returning Deferreds from spider errbacks is deprecated.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return await ensure_awaitable(iterate_spider_output(output)) def handle_spider_error( self, _failure: Failure, request: Request, response: Response | Failure, - spider: Spider | None = None, ) -> None: """Handle an exception raised by a spider callback or errback.""" - if spider is not None: - warnings.warn( - "Passing a 'spider' argument to Scraper.handle_spider_error() is deprecated.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - assert self.crawler.spider exc = _failure.value if isinstance(exc, CloseSpider): assert self.crawler.engine is not None # typing - self.crawler.engine.close_spider( - self.crawler.spider, exc.reason or "cancelled" + _schedule_coro( + self.crawler.engine.close_spider_async(reason=exc.reason or "cancelled") ) return logkws = self.logformatter.spider_error( @@ -298,12 +375,9 @@ class Scraper: spider=self.crawler.spider, ) assert self.crawler.stats + self.crawler.stats.inc_value("spider_exceptions/count") self.crawler.stats.inc_value( - "spider_exceptions/count", spider=self.crawler.spider - ) - self.crawler.stats.inc_value( - f"spider_exceptions/{_failure.value.__class__.__name__}", - spider=self.crawler.spider, + f"spider_exceptions/{_failure.value.__class__.__name__}" ) def handle_spider_output( @@ -311,15 +385,13 @@ class Scraper: result: Iterable[_T] | AsyncIterator[_T], request: Request, response: Response | Failure, - spider: Spider | None = None, - ) -> Deferred[None]: + ) -> Deferred[None]: # pragma: no cover """Pass items/requests produced by a callback to ``_process_spidermw_output()`` in parallel.""" - if spider is not None: - warnings.warn( - "Passing a 'spider' argument to Scraper.handle_spider_output() is deprecated.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) + warnings.warn( + "Scraper.handle_spider_output() is deprecated, use handle_spider_output_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) return deferred_from_coro( self.handle_spider_output_async(result, request, response) ) @@ -330,7 +402,10 @@ class Scraper: request: Request, response: Response | Failure, ) -> None: - """Pass items/requests produced by a callback to ``_process_spidermw_output()`` in parallel.""" + """Pass items/requests produced by a callback to ``_process_spidermw_output()`` in parallel. + + .. versionadded:: 2.13 + """ it: Iterable[_T] | AsyncIterator[_T] if is_asyncio_available(): if isinstance(result, AsyncIterator): @@ -389,12 +464,17 @@ class Scraper: def start_itemproc( self, item: Any, *, response: Response | Failure | None - ) -> Deferred[None]: + ) -> Deferred[None]: # pragma: no cover """Send *item* to the item pipelines for processing. *response* is the source of the item data. If the item does not come from response data, e.g. it was hard-coded, set it to ``None``. """ + warnings.warn( + "Scraper.start_itemproc() is deprecated, use start_itemproc_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) return deferred_from_coro(self.start_itemproc_async(item, response=response)) async def start_itemproc_async( @@ -404,14 +484,19 @@ class Scraper: *response* is the source of the item data. If the item does not come from response data, e.g. it was hard-coded, set it to ``None``. + + .. versionadded:: 2.14 """ assert self.slot is not None # typing assert self.crawler.spider is not None # typing self.slot.itemproc_size += 1 try: - output = await maybe_deferred_to_future( - self.itemproc.process_item(item, self.crawler.spider) - ) + if self._itemproc_has_async["process_item"]: + output = await self.itemproc.process_item_async(item) + else: + output = await maybe_deferred_to_future( + self.itemproc.process_item(item, self.crawler.spider) + ) except DropItem as ex: logkws = self.logformatter.dropped(item, ex, response, self.crawler.spider) if logkws is not None: diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 10aad7858..fbc6f2530 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -7,30 +7,30 @@ See documentation in docs/topics/spider-middleware.rst from __future__ import annotations import logging -from collections.abc import AsyncIterator, Callable, Iterable -from inspect import isasyncgenfunction, iscoroutine +from collections.abc import AsyncIterator, Callable, Coroutine, Iterable +from functools import wraps +from inspect import isasyncgenfunction from itertools import islice -from typing import TYPE_CHECKING, Any, TypeVar, Union, cast +from typing import TYPE_CHECKING, Any, TypeAlias, TypeVar from warnings import warn -from twisted.internet.defer import Deferred, inlineCallbacks from twisted.python.failure import Failure from scrapy import Request, Spider from scrapy.exceptions import ScrapyDeprecationWarning, _InvalidOutput from scrapy.http import Response from scrapy.middleware import MiddlewareManager -from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen +from scrapy.utils.asyncgen import as_async_generator from scrapy.utils.conf import build_component_list from scrapy.utils.defer import ( + _defer_sleep_async, deferred_from_coro, maybe_deferred_to_future, - mustbe_deferred, ) -from scrapy.utils.python import MutableAsyncChain, MutableChain, global_object_name +from scrapy.utils.python import MutableAsyncChain, global_object_name if TYPE_CHECKING: - from collections.abc import Generator + from twisted.internet.defer import Deferred from scrapy.settings import BaseSettings @@ -39,108 +39,52 @@ logger = logging.getLogger(__name__) _T = TypeVar("_T") -ScrapeFunc = Callable[ - [Union[Response, Failure], Request], - Deferred[Union[Iterable[_T], AsyncIterator[_T]]], +ScrapeFunc: TypeAlias = Callable[ + [Response | Failure, Request], + Coroutine[Any, Any, Iterable[_T] | AsyncIterator[_T]], ] -def _isiterable(o: Any) -> bool: - return isinstance(o, (Iterable, AsyncIterator)) - - class SpiderMiddlewareManager(MiddlewareManager): component_name = "spider middleware" @classmethod def _get_mwlist_from_settings(cls, settings: BaseSettings) -> list[Any]: - return build_component_list(settings.getwithbase("SPIDER_MIDDLEWARES")) - - def __init__(self, *middlewares: Any) -> None: - self._check_deprecated_process_start_requests_use(middlewares) - super().__init__(*middlewares) - - def _check_deprecated_process_start_requests_use( - self, middlewares: tuple[Any] - ) -> None: - deprecated_middlewares = [ - middleware - for middleware in middlewares - if hasattr(middleware, "process_start_requests") - and not hasattr(middleware, "process_start") - ] - modern_middlewares = [ - middleware - for middleware in middlewares - if not hasattr(middleware, "process_start_requests") - and hasattr(middleware, "process_start") - ] - if deprecated_middlewares and modern_middlewares: - raise ValueError( - "You are trying to combine spider middlewares that only " - "define the deprecated process_start_requests() method () " - "with spider middlewares that only define the " - "process_start() method (). This is not possible. You must " - "either disable or make universal 1 of those 2 sets of " - "spider middlewares. Making a spider middleware universal " - "means having it define both methods. See the release notes " - "of Scrapy 2.13 for details: " - "https://docs.scrapy.org/en/2.13/news.html" - ) - - self._use_start_requests = bool(deprecated_middlewares) - if self._use_start_requests: - deprecated_middleware_list = ", ".join( - global_object_name(middleware.__class__) - for middleware in deprecated_middlewares - ) - warn( - f"The following enabled spider middlewares, directly or " - f"through their parent classes, define the deprecated " - f"process_start_requests() method: " - f"{deprecated_middleware_list}. process_start_requests() has " - f"been deprecated in favor of a new method, process_start(), " - f"to support asynchronous code execution. " - f"process_start_requests() will stop being called in a future " - f"version of Scrapy. If you use Scrapy 2.13 or higher " - f"only, replace process_start_requests() with " - f"process_start(); note that process_start() is a coroutine " - f"(async def). If you need to maintain compatibility with " - f"lower Scrapy versions, when defining " - f"process_start_requests() in a spider middleware class, " - f"define process_start() as well. See the release notes of " - f"Scrapy 2.13 for details: " - f"https://docs.scrapy.org/en/2.13/news.html", - ScrapyDeprecationWarning, - ) + return build_component_list( + settings.get_component_priority_dict_with_base("SPIDER_MIDDLEWARES") + ) def _add_middleware(self, mw: Any) -> None: - super()._add_middleware(mw) if hasattr(mw, "process_spider_input"): self.methods["process_spider_input"].append(mw.process_spider_input) - if self._use_start_requests: - if hasattr(mw, "process_start_requests"): - self.methods["process_start_requests"].appendleft( - mw.process_start_requests - ) - elif hasattr(mw, "process_start"): + self._check_mw_method_spider_arg(mw.process_spider_input) + + if hasattr(mw, "process_start"): self.methods["process_start"].appendleft(mw.process_start) - process_spider_output = self._get_async_method_pair(mw, "process_spider_output") + + process_spider_output = self._get_process_spider_output(mw) self.methods["process_spider_output"].appendleft(process_spider_output) + if process_spider_output is not None: + self._check_mw_method_spider_arg(process_spider_output) + process_spider_exception = getattr(mw, "process_spider_exception", None) self.methods["process_spider_exception"].appendleft(process_spider_exception) + if process_spider_exception is not None: + self._check_mw_method_spider_arg(process_spider_exception) - def _process_spider_input( + async def _process_spider_input( self, scrape_func: ScrapeFunc[_T], response: Response, request: Request, - spider: Spider, - ) -> Deferred[Iterable[_T] | AsyncIterator[_T]]: + ) -> Iterable[_T] | AsyncIterator[_T]: for method in self.methods["process_spider_input"]: - method = cast(Callable, method) + assert method is not None try: - result = method(response=response, spider=spider) + if method in self._mw_methods_requiring_spider: + result = method(response=response, spider=self._spider) + else: + result = method(response=response) if result is not None: msg = ( f"{global_object_name(method)} must return None " @@ -150,59 +94,31 @@ class SpiderMiddlewareManager(MiddlewareManager): except _InvalidOutput: raise except Exception: - return scrape_func(Failure(), request) - return scrape_func(response, request) + return await scrape_func(Failure(), request) + return await scrape_func(response, request) - def _evaluate_iterable( + async def _evaluate_iterable( self, response: Response, - spider: Spider, - iterable: Iterable[_T] | AsyncIterator[_T], + iterable: AsyncIterator[_T], exception_processor_index: int, - recover_to: MutableChain[_T] | MutableAsyncChain[_T], - ) -> Iterable[_T] | AsyncIterator[_T]: - def process_sync(iterable: Iterable[_T]) -> Iterable[_T]: - try: - yield from iterable - except Exception as ex: - exception_result = cast( - Union[Failure, MutableChain[_T]], - self._process_spider_exception( - response, spider, ex, exception_processor_index - ), - ) - if isinstance(exception_result, Failure): - raise - assert isinstance(recover_to, MutableChain) - recover_to.extend(exception_result) - - async def process_async(iterable: AsyncIterator[_T]) -> AsyncIterator[_T]: - try: - async for r in iterable: - yield r - except Exception as ex: - exception_result = cast( - Union[Failure, MutableAsyncChain[_T]], - self._process_spider_exception( - response, spider, ex, exception_processor_index - ), - ) - if isinstance(exception_result, Failure): - raise - assert isinstance(recover_to, MutableAsyncChain) - recover_to.extend(exception_result) - - if isinstance(iterable, AsyncIterator): - return process_async(iterable) - return process_sync(iterable) + recover_to: MutableAsyncChain[_T], + ) -> AsyncIterator[_T]: + try: + async for r in iterable: + yield r + except Exception as ex: + exception_result: MutableAsyncChain[_T] = self._process_spider_exception( + response, ex, exception_processor_index + ) + recover_to.extend(exception_result) def _process_spider_exception( self, response: Response, - spider: Spider, exception: Exception, start_index: int = 0, - ) -> MutableChain[_T] | MutableAsyncChain[_T]: + ) -> MutableAsyncChain[_T]: # don't handle _InvalidOutput exception if isinstance(exception, _InvalidOutput): raise exception @@ -212,27 +128,18 @@ class SpiderMiddlewareManager(MiddlewareManager): for method_index, method in enumerate(method_list, start=start_index): if method is None: continue - method = cast(Callable, method) - result = method(response=response, exception=exception, spider=spider) - if _isiterable(result): + if method in self._mw_methods_requiring_spider: + result = method( + response=response, exception=exception, spider=self._spider + ) + else: + result = method(response=response, exception=exception) + if isinstance(result, (Iterable, AsyncIterator)): # stop exception handling by handing control over to the # process_spider_output chain if an iterable has been returned - dfd: Deferred[MutableChain[_T] | MutableAsyncChain[_T]] = ( - self._process_spider_output( - response, spider, result, method_index + 1 - ) - ) - # _process_spider_output() returns a Deferred only because of downgrading so this can be - # simplified when downgrading is removed. - if dfd.called: - # the result is available immediately if _process_spider_output didn't do downgrading - return cast( - Union[MutableChain[_T], MutableAsyncChain[_T]], dfd.result - ) - # we forbid waiting here because otherwise we would need to return a deferred from - # _process_spider_exception too, which complicates the architecture - msg = f"Async iterable returned from {global_object_name(method)} cannot be downgraded" - raise _InvalidOutput(msg) + if isinstance(result, Iterable): + result = as_async_generator(result) + return self._process_spider_output(response, result, method_index + 1) if result is None: continue msg = ( @@ -242,133 +149,61 @@ class SpiderMiddlewareManager(MiddlewareManager): raise _InvalidOutput(msg) raise exception - # This method cannot be made async def, as _process_spider_exception relies on the Deferred result - # being available immediately which doesn't work when it's a wrapped coroutine. - # It also needs @inlineCallbacks only because of downgrading so it can be removed when downgrading is removed. - @inlineCallbacks def _process_spider_output( self, response: Response, - spider: Spider, - result: Iterable[_T] | AsyncIterator[_T], + result: AsyncIterator[_T], start_index: int = 0, - ) -> Generator[Deferred[Any], Any, MutableChain[_T] | MutableAsyncChain[_T]]: + ) -> MutableAsyncChain[_T]: # items in this iterable do not need to go through the process_spider_output # chain, they went through it already from the process_spider_exception method - recovered: MutableChain[_T] | MutableAsyncChain[_T] - last_result_is_async = isinstance(result, AsyncIterator) - recovered = MutableAsyncChain() if last_result_is_async else MutableChain() - - # There are three cases for the middleware: def foo, async def foo, def foo + async def foo_async. - # 1. def foo. Sync iterables are passed as is, async ones are downgraded. - # 2. async def foo. Sync iterables are upgraded, async ones are passed as is. - # 3. def foo + async def foo_async. Iterables are passed to the respective method. - # Storing methods and method tuples in the same list is weird but we should be able to roll this back - # when we drop this compatibility feature. - + recovered: MutableAsyncChain[_T] = MutableAsyncChain() method_list = islice(self.methods["process_spider_output"], start_index, None) - for method_index, method_pair in enumerate(method_list, start=start_index): - if method_pair is None: + for method_index, method in enumerate(method_list, start=start_index): + if method is None: continue - need_upgrade = need_downgrade = False - if isinstance(method_pair, tuple): - # This tuple handling is only needed until _async compatibility methods are removed. - method_sync, method_async = method_pair - method = method_async if last_result_is_async else method_sync + if method in self._mw_methods_requiring_spider: + result = method(response=response, result=result, spider=self._spider) else: - method = method_pair - if not last_result_is_async and isasyncgenfunction(method): - need_upgrade = True - elif last_result_is_async and not isasyncgenfunction(method): - need_downgrade = True - try: - if need_upgrade: - # Iterable -> AsyncIterator - result = as_async_generator(result) - elif need_downgrade: - logger.warning( - f"Async iterable passed to {global_object_name(method)} was" - f" downgraded to a non-async one. This is deprecated and will" - f" stop working in a future version of Scrapy. Please see" - f" https://docs.scrapy.org/en/latest/topics/coroutines.html#for-middleware-users" - f" for more information." - ) - assert isinstance(result, AsyncIterator) - # AsyncIterator -> Iterable - result = yield deferred_from_coro(collect_asyncgen(result)) - if isinstance(recovered, AsyncIterator): - recovered_collected = yield deferred_from_coro( - collect_asyncgen(recovered) - ) - recovered = MutableChain(recovered_collected) - # might fail directly if the output value is not a generator - result = method(response=response, result=result, spider=spider) - except Exception as ex: - exception_result: Failure | MutableChain[_T] | MutableAsyncChain[_T] = ( - self._process_spider_exception( - response, spider, ex, method_index + 1 - ) - ) - if isinstance(exception_result, Failure): - raise - return exception_result - if _isiterable(result): - result = self._evaluate_iterable( - response, spider, result, method_index + 1, recovered - ) - else: - if iscoroutine(result): - result.close() # Silence warning about not awaiting - msg = ( - f"{global_object_name(method)} must be an asynchronous " - f"generator (i.e. use yield)" - ) - else: - msg = ( - f"{global_object_name(method)} must return an iterable, got " - f"{type(result)}" - ) - raise _InvalidOutput(msg) - last_result_is_async = isinstance(result, AsyncIterator) - - if last_result_is_async: - return MutableAsyncChain(result, recovered) - return MutableChain(result, recovered) # type: ignore[arg-type] + result = method(response=response, result=result) + result = self._evaluate_iterable( + response, result, method_index + 1, recovered + ) + return MutableAsyncChain(result, recovered) async def _process_callback_output( - self, - response: Response, - spider: Spider, - result: Iterable[_T] | AsyncIterator[_T], - ) -> MutableChain[_T] | MutableAsyncChain[_T]: - recovered: MutableChain[_T] | MutableAsyncChain[_T] - if isinstance(result, AsyncIterator): - recovered = MutableAsyncChain() - else: - recovered = MutableChain() - result = self._evaluate_iterable(response, spider, result, 0, recovered) - result = await maybe_deferred_to_future( - cast( - "Deferred[Iterable[_T] | AsyncIterator[_T]]", - self._process_spider_output(response, spider, result), - ) - ) - if isinstance(result, AsyncIterator): - return MutableAsyncChain(result, recovered) - if isinstance(recovered, AsyncIterator): - recovered_collected = await collect_asyncgen(recovered) - recovered = MutableChain(recovered_collected) - return MutableChain(result, recovered) + self, response: Response, result: AsyncIterator[_T] + ) -> MutableAsyncChain[_T]: + recovered: MutableAsyncChain[_T] = MutableAsyncChain() + result = self._evaluate_iterable(response, result, 0, recovered) + result = self._process_spider_output(response, result) + return MutableAsyncChain(result, recovered) def scrape_response( self, - scrape_func: ScrapeFunc[_T], + scrape_func: Callable[ + [Response | Failure, Request], + Deferred[Iterable[_T] | AsyncIterator[_T]], + ], response: Response, request: Request, spider: Spider, - ) -> Deferred[MutableChain[_T] | MutableAsyncChain[_T]]: + ) -> Deferred[MutableAsyncChain[_T]]: # pragma: no cover + warn( + "SpiderMiddlewareManager.scrape_response() is deprecated, use scrape_response_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + + @wraps(scrape_func) + async def scrape_func_wrapped( + response: Response | Failure, request: Request + ) -> Iterable[_T] | AsyncIterator[_T]: + return await maybe_deferred_to_future(scrape_func(response, request)) + + self._set_compat_spider(spider) return deferred_from_coro( - self.scrape_response_async(scrape_func, response, request, spider) + self.scrape_response_async(scrape_func_wrapped, response, request) ) async def scrape_response_async( @@ -376,136 +211,64 @@ class SpiderMiddlewareManager(MiddlewareManager): scrape_func: ScrapeFunc[_T], response: Response, request: Request, - spider: Spider, - ) -> MutableChain[_T] | MutableAsyncChain[_T]: - async def process_callback_output( - result: Iterable[_T] | AsyncIterator[_T], - ) -> MutableChain[_T] | MutableAsyncChain[_T]: - return await self._process_callback_output(response, spider, result) - - def process_spider_exception( - exception: Exception, - ) -> MutableChain[_T] | MutableAsyncChain[_T]: - return self._process_spider_exception(response, spider, exception) - + ) -> MutableAsyncChain[_T]: + if not self.crawler: + raise RuntimeError( + "scrape_response_async() called on a SpiderMiddlewareManager" + " instance created without a crawler." + ) try: - it: Iterable[_T] | AsyncIterator[_T] = await maybe_deferred_to_future( - mustbe_deferred( - self._process_spider_input, scrape_func, response, request, spider - ) + it: Iterable[_T] | AsyncIterator[_T] = await self._process_spider_input( + scrape_func, response, request ) - return await process_callback_output(it) + ait = it if isinstance(it, AsyncIterator) else as_async_generator(it) + return await self._process_callback_output(response, ait) except Exception as ex: - return process_spider_exception(ex) + await _defer_sleep_async() + return self._process_spider_exception(response, ex) - async def process_start(self, spider: Spider) -> AsyncIterator[Any] | None: - self._check_deprecated_start_requests_use(spider) - if self._use_start_requests: - sync_start = iter(spider.start_requests()) - sync_start = await maybe_deferred_to_future( - self._process_chain("process_start_requests", sync_start, spider) - ) - start: AsyncIterator[Any] = as_async_generator(sync_start) - else: - start = spider.start() - start = await maybe_deferred_to_future( - self._process_chain("process_start", start) - ) - return start - - def _check_deprecated_start_requests_use(self, spider: Spider): - start_requests_cls = None - start_cls = None - spidercls = spider.__class__ - mro = spidercls.__mro__ - - for cls in mro: - cls_dict = cls.__dict__ - if start_requests_cls is None and "start_requests" in cls_dict: - start_requests_cls = cls - if start_cls is None and "start" in cls_dict: - start_cls = cls - if start_requests_cls is not None and start_cls is not None: - break - - # Spider defines both, start_requests and start. - assert start_requests_cls is not None - assert start_cls is not None - - if ( - start_requests_cls is not Spider - and start_cls is not start_requests_cls - and mro.index(start_requests_cls) < mro.index(start_cls) - ): - src = global_object_name(start_requests_cls) - if start_requests_cls is not spidercls: - src += f" (inherited by {global_object_name(spidercls)})" - warn( - f"{src} defines the deprecated start_requests() method. " - f"start_requests() has been deprecated in favor of a new " - f"method, start(), to support asynchronous code " - f"execution. start_requests() will stop being called in a " - f"future version of Scrapy. If you use Scrapy 2.13 or " - f"higher only, replace start_requests() with start(); " - f"note that start() is a coroutine (async def). If you " - f"need to maintain compatibility with lower Scrapy versions, " - f"when overriding start_requests() in a spider class, " - f"override start() as well; you can use super() to " - f"reuse the inherited start() implementation without " - f"copy-pasting. See the release notes of Scrapy 2.13 for " - f"details: https://docs.scrapy.org/en/2.13/news.html", - ScrapyDeprecationWarning, - ) - - if ( - self._use_start_requests - and start_cls is not Spider - and start_requests_cls is not start_cls - and mro.index(start_cls) < mro.index(start_requests_cls) - ): - src = global_object_name(start_cls) - if start_cls is not spidercls: - src += f" (inherited by {global_object_name(spidercls)})" - raise ValueError( - f"{src} does not define the deprecated start_requests() " - f"method. However, one or more of your enabled spider " - f"middlewares (reported in an earlier deprecation warning) " - f"define the process_start_requests() method, and not the " - f"process_start() method, making them only compatible with " - f"(deprecated) spiders that define the start_requests() " - f"method. To solve this issue, disable the offending spider " - f"middlewares, upgrade them as described in that earlier " - f"deprecation warning, or make your spider compatible with " - f"deprecated spider middlewares (and earlier Scrapy versions) " - f"by defining a sync start_requests() method that works " - f"similarly to its existing start() method. See the " - f"release notes of Scrapy 2.13 for details: " - f"https://docs.scrapy.org/en/2.13/news.html" - ) + async def process_start( + self, spider: Spider | None = None + ) -> AsyncIterator[Any] | None: + if spider: + if self.crawler: + msg = ( + "Passing a spider argument to SpiderMiddlewareManager.process_start() is deprecated" + " and the passed value is ignored." + ) + else: + msg = ( + "Passing a spider argument to SpiderMiddlewareManager.process_start() is deprecated," + " SpiderMiddlewareManager should be instantiated with a Crawler instance instead." + ) + warn(msg, category=ScrapyDeprecationWarning, stacklevel=2) + self._set_compat_spider(spider) + start = self._spider.start() + return await self._process_chain("process_start", start) # This method is only needed until _async compatibility methods are removed. @staticmethod - def _get_async_method_pair( - mw: Any, methodname: str - ) -> Callable | tuple[Callable, Callable] | None: - normal_method: Callable | None = getattr(mw, methodname, None) - methodname_async = methodname + "_async" - async_method: Callable | None = getattr(mw, methodname_async, None) + def _get_process_spider_output(mw: Any) -> Callable[..., Any] | None: + normal_method: Callable[..., Any] | None = getattr( + mw, "process_spider_output", None + ) + async_method: Callable[..., Any] | None = getattr( + mw, "process_spider_output_async", None + ) if not async_method: if normal_method and not isasyncgenfunction(normal_method): - logger.warning( + raise TypeError( f"Middleware {global_object_name(mw.__class__)} doesn't support" - f" asynchronous spider output, this is deprecated and will stop" - f" working in a future version of Scrapy. The middleware should" - f" be updated to support it. Please see" - f" https://docs.scrapy.org/en/latest/topics/coroutines.html#for-middleware-users" - f" for more information." + f" asynchronous spider output. Its process_spider_output() method" + f" should be an async generator function or it should additionally" + f" define a process_spider_output_async() method." ) return normal_method if not normal_method: logger.error( - f"Middleware {global_object_name(mw.__class__)} has {methodname_async} " - f"without {methodname}, skipping this method." + f"Middleware {global_object_name(mw.__class__)} has" + f" process_spider_output_async() without process_spider_output()," + f" skipping this method. Please rename it to process_spider_output()." ) return None if not isasyncgenfunction(async_method): @@ -517,8 +280,8 @@ class SpiderMiddlewareManager(MiddlewareManager): if isasyncgenfunction(normal_method): logger.error( f"{global_object_name(normal_method)} is an async " - f"generator function while {methodname_async} exists, " - f"skipping both methods." + f"generator function while process_spider_output_async() exists, " + f"skipping both methods. Please remove process_spider_output_async()." ) return None - return normal_method, async_method + return async_method diff --git a/scrapy/crawler.py b/scrapy/crawler.py index d3110b488..c18e061f8 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -5,26 +5,23 @@ import contextlib import logging import pprint import signal +import warnings from abc import ABC, abstractmethod +from functools import partial from typing import TYPE_CHECKING, Any, TypeVar -from twisted.internet.defer import ( - Deferred, - DeferredList, - inlineCallbacks, -) +from twisted.internet.defer import Deferred, DeferredList, inlineCallbacks -from scrapy import Spider, signals +from scrapy import Spider from scrapy.addons import AddonManager from scrapy.core.engine import ExecutionEngine +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.extension import ExtensionManager -from scrapy.settings import Settings, overridden_settings +from scrapy.settings import SETTINGS_PRIORITIES, Settings, overridden_settings from scrapy.signalmanager import SignalManager from scrapy.spiderloader import SpiderLoaderProtocol, get_spider_loader -from scrapy.utils.asyncio import is_asyncio_available -from scrapy.utils.defer import deferred_from_coro, deferred_to_future +from scrapy.utils.defer import deferred_from_coro from scrapy.utils.log import ( - LogCounterHandler, configure_logging, get_scrapy_root_handler, install_scrapy_root_handler, @@ -38,9 +35,11 @@ from scrapy.utils.reactor import ( install_reactor, is_asyncio_reactor_installed, is_reactor_installed, + set_asyncio_event_loop, verify_installed_asyncio_event_loop, verify_installed_reactor, ) +from scrapy.utils.reactorless import install_reactor_import_hook if TYPE_CHECKING: from collections.abc import Awaitable, Generator, Iterable @@ -101,13 +100,6 @@ class Crawler: self.addons.load_settings(self.settings) self.stats = load_object(self.settings["STATS_CLASS"])(self) - handler = LogCounterHandler(self, level=self.settings.get("LOG_LEVEL")) - logging.root.addHandler(handler) - # lambda is assigned to Crawler attribute because this way it is not - # garbage collected after leaving the scope - self.__remove_handler = lambda: logging.root.removeHandler(handler) - self.signals.connect(self.__remove_handler, signals.engine_stopped) - lf_cls: type[LogFormatter] = load_object(self.settings["LOG_FORMATTER"]) self.logformatter = lf_cls.from_crawler(self) @@ -120,22 +112,42 @@ class Crawler: self, ) - reactor_class: str = self.settings["TWISTED_REACTOR"] - event_loop: str = self.settings["ASYNCIO_EVENT_LOOP"] - if self._init_reactor: - # this needs to be done after the spider settings are merged, - # but before something imports twisted.internet.reactor + use_reactor = self.settings.getbool("TWISTED_REACTOR_ENABLED") + if use_reactor: + # We either install a reactor or expect one to be installed. + reactor_class: str = self.settings["TWISTED_REACTOR"] + event_loop: str = self.settings["ASYNCIO_EVENT_LOOP"] + if self._init_reactor: + # We need to install a reactor. + # This needs to be done after the spider settings are merged, + # but before something imports twisted.internet.reactor. + if reactor_class: + # Install a specific reactor. + install_reactor(reactor_class, event_loop) + else: + # Install the default one. + from twisted.internet import reactor # noqa: F401 + elif not is_reactor_installed(): + # We need a reactor to be already installed. + raise RuntimeError( + "We expected a Twisted reactor to be installed but it isn't." + ) if reactor_class: - install_reactor(reactor_class, event_loop) - else: - from twisted.internet import reactor # noqa: F401 - if reactor_class: - verify_installed_reactor(reactor_class) - if is_asyncio_reactor_installed() and event_loop: - verify_installed_asyncio_event_loop(event_loop) + # We need to check that the correct reactor is installed. + verify_installed_reactor(reactor_class) + if is_asyncio_reactor_installed() and event_loop: + verify_installed_asyncio_event_loop(event_loop) - if self._init_reactor or reactor_class: - log_reactor_info() + if self._init_reactor or reactor_class: + log_reactor_info() + else: + # We expect a reactor to not be installed. + if is_reactor_installed(): + raise RuntimeError( + "TWISTED_REACTOR_ENABLED is False but a Twisted reactor is installed." + ) + logger.debug("Not using a Twisted reactor") + self._apply_reactorless_default_settings() self.extensions = ExtensionManager.from_crawler(self) self.settings.freeze() @@ -145,6 +157,20 @@ class Crawler: "Overridden settings:\n%(settings)s", {"settings": pprint.pformat(d)} ) + def _apply_reactorless_default_settings(self) -> None: + """Change some setting defaults when not using a Twisted reactor. + + Some settings need different defaults when using and not using a + reactor, but as we can't put this logic into default_settings.py we + change them here when the reactor is not used. + """ + self.settings.set("TELNETCONSOLE_ENABLED", False, priority="default") + for scheme in ("http", "https"): + self.settings["DOWNLOAD_HANDLERS_BASE"][scheme] = ( + "scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler" + ) + self.settings["DOWNLOAD_HANDLERS_BASE"]["ftp"] = None + # Cannot use @deferred_f_from_coro_f because that relies on the reactor # being installed already, which is done within _apply_settings(), inside # this method. @@ -169,12 +195,12 @@ class Crawler: self._apply_settings() self._update_root_log_handler() self.engine = self._create_engine() - yield self.engine.open_spider(self.spider) - yield self.engine.start() + yield deferred_from_coro(self.engine.open_spider_async()) + yield deferred_from_coro(self.engine.start_async()) except Exception: self.crawling = False if self.engine is not None: - yield self.engine.close() + yield deferred_from_coro(self.engine.close_async()) raise async def crawl_async(self, *args: Any, **kwargs: Any) -> None: @@ -182,16 +208,10 @@ class Crawler: *args* and *kwargs* arguments, while setting the execution engine in motion. Should be called only once. - .. versionadded:: VERSION + .. versionadded:: 2.14 Complete when the crawl is finished. - - This function requires - :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` to be - installed. """ - if not is_asyncio_available(): - raise RuntimeError("Crawler.crawl_async() requires AsyncioSelectorReactor.") if self.crawling: raise RuntimeError("Crawling already taking place") if self._started: @@ -205,41 +225,40 @@ class Crawler: self._apply_settings() self._update_root_log_handler() self.engine = self._create_engine() - await self.engine.open_spider_async(self.spider) + await self.engine.open_spider_async() await self.engine.start_async() except Exception: self.crawling = False if self.engine is not None: - await deferred_to_future(self.engine.close()) + await self.engine.close_async() raise def _create_spider(self, *args: Any, **kwargs: Any) -> Spider: return self.spidercls.from_crawler(self, *args, **kwargs) def _create_engine(self) -> ExecutionEngine: - return ExecutionEngine(self, lambda _: self.stop()) + return ExecutionEngine(self, lambda _: self.stop_async()) - @inlineCallbacks - def stop(self) -> Generator[Deferred[Any], Any, None]: + def stop(self) -> Deferred[None]: """Start a graceful stop of the crawler and return a deferred that is fired when the crawler is stopped.""" - if self.crawling: - self.crawling = False - assert self.engine - yield self.engine.stop() + warnings.warn( + "Crawler.stop() is deprecated, use stop_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return deferred_from_coro(self.stop_async()) async def stop_async(self) -> None: """Start a graceful stop of the crawler and complete when the crawler is stopped. - .. versionadded:: VERSION - - This function requires - :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` to be - installed. + .. versionadded:: 2.14 """ - if not is_asyncio_available(): - raise RuntimeError("Crawler.stop_async() requires AsyncioSelectorReactor.") - await deferred_to_future(self.stop()) + if self.crawling: + self.crawling = False + assert self.engine + if self.engine.running: + await self.engine.stop_async() @staticmethod def _get_component( @@ -350,9 +369,12 @@ class CrawlerRunnerBase(ABC): """ Return a :class:`~scrapy.crawler.Crawler` object. - * If ``crawler_or_spidercls`` is a Crawler, it is returned as-is. + * If ``crawler_or_spidercls`` is a Crawler, the runner's settings are + merged into it as defaults: for each setting, the runner's value + is applied only if the Crawler does not already have that setting at + an equal or higher priority. The Crawler is then returned. * If ``crawler_or_spidercls`` is a Spider subclass, a new Crawler - is constructed for it. + is constructed for it using this runner's settings. * If ``crawler_or_spidercls`` is a string, this function finds a spider with this name in a Scrapy project (using spider loader), then creates a Crawler instance for it. @@ -363,6 +385,7 @@ class CrawlerRunnerBase(ABC): "it must be a spider class (or a Crawler object)" ) if isinstance(crawler_or_spidercls, Crawler): + crawler_or_spidercls.settings.update(self.settings) return crawler_or_spidercls return self._create_crawler(crawler_or_spidercls) @@ -399,6 +422,10 @@ class CrawlerRunner(CrawlerRunnerBase): def __init__(self, settings: dict[str, Any] | Settings | None = None): super().__init__(settings) + if not self.settings.getbool("TWISTED_REACTOR_ENABLED"): + raise RuntimeError( + f"{type(self).__name__} doesn't support TWISTED_REACTOR_ENABLED=False." + ) self._active: set[Deferred[None]] = set() def crawl( @@ -443,12 +470,16 @@ class CrawlerRunner(CrawlerRunnerBase): self.crawlers.add(crawler) d = crawler.crawl(*args, **kwargs) self._active.add(d) + failed = False try: yield d + except Exception: + failed = True + raise finally: self.crawlers.discard(crawler) self._active.discard(d) - self.bootstrap_failed |= not getattr(crawler, "spider", None) + self.bootstrap_failed |= not getattr(crawler, "spider", None) or failed def stop(self) -> Deferred[Any]: """ @@ -456,7 +487,7 @@ class CrawlerRunner(CrawlerRunnerBase): Returns a deferred that is fired when they all have ended. """ - return DeferredList(c.stop() for c in self.crawlers) + return DeferredList(deferred_from_coro(c.stop_async()) for c in self.crawlers) @inlineCallbacks def join(self) -> Generator[Deferred[Any], Any, None]: @@ -473,17 +504,24 @@ class CrawlerRunner(CrawlerRunnerBase): class AsyncCrawlerRunner(CrawlerRunnerBase): """ This is a convenient helper class that keeps track of, manages and runs - crawlers inside an already setup :mod:`~twisted.internet.reactor`. + crawlers inside an already setup :mod:`~twisted.internet.reactor` or + asyncio event loop. The AsyncCrawlerRunner object must be instantiated with a :class:`~scrapy.settings.Settings` object. + When the :setting:`TWISTED_REACTOR_ENABLED` setting is set to ``True``, + this class requires a reactor to be installed and uses it, otherwise it + requires a reactor to not be installed but requires an asyncio event loop + to be installed and uses it. + This class shouldn't be needed (since Scrapy is responsible of using it accordingly) unless writing scripts that manually handle the crawling process. See :ref:`run-from-script` for an example. This class provides coroutine APIs. It requires - :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor`. + :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` when used + with a reactor. """ def __init__(self, settings: dict[str, Any] | Settings | None = None): @@ -523,27 +561,48 @@ class AsyncCrawlerRunner(CrawlerRunnerBase): "The crawler_or_spidercls argument cannot be a spider object, " "it must be a spider class (or a Crawler object)" ) - if not is_asyncio_reactor_installed(): + if self.settings.getbool("TWISTED_REACTOR_ENABLED"): + if not is_reactor_installed(): + raise RuntimeError( + "We expected a Twisted reactor to be installed but it isn't." + ) + if not is_asyncio_reactor_installed(): + raise RuntimeError( + f"When TWISTED_REACTOR_ENABLED is True, {type(self).__name__} " + f"requires that the installed Twisted reactor is " + f'"twisted.internet.asyncioreactor.AsyncioSelectorReactor".' + ) + elif is_reactor_installed(): raise RuntimeError( - f"{type(self).__name__} requires AsyncioSelectorReactor." + "TWISTED_REACTOR_ENABLED is False but a Twisted reactor is installed." ) crawler = self.create_crawler(crawler_or_spidercls) return self._crawl(crawler, *args, **kwargs) + async def _crawl_and_track( + self, crawler: Crawler, *args: Any, **kwargs: Any + ) -> None: + try: + await crawler.crawl_async(*args, **kwargs) + except Exception: + self.bootstrap_failed = True + raise # re-raise so asyncio still logs it to stderr naturally + + def _done(self, task: asyncio.Task[None], crawler: Crawler) -> None: + self._active.discard(task) + self.crawlers.discard(crawler) + self.bootstrap_failed |= not getattr(crawler, "spider", None) + def _crawl(self, crawler: Crawler, *args: Any, **kwargs: Any) -> asyncio.Task[None]: # At this point the asyncio loop has been installed either by the user # or by AsyncCrawlerProcess (but it isn't running yet, so no asyncio.create_task()). loop = asyncio.get_event_loop() self.crawlers.add(crawler) - task = loop.create_task(crawler.crawl_async(*args, **kwargs)) + + task = loop.create_task(self._crawl_and_track(crawler, *args, **kwargs)) self._active.add(task) + task.add_done_callback(partial(self._done, crawler=crawler)) - def _done(_: asyncio.Task[None]) -> None: - self.crawlers.discard(crawler) - self._active.discard(task) - self.bootstrap_failed |= not getattr(crawler, "spider", None) - - task.add_done_callback(_done) return task async def stop(self) -> None: @@ -586,30 +645,60 @@ class CrawlerProcessBase(CrawlerRunnerBase): from twisted.internet import reactor install_shutdown_handlers(self._signal_kill) - signame = signal_names[signum] - logger.info( - "Received %(signame)s, shutting down gracefully. Send again to force ", - {"signame": signame}, - ) + self._log_shutdown(signum) reactor.callFromThread(self._graceful_stop_reactor) def _signal_kill(self, signum: int, _: Any) -> None: from twisted.internet import reactor install_shutdown_handlers(signal.SIG_IGN) + self._log_kill(signum) + reactor.callFromThread(self._stop_reactor) + + @staticmethod + def _log_shutdown(signum: int) -> None: + signame = signal_names[signum] + logger.info( + "Received %(signame)s, shutting down gracefully. Send again to force ", + {"signame": signame}, + ) + + @staticmethod + def _log_kill(signum: int) -> None: signame = signal_names[signum] logger.info( "Received %(signame)s twice, forcing unclean shutdown", {"signame": signame} ) - reactor.callFromThread(self._stop_reactor) def _setup_reactor(self, install_signal_handlers: bool) -> None: from twisted.internet import reactor - resolver_class = load_object(self.settings["DNS_RESOLVER"]) + dns_priority = self.settings.getpriority("DNS_RESOLVER") or 0 + default_priority = SETTINGS_PRIORITIES["default"] + + if dns_priority > default_priority: + warnings.warn( + "The DNS_RESOLVER setting is deprecated, please use " + "TWISTED_DNS_RESOLVER instead.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + + twisted_dns_priority = ( + self.settings.getpriority("TWISTED_DNS_RESOLVER") or 0 + ) + if twisted_dns_priority > dns_priority: + resolver_cls_path = self.settings["TWISTED_DNS_RESOLVER"] + else: + resolver_cls_path = self.settings["DNS_RESOLVER"] + else: + resolver_cls_path = self.settings["TWISTED_DNS_RESOLVER"] + + resolver_class = load_object(resolver_cls_path) + # We pass self, which is CrawlerProcess, instead of Crawler here, # which works because the default resolvers only use crawler.settings. - resolver = build_from_crawler(resolver_class, self, reactor=reactor) # type: ignore[arg-type] + resolver = build_from_crawler(resolver_class, self, reactor=reactor) # type: ignore[call-overload] resolver.install_on_reactor() tp = reactor.getThreadPool() tp.adjustPoolsize(maxthreads=self.settings.getint("REACTOR_THREADPOOL_MAXSIZE")) @@ -672,6 +761,7 @@ class CrawlerProcess(CrawlerProcessBase, CrawlerRunner): ): super().__init__(settings, install_root_handler) self._initialized_reactor: bool = False + logger.debug("Using CrawlerProcess") def _create_crawler(self, spidercls: type[Spider] | str) -> Crawler: if isinstance(spidercls, str): @@ -688,8 +778,8 @@ class CrawlerProcess(CrawlerProcessBase, CrawlerRunner): ) -> None: """ This method starts a :mod:`~twisted.internet.reactor`, adjusts its pool - size to :setting:`REACTOR_THREADPOOL_MAXSIZE`, and installs a DNS cache - based on :setting:`DNSCACHE_ENABLED` and :setting:`DNSCACHE_SIZE`. + size to :setting:`REACTOR_THREADPOOL_MAXSIZE`, and installs a DNS + resolver based on :setting:`DNSCACHE_ENABLED`. If ``stop_after_crawl`` is True, the reactor will be stopped after all crawlers have finished, using :meth:`join`. @@ -729,6 +819,10 @@ class AsyncCrawlerProcess(CrawlerProcessBase, AsyncCrawlerRunner): The AsyncCrawlerProcess object must be instantiated with a :class:`~scrapy.settings.Settings` object. + When the :setting:`TWISTED_REACTOR_ENABLED` setting is set to ``True``, + this class installs a reactor and uses it, otherwise it requires a reactor + to not be installed but installs an asyncio event loop and uses it. + :param install_root_handler: whether to install root logging handler (default: True) @@ -737,7 +831,8 @@ class AsyncCrawlerProcess(CrawlerProcessBase, AsyncCrawlerRunner): process. See :ref:`run-from-script` for an example. This class provides coroutine APIs. It requires - :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor`. + :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` when used + with a reactor. """ def __init__( @@ -746,13 +841,22 @@ class AsyncCrawlerProcess(CrawlerProcessBase, AsyncCrawlerRunner): install_root_handler: bool = True, ): super().__init__(settings, install_root_handler) + logger.debug("Using AsyncCrawlerProcess") + self._reactorless_loop: asyncio.AbstractEventLoop | None = None # We want the asyncio event loop to be installed early, so that it's # always the correct one. And as we do that, we can also install the # reactor here. # The ASYNCIO_EVENT_LOOP setting cannot be overridden by add-ons and # spiders when using AsyncCrawlerProcess. loop_path = self.settings["ASYNCIO_EVENT_LOOP"] - if is_reactor_installed(): + if not self.settings.getbool("TWISTED_REACTOR_ENABLED"): + if is_reactor_installed(): + raise RuntimeError( + "TWISTED_REACTOR_ENABLED is False but a Twisted reactor is installed." + ) + self._reactorless_loop = set_asyncio_event_loop(loop_path) + install_reactor_import_hook() + elif is_reactor_installed(): # The user could install a reactor before this class is instantiated. # We need to make sure the reactor is the correct one and the loop # type matches the setting. @@ -762,6 +866,7 @@ class AsyncCrawlerProcess(CrawlerProcessBase, AsyncCrawlerRunner): else: install_reactor(_asyncio_reactor_path, loop_path) self._initialized_reactor = True + self._reactorless_main_task: asyncio.Future[None] | None = None def _stop_dfd(self) -> Deferred[Any]: return deferred_from_coro(self.stop()) @@ -770,9 +875,13 @@ class AsyncCrawlerProcess(CrawlerProcessBase, AsyncCrawlerRunner): self, stop_after_crawl: bool = True, install_signal_handlers: bool = True ) -> None: """ - This method starts a :mod:`~twisted.internet.reactor`, adjusts its pool - size to :setting:`REACTOR_THREADPOOL_MAXSIZE`, and installs a DNS cache - based on :setting:`DNSCACHE_ENABLED` and :setting:`DNSCACHE_SIZE`. + This method starts a :mod:`~twisted.internet.reactor` or an asyncio + event loop, depending on the value of the + :setting:`TWISTED_REACTOR_ENABLED` setting. + + When using a reactor it adjusts its pool size to + :setting:`REACTOR_THREADPOOL_MAXSIZE` and installs a DNS resolver based + on :setting:`DNSCACHE_ENABLED`. If ``stop_after_crawl`` is True, the reactor will be stopped after all crawlers have finished, using :meth:`join`. @@ -783,6 +892,163 @@ class AsyncCrawlerProcess(CrawlerProcessBase, AsyncCrawlerRunner): :param bool install_signal_handlers: whether to install the OS signal handlers from Twisted and Scrapy (default: True) """ + + if not self.settings.getbool("TWISTED_REACTOR_ENABLED"): + self._start_asyncio(stop_after_crawl, install_signal_handlers) + else: + self._start_twisted(stop_after_crawl, install_signal_handlers) + + def _start_asyncio( + self, stop_after_crawl: bool, install_signal_handlers: bool + ) -> None: + # We cannot use asyncio.run() here, because we can't let it handle the + # loop lifetime: _crawl() needs a loop (which we create in __init__()), + # because crawl() returns a Task. + # So we reproduce a part of asyncio.runners.Runner that is useful to us. + + # Normal workflow: + # 1. _start_asyncio() creates a task for self.join() and calls _run_loop() + # 2. _run_loop() calls loop.run_until_complete(main_task) + # 3. Crawling tasks start and finish + # 4. join() completes, loop.run_until_complete() and thus _run_loop() return + # 5. _start_asyncio() calls _close_loop() + # 6. _close_loop() does finalization and calls loop.close() + + # Normal workflow with stop_after_crawl=False: + # 1. _start_asyncio() creates a simple future and calls _run_loop() + # 2. _run_loop() calls loop.run_until_complete(main_task) + # 3. Crawling tasks start and finish + # 4. _run_loop() blocks until the loop is stopped externally or the + # future is cancelled via Ctrl-C + # 5. (after _run_loop() returns) _start_asyncio() calls _close_loop() + # 6. _close_loop() does finalization and calls loop.close() + + # Workflow with Ctrl-C pressed once: + # 1. While loop.run_until_complete() blocks, _signal_shutdown_reactorless() + # is called + # 2. _signal_shutdown_reactorless() calls _shutdown_graceful_reactorless() + # (via call_soon_threadsafe()) + # 3. _shutdown_graceful_reactorless() calls stop() + # 4. For stop_after_crawl=True: crawl tasks finish, join() completes, + # loop.run_until_complete() and thus _run_loop() return + # For stop_after_crawl=False: _shutdown_graceful_reactorless() waits + # for crawl tasks via join(), then cancels the main task, + # loop.run_until_complete() raises CancelledError, _run_loop() returns + # 5. _start_asyncio() calls _close_loop() + # 6. _close_loop() does finalization and calls loop.close() + + # Workflow with Ctrl-C pressed twice: + # 1. While loop.run_until_complete() blocks, _signal_shutdown_reactorless() + # is called + # 2. _signal_shutdown_reactorless() calls _shutdown_graceful_reactorless() + # (via call_soon_threadsafe()) and installs _signal_kill_reactorless() + # as the next handler + # 3. Before _shutdown_graceful_reactorless() completes, + # _signal_kill_reactorless() is called + # 4. _signal_kill_reactorless() cancels the main task + # (via call_soon_threadsafe()) + # 5. loop.run_until_complete() raises CancelledError, _run_loop() returns + # 6. _start_asyncio() calls _close_loop() + # 7. _close_loop() cancels all pending tasks (including + # _shutdown_graceful_reactorless()), does finalization and calls loop.close() + + loop = self._reactorless_loop + assert loop + + if stop_after_crawl: + self._reactorless_main_task = loop.create_task(self.join()) + else: + self._reactorless_main_task = loop.create_future() + self._stop_after_crawl = stop_after_crawl + + try: + self._run_loop(install_signal_handlers) # blocking call + except asyncio.CancelledError: + pass + finally: + self._close_loop() + + def _run_loop(self, install_signal_handlers: bool) -> None: + # similar to asyncio.runners.Runner.run() + if install_signal_handlers: + install_shutdown_handlers(self._signal_shutdown_reactorless) + assert self._reactorless_loop + assert self._reactorless_main_task + self._reactorless_loop.run_until_complete(self._reactorless_main_task) + + def _close_loop(self) -> None: + # Similar to asyncio.runners.Runner.close() + loop = self._reactorless_loop + assert loop + try: + self._cancel_all_tasks(loop) + loop.run_until_complete(loop.shutdown_asyncgens()) + loop.run_until_complete(loop.shutdown_default_executor()) + finally: + self._reactorless_main_task = None + asyncio.set_event_loop(None) + loop.close() + self._reactorless_loop = None + + @staticmethod + def _cancel_all_tasks(loop: asyncio.AbstractEventLoop) -> None: + # copy of asyncio.runners._cancel_all_tasks() + to_cancel = asyncio.all_tasks(loop) + if not to_cancel: + return + + for task in to_cancel: + task.cancel() + + loop.run_until_complete(asyncio.gather(*to_cancel, return_exceptions=True)) + + for task in to_cancel: + if task.cancelled(): + continue + if task.exception() is not None: + loop.call_exception_handler( + { + "message": "unhandled exception during AsyncCrawlerProcess shutdown", + "exception": task.exception(), + "task": task, + } + ) + + def _signal_shutdown_reactorless(self, signum: int, _: Any) -> None: + install_shutdown_handlers(self._signal_kill_reactorless) + self._log_shutdown(signum) + if (loop := self._reactorless_loop) is None: + return + + loop.call_soon_threadsafe(self._create_shutdown_task) + + def _create_shutdown_task(self) -> None: + assert self._reactorless_loop + coro = self._shutdown_graceful_reactorless() + try: + self._reactorless_loop.create_task(coro) + except RuntimeError: + coro.close() + + async def _shutdown_graceful_reactorless(self) -> None: + await self.stop() + if not self._stop_after_crawl: + # wait until crawl tasks finish and cancel the future + await self.join() + if self._reactorless_main_task and not self._reactorless_main_task.done(): + self._reactorless_main_task.cancel() + + def _signal_kill_reactorless(self, signum: int, _: Any) -> None: + install_shutdown_handlers(signal.SIG_IGN) + self._log_kill(signum) + if (loop := self._reactorless_loop) is None: + return + if (task := self._reactorless_main_task) is not None: + loop.call_soon_threadsafe(task.cancel) + + def _start_twisted( + self, stop_after_crawl: bool, install_signal_handlers: bool + ) -> None: from twisted.internet import reactor if stop_after_crawl: diff --git a/scrapy/downloadermiddlewares/ajaxcrawl.py b/scrapy/downloadermiddlewares/ajaxcrawl.py deleted file mode 100644 index a23deaa45..000000000 --- a/scrapy/downloadermiddlewares/ajaxcrawl.py +++ /dev/null @@ -1,114 +0,0 @@ -from __future__ import annotations - -import logging -import re -from typing import TYPE_CHECKING -from warnings import warn - -from w3lib import html - -from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning -from scrapy.http import HtmlResponse, Response -from scrapy.utils.url import escape_ajax - -if TYPE_CHECKING: - # typing.Self requires Python 3.11 - from typing_extensions import Self - - from scrapy import Request, Spider - from scrapy.crawler import Crawler - from scrapy.settings import BaseSettings - - -logger = logging.getLogger(__name__) - - -class AjaxCrawlMiddleware: - """ - Handle 'AJAX crawlable' pages marked as crawlable via meta tag. - """ - - def __init__(self, settings: BaseSettings): - if not settings.getbool("AJAXCRAWL_ENABLED"): - raise NotConfigured - - warn( - "scrapy.downloadermiddlewares.ajaxcrawl.AjaxCrawlMiddleware is deprecated" - " and will be removed in a future Scrapy version.", - ScrapyDeprecationWarning, - stacklevel=2, - ) - - # XXX: Google parses at least first 100k bytes; scrapy's redirect - # middleware parses first 4k. 4k turns out to be insufficient - # for this middleware, and parsing 100k could be slow. - # We use something in between (32K) by default. - self.lookup_bytes: int = settings.getint("AJAXCRAWL_MAXSIZE") - - @classmethod - def from_crawler(cls, crawler: Crawler) -> Self: - return cls(crawler.settings) - - def process_response( - self, request: Request, response: Response, spider: Spider - ) -> Request | Response: - if not isinstance(response, HtmlResponse) or response.status != 200: - return response - - if request.method != "GET": - # other HTTP methods are either not safe or don't have a body - return response - - if "ajax_crawlable" in request.meta: # prevent loops - return response - - if not self._has_ajax_crawlable_variant(response): - return response - - ajax_crawl_request = request.replace(url=escape_ajax(request.url + "#!")) - logger.debug( - "Downloading AJAX crawlable %(ajax_crawl_request)s instead of %(request)s", - {"ajax_crawl_request": ajax_crawl_request, "request": request}, - extra={"spider": spider}, - ) - - ajax_crawl_request.meta["ajax_crawlable"] = True - return ajax_crawl_request - - def _has_ajax_crawlable_variant(self, response: Response) -> bool: - """ - Return True if a page without hash fragment could be "AJAX crawlable". - """ - body = response.text[: self.lookup_bytes] - return _has_ajaxcrawlable_meta(body) - - -_ajax_crawlable_re: re.Pattern[str] = re.compile( - r'' -) - - -def _has_ajaxcrawlable_meta(text: str) -> bool: - """ - >>> _has_ajaxcrawlable_meta('') - True - >>> _has_ajaxcrawlable_meta("") - True - >>> _has_ajaxcrawlable_meta('') - False - >>> _has_ajaxcrawlable_meta('') - False - """ - - # Stripping scripts and comments is slow (about 20x slower than - # just checking if a string is in text); this is a quick fail-fast - # path that should work for most pages. - if "fragment" not in text: - return False - if "content" not in text: - return False - - text = html.remove_tags_with_content(text, ("script", "noscript")) - text = html.replace_entities(text) - text = html.remove_comments(text) - return _ajax_crawlable_re.search(text) is not None diff --git a/scrapy/downloadermiddlewares/cookies.py b/scrapy/downloadermiddlewares/cookies.py index 9156b8c3a..cd8c2abca 100644 --- a/scrapy/downloadermiddlewares/cookies.py +++ b/scrapy/downloadermiddlewares/cookies.py @@ -9,6 +9,7 @@ from tldextract import TLDExtract from scrapy.exceptions import NotConfigured from scrapy.http import Response from scrapy.http.cookies import CookieJar +from scrapy.utils.decorators import _warn_spider_arg from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.python import to_unicode @@ -39,6 +40,8 @@ def _is_public_domain(domain: str) -> bool: class CookiesMiddleware: """This middleware enables working with sites that need cookies""" + crawler: Crawler + def __init__(self, debug: bool = False): self.jars: defaultdict[Any, CookieJar] = defaultdict(CookieJar) self.debug: bool = debug @@ -47,7 +50,9 @@ class CookiesMiddleware: def from_crawler(cls, crawler: Crawler) -> Self: if not crawler.settings.getbool("COOKIES_ENABLED"): raise NotConfigured - return cls(crawler.settings.getbool("COOKIES_DEBUG")) + o = cls(crawler.settings.getbool("COOKIES_DEBUG")) + o.crawler = crawler + return o def _process_cookies( self, cookies: Iterable[Cookie], *, jar: CookieJar, request: Request @@ -67,8 +72,9 @@ class CookiesMiddleware: jar.set_cookie_if_ok(cookie, request) + @_warn_spider_arg def process_request( - self, request: Request, spider: Spider + self, request: Request, spider: Spider | None = None ) -> Request | Response | None: if request.meta.get("dont_merge_cookies", False): return None @@ -81,11 +87,12 @@ class CookiesMiddleware: # set Cookie header request.headers.pop("Cookie", None) jar.add_cookie_header(request) - self._debug_cookie(request, spider) + self._debug_cookie(request) return None + @_warn_spider_arg def process_response( - self, request: Request, response: Response, spider: Spider + self, request: Request, response: Response, spider: Spider | None = None ) -> Request | Response: if request.meta.get("dont_merge_cookies", False): return response @@ -96,11 +103,11 @@ class CookiesMiddleware: cookies = jar.make_cookies(response, request) self._process_cookies(cookies, jar=jar, request=request) - self._debug_set_cookie(response, spider) + self._debug_set_cookie(response) return response - def _debug_cookie(self, request: Request, spider: Spider) -> None: + def _debug_cookie(self, request: Request) -> None: if self.debug: cl = [ to_unicode(c, errors="replace") @@ -109,9 +116,9 @@ class CookiesMiddleware: if cl: cookies = "\n".join(f"Cookie: {c}\n" for c in cl) msg = f"Sending cookies to: {request}\n{cookies}" - logger.debug(msg, extra={"spider": spider}) + logger.debug(msg, extra={"spider": self.crawler.spider}) - def _debug_set_cookie(self, response: Response, spider: Spider) -> None: + def _debug_set_cookie(self, response: Response) -> None: if self.debug: cl = [ to_unicode(c, errors="replace") @@ -120,7 +127,7 @@ class CookiesMiddleware: if cl: cookies = "\n".join(f"Set-Cookie: {c}\n" for c in cl) msg = f"Received cookies from: {response}\n{cookies}" - logger.debug(msg, extra={"spider": spider}) + logger.debug(msg, extra={"spider": self.crawler.spider}) def _format_cookie(self, cookie: VerboseCookie, request: Request) -> str | None: """ @@ -132,7 +139,7 @@ class CookiesMiddleware: for key in ("name", "value", "path", "domain"): value = cookie.get(key) if value is None: - if key in ("name", "value"): + if key in {"name", "value"}: msg = f"Invalid cookie found in request {request}: {cookie} ('{key}' is missing)" logger.warning(msg) return None @@ -169,7 +176,7 @@ class CookiesMiddleware: Extract cookies from the Request.cookies attribute """ if not request.cookies: - return [] + return () cookies: Iterable[VerboseCookie] if isinstance(request.cookies, dict): cookies = tuple({"name": k, "value": v} for k, v in request.cookies.items()) diff --git a/scrapy/downloadermiddlewares/defaultheaders.py b/scrapy/downloadermiddlewares/defaultheaders.py index d58b4490b..7c940a078 100644 --- a/scrapy/downloadermiddlewares/defaultheaders.py +++ b/scrapy/downloadermiddlewares/defaultheaders.py @@ -8,6 +8,7 @@ from __future__ import annotations from typing import TYPE_CHECKING +from scrapy.utils.decorators import _warn_spider_arg from scrapy.utils.python import without_none_values if TYPE_CHECKING: @@ -30,8 +31,9 @@ class DefaultHeadersMiddleware: headers = without_none_values(crawler.settings["DEFAULT_REQUEST_HEADERS"]) return cls(headers.items()) + @_warn_spider_arg def process_request( - self, request: Request, spider: Spider + self, request: Request, spider: Spider | None = None ) -> Request | Response | None: for k, v in self._headers: request.headers.setdefault(k, v) diff --git a/scrapy/downloadermiddlewares/downloadtimeout.py b/scrapy/downloadermiddlewares/downloadtimeout.py index 28456c697..bccfb230c 100644 --- a/scrapy/downloadermiddlewares/downloadtimeout.py +++ b/scrapy/downloadermiddlewares/downloadtimeout.py @@ -9,6 +9,8 @@ from __future__ import annotations from typing import TYPE_CHECKING from scrapy import Request, Spider, signals +from scrapy.utils.decorators import _warn_spider_arg +from scrapy.utils.deprecate import warn_on_deprecated_spider_attribute if TYPE_CHECKING: # typing.Self requires Python 3.11 @@ -29,10 +31,13 @@ class DownloadTimeoutMiddleware: return o def spider_opened(self, spider: Spider) -> None: + if hasattr(spider, "download_timeout"): # pragma: no cover + warn_on_deprecated_spider_attribute("download_timeout", "DOWNLOAD_TIMEOUT") self._timeout = getattr(spider, "download_timeout", self._timeout) + @_warn_spider_arg def process_request( - self, request: Request, spider: Spider + self, request: Request, spider: Spider | None = None ) -> Request | Response | None: if self._timeout: request.meta.setdefault("download_timeout", self._timeout) diff --git a/scrapy/downloadermiddlewares/httpauth.py b/scrapy/downloadermiddlewares/httpauth.py index 80107261b..b09abdadd 100644 --- a/scrapy/downloadermiddlewares/httpauth.py +++ b/scrapy/downloadermiddlewares/httpauth.py @@ -6,11 +6,15 @@ See documentation in docs/topics/downloader-middleware.rst from __future__ import annotations +import warnings from typing import TYPE_CHECKING from w3lib.http import basic_auth_header from scrapy import Request, Spider, signals +from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.settings import SETTINGS_PRIORITIES +from scrapy.utils.decorators import _warn_spider_arg from scrapy.utils.url import url_is_from_any_domain if TYPE_CHECKING: @@ -22,12 +26,28 @@ if TYPE_CHECKING: class HttpAuthMiddleware: - """Set Basic HTTP Authorization header - (http_user and http_pass spider class attributes)""" + """Set Basic HTTP Authorization header.""" + + def __init__(self) -> None: + self._auth: bytes | None = None + self._domain: str | None = None @classmethod def from_crawler(cls, crawler: Crawler) -> Self: o = cls() + usr = crawler.settings.get("HTTPAUTH_USER", "") + pwd = crawler.settings.get("HTTPAUTH_PASS", "") + if usr or pwd: + domain_priority = crawler.settings.getpriority("HTTPAUTH_DOMAIN") or 0 + if domain_priority <= SETTINGS_PRIORITIES["default"]: + raise ValueError( + "HTTPAUTH_DOMAIN must be set when HTTPAUTH_USER or HTTPAUTH_PASS " + "is configured. Set it to a domain (e.g. 'example.com') to restrict " + "credentials to that domain, or set it to None to send credentials " + "with all requests." + ) + o._auth = basic_auth_header(usr, pwd) + o._domain = crawler.settings.get("HTTPAUTH_DOMAIN") crawler.signals.connect(o.spider_opened, signal=signals.spider_opened) return o @@ -35,17 +55,34 @@ class HttpAuthMiddleware: usr = getattr(spider, "http_user", "") pwd = getattr(spider, "http_pass", "") if usr or pwd: - self.auth = basic_auth_header(usr, pwd) - self.domain = spider.http_auth_domain # type: ignore[attr-defined] + warnings.warn( + "Use the HTTPAUTH_USER, HTTPAUTH_PASS, and HTTPAUTH_DOMAIN settings " + "instead of the http_user, http_pass, and http_auth_domain spider " + "attributes. Support for the spider attributes will be removed in a " + "future version of Scrapy.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + self._auth = basic_auth_header(usr, pwd) + self._domain = spider.http_auth_domain # type: ignore[attr-defined] + @_warn_spider_arg def process_request( - self, request: Request, spider: Spider + self, request: Request, spider: Spider | None = None ) -> Request | Response | None: - auth = getattr(self, "auth", None) - if ( - auth - and b"Authorization" not in request.headers - and (not self.domain or url_is_from_any_domain(request.url, [self.domain])) + if b"Authorization" in request.headers: + return None + # Per-request meta overrides + usr = request.meta.get("http_user", "") + pwd = request.meta.get("http_pass", "") + if usr or pwd: + domain = request.meta.get("http_auth_domain") + if not domain or url_is_from_any_domain(request.url, [domain]): + request.headers[b"Authorization"] = basic_auth_header(usr, pwd) + return None + # Middleware-level auth + if self._auth and ( + not self._domain or url_is_from_any_domain(request.url, [self._domain]) ): - request.headers[b"Authorization"] = auth + request.headers[b"Authorization"] = self._auth return None diff --git a/scrapy/downloadermiddlewares/httpcache.py b/scrapy/downloadermiddlewares/httpcache.py index 3892dba23..c6c811809 100644 --- a/scrapy/downloadermiddlewares/httpcache.py +++ b/scrapy/downloadermiddlewares/httpcache.py @@ -3,20 +3,17 @@ from __future__ import annotations from email.utils import formatdate from typing import TYPE_CHECKING -from twisted.internet import defer -from twisted.internet.error import ( - ConnectError, - ConnectionDone, - ConnectionLost, - ConnectionRefusedError, - DNSLookupError, - TCPTimedOutError, - TimeoutError, -) -from twisted.web.client import ResponseFailed +from twisted.internet.error import ConnectError, ConnectionDone, ConnectionLost from scrapy import signals -from scrapy.exceptions import IgnoreRequest, NotConfigured +from scrapy.exceptions import ( + DownloadConnectionRefusedError, + DownloadFailedError, + DownloadTimeoutError, + IgnoreRequest, + NotConfigured, +) +from scrapy.utils.decorators import _warn_spider_arg from scrapy.utils.misc import load_object if TYPE_CHECKING: @@ -33,18 +30,17 @@ if TYPE_CHECKING: class HttpCacheMiddleware: DOWNLOAD_EXCEPTIONS = ( - defer.TimeoutError, - TimeoutError, - DNSLookupError, - ConnectionRefusedError, ConnectionDone, ConnectError, ConnectionLost, - TCPTimedOutError, - ResponseFailed, OSError, + DownloadTimeoutError, + DownloadConnectionRefusedError, + DownloadFailedError, ) + crawler: Crawler + def __init__(self, settings: Settings, stats: StatsCollector) -> None: if not settings.getbool("HTTPCACHE_ENABLED"): raise NotConfigured @@ -59,6 +55,7 @@ class HttpCacheMiddleware: o = cls(crawler.settings, crawler.stats) crawler.signals.connect(o.spider_opened, signal=signals.spider_opened) crawler.signals.connect(o.spider_closed, signal=signals.spider_closed) + o.crawler = crawler return o def spider_opened(self, spider: Spider) -> None: @@ -67,8 +64,9 @@ class HttpCacheMiddleware: def spider_closed(self, spider: Spider) -> None: self.storage.close_spider(spider) + @_warn_spider_arg def process_request( - self, request: Request, spider: Spider + self, request: Request, spider: Spider | None = None ) -> Request | Response | None: if request.meta.get("dont_cache", False): return None @@ -80,19 +78,19 @@ class HttpCacheMiddleware: # Look for cached response and check if expired cachedresponse: Response | None = self.storage.retrieve_response( - spider, request + self.crawler.spider, request ) if cachedresponse is None: - self.stats.inc_value("httpcache/miss", spider=spider) + self.stats.inc_value("httpcache/miss") if self.ignore_missing: - self.stats.inc_value("httpcache/ignore", spider=spider) + self.stats.inc_value("httpcache/ignore") raise IgnoreRequest(f"Ignored request not in cache: {request}") return None # first time request # Return cached response only if not expired cachedresponse.flags.append("cached") if self.policy.is_cached_response_fresh(cachedresponse, request): - self.stats.inc_value("httpcache/hit", spider=spider) + self.stats.inc_value("httpcache/hit") return cachedresponse # Keep a reference to cached response to avoid a second cache lookup on @@ -101,14 +99,15 @@ class HttpCacheMiddleware: return None + @_warn_spider_arg def process_response( - self, request: Request, response: Response, spider: Spider + self, request: Request, response: Response, spider: Spider | None = None ) -> Request | Response: if request.meta.get("dont_cache", False): return response # Skip cached responses and uncacheable requests - if "cached" in response.flags or "_dont_cache" in request.meta: + if "_dont_cache" in request.meta or "cached" in response.flags: request.meta.pop("_dont_cache", None) return response @@ -120,38 +119,33 @@ class HttpCacheMiddleware: # Do not validate first-hand responses cachedresponse: Response | None = request.meta.pop("cached_response", None) if cachedresponse is None: - self.stats.inc_value("httpcache/firsthand", spider=spider) - self._cache_response(spider, response, request, cachedresponse) + self.stats.inc_value("httpcache/firsthand") + self._cache_response(response, request) return response if self.policy.is_cached_response_valid(cachedresponse, response, request): - self.stats.inc_value("httpcache/revalidate", spider=spider) + self.stats.inc_value("httpcache/revalidate") return cachedresponse - self.stats.inc_value("httpcache/invalidate", spider=spider) - self._cache_response(spider, response, request, cachedresponse) + self.stats.inc_value("httpcache/invalidate") + self._cache_response(response, request) return response + @_warn_spider_arg def process_exception( - self, request: Request, exception: Exception, spider: Spider + self, request: Request, exception: Exception, spider: Spider | None = None ) -> Request | Response | None: cachedresponse: Response | None = request.meta.pop("cached_response", None) if cachedresponse is not None and isinstance( exception, self.DOWNLOAD_EXCEPTIONS ): - self.stats.inc_value("httpcache/errorrecovery", spider=spider) + self.stats.inc_value("httpcache/errorrecovery") return cachedresponse return None - def _cache_response( - self, - spider: Spider, - response: Response, - request: Request, - cachedresponse: Response | None, - ) -> None: + def _cache_response(self, response: Response, request: Request) -> None: if self.policy.should_cache_response(response, request): - self.stats.inc_value("httpcache/store", spider=spider) - self.storage.store_response(spider, request, response) + self.stats.inc_value("httpcache/store") + self.storage.store_response(self.crawler.spider, request, response) else: - self.stats.inc_value("httpcache/uncacheable", spider=spider) + self.stats.inc_value("httpcache/uncacheable") diff --git a/scrapy/downloadermiddlewares/httpcompression.py b/scrapy/downloadermiddlewares/httpcompression.py index 58891b952..414c3d8a3 100644 --- a/scrapy/downloadermiddlewares/httpcompression.py +++ b/scrapy/downloadermiddlewares/httpcompression.py @@ -1,5 +1,6 @@ from __future__ import annotations +import warnings from itertools import chain from logging import getLogger from typing import TYPE_CHECKING, Any @@ -14,6 +15,8 @@ from scrapy.utils._compression import ( _unbrotli, _unzstd, ) +from scrapy.utils.decorators import _warn_spider_arg +from scrapy.utils.deprecate import warn_on_deprecated_spider_attribute from scrapy.utils.gz import gunzip if TYPE_CHECKING: @@ -30,13 +33,23 @@ ACCEPTED_ENCODINGS: list[bytes] = [b"gzip", b"deflate"] try: try: - import brotli # noqa: F401 + import brotli except ImportError: - import brotlicffi # noqa: F401 + import brotlicffi as brotli except ImportError: pass else: - ACCEPTED_ENCODINGS.append(b"br") + try: + brotli.Decompressor.can_accept_more_data # noqa: B018 + except AttributeError: # pragma: no cover + warnings.warn( + "You have brotli installed. But 'br' encoding support now requires " + "brotli's or brotlicffi's version >= 1.2.0. Please upgrade " + "brotli/brotlicffi to make Scrapy decode 'br' encoded responses.", + stacklevel=2, + ) + else: + ACCEPTED_ENCODINGS.append(b"br") try: import zstandard # noqa: F401 @@ -74,18 +87,24 @@ class HttpCompressionMiddleware: def open_spider(self, spider: Spider) -> None: if hasattr(spider, "download_maxsize"): + warn_on_deprecated_spider_attribute("download_maxsize", "DOWNLOAD_MAXSIZE") self._max_size = spider.download_maxsize if hasattr(spider, "download_warnsize"): + warn_on_deprecated_spider_attribute( + "download_warnsize", "DOWNLOAD_WARNSIZE" + ) self._warn_size = spider.download_warnsize + @_warn_spider_arg def process_request( - self, request: Request, spider: Spider + self, request: Request, spider: Spider | None = None ) -> Request | Response | None: request.headers.setdefault("Accept-Encoding", b", ".join(ACCEPTED_ENCODINGS)) return None + @_warn_spider_arg def process_response( - self, request: Request, response: Response, spider: Spider + self, request: Request, response: Response, spider: Spider | None = None ) -> Request | Response: if request.method == "HEAD": return response @@ -98,13 +117,13 @@ class HttpCompressionMiddleware: decoded_body, content_encoding = self._handle_encoding( response.body, content_encoding, max_size ) - except _DecompressionMaxSizeExceeded: + except _DecompressionMaxSizeExceeded as e: raise IgnoreRequest( f"Ignored response {response} because its body " - f"({len(response.body)} B compressed) exceeded " - f"DOWNLOAD_MAXSIZE ({max_size} B) during " - f"decompression." - ) + f"({len(response.body)} B compressed, " + f"{e.decompressed_size} B decompressed so far) exceeded " + f"DOWNLOAD_MAXSIZE ({max_size} B) during decompression." + ) from e if len(response.body) < warn_size <= len(decoded_body): logger.warning( f"{response} body size after decompression " @@ -118,11 +137,8 @@ class HttpCompressionMiddleware: self.stats.inc_value( "httpcompression/response_bytes", len(decoded_body), - spider=spider, - ) - self.stats.inc_value( - "httpcompression/response_count", spider=spider ) + self.stats.inc_value("httpcompression/response_count") respcls = responsetypes.from_args( headers=response.headers, url=response.url, body=decoded_body ) @@ -187,7 +203,7 @@ class HttpCompressionMiddleware: f"from unsupported encoding(s) '{encodings_str}'." ) if b"br" in encodings: - msg += " You need to install brotli or brotlicffi to decode 'br'." + msg += " You need to install brotli or brotlicffi >= 1.2.0 to decode 'br'." if b"zstd" in encodings: msg += " You need to install zstandard to decode 'zstd'." logger.warning(msg) diff --git a/scrapy/downloadermiddlewares/httpproxy.py b/scrapy/downloadermiddlewares/httpproxy.py index cb7fa8c90..e034dced1 100644 --- a/scrapy/downloadermiddlewares/httpproxy.py +++ b/scrapy/downloadermiddlewares/httpproxy.py @@ -10,6 +10,7 @@ from urllib.request import ( # type: ignore[attr-defined] ) from scrapy.exceptions import NotConfigured +from scrapy.utils.decorators import _warn_spider_arg from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.python import to_bytes @@ -55,8 +56,9 @@ class HttpProxyMiddleware: return creds, proxy_url + @_warn_spider_arg def process_request( - self, request: Request, spider: Spider + self, request: Request, spider: Spider | None = None ) -> Request | Response | None: creds, proxy_url, scheme = None, None, None if "proxy" in request.meta: @@ -67,7 +69,7 @@ class HttpProxyMiddleware: _scheme = parsed.scheme if ( # 'no_proxy' is only supported by http schemes - _scheme not in ("http", "https") + _scheme not in {"http", "https"} or (parsed.hostname and not proxy_bypass(parsed.hostname)) ) and _scheme in self.proxies: scheme = _scheme diff --git a/scrapy/downloadermiddlewares/offsite.py b/scrapy/downloadermiddlewares/offsite.py index 787c46a60..e03dc040e 100644 --- a/scrapy/downloadermiddlewares/offsite.py +++ b/scrapy/downloadermiddlewares/offsite.py @@ -2,11 +2,11 @@ from __future__ import annotations import logging import re -import warnings from typing import TYPE_CHECKING from scrapy import Request, Spider, signals from scrapy.exceptions import IgnoreRequest +from scrapy.utils.decorators import _warn_spider_arg from scrapy.utils.httpobj import urlparse_cached if TYPE_CHECKING: @@ -21,29 +21,34 @@ logger = logging.getLogger(__name__) class OffsiteMiddleware: + crawler: Crawler + + def __init__(self, stats: StatsCollector): + self.stats = stats + self.domains_seen: set[str] = set() + @classmethod def from_crawler(cls, crawler: Crawler) -> Self: assert crawler.stats o = cls(crawler.stats) crawler.signals.connect(o.spider_opened, signal=signals.spider_opened) crawler.signals.connect(o.request_scheduled, signal=signals.request_scheduled) + o.crawler = crawler return o - def __init__(self, stats: StatsCollector): - self.stats = stats - self.domains_seen: set[str] = set() - def spider_opened(self, spider: Spider) -> None: self.host_regex: re.Pattern[str] = self.get_host_regex(spider) def request_scheduled(self, request: Request, spider: Spider) -> None: - self.process_request(request, spider) + self.process_request(request) - def process_request(self, request: Request, spider: Spider) -> None: + @_warn_spider_arg + def process_request(self, request: Request, spider: Spider | None = None) -> None: + assert self.crawler.spider if ( request.dont_filter or request.meta.get("allow_offsite") - or self.should_follow(request, spider) + or self.should_follow(request, self.crawler.spider) ): return domain = urlparse_cached(request).hostname @@ -52,10 +57,10 @@ class OffsiteMiddleware: logger.debug( "Filtered offsite request to %(domain)r: %(request)s", {"domain": domain, "request": request}, - extra={"spider": spider}, + extra={"spider": self.crawler.spider}, ) - self.stats.inc_value("offsite/domains", spider=spider) - self.stats.inc_value("offsite/filtered", spider=spider) + self.stats.inc_value("offsite/domains") + self.stats.inc_value("offsite/filtered") raise IgnoreRequest def should_follow(self, request: Request, spider: Spider) -> bool: @@ -69,25 +74,10 @@ class OffsiteMiddleware: allowed_domains = getattr(spider, "allowed_domains", None) if not allowed_domains: return re.compile("") # allow all by default - url_pattern = re.compile(r"^https?://.*$") - port_pattern = re.compile(r":\d+$") domains = [] for domain in allowed_domains: if domain is None: continue - if url_pattern.match(domain): - message = ( - "allowed_domains accepts only domains, not URLs. " - f"Ignoring URL entry {domain} in allowed_domains." - ) - warnings.warn(message) - elif port_pattern.search(domain): - message = ( - "allowed_domains accepts only domains without ports. " - f"Ignoring entry {domain} in allowed_domains." - ) - warnings.warn(message) - else: - domains.append(re.escape(domain)) + domains.append(re.escape(domain)) regex = rf"^(.*\.)?({'|'.join(domains)})$" return re.compile(regex) diff --git a/scrapy/downloadermiddlewares/redirect.py b/scrapy/downloadermiddlewares/redirect.py index 612426371..821f41699 100644 --- a/scrapy/downloadermiddlewares/redirect.py +++ b/scrapy/downloadermiddlewares/redirect.py @@ -2,13 +2,17 @@ from __future__ import annotations import logging from typing import TYPE_CHECKING, Any, cast -from urllib.parse import urljoin +from urllib.parse import urljoin, urlparse from w3lib.url import safe_url_string +from scrapy import signals from scrapy.exceptions import IgnoreRequest, NotConfigured from scrapy.http import HtmlResponse, Response +from scrapy.spidermiddlewares.referer import RefererMiddleware +from scrapy.utils.decorators import _warn_spider_arg from scrapy.utils.httpobj import urlparse_cached +from scrapy.utils.python import global_object_name from scrapy.utils.response import get_meta_refresh if TYPE_CHECKING: @@ -23,62 +27,8 @@ if TYPE_CHECKING: logger = logging.getLogger(__name__) -def _build_redirect_request( - source_request: Request, *, url: str, **kwargs: Any -) -> Request: - redirect_request = source_request.replace( - url=url, - **kwargs, - cls=None, - cookies=None, - ) - if "_scheme_proxy" in redirect_request.meta: - source_request_scheme = urlparse_cached(source_request).scheme - redirect_request_scheme = urlparse_cached(redirect_request).scheme - if source_request_scheme != redirect_request_scheme: - redirect_request.meta.pop("_scheme_proxy") - redirect_request.meta.pop("proxy", None) - redirect_request.meta.pop("_auth_proxy", None) - redirect_request.headers.pop(b"Proxy-Authorization", None) - has_cookie_header = "Cookie" in redirect_request.headers - has_authorization_header = "Authorization" in redirect_request.headers - if has_cookie_header or has_authorization_header: - default_ports = {"http": 80, "https": 443} - - parsed_source_request = urlparse_cached(source_request) - source_scheme, source_host, source_port = ( - parsed_source_request.scheme, - parsed_source_request.hostname, - parsed_source_request.port - or default_ports.get(parsed_source_request.scheme), - ) - - parsed_redirect_request = urlparse_cached(redirect_request) - redirect_scheme, redirect_host, redirect_port = ( - parsed_redirect_request.scheme, - parsed_redirect_request.hostname, - parsed_redirect_request.port - or default_ports.get(parsed_redirect_request.scheme), - ) - - if has_cookie_header and ( - redirect_scheme not in {source_scheme, "https"} - or source_host != redirect_host - ): - del redirect_request.headers["Cookie"] - - # https://fetch.spec.whatwg.org/#ref-for-cors-non-wildcard-request-header-name - if has_authorization_header and ( - source_scheme != redirect_scheme - or source_host != redirect_host - or source_port != redirect_port - ): - del redirect_request.headers["Authorization"] - - return redirect_request - - class BaseRedirectMiddleware: + crawler: Crawler enabled_setting: str = "REDIRECT_ENABLED" def __init__(self, settings: BaseSettings): @@ -87,14 +37,60 @@ class BaseRedirectMiddleware: self.max_redirect_times: int = settings.getint("REDIRECT_MAX_TIMES") self.priority_adjust: int = settings.getint("REDIRECT_PRIORITY_ADJUST") + self._referer_spider_middleware: RefererMiddleware | None = None @classmethod def from_crawler(cls, crawler: Crawler) -> Self: - return cls(crawler.settings) + o = cls(crawler.settings) + o.crawler = crawler + crawler.signals.connect(o._engine_started, signal=signals.engine_started) + return o - def _redirect( - self, redirected: Request, request: Request, spider: Spider, reason: Any - ) -> Request: + def handle_referer(self, request: Request, response: Response) -> None: + """Remove, modify or keep the Referer header of *request* based on the + *response* that triggered *request*. + + By default, this method finds a run-time instance of + scrapy.spidermiddlewares.referer.RefererMiddleware (or of a subclass) + and uses it to set the right Referer header. + + Override this method if you use a different Scrapy component to handle + Referer headers, of if you want to use a custom logic to set the + Referer header on redirects. + """ + request.headers.pop("Referer", None) + if not self._referer_spider_middleware: + return + self._referer_spider_middleware.get_processed_request(request, response) + + def _engine_started(self) -> None: + self._referer_spider_middleware = self.crawler.get_spider_middleware( + RefererMiddleware + ) + if self._referer_spider_middleware: + return + redirect_cls = global_object_name(self.__class__) + referer_cls = global_object_name(RefererMiddleware) + if self.__class__ in {RedirectMiddleware, MetaRefreshMiddleware}: + replacement = ( + f"replace {redirect_cls} with a subclass that overrides the " + f"handle_referer() method" + ) + else: + replacement = ( + f"or edit {redirect_cls} (if defined in your code base) to " + f"override the handle_referer() method, or replace " + f"{redirect_cls} with a subclass that overrides the " + f"handle_referer() method." + ) + logger.warning( + f"{redirect_cls} found no {referer_cls} instance to handle " + f"Referer header handling, so the Referer header will be removed " + f"on redirects. To set a Referer header on redirects, enable " + f"{referer_cls} (or a subclass), or {replacement}.", + ) + + def _redirect(self, redirected: Request, request: Request, reason: Any) -> Request: ttl = request.meta.setdefault("redirect_ttl", self.max_redirect_times) redirects = request.meta.get("redirect_times", 0) + 1 @@ -114,27 +110,88 @@ class BaseRedirectMiddleware: logger.debug( "Redirecting (%(reason)s) to %(redirected)s from %(request)s", {"reason": reason, "redirected": redirected, "request": request}, - extra={"spider": spider}, + extra={"spider": self.crawler.spider}, ) return redirected logger.debug( "Discarding %(request)s: max redirections reached", {"request": request}, - extra={"spider": spider}, + extra={"spider": self.crawler.spider}, ) raise IgnoreRequest("max redirections reached") - def _redirect_request_using_get( - self, request: Request, redirect_url: str + def _build_redirect_request( + self, source_request: Request, response: Response, *, url: str, **kwargs: Any ) -> Request: - redirect_request = _build_redirect_request( + redirect_request = source_request.replace( + url=url, + **kwargs, + cls=None, + cookies=None, + ) + if "_scheme_proxy" in redirect_request.meta: + source_request_scheme = urlparse_cached(source_request).scheme + redirect_request_scheme = urlparse_cached(redirect_request).scheme + if source_request_scheme != redirect_request_scheme: + redirect_request.meta.pop("_scheme_proxy") + redirect_request.meta.pop("proxy", None) + redirect_request.meta.pop("_auth_proxy", None) + redirect_request.headers.pop(b"Proxy-Authorization", None) + + has_cookie_header = "Cookie" in redirect_request.headers + has_authorization_header = "Authorization" in redirect_request.headers + if has_cookie_header or has_authorization_header: + default_ports = {"http": 80, "https": 443} + + parsed_source_request = urlparse_cached(source_request) + source_scheme, source_host, source_port = ( + parsed_source_request.scheme, + parsed_source_request.hostname, + parsed_source_request.port + or default_ports.get(parsed_source_request.scheme), + ) + + parsed_redirect_request = urlparse_cached(redirect_request) + redirect_scheme, redirect_host, redirect_port = ( + parsed_redirect_request.scheme, + parsed_redirect_request.hostname, + parsed_redirect_request.port + or default_ports.get(parsed_redirect_request.scheme), + ) + + if has_cookie_header and ( + redirect_scheme not in {source_scheme, "https"} + or source_host != redirect_host + ): + del redirect_request.headers["Cookie"] + + # https://fetch.spec.whatwg.org/#ref-for-cors-non-wildcard-request-header-name + if has_authorization_header and ( + source_scheme != redirect_scheme + or source_host != redirect_host + or source_port != redirect_port + ): + del redirect_request.headers["Authorization"] + + self.handle_referer(redirect_request, response) + + return redirect_request + + def _redirect_request_using_get( + self, request: Request, response: Response, redirect_url: str + ) -> Request: + redirect_request = self._build_redirect_request( request, + response, url=redirect_url, method="GET", body="", ) redirect_request.headers.pop("Content-Type", None) redirect_request.headers.pop("Content-Length", None) + redirect_request.headers.pop("Content-Encoding", None) + redirect_request.headers.pop("Content-Language", None) + redirect_request.headers.pop("Content-Location", None) return redirect_request @@ -144,19 +201,26 @@ class RedirectMiddleware(BaseRedirectMiddleware): and meta-refresh html tag. """ + @_warn_spider_arg def process_response( - self, request: Request, response: Response, spider: Spider + self, request: Request, response: Response, spider: Spider | None = None ) -> Request | Response: if ( request.meta.get("dont_redirect", False) - or response.status in getattr(spider, "handle_httpstatus_list", []) - or response.status in request.meta.get("handle_httpstatus_list", []) + or response.status + in getattr(self.crawler.spider, "handle_httpstatus_list", ()) + or response.status in request.meta.get("handle_httpstatus_list", ()) or request.meta.get("handle_httpstatus_all", False) ): return response - allowed_status = (301, 302, 303, 307, 308) - if "Location" not in response.headers or response.status not in allowed_status: + if "Location" not in response.headers or response.status not in { + 301, + 302, + 303, + 307, + 308, + }: return response assert response.headers["Location"] is not None @@ -166,15 +230,24 @@ class RedirectMiddleware(BaseRedirectMiddleware): location = request_scheme + "://" + location.lstrip("/") redirected_url = urljoin(request.url, location) - redirected = _build_redirect_request(request, url=redirected_url) + + if not urlparse(redirected_url).fragment: + fragment = urlparse_cached(request).fragment + if fragment: + redirected_url = urljoin(redirected_url, f"#{fragment}") + + redirected = self._build_redirect_request(request, response, url=redirected_url) if urlparse_cached(redirected).scheme not in {"http", "https"}: return response - if response.status in (301, 307, 308) or request.method == "HEAD": - return self._redirect(redirected, request, spider, response.status) + if (response.status in {301, 302} and request.method == "POST") or ( + response.status == 303 and request.method not in {"GET", "HEAD"} + ): + redirected = self._redirect_request_using_get( + request, response, redirected_url + ) - redirected = self._redirect_request_using_get(request, redirected_url) - return self._redirect(redirected, request, spider, response.status) + return self._redirect(redirected, request, response.status) class MetaRefreshMiddleware(BaseRedirectMiddleware): @@ -185,8 +258,9 @@ class MetaRefreshMiddleware(BaseRedirectMiddleware): self._ignore_tags: list[str] = settings.getlist("METAREFRESH_IGNORE_TAGS") self._maxdelay: int = settings.getint("METAREFRESH_MAXDELAY") + @_warn_spider_arg def process_response( - self, request: Request, response: Response, spider: Spider + self, request: Request, response: Response, spider: Spider | None = None ) -> Request | Response: if ( request.meta.get("dont_redirect", False) @@ -199,9 +273,9 @@ class MetaRefreshMiddleware(BaseRedirectMiddleware): interval, url = get_meta_refresh(response, ignore_tags=self._ignore_tags) if not url: return response - redirected = self._redirect_request_using_get(request, url) + redirected = self._redirect_request_using_get(request, response, url) if urlparse_cached(redirected).scheme not in {"http", "https"}: return response - if cast(float, interval) < self._maxdelay: - return self._redirect(redirected, request, spider, "meta refresh") + if cast("float", interval) < self._maxdelay: + return self._redirect(redirected, request, "meta refresh") return response diff --git a/scrapy/downloadermiddlewares/retry.py b/scrapy/downloadermiddlewares/retry.py index 723fe5e93..5f125cae4 100644 --- a/scrapy/downloadermiddlewares/retry.py +++ b/scrapy/downloadermiddlewares/retry.py @@ -12,10 +12,11 @@ once the spider has finished crawling all regular (non-failed) pages. from __future__ import annotations -from logging import Logger, getLogger +from logging import Logger, getLevelName, getLogger from typing import TYPE_CHECKING from scrapy.exceptions import NotConfigured +from scrapy.utils.decorators import _warn_spider_arg from scrapy.utils.misc import load_object from scrapy.utils.python import global_object_name from scrapy.utils.response import response_status_message @@ -24,11 +25,11 @@ if TYPE_CHECKING: # typing.Self requires Python 3.11 from typing_extensions import Self + import scrapy from scrapy.crawler import Crawler from scrapy.http import Response from scrapy.http.request import Request from scrapy.settings import BaseSettings - from scrapy.spiders import Spider retry_logger = getLogger(__name__) @@ -37,11 +38,12 @@ retry_logger = getLogger(__name__) def get_retry_request( request: Request, *, - spider: Spider, + spider: scrapy.Spider, reason: str | Exception | type[Exception] = "unspecified", max_retry_times: int | None = None, priority_adjust: int | None = None, logger: Logger = retry_logger, + give_up_log_level: int | str | None = None, stats_base_key: str = "retry", ) -> Request | None: """ @@ -50,14 +52,16 @@ def get_retry_request( exhausted. For example, in a :class:`~scrapy.Spider` callback, you could use it as - follows:: + follows: + + .. code-block:: python def parse(self, response): if not response.text: new_request_or_none = get_retry_request( response.request, spider=self, - reason='empty', + reason="empty", ) return new_request_or_none @@ -81,6 +85,10 @@ def get_retry_request( *logger* is the logging.Logger object to be used when logging messages + *give_up_log_level* is the :ref:`logging level ` used for the + message logged when a request exceeds its retries. See + :setting:`RETRY_GIVE_UP_LOG_LEVEL` for details. + *stats_base_key* is a string to be used as the base key for the retry-related job stats """ @@ -113,8 +121,16 @@ def get_retry_request( stats.inc_value(f"{stats_base_key}/count") stats.inc_value(f"{stats_base_key}/reason_count/{reason}") return new_request + if give_up_log_level is None: + give_up_log_level = settings["RETRY_GIVE_UP_LOG_LEVEL"] + if isinstance(give_up_log_level, str): + level = getLevelName(give_up_log_level) + if not isinstance(level, int): + raise ValueError(f"Invalid give-up log level: {give_up_log_level!r}") + give_up_log_level = level stats.inc_value(f"{stats_base_key}/max_reached") - logger.error( + logger.log( + give_up_log_level, "Gave up retrying %(request)s (failed %(retry_times)d times): %(reason)s", {"request": request, "retry_times": retry_times, "reason": reason}, extra={"spider": spider}, @@ -123,12 +139,15 @@ def get_retry_request( class RetryMiddleware: + crawler: Crawler + def __init__(self, settings: BaseSettings): if not settings.getbool("RETRY_ENABLED"): raise NotConfigured self.max_retry_times = settings.getint("RETRY_TIMES") self.retry_http_codes = {int(x) for x in settings.getlist("RETRY_HTTP_CODES")} self.priority_adjust = settings.getint("RETRY_PRIORITY_ADJUST") + self.give_up_log_level = settings["RETRY_GIVE_UP_LOG_LEVEL"] self.exceptions_to_retry = tuple( load_object(x) if isinstance(x, str) else x for x in settings.getlist("RETRY_EXCEPTIONS") @@ -136,39 +155,51 @@ class RetryMiddleware: @classmethod def from_crawler(cls, crawler: Crawler) -> Self: - return cls(crawler.settings) + o = cls(crawler.settings) + o.crawler = crawler + return o + @_warn_spider_arg def process_response( - self, request: Request, response: Response, spider: Spider + self, + request: Request, + response: Response, + spider: scrapy.Spider | None = None, ) -> Request | Response: if request.meta.get("dont_retry", False): return response if response.status in self.retry_http_codes: reason = response_status_message(response.status) - return self._retry(request, reason, spider) or response + return self._retry(request, reason) or response return response + @_warn_spider_arg def process_exception( - self, request: Request, exception: Exception, spider: Spider + self, + request: Request, + exception: Exception, + spider: scrapy.Spider | None = None, ) -> Request | Response | None: if isinstance(exception, self.exceptions_to_retry) and not request.meta.get( "dont_retry", False ): - return self._retry(request, exception, spider) + return self._retry(request, exception) return None def _retry( - self, - request: Request, - reason: str | Exception | type[Exception], - spider: Spider, + self, request: Request, reason: str | Exception | type[Exception] ) -> Request | None: max_retry_times = request.meta.get("max_retry_times", self.max_retry_times) priority_adjust = request.meta.get("priority_adjust", self.priority_adjust) + give_up_log_level = request.meta.get( + "give_up_log_level", self.give_up_log_level + ) + assert self.crawler.spider return get_retry_request( request, reason=reason, - spider=spider, + spider=self.crawler.spider, max_retry_times=max_retry_times, priority_adjust=priority_adjust, + give_up_log_level=give_up_log_level, ) diff --git a/scrapy/downloadermiddlewares/robotstxt.py b/scrapy/downloadermiddlewares/robotstxt.py index fbd737970..7d0c17884 100644 --- a/scrapy/downloadermiddlewares/robotstxt.py +++ b/scrapy/downloadermiddlewares/robotstxt.py @@ -9,18 +9,17 @@ from __future__ import annotations import logging from typing import TYPE_CHECKING -from twisted.internet.defer import Deferred, maybeDeferred +from twisted.internet.defer import Deferred from scrapy.exceptions import IgnoreRequest, NotConfigured from scrapy.http import Request, Response from scrapy.http.request import NO_CALLBACK +from scrapy.utils.decorators import _warn_spider_arg +from scrapy.utils.defer import maybe_deferred_to_future from scrapy.utils.httpobj import urlparse_cached -from scrapy.utils.log import failure_to_exc_info from scrapy.utils.misc import load_object if TYPE_CHECKING: - from twisted.python.failure import Failure - # typing.Self requires Python 3.11 from typing_extensions import Self @@ -53,24 +52,18 @@ class RobotsTxtMiddleware: def from_crawler(cls, crawler: Crawler) -> Self: return cls(crawler) - def process_request( - self, request: Request, spider: Spider - ) -> Deferred[None] | None: - if request.meta.get("dont_obey_robotstxt"): - return None - if request.url.startswith("data:") or request.url.startswith("file:"): - return None - d: Deferred[RobotParser | None] = maybeDeferred( - self.robot_parser, - request, - spider, # type: ignore[call-overload] - ) - d2: Deferred[None] = d.addCallback(self.process_request_2, request, spider) - return d2 - - def process_request_2( - self, rp: RobotParser | None, request: Request, spider: Spider + @_warn_spider_arg + async def process_request( + self, request: Request, spider: Spider | None = None ) -> None: + if request.meta.get("dont_obey_robotstxt"): + return + if request.url.startswith("data:") or request.url.startswith("file:"): + return + rp = await self.robot_parser(request) + self.process_request_2(rp, request) + + def process_request_2(self, rp: RobotParser | None, request: Request) -> None: if rp is None: return @@ -82,15 +75,13 @@ class RobotsTxtMiddleware: logger.debug( "Forbidden by robots.txt: %(request)s", {"request": request}, - extra={"spider": spider}, + extra={"spider": self.crawler.spider}, ) assert self.crawler.stats self.crawler.stats.inc_value("robotstxt/forbidden") raise IgnoreRequest("Forbidden by robots.txt") - def robot_parser( - self, request: Request, spider: Spider - ) -> RobotParser | Deferred[RobotParser | None] | None: + async def robot_parser(self, request: Request) -> RobotParser | None: url = urlparse_cached(request) netloc = url.netloc @@ -105,35 +96,26 @@ class RobotsTxtMiddleware: ) assert self.crawler.engine assert self.crawler.stats - dfd = self.crawler.engine.download(robotsreq) - dfd.addCallback(self._parse_robots, netloc, spider) - dfd.addErrback(self._logerror, robotsreq, spider) - dfd.addErrback(self._robots_error, netloc) + try: + resp = await self.crawler.engine.download_async(robotsreq) + self._parse_robots(resp, netloc) + except Exception as e: + if not isinstance(e, IgnoreRequest): + logger.error( + "Error downloading %(request)s: %(f_exception)s", + {"request": request, "f_exception": e}, + exc_info=True, + extra={"spider": self.crawler.spider}, + ) + self._robots_error(e, netloc) self.crawler.stats.inc_value("robotstxt/request_count") parser = self._parsers[netloc] if isinstance(parser, Deferred): - d: Deferred[RobotParser | None] = Deferred() - - def cb(result: RobotParser | None) -> RobotParser | None: - d.callback(result) - return result - - parser.addCallback(cb) - return d + return await maybe_deferred_to_future(parser) return parser - def _logerror(self, failure: Failure, request: Request, spider: Spider) -> Failure: - if failure.type is not IgnoreRequest: - logger.error( - "Error downloading %(request)s: %(f_exception)s", - {"request": request, "f_exception": failure.value}, - exc_info=failure_to_exc_info(failure), - extra={"spider": spider}, - ) - return failure - - def _parse_robots(self, response: Response, netloc: str, spider: Spider) -> None: + def _parse_robots(self, response: Response, netloc: str) -> None: assert self.crawler.stats self.crawler.stats.inc_value("robotstxt/response_count") self.crawler.stats.inc_value( @@ -145,9 +127,9 @@ class RobotsTxtMiddleware: self._parsers[netloc] = rp rp_dfd.callback(rp) - def _robots_error(self, failure: Failure, netloc: str) -> None: - if failure.type is not IgnoreRequest: - key = f"robotstxt/exception_count/{failure.type}" + def _robots_error(self, exc: Exception, netloc: str) -> None: + if not isinstance(exc, IgnoreRequest): + key = f"robotstxt/exception_count/{type(exc)}" assert self.crawler.stats self.crawler.stats.inc_value(key) rp_dfd = self._parsers[netloc] diff --git a/scrapy/downloadermiddlewares/stats.py b/scrapy/downloadermiddlewares/stats.py index cb5887a6f..bafa931de 100644 --- a/scrapy/downloadermiddlewares/stats.py +++ b/scrapy/downloadermiddlewares/stats.py @@ -5,6 +5,7 @@ from typing import TYPE_CHECKING from twisted.web import http from scrapy.exceptions import NotConfigured +from scrapy.utils.decorators import _warn_spider_arg from scrapy.utils.python import global_object_name, to_bytes from scrapy.utils.request import request_httprepr @@ -45,24 +46,22 @@ class DownloaderStats: assert crawler.stats return cls(crawler.stats) + @_warn_spider_arg def process_request( - self, request: Request, spider: Spider + self, request: Request, spider: Spider | None = None ) -> Request | Response | None: - self.stats.inc_value("downloader/request_count", spider=spider) - self.stats.inc_value( - f"downloader/request_method_count/{request.method}", spider=spider - ) + self.stats.inc_value("downloader/request_count") + self.stats.inc_value(f"downloader/request_method_count/{request.method}") reqlen = len(request_httprepr(request)) - self.stats.inc_value("downloader/request_bytes", reqlen, spider=spider) + self.stats.inc_value("downloader/request_bytes", reqlen) return None + @_warn_spider_arg def process_response( - self, request: Request, response: Response, spider: Spider + self, request: Request, response: Response, spider: Spider | None = None ) -> Request | Response: - self.stats.inc_value("downloader/response_count", spider=spider) - self.stats.inc_value( - f"downloader/response_status_count/{response.status}", spider=spider - ) + self.stats.inc_value("downloader/response_count") + self.stats.inc_value(f"downloader/response_status_count/{response.status}") reslen = ( len(response.body) + get_header_size(response.headers) @@ -70,15 +69,14 @@ class DownloaderStats: + 4 ) # response.body + b"\r\n"+ response.header + b"\r\n" + response.status - self.stats.inc_value("downloader/response_bytes", reslen, spider=spider) + self.stats.inc_value("downloader/response_bytes", reslen) return response + @_warn_spider_arg def process_exception( - self, request: Request, exception: Exception, spider: Spider + self, request: Request, exception: Exception, spider: Spider | None = None ) -> Request | Response | None: ex_class = global_object_name(exception.__class__) - self.stats.inc_value("downloader/exception_count", spider=spider) - self.stats.inc_value( - f"downloader/exception_type_count/{ex_class}", spider=spider - ) + self.stats.inc_value("downloader/exception_count") + self.stats.inc_value(f"downloader/exception_type_count/{ex_class}") return None diff --git a/scrapy/downloadermiddlewares/useragent.py b/scrapy/downloadermiddlewares/useragent.py index ba379f862..61f84b518 100644 --- a/scrapy/downloadermiddlewares/useragent.py +++ b/scrapy/downloadermiddlewares/useragent.py @@ -5,6 +5,8 @@ from __future__ import annotations from typing import TYPE_CHECKING from scrapy import Request, Spider, signals +from scrapy.utils.decorators import _warn_spider_arg +from scrapy.utils.deprecate import warn_on_deprecated_spider_attribute if TYPE_CHECKING: # typing.Self requires Python 3.11 @@ -27,10 +29,14 @@ class UserAgentMiddleware: return o def spider_opened(self, spider: Spider) -> None: + if hasattr(spider, "user_agent"): # pragma: no cover + warn_on_deprecated_spider_attribute("user_agent", "USER_AGENT") + self.user_agent = getattr(spider, "user_agent", self.user_agent) + @_warn_spider_arg def process_request( - self, request: Request, spider: Spider + self, request: Request, spider: Spider | None = None ) -> Request | Response | None: if self.user_agent: request.headers.setdefault(b"User-Agent", self.user_agent) diff --git a/scrapy/dupefilters.py b/scrapy/dupefilters.py index a3e2c5eb4..36fb0f97d 100644 --- a/scrapy/dupefilters.py +++ b/scrapy/dupefilters.py @@ -1,7 +1,6 @@ from __future__ import annotations import logging -import warnings from pathlib import Path from typing import TYPE_CHECKING from warnings import warn @@ -22,7 +21,6 @@ if TYPE_CHECKING: from scrapy.crawler import Crawler from scrapy.http.request import Request - from scrapy.settings import BaseSettings from scrapy.spiders import Spider @@ -30,15 +28,6 @@ class BaseDupeFilter: """Dummy duplicate request filtering class (:setting:`DUPEFILTER_CLASS`) that does not filter out any request.""" - @classmethod - def from_settings(cls, settings: BaseSettings) -> Self: - warnings.warn( - f"{cls.__name__}.from_settings() is deprecated, use from_crawler() instead.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - return cls() - @classmethod def from_crawler(cls, crawler: Crawler) -> Self: return cls() @@ -66,6 +55,18 @@ class RFPDupeFilter(BaseDupeFilter): filters out requests with the canonical (:func:`w3lib.url.canonicalize_url`) :attr:`~scrapy.http.Request.url`, :attr:`~scrapy.http.Request.method` and :attr:`~scrapy.http.Request.body`. + + Job directory contents + ====================== + + .. warning:: The files that this class generates in the :ref:`job directory + ` are an implementation detail, and may change without a + warning in a future version of Scrapy. Do not rely on the following + information for anything other than debugging purposes. + + When using :setting:`JOBDIR`, seen fingerprints are tracked in a file named + ``requests.seen`` in the :ref:`job directory `, which contains 1 + request fingerprint per line. """ def __init__( @@ -84,42 +85,24 @@ class RFPDupeFilter(BaseDupeFilter): self.debug = debug self.logger = logging.getLogger(__name__) if path: - self.file = Path(path, "requests.seen").open("a+", encoding="utf-8") + # line-by-line writing, see: https://github.com/scrapy/scrapy/issues/6019 + self.file = Path(path, "requests.seen").open( + "a+", buffering=1, encoding="utf-8" + ) + self.file.reconfigure(write_through=True) self.file.seek(0) self.fingerprints.update(x.rstrip() for x in self.file) - @classmethod - def from_settings( - cls, - settings: BaseSettings, - *, - fingerprinter: RequestFingerprinterProtocol | None = None, - ) -> Self: - warnings.warn( - f"{cls.__name__}.from_settings() is deprecated, use from_crawler() instead.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - return cls._from_settings(settings, fingerprinter=fingerprinter) - @classmethod def from_crawler(cls, crawler: Crawler) -> Self: assert crawler.request_fingerprinter - return cls._from_settings( - crawler.settings, + debug = crawler.settings.getbool("DUPEFILTER_DEBUG") + return cls( + job_dir(crawler.settings), + debug, fingerprinter=crawler.request_fingerprinter, ) - @classmethod - def _from_settings( - cls, - settings: BaseSettings, - *, - fingerprinter: RequestFingerprinterProtocol | None = None, - ) -> Self: - debug = settings.getbool("DUPEFILTER_DEBUG") - return cls(job_dir(settings), debug, fingerprinter=fingerprinter) - def request_seen(self, request: Request) -> bool: fp = self.request_fingerprint(request) if fp in self.fingerprints: @@ -152,4 +135,4 @@ class RFPDupeFilter(BaseDupeFilter): self.logdupes = False assert spider.crawler.stats - spider.crawler.stats.inc_value("dupefilter/filtered", spider=spider) + spider.crawler.stats.inc_value("dupefilter/filtered") diff --git a/scrapy/exceptions.py b/scrapy/exceptions.py index f37f881a7..204132973 100644 --- a/scrapy/exceptions.py +++ b/scrapy/exceptions.py @@ -7,7 +7,10 @@ new exceptions here without documenting them there. from __future__ import annotations -from typing import Any +from typing import TYPE_CHECKING, Any + +if TYPE_CHECKING: + from scrapy.http import Response # Internal @@ -49,11 +52,41 @@ class StopDownload(Exception): should be handled by the request errback. Note that 'fail' is a keyword-only argument. """ + response: Response | None + def __init__(self, *, fail: bool = True): super().__init__() self.fail = fail +class DownloadConnectionRefusedError(Exception): + """Indicates that a connection was refused by the server.""" + + +class CannotResolveHostError(Exception): + """Indicates that the provided hostname cannot be resolved.""" + + +class DownloadTimeoutError(Exception): + """Indicates that a request download has timed out.""" + + +class DownloadCancelledError(Exception): + """Indicates that a request download was cancelled.""" + + +class DownloadFailedError(Exception): + """Indicates that a request download has failed.""" + + +class ResponseDataLossError(Exception): + """Indicates that Scrapy couldn't get a complete response.""" + + +class UnsupportedURLSchemeError(Exception): + """Indicates that the URL scheme is not supported.""" + + # Items diff --git a/scrapy/exporters.py b/scrapy/exporters.py index 0a641752e..e18f1e6ed 100644 --- a/scrapy/exporters.py +++ b/scrapy/exporters.py @@ -8,6 +8,7 @@ import csv import marshal import pickle import pprint +from abc import ABC, abstractmethod from collections.abc import Callable, Iterable, Mapping from io import BytesIO, TextIOWrapper from typing import TYPE_CHECKING, Any @@ -35,7 +36,7 @@ __all__ = [ ] -class BaseItemExporter: +class BaseItemExporter(ABC): def __init__(self, *, dont_fail: bool = False, **kwargs: Any): self._kwargs: dict[str, Any] = kwargs self._configure(kwargs, dont_fail=dont_fail) @@ -54,6 +55,7 @@ class BaseItemExporter: if not dont_fail and options: raise TypeError(f"Unexpected options: {', '.join(options.keys())}") + @abstractmethod def export_item(self, item: Any) -> None: raise NotImplementedError @@ -63,10 +65,10 @@ class BaseItemExporter: serializer: Callable[[Any], Any] = field.get("serializer", lambda x: x) return serializer(value) - def start_exporting(self) -> None: + def start_exporting(self) -> None: # noqa: B027 pass - def finish_exporting(self) -> None: + def finish_exporting(self) -> None: # noqa: B027 pass def _get_serialized_fields( diff --git a/scrapy/extension.py b/scrapy/extension.py index 9f978fa32..05cce326b 100644 --- a/scrapy/extension.py +++ b/scrapy/extension.py @@ -20,4 +20,6 @@ class ExtensionManager(MiddlewareManager): @classmethod def _get_mwlist_from_settings(cls, settings: Settings) -> list[Any]: - return build_component_list(settings.getwithbase("EXTENSIONS")) + return build_component_list( + settings.get_component_priority_dict_with_base("EXTENSIONS") + ) diff --git a/scrapy/extensions/closespider.py b/scrapy/extensions/closespider.py index b4c6c73a0..a4362b182 100644 --- a/scrapy/extensions/closespider.py +++ b/scrapy/extensions/closespider.py @@ -18,6 +18,7 @@ from scrapy.utils.asyncio import ( call_later, create_looping_call, ) +from scrapy.utils.defer import _schedule_coro if TYPE_CHECKING: from twisted.internet.task import LoopingCall @@ -86,38 +87,31 @@ class CloseSpider: def error_count(self, failure: Failure, response: Response, spider: Spider) -> None: self.counter["errorcount"] += 1 if self.counter["errorcount"] == self.close_on["errorcount"]: - assert self.crawler.engine - self.crawler.engine.close_spider(spider, "closespider_errorcount") + self._close_spider("closespider_errorcount") def page_count(self, response: Response, request: Request, spider: Spider) -> None: self.counter["pagecount"] += 1 self.counter["pagecount_since_last_item"] += 1 if self.counter["pagecount"] == self.close_on["pagecount"]: - assert self.crawler.engine - self.crawler.engine.close_spider(spider, "closespider_pagecount") + self._close_spider("closespider_pagecount") return if self.close_on["pagecount_no_item"] and ( self.counter["pagecount_since_last_item"] >= self.close_on["pagecount_no_item"] ): - assert self.crawler.engine - self.crawler.engine.close_spider(spider, "closespider_pagecount_no_item") + self._close_spider("closespider_pagecount_no_item") def spider_opened(self, spider: Spider) -> None: assert self.crawler.engine self.task = call_later( - self.close_on["timeout"], - self.crawler.engine.close_spider, - spider, - "closespider_timeout", + self.close_on["timeout"], self._close_spider, "closespider_timeout" ) def item_scraped(self, item: Any, spider: Spider) -> None: self.counter["itemcount"] += 1 self.counter["pagecount_since_last_item"] = 0 if self.counter["itemcount"] == self.close_on["itemcount"]: - assert self.crawler.engine - self.crawler.engine.close_spider(spider, "closespider_itemcount") + self._close_spider("closespider_itemcount") def spider_closed(self, spider: Spider) -> None: if self.task: @@ -130,7 +124,7 @@ class CloseSpider: self.task_no_item = None def spider_opened_no_item(self, spider: Spider) -> None: - self.task_no_item = create_looping_call(self._count_items_produced, spider) + self.task_no_item = create_looping_call(self._count_items_produced) self.task_no_item.start(self.timeout_no_item, now=False) logger.info( @@ -141,7 +135,7 @@ class CloseSpider: def item_scraped_no_item(self, item: Any, spider: Spider) -> None: self.items_in_period += 1 - def _count_items_produced(self, spider: Spider) -> None: + def _count_items_produced(self) -> None: if self.items_in_period >= 1: self.items_in_period = 0 else: @@ -149,5 +143,8 @@ class CloseSpider: f"Closing spider since no items were produced in the last " f"{self.timeout_no_item} seconds." ) - assert self.crawler.engine - self.crawler.engine.close_spider(spider, "closespider_timeout_no_item") + self._close_spider("closespider_timeout_no_item") + + def _close_spider(self, reason: str) -> None: + assert self.crawler.engine + _schedule_coro(self.crawler.engine.close_spider_async(reason=reason)) diff --git a/scrapy/extensions/corestats.py b/scrapy/extensions/corestats.py index 779cd5d1c..6a5e55992 100644 --- a/scrapy/extensions/corestats.py +++ b/scrapy/extensions/corestats.py @@ -5,6 +5,7 @@ Extension for collecting core stats like items scraped and start/finish times from __future__ import annotations from datetime import datetime, timezone +from time import monotonic from typing import TYPE_CHECKING, Any from scrapy import Spider, signals @@ -21,6 +22,7 @@ class CoreStats: def __init__(self, stats: StatsCollector): self.stats: StatsCollector = stats self.start_time: datetime | None = None + self._start_time_mono: float | None = None @classmethod def from_crawler(cls, crawler: Crawler) -> Self: @@ -35,26 +37,25 @@ class CoreStats: def spider_opened(self, spider: Spider) -> None: self.start_time = datetime.now(tz=timezone.utc) - self.stats.set_value("start_time", self.start_time, spider=spider) + self._start_time_mono = monotonic() + self.stats.set_value("start_time", self.start_time) def spider_closed(self, spider: Spider, reason: str) -> None: assert self.start_time is not None - finish_time = datetime.now(tz=timezone.utc) - elapsed_time = finish_time - self.start_time - elapsed_time_seconds = elapsed_time.total_seconds() - self.stats.set_value( - "elapsed_time_seconds", elapsed_time_seconds, spider=spider - ) - self.stats.set_value("finish_time", finish_time, spider=spider) - self.stats.set_value("finish_reason", reason, spider=spider) + assert self._start_time_mono is not None + finish_time, finish_time_mono = datetime.now(tz=timezone.utc), monotonic() + elapsed_time_seconds = finish_time_mono - self._start_time_mono + self.stats.set_value("elapsed_time_seconds", elapsed_time_seconds) + self.stats.set_value("finish_time", finish_time) + self.stats.set_value("finish_reason", reason) def item_scraped(self, item: Any, spider: Spider) -> None: - self.stats.inc_value("item_scraped_count", spider=spider) + self.stats.inc_value("item_scraped_count") def response_received(self, spider: Spider) -> None: - self.stats.inc_value("response_received_count", spider=spider) + self.stats.inc_value("response_received_count") def item_dropped(self, item: Any, spider: Spider, exception: BaseException) -> None: reason = exception.__class__.__name__ - self.stats.inc_value("item_dropped_count", spider=spider) - self.stats.inc_value(f"item_dropped_reasons_count/{reason}", spider=spider) + self.stats.inc_value("item_dropped_count") + self.stats.inc_value(f"item_dropped_reasons_count/{reason}") diff --git a/scrapy/extensions/debug.py b/scrapy/extensions/debug.py index afaf81928..5def7509e 100644 --- a/scrapy/extensions/debug.py +++ b/scrapy/extensions/debug.py @@ -34,8 +34,8 @@ class StackTraceDump: def __init__(self, crawler: Crawler): self.crawler: Crawler = crawler try: - signal.signal(signal.SIGUSR2, self.dump_stacktrace) # type: ignore[attr-defined] - signal.signal(signal.SIGQUIT, self.dump_stacktrace) # type: ignore[attr-defined] + signal.signal(signal.SIGUSR2, self.dump_stacktrace) # type: ignore[attr-defined,unused-ignore] + signal.signal(signal.SIGQUIT, self.dump_stacktrace) # type: ignore[attr-defined,unused-ignore] except AttributeError: # win32 platforms don't support SIGUSR signals pass @@ -72,7 +72,7 @@ class Debugger: def __init__(self) -> None: # win32 platforms don't support SIGUSR signals with contextlib.suppress(AttributeError): - signal.signal(signal.SIGUSR2, self._enter_debugger) # type: ignore[attr-defined] + signal.signal(signal.SIGUSR2, self._enter_debugger) # type: ignore[attr-defined,unused-ignore] def _enter_debugger(self, signum: int, frame: FrameType | None) -> None: assert frame diff --git a/scrapy/extensions/feedexport.py b/scrapy/extensions/feedexport.py index f7bf50a5c..8029f85c9 100644 --- a/scrapy/extensions/feedexport.py +++ b/scrapy/extensions/feedexport.py @@ -6,38 +6,36 @@ See documentation in docs/topics/feed-exports.rst from __future__ import annotations +import asyncio import contextlib import logging import re import sys import warnings -from collections.abc import Callable +from abc import ABC, abstractmethod +from collections.abc import Callable, Coroutine from datetime import datetime, timezone from pathlib import Path, PureWindowsPath from tempfile import NamedTemporaryFile -from typing import IO, TYPE_CHECKING, Any, Optional, Protocol, TypeVar, cast +from typing import IO, TYPE_CHECKING, Any, Protocol, TypeAlias, cast from urllib.parse import unquote, urlparse -from twisted.internet.defer import Deferred, DeferredList, maybeDeferred -from twisted.internet.threads import deferToThread +from twisted.internet.defer import Deferred, DeferredList from w3lib.url import file_uri_to_path from zope.interface import Interface, implementer from scrapy import Spider, signals from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.extensions.postprocessing import PostProcessingManager +from scrapy.utils.asyncio import is_asyncio_available, run_in_thread from scrapy.utils.conf import feed_complete_default_values_from_settings -from scrapy.utils.defer import maybe_deferred_to_future +from scrapy.utils.defer import deferred_from_coro, ensure_awaitable from scrapy.utils.ftp import ftp_store_file -from scrapy.utils.log import failure_to_exc_info from scrapy.utils.misc import build_from_crawler, load_object from scrapy.utils.python import without_none_values if TYPE_CHECKING: - from collections.abc import Iterable - from _typeshed import OpenBinaryMode - from twisted.python.failure import Failure # typing.Self requires Python 3.11 from typing_extensions import Self @@ -49,26 +47,9 @@ if TYPE_CHECKING: logger = logging.getLogger(__name__) -UriParamsCallableT = Callable[[dict[str, Any], Spider], Optional[dict[str, Any]]] - -_StorageT = TypeVar("_StorageT", bound="FeedStorageProtocol") - - -def build_storage( - builder: Callable[..., _StorageT], - uri: str, - *args: Any, - feed_options: dict[str, Any] | None = None, - preargs: Iterable[Any] = (), - **kwargs: Any, -) -> _StorageT: - warnings.warn( - "scrapy.extensions.feedexport.build_storage() is deprecated, call the builder directly.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - kwargs["feed_options"] = feed_options - return builder(*preargs, uri, *args, **kwargs) +UriParamsCallableT: TypeAlias = Callable[ + [dict[str, Any], Spider], dict[str, Any] | None +] class ItemFilter: @@ -107,20 +88,20 @@ class ItemFilter: return True # accept all items by default -class IFeedStorage(Interface): +class IFeedStorage(Interface): # type: ignore[misc] """Interface that all Feed Storages must implement""" # pylint: disable=no-self-argument - def __init__(uri, *, feed_options=None): # pylint: disable=super-init-not-called + def __init__(uri, *, feed_options=None): # type: ignore[no-untyped-def] # pylint: disable=super-init-not-called """Initialize the storage with the parameters given in the URI and the feed-specific options (see :setting:`FEEDS`)""" - def open(spider): + def open(spider): # type: ignore[no-untyped-def] """Open the storage for the given spider. It must return a file-like object that will be used for the exporters""" - def store(file): + def store(file): # type: ignore[no-untyped-def] """Store the given file stream""" @@ -140,7 +121,7 @@ class FeedStorageProtocol(Protocol): @implementer(IFeedStorage) -class BlockingFeedStorage: +class BlockingFeedStorage(ABC): def open(self, spider: Spider) -> IO[bytes]: path = spider.crawler.settings["FEED_TEMPDIR"] if path and not Path(path).is_dir(): @@ -149,8 +130,9 @@ class BlockingFeedStorage: return NamedTemporaryFile(prefix="feed-", dir=path) def store(self, file: IO[bytes]) -> Deferred[None] | None: - return deferToThread(self._store_in_thread, file) + return deferred_from_coro(run_in_thread(self._store_in_thread, file)) + @abstractmethod def _store_in_thread(self, file: IO[bytes]) -> None: raise NotImplementedError @@ -185,7 +167,7 @@ class StdoutFeedStorage: @implementer(IFeedStorage) class FileFeedStorage: def __init__(self, uri: str, *, feed_options: dict[str, Any] | None = None): - self.path: str = file_uri_to_path(uri) if uri.startswith("file://") else uri + self.path: str = file_uri_to_path(uri) if uri.startswith("file:") else uri feed_options = feed_options or {} self.write_mode: OpenBinaryMode = ( "wb" if feed_options.get("overwrite", False) else "ab" @@ -216,9 +198,9 @@ class S3FeedStorage(BlockingFeedStorage): region_name: str | None = None, ): try: - import boto3.session + import boto3.session # noqa: PLC0415 except ImportError: - raise NotConfigured("missing boto3 library") + raise NotConfigured("missing boto3 library") from None u = urlparse(uri) assert u.hostname self.bucketname: str = u.hostname @@ -268,10 +250,19 @@ class S3FeedStorage(BlockingFeedStorage): def _store_in_thread(self, file: IO[bytes]) -> None: file.seek(0) - kwargs: dict[str, Any] = {"ExtraArgs": {"ACL": self.acl}} if self.acl else {} - self.s3_client.upload_fileobj( - Bucket=self.bucketname, Key=self.keyname, Fileobj=file, **kwargs - ) + if self.acl: + self.s3_client.upload_fileobj( + Bucket=self.bucketname, + Key=self.keyname, + Fileobj=file, + ExtraArgs={"ACL": self.acl}, + ) + else: + self.s3_client.upload_fileobj( + Bucket=self.bucketname, + Key=self.keyname, + Fileobj=file, + ) file.close() @@ -315,12 +306,15 @@ class GCSFeedStorage(BlockingFeedStorage): def _store_in_thread(self, file: IO[bytes]) -> None: file.seek(0) - from google.cloud.storage import Client + try: + from google.cloud.storage import Client # noqa: PLC0415 - client = Client(project=self.project_id) - bucket = client.get_bucket(self.bucket_name) - blob = bucket.blob(self.blob_name) - blob.upload_from_file(file, predefined_acl=self.acl) + client = Client(project=self.project_id) + bucket = client.get_bucket(self.bucket_name) + blob = bucket.blob(self.blob_name) + blob.upload_from_file(file, predefined_acl=self.acl) + finally: + file.close() class FTPFeedStorage(BlockingFeedStorage): @@ -374,11 +368,11 @@ class FeedSlot: self, storage: FeedStorageProtocol, uri: str, - format: str, + format: str, # noqa: A002 store_empty: bool, batch_id: int, uri_template: str, - filter: ItemFilter, + filter: ItemFilter, # noqa: A002 feed_options: dict[str, Any], spider: Spider, exporters: dict[str, type[BaseItemExporter]], @@ -411,7 +405,7 @@ class FeedSlot: self.file = self.storage.open(self.spider) if "postprocessing" in self.feed_options: self.file = cast( - IO[bytes], + "IO[bytes]", PostProcessingManager( self.feed_options["postprocessing"], self.file, @@ -420,7 +414,7 @@ class FeedSlot: ) self.exporter = self._get_exporter( file=self.file, - format=self.feed_options["format"], + format_=self.feed_options["format"], fields_to_export=self.feed_options["fields"], encoding=self.feed_options["encoding"], indent=self.feed_options["indent"], @@ -434,10 +428,10 @@ class FeedSlot: self._exporting = True def _get_exporter( - self, file: IO[bytes], format: str, *args: Any, **kwargs: Any + self, file: IO[bytes], format_: str, *args: Any, **kwargs: Any ) -> BaseItemExporter: return build_from_crawler( - self.exporters[format], self.crawler, file, *args, **kwargs + self.exporters[format_], self.crawler, file, *args, **kwargs ) def finish_exporting(self) -> None: @@ -448,8 +442,6 @@ class FeedSlot: class FeedExporter: - _pending_deferreds: list[Deferred[None]] = [] - @classmethod def from_crawler(cls, crawler: Crawler) -> Self: exporter = cls(crawler) @@ -464,6 +456,7 @@ class FeedExporter: self.feeds = {} self.slots: list[FeedSlot] = [] self.filters: dict[str, ItemFilter] = {} + self._pending_close_coros: list[Coroutine[Any, Any, None]] = [] if not self.settings["FEEDS"] and not self.settings["FEED_URI"]: raise NotConfigured @@ -487,9 +480,13 @@ class FeedExporter: # End: Backward compatibility for FEED_URI and FEED_FORMAT settings # 'FEEDS' setting takes precedence over 'FEED_URI' - for uri, feed_options in self.settings.getdict("FEEDS").items(): + for settings_uri, feed_options in self.settings.getdict("FEEDS").items(): # handle pathlib.Path objects - uri = str(uri) if not isinstance(uri, Path) else uri.absolute().as_uri() + uri = ( + str(settings_uri) + if not isinstance(settings_uri, Path) + else settings_uri.absolute().as_uri() + ) self.feeds[uri] = feed_complete_default_values_from_settings( feed_options, self.settings ) @@ -523,23 +520,32 @@ class FeedExporter: ) async def close_spider(self, spider: Spider) -> None: - for slot in self.slots: - self._close_slot(slot, spider) + self._pending_close_coros.extend( + self._close_slot(slot, spider) for slot in self.slots + ) - # Await all deferreds - if self._pending_deferreds: - await maybe_deferred_to_future(DeferredList(self._pending_deferreds)) + if self._pending_close_coros: + if is_asyncio_available(): + await asyncio.wait( + [asyncio.create_task(coro) for coro in self._pending_close_coros] + ) + else: + await DeferredList( + deferred_from_coro(coro) for coro in self._pending_close_coros + ) # Send FEED_EXPORTER_CLOSED signal await self.crawler.signals.send_catch_log_async(signals.feed_exporter_closed) - def _close_slot(self, slot: FeedSlot, spider: Spider) -> Deferred[None] | None: - def get_file(slot_: FeedSlot) -> IO[bytes]: - assert slot_.file - if isinstance(slot_.file, PostProcessingManager): - slot_.file.close() - return slot_.file.file - return slot_.file + @staticmethod + def _get_file(slot_: FeedSlot) -> IO[bytes]: + assert slot_.file + if isinstance(slot_.file, PostProcessingManager): + slot_.file.close() + return slot_.file.file + return slot_.file + + async def _close_slot(self, slot: FeedSlot, spider: Spider) -> None: if slot.itemcount: # Normal case @@ -550,45 +556,28 @@ class FeedExporter: slot.finish_exporting() else: # In this case, the file is not stored, so no processing is required. - return None + return logmsg = f"{slot.format} feed ({slot.itemcount} items) in: {slot.uri}" - d: Deferred[None] = maybeDeferred(slot.storage.store, get_file(slot)) # type: ignore[call-overload] - - d.addCallback( - self._handle_store_success, logmsg, spider, type(slot.storage).__name__ - ) - d.addErrback( - self._handle_store_error, logmsg, spider, type(slot.storage).__name__ - ) - self._pending_deferreds.append(d) - d.addCallback( - lambda _: self.crawler.signals.send_catch_log_deferred( - signals.feed_slot_closed, slot=slot + slot_type = type(slot.storage).__name__ + assert self.crawler.stats + try: + await ensure_awaitable(slot.storage.store(self._get_file(slot))) + except Exception: + logger.error( + "Error storing %s", + logmsg, + exc_info=True, + extra={"spider": spider}, ) + self.crawler.stats.inc_value(f"feedexport/failed_count/{slot_type}") + else: + logger.info("Stored %s", logmsg, extra={"spider": spider}) + self.crawler.stats.inc_value(f"feedexport/success_count/{slot_type}") + + await self.crawler.signals.send_catch_log_async( + signals.feed_slot_closed, slot=slot ) - d.addBoth(lambda _: self._pending_deferreds.remove(d)) - - return d - - def _handle_store_error( - self, f: Failure, logmsg: str, spider: Spider, slot_type: str - ) -> None: - logger.error( - "Error storing %s", - logmsg, - exc_info=failure_to_exc_info(f), - extra={"spider": spider}, - ) - assert self.crawler.stats - self.crawler.stats.inc_value(f"feedexport/failed_count/{slot_type}") - - def _handle_store_success( - self, result: Any, logmsg: str, spider: Spider, slot_type: str - ) -> None: - logger.info("Stored %s", logmsg, extra={"spider": spider}) - assert self.crawler.stats - self.crawler.stats.inc_value(f"feedexport/success_count/{slot_type}") def _start_new_batch( self, @@ -644,7 +633,7 @@ class FeedExporter: uri_params = self._get_uri_params( spider, self.feeds[slot.uri_template]["uri_params"], slot ) - self._close_slot(slot, spider) + self._pending_close_coros.append(self._close_slot(slot, spider)) slots.append( self._start_new_batch( batch_id=slot.batch_id + 1, @@ -660,7 +649,7 @@ class FeedExporter: def _load_components(self, setting_prefix: str) -> dict[str, Any]: conf = without_none_values( - cast(dict[str, str], self.settings.getwithbase(setting_prefix)) + cast("dict[str, str]", self.settings.getwithbase(setting_prefix)) ) d = {} for k, v in conf.items(): @@ -668,10 +657,10 @@ class FeedExporter: d[k] = load_object(v) return d - def _exporter_supported(self, format: str) -> bool: - if format in self.exporters: + def _exporter_supported(self, format_: str) -> bool: + if format_ in self.exporters: return True - logger.error("Unknown feed format: %(format)s", {"format": format}) + logger.error("Unknown feed format: %(format)s", {"format": format_}) return False def _settings_are_valid(self) -> bool: @@ -721,9 +710,7 @@ class FeedExporter: uri_params_function: str | UriParamsCallableT | None, slot: FeedSlot | None = None, ) -> dict[str, Any]: - params = {} - for k in dir(spider): - params[k] = getattr(spider, k) + params = {k: getattr(spider, k) for k in dir(spider)} utc_now = datetime.now(tz=timezone.utc) params["time"] = utc_now.replace(microsecond=0).isoformat().replace(":", "-") params["batch_time"] = utc_now.isoformat().replace(":", "-") diff --git a/scrapy/extensions/httpcache.py b/scrapy/extensions/httpcache.py index 0cd16d737..dbb79b02d 100644 --- a/scrapy/extensions/httpcache.py +++ b/scrapy/extensions/httpcache.py @@ -7,7 +7,7 @@ from email.utils import mktime_tz, parsedate_tz from importlib import import_module from pathlib import Path from time import time -from typing import IO, TYPE_CHECKING, Any, cast +from typing import IO, TYPE_CHECKING, Any, Concatenate, cast from weakref import WeakKeyDictionary from w3lib.http import headers_dict_to_raw, headers_raw_to_dict @@ -23,9 +23,6 @@ if TYPE_CHECKING: from collections.abc import Callable from types import ModuleType - # typing.Concatenate requires Python 3.10 - from typing_extensions import Concatenate - from scrapy.http.request import Request from scrapy.settings import BaseSettings from scrapy.spiders import Spider @@ -109,10 +106,10 @@ class RFC2616Policy: if b"max-age" in cc or b"Expires" in response.headers: return True # Firefox fallbacks this statuses to one year expiration if none is set - if response.status in (300, 301, 308): + if response.status in {300, 301, 308}: return True # Other statuses without expiration requires at least one validator - if response.status in (200, 203, 401): + if response.status in {200, 203, 401}: return b"Last-Modified" in response.headers or b"ETag" in response.headers # Any other is probably not eligible for caching # Makes no sense to cache responses that does not contain expiration @@ -219,7 +216,7 @@ class RFC2616Policy: return (date - lastmodified) / 10 # This request can be cached indefinitely - if response.status in (300, 301, 308): + if response.status in {300, 301, 308}: return self.MAXAGE # Insufficient information to compute freshness lifetime @@ -307,7 +304,7 @@ class DbmCacheStorage: if 0 < self.expiration_secs < time() - float(ts): return None # expired - return cast(dict[str, Any], pickle.loads(db[f"{key}_data"])) # noqa: S301 + return cast("dict[str, Any]", pickle.loads(db[f"{key}_data"])) # noqa: S301 class FilesystemCacheStorage: @@ -316,7 +313,9 @@ class FilesystemCacheStorage: self.expiration_secs: int = settings.getint("HTTPCACHE_EXPIRATION_SECS") self.use_gzip: bool = settings.getbool("HTTPCACHE_GZIP") # https://github.com/python/mypy/issues/10740 - self._open: Callable[Concatenate[str | os.PathLike, str, ...], IO[bytes]] = ( + self._open: Callable[ + Concatenate[str | os.PathLike[str], str, ...], IO[bytes] + ] = ( gzip.open if self.use_gzip else open # type: ignore[assignment] ) @@ -389,7 +388,7 @@ class FilesystemCacheStorage: if 0 < self.expiration_secs < time() - mtime: return None # expired with self._open(metapath, "rb") as f: - return cast(dict[str, Any], pickle.load(f)) # noqa: S301 + return cast("dict[str, Any]", pickle.load(f)) # noqa: S301 def parse_cachecontrol(header: bytes) -> dict[bytes, bytes | None]: diff --git a/scrapy/extensions/logcount.py b/scrapy/extensions/logcount.py new file mode 100644 index 000000000..e6d51a7d8 --- /dev/null +++ b/scrapy/extensions/logcount.py @@ -0,0 +1,48 @@ +from __future__ import annotations + +import logging +from typing import TYPE_CHECKING + +from scrapy import Spider, signals +from scrapy.utils.log import LogCounterHandler + +if TYPE_CHECKING: + # typing.Self requires Python 3.11 + from typing_extensions import Self + + from scrapy.crawler import Crawler + + +logger = logging.getLogger(__name__) + + +class LogCount: + """Install a log handler that counts log messages by level. + + The handler installed is :class:`scrapy.utils.log.LogCounterHandler`. + The counts are stored in stats as ``log_count/``. + + .. versionadded:: 2.14 + """ + + def __init__(self, crawler: Crawler): + self.crawler: Crawler = crawler + self.handler: LogCounterHandler | None = None + + @classmethod + def from_crawler(cls, crawler: Crawler) -> Self: + o = cls(crawler) + crawler.signals.connect(o.spider_opened, signal=signals.spider_opened) + crawler.signals.connect(o.spider_closed, signal=signals.spider_closed) + return o + + def spider_opened(self, spider: Spider) -> None: + self.handler = LogCounterHandler( + self.crawler, level=self.crawler.settings.get("LOG_LEVEL") + ) + logging.root.addHandler(self.handler) + + def spider_closed(self, spider: Spider, reason: str) -> None: + if self.handler: + logging.root.removeHandler(self.handler) + self.handler = None diff --git a/scrapy/extensions/logstats.py b/scrapy/extensions/logstats.py index 387cfddb3..3d7674905 100644 --- a/scrapy/extensions/logstats.py +++ b/scrapy/extensions/logstats.py @@ -5,10 +5,7 @@ from typing import TYPE_CHECKING from scrapy import Spider, signals from scrapy.exceptions import NotConfigured -from scrapy.utils.asyncio import ( - AsyncioLoopingCall, - create_looping_call, -) +from scrapy.utils.asyncio import AsyncioLoopingCall, create_looping_call if TYPE_CHECKING: from twisted.internet.task import LoopingCall diff --git a/scrapy/extensions/memdebug.py b/scrapy/extensions/memdebug.py index 3cbbb64e5..1fde6b296 100644 --- a/scrapy/extensions/memdebug.py +++ b/scrapy/extensions/memdebug.py @@ -36,12 +36,8 @@ class MemoryDebugger: def spider_closed(self, spider: Spider, reason: str) -> None: gc.collect() - self.stats.set_value( - "memdebug/gc_garbage_count", len(gc.garbage), spider=spider - ) + self.stats.set_value("memdebug/gc_garbage_count", len(gc.garbage)) for cls, wdict in live_refs.items(): if not wdict: continue - self.stats.set_value( - f"memdebug/live_refs/{cls.__name__}", len(wdict), spider=spider - ) + self.stats.set_value(f"memdebug/live_refs/{cls.__name__}", len(wdict)) diff --git a/scrapy/extensions/memusage.py b/scrapy/extensions/memusage.py index 2ef322f1a..1444c8941 100644 --- a/scrapy/extensions/memusage.py +++ b/scrapy/extensions/memusage.py @@ -9,17 +9,15 @@ from __future__ import annotations import logging import socket import sys +import warnings from importlib import import_module from pprint import pformat from typing import TYPE_CHECKING from scrapy import signals -from scrapy.exceptions import NotConfigured -from scrapy.mail import MailSender -from scrapy.utils.asyncio import ( - AsyncioLoopingCall, - create_looping_call, -) +from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning +from scrapy.utils.asyncio import AsyncioLoopingCall, create_looping_call +from scrapy.utils.defer import _schedule_coro from scrapy.utils.engine import get_engine_status if TYPE_CHECKING: @@ -41,18 +39,29 @@ class MemoryUsage: try: # stdlib's resource module is only available on unix platforms. self.resource = import_module("resource") - except ImportError: - raise NotConfigured + except ImportError as exc: + raise NotConfigured from exc self.crawler: Crawler = crawler self.warned: bool = False self.notify_mails: list[str] = crawler.settings.getlist("MEMUSAGE_NOTIFY_MAIL") + if self.notify_mails: # pragma: no cover + from scrapy.mail import MailSender # noqa: PLC0415 + + warnings.warn( + "The 'MEMUSAGE_NOTIFY_MAIL' setting is deprecated and will be removed " + "in a future release. Please use the 'memusage_warning_reached' and 'spider_closed' " + "signals to implement custom notifications.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + self.mail = MailSender.from_crawler(crawler) + self.limit: int = crawler.settings.getint("MEMUSAGE_LIMIT_MB") * 1024 * 1024 self.warning: int = crawler.settings.getint("MEMUSAGE_WARNING_MB") * 1024 * 1024 self.check_interval: float = crawler.settings.getfloat( "MEMUSAGE_CHECK_INTERVAL_SECONDS" ) - self.mail: MailSender = MailSender.from_crawler(crawler) crawler.signals.connect(self.engine_started, signal=signals.engine_started) crawler.signals.connect(self.engine_stopped, signal=signals.engine_stopped) @@ -104,7 +113,7 @@ class MemoryUsage: {"memusage": mem}, extra={"crawler": self.crawler}, ) - if self.notify_mails: + if self.notify_mails: # pragma: no cover subj = ( f"{self.crawler.settings['BOT_NAME']} terminated: " f"memory usage exceeded {mem}MiB at {socket.gethostname()}" @@ -113,11 +122,11 @@ class MemoryUsage: self.crawler.stats.set_value("memusage/limit_notified", 1) if self.crawler.engine.spider is not None: - self.crawler.engine.close_spider( - self.crawler.engine.spider, "memusage_exceeded" + _schedule_coro( + self.crawler.engine.close_spider_async(reason="memusage_exceeded") ) else: - self.crawler.stop() + _schedule_coro(self.crawler.stop_async()) else: logger.info( "Peak memory usage is %(virtualsize)dMiB", @@ -130,13 +139,14 @@ class MemoryUsage: assert self.crawler.stats if self.get_virtual_size() > self.warning: self.crawler.stats.set_value("memusage/warning_reached", 1) + self.crawler.signals.send_catch_log(signal=signals.memusage_warning_reached) mem = self.warning / 1024 / 1024 logger.warning( "Memory usage reached %(memusage)dMiB", {"memusage": mem}, extra={"crawler": self.crawler}, ) - if self.notify_mails: + if self.notify_mails: # pragma: no cover subj = ( f"{self.crawler.settings['BOT_NAME']} warning: " f"memory usage reached {mem}MiB at {socket.gethostname()}" @@ -145,7 +155,7 @@ class MemoryUsage: self.crawler.stats.set_value("memusage/warning_notified", 1) self.warned = True - def _send_report(self, rcpts: list[str], subject: str) -> None: + def _send_report(self, rcpts: list[str], subject: str) -> None: # pragma: no cover """send notification mail with some additional useful info""" assert self.crawler.engine assert self.crawler.stats diff --git a/scrapy/extensions/periodic_log.py b/scrapy/extensions/periodic_log.py index 98210990a..cd35c8165 100644 --- a/scrapy/extensions/periodic_log.py +++ b/scrapy/extensions/periodic_log.py @@ -6,13 +6,11 @@ from typing import TYPE_CHECKING, Any from scrapy import Spider, signals from scrapy.exceptions import NotConfigured -from scrapy.utils.asyncio import ( - AsyncioLoopingCall, - create_looping_call, -) +from scrapy.utils.asyncio import AsyncioLoopingCall, create_looping_call from scrapy.utils.serialize import ScrapyJSONEncoder if TYPE_CHECKING: + from collections.abc import Sequence from json import JSONEncoder from twisted.internet.task import LoopingCall @@ -34,8 +32,8 @@ class PeriodicLog: self, stats: StatsCollector, interval: float = 60.0, - ext_stats: dict[str, Any] = {}, - ext_delta: dict[str, Any] = {}, + ext_stats: dict[str, Any] | None = None, + ext_delta: dict[str, Any] | None = None, ext_timing_enabled: bool = False, ): self.stats: StatsCollector = stats @@ -44,11 +42,19 @@ class PeriodicLog: self.task: AsyncioLoopingCall | LoopingCall | None = None self.encoder: JSONEncoder = ScrapyJSONEncoder(sort_keys=True, indent=4) self.ext_stats_enabled: bool = bool(ext_stats) - self.ext_stats_include: list[str] = ext_stats.get("include", []) - self.ext_stats_exclude: list[str] = ext_stats.get("exclude", []) + self.ext_stats_include: Sequence[str] = ( + ext_stats.get("include", ()) if ext_stats else () + ) + self.ext_stats_exclude: Sequence[str] = ( + ext_stats.get("exclude", ()) if ext_stats else () + ) self.ext_delta_enabled: bool = bool(ext_delta) - self.ext_delta_include: list[str] = ext_delta.get("include", []) - self.ext_delta_exclude: list[str] = ext_delta.get("exclude", []) + self.ext_delta_include: Sequence[str] = ( + ext_delta.get("include", ()) if ext_delta else () + ) + self.ext_delta_exclude: Sequence[str] = ( + ext_delta.get("exclude", ()) if ext_delta else () + ) self.ext_timing_enabled: bool = ext_timing_enabled @classmethod @@ -146,7 +152,7 @@ class PeriodicLog: return {"stats": stats} def param_allowed( - self, stat_name: str, include: list[str], exclude: list[str] + self, stat_name: str, include: Sequence[str], exclude: Sequence[str] ) -> bool: if not include and not exclude: return True diff --git a/scrapy/extensions/postprocessing.py b/scrapy/extensions/postprocessing.py index b1fa160c8..5828ae52e 100644 --- a/scrapy/extensions/postprocessing.py +++ b/scrapy/extensions/postprocessing.py @@ -92,14 +92,14 @@ class LZMAPlugin: self.file = file self.feed_options = feed_options - format = self.feed_options.get("lzma_format") + format_ = self.feed_options.get("lzma_format") check = self.feed_options.get("lzma_check", -1) preset = self.feed_options.get("lzma_preset") filters = self.feed_options.get("lzma_filters") self.lzmafile = LZMAFile( filename=self.file, mode="wb", - format=format, + format=format_, check=check, preset=preset, filters=filters, @@ -142,7 +142,7 @@ class PostProcessingManager(IOBase): :return: returns number of bytes written :rtype: int """ - return cast(int, self.head_plugin.write(data)) + return cast("int", self.head_plugin.write(data)) def tell(self) -> int: return self.file.tell() diff --git a/scrapy/extensions/statsmailer.py b/scrapy/extensions/statsmailer.py index 221628642..f05595806 100644 --- a/scrapy/extensions/statsmailer.py +++ b/scrapy/extensions/statsmailer.py @@ -6,10 +6,11 @@ Use STATSMAILER_RCPTS setting to enable and give the recipient mail address from __future__ import annotations +import warnings from typing import TYPE_CHECKING from scrapy import Spider, signals -from scrapy.exceptions import NotConfigured +from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.mail import MailSender if TYPE_CHECKING: @@ -21,6 +22,13 @@ if TYPE_CHECKING: from scrapy.crawler import Crawler from scrapy.statscollectors import StatsCollector +warnings.warn( + "The scrapy.extensions.statsmailer module is deprecated and will be " + "removed in a future release.", + stacklevel=2, + category=ScrapyDeprecationWarning, +) + class StatsMailer: def __init__(self, stats: StatsCollector, recipients: list[str], mail: MailSender): @@ -40,7 +48,7 @@ class StatsMailer: return o def spider_closed(self, spider: Spider) -> Deferred[None] | None: - spider_stats = self.stats.get_stats(spider) + spider_stats = self.stats.get_stats() body = "Global stats\n\n" body += "\n".join(f"{k:<50} : {v}" for k, v in self.stats.get_stats().items()) body += f"\n\n{spider.name} stats\n\n" diff --git a/scrapy/extensions/telnet.py b/scrapy/extensions/telnet.py index bacee8f0a..3be24c53f 100644 --- a/scrapy/extensions/telnet.py +++ b/scrapy/extensions/telnet.py @@ -12,17 +12,18 @@ import os import pprint from typing import TYPE_CHECKING, Any +from twisted.conch import telnet +from twisted.conch.insults import insults from twisted.internet import protocol +from twisted.internet.defer import fail, succeed from scrapy import signals from scrapy.exceptions import NotConfigured -from scrapy.utils.decorators import defers from scrapy.utils.engine import print_engine_status from scrapy.utils.reactor import listen_tcp from scrapy.utils.trackref import print_live_refs if TYPE_CHECKING: - from twisted.conch import telnet from twisted.internet.tcp import Port # typing.Self requires Python 3.11 @@ -43,6 +44,12 @@ class TelnetConsole(protocol.ServerFactory): if not crawler.settings.getbool("TELNETCONSOLE_ENABLED"): raise NotConfigured + if not crawler.settings.getbool("TWISTED_REACTOR_ENABLED"): + raise NotConfigured( + "The TelnetConsole extension requires a Twisted reactor." + " You can set the TELNETCONSOLE_ENABLED setting to False to remove this warning." + ) + self.crawler: Crawler = crawler self.noisy: bool = False self.portrange: list[int] = [ @@ -76,25 +83,22 @@ class TelnetConsole(protocol.ServerFactory): self.port.stopListening() def protocol(self) -> telnet.TelnetTransport: - # these import twisted.internet.reactor - from twisted.conch import manhole, telnet - from twisted.conch.insults import insults - class Portal: """An implementation of IPortal""" - @defers - def login(self_, credentials, mind, *interfaces): # pylint: disable=no-self-argument + def login(self_, credentials, mind, *interfaces): # type: ignore[no-untyped-def] # pylint: disable=no-self-argument if not ( credentials.username == self.username.encode("utf8") and credentials.checkPassword(self.password.encode("utf8")) ): - raise ValueError("Invalid credentials") + return fail(ValueError("Invalid credentials")) + + from twisted.conch import manhole protocol = telnet.TelnetBootstrapProtocol( insults.ServerProtocol, manhole.Manhole, self._get_telnet_vars() ) - return (interfaces[0], protocol, lambda: None) + return succeed((interfaces[0], protocol, lambda: None)) return telnet.TelnetTransport(telnet.AuthenticatingTelnetProtocol, Portal()) diff --git a/scrapy/http/__init__.py b/scrapy/http/__init__.py index 0e5c2b53b..e20e894ae 100644 --- a/scrapy/http/__init__.py +++ b/scrapy/http/__init__.py @@ -5,9 +5,11 @@ Use this module (instead of the more specific ones) when importing Headers, Request and Response outside this module. """ +from warnings import catch_warnings, filterwarnings + +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http.headers import Headers from scrapy.http.request import Request -from scrapy.http.request.form import FormRequest from scrapy.http.request.json_request import JsonRequest from scrapy.http.request.rpc import XmlRpcRequest from scrapy.http.response import Response @@ -15,6 +17,19 @@ from scrapy.http.response.html import HtmlResponse from scrapy.http.response.json import JsonResponse from scrapy.http.response.text import TextResponse from scrapy.http.response.xml import XmlResponse +from scrapy.utils.deprecate import create_deprecated_class + +with catch_warnings(): + filterwarnings("ignore", category=ScrapyDeprecationWarning) + + from scrapy.http.request.form import FormRequest as _FormRequest + + FormRequest = create_deprecated_class( + name="FormRequest", + new_class=_FormRequest, + subclass_warn_message="{cls} inherits from deprecated class {old}, use the form2request library instead.", + instance_warn_message="{cls} is deprecated, use the form2request library instead.", + ) __all__ = [ "FormRequest", diff --git a/scrapy/http/cookies.py b/scrapy/http/cookies.py index b7c3b9d37..599f20947 100644 --- a/scrapy/http/cookies.py +++ b/scrapy/http/cookies.py @@ -54,14 +54,14 @@ class CookieJar: if not IPV4_RE.search(req_host): hosts = potential_domain_matches(req_host) if "." not in req_host: - hosts += [req_host + ".local"] + hosts.append(req_host + ".local") else: hosts = [req_host] cookies = [] for host in hosts: if host in self.jar._cookies: # type: ignore[attr-defined] - cookies += self.jar._cookies_for_domain(host, wreq) # type: ignore[attr-defined] + cookies.extend(self.jar._cookies_for_domain(host, wreq)) # type: ignore[attr-defined] attrs = self.jar._cookie_attrs(cookies) # type: ignore[attr-defined] if attrs and not wreq.has_header("Cookie"): @@ -161,7 +161,7 @@ class WrappedRequest: HTML document, and the user had no option to approve the automatic fetching of the image, this should be true. """ - return cast(bool, self.request.meta.get("is_unverifiable", False)) + return cast("bool", self.request.meta.get("is_unverifiable", False)) @property def full_url(self) -> str: @@ -181,7 +181,7 @@ class WrappedRequest: @property def origin_req_host(self) -> str: - return cast(str, urlparse_cached(self.request).hostname) + return cast("str", urlparse_cached(self.request).hostname) def has_header(self, name: str) -> bool: return name in self.request.headers diff --git a/scrapy/http/headers.py b/scrapy/http/headers.py index 60b04753b..34d4ec6f2 100644 --- a/scrapy/http/headers.py +++ b/scrapy/http/headers.py @@ -1,7 +1,7 @@ from __future__ import annotations from collections.abc import Mapping -from typing import TYPE_CHECKING, Any, AnyStr, Union, cast +from typing import TYPE_CHECKING, Any, AnyStr, TypeAlias, cast from w3lib.http import headers_dict_to_raw @@ -15,7 +15,7 @@ if TYPE_CHECKING: from typing_extensions import Self -_RawValueT = Union[bytes, str, int] +_RawValue: TypeAlias = bytes | str | int # isn't fully compatible typing-wise with either dict or CaselessDict, @@ -44,9 +44,9 @@ class Headers(CaselessDict): """Normalize key to bytes""" return self._tobytes(key.title()) - def normvalue(self, value: _RawValueT | Iterable[_RawValueT]) -> list[bytes]: + def normvalue(self, value: _RawValue | Iterable[_RawValue]) -> list[bytes]: """Normalize values to bytes""" - _value: Iterable[_RawValueT] + _value: Iterable[_RawValue] if value is None: _value = [] elif isinstance(value, (str, bytes)): @@ -58,7 +58,7 @@ class Headers(CaselessDict): return [self._tobytes(x) for x in _value] - def _tobytes(self, x: _RawValueT) -> bytes: + def _tobytes(self, x: _RawValue) -> bytes: if isinstance(x, bytes): return x if isinstance(x, str): @@ -69,33 +69,33 @@ class Headers(CaselessDict): def __getitem__(self, key: AnyStr) -> bytes | None: try: - return cast(list[bytes], super().__getitem__(key))[-1] + return cast("list[bytes]", super().__getitem__(key))[-1] except IndexError: return None def get(self, key: AnyStr, def_val: Any = None) -> bytes | None: try: - return cast(list[bytes], super().get(key, def_val))[-1] + return cast("list[bytes]", super().get(key, def_val))[-1] except IndexError: return None def getlist(self, key: AnyStr, def_val: Any = None) -> list[bytes]: try: - return cast(list[bytes], super().__getitem__(key)) + return cast("list[bytes]", super().__getitem__(key)) except KeyError: if def_val is not None: return self.normvalue(def_val) return [] - def setlist(self, key: AnyStr, list_: Iterable[_RawValueT]) -> None: + def setlist(self, key: AnyStr, list_: Iterable[_RawValue]) -> None: self[key] = list_ def setlistdefault( - self, key: AnyStr, default_list: Iterable[_RawValueT] = () + self, key: AnyStr, default_list: Iterable[_RawValue] = () ) -> Any: return self.setdefault(key, default_list) - def appendlist(self, key: AnyStr, value: Iterable[_RawValueT]) -> None: + def appendlist(self, key: AnyStr, value: Iterable[_RawValue]) -> None: lst = self.getlist(key) lst.extend(self.normvalue(value)) self[key] = lst @@ -124,6 +124,17 @@ class Headers(CaselessDict): for key, value in self.items() ) + def to_tuple_list(self) -> list[tuple[str, str]]: + """Return headers as a list of ``(key, value)`` tuples. + + Multiple values are represented as multiple tuples with the same key. + """ + return [ + (key.decode(self.encoding), value.decode(self.encoding)) + for key, values in self.items() + for value in values + ] + def __copy__(self) -> Self: return self.__class__(self) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index 2b8d0ab84..7db648a45 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -12,10 +12,11 @@ from typing import ( TYPE_CHECKING, Any, AnyStr, + Concatenate, NoReturn, + TypeAlias, TypedDict, TypeVar, - Union, overload, ) @@ -33,13 +34,13 @@ if TYPE_CHECKING: from twisted.python.failure import Failure - # typing.Concatenate requires Python 3.10 # typing.NotRequired and typing.Self require Python 3.11 - from typing_extensions import Concatenate, NotRequired, Self + from typing_extensions import NotRequired, Self + # circular import from scrapy.http import Response - CallbackT = Callable[Concatenate[Response, ...], Any] + CallbackT: TypeAlias = Callable[Concatenate[Response, ...], Any] class VerboseCookie(TypedDict): @@ -50,7 +51,7 @@ class VerboseCookie(TypedDict): secure: NotRequired[bool] -CookiesT = Union[dict[str, str], list[VerboseCookie]] +CookiesT: TypeAlias = dict[str, str] | list[VerboseCookie] RequestTypeVar = TypeVar("RequestTypeVar", bound="Request") @@ -85,20 +86,17 @@ class Request(object_ref): executed by the Downloader, thus generating a :class:`~scrapy.http.Response`. """ + __attrs_and_slots = ("callback", "dont_filter", "errback", "method", "priority") attributes: tuple[str, ...] = ( "url", - "callback", - "method", "headers", "body", "cookies", "meta", "encoding", - "priority", - "dont_filter", - "errback", "flags", "cb_kwargs", + *__attrs_and_slots, ) """A tuple of :class:`str` objects containing the name of all public attributes of the class that are also keyword parameters of the @@ -108,6 +106,20 @@ class Request(object_ref): :func:`~scrapy.utils.request.request_from_dict`. """ + __slots__ = ( + "__weakref__", + "_body", + "_cb_kwargs", + "_cookies", + "_encoding", + "_flags", + "_headers", + "_meta", + "_url", + *__attrs_and_slots, + ) + del __attrs_and_slots + def __init__( self, url: str, @@ -126,6 +138,7 @@ class Request(object_ref): ) -> None: self._encoding: str = encoding # this one has to be set first self.method: str = str(method).upper() + self._meta: dict[str, Any] | None = dict(meta) if meta else None self._set_url(url) self._set_body(body) if not isinstance(priority, int): @@ -188,25 +201,40 @@ class Request(object_ref): #: .. seealso:: :ref:`topics-request-response-ref-errbacks` self.errback: Callable[[Failure], Any] | None = errback - self.cookies: CookiesT = cookies or {} - self.headers: Headers = Headers(headers or {}, encoding=encoding) + self._cookies: CookiesT | None = cookies or None + self._headers: Headers | None = ( + Headers(headers, encoding=encoding) if headers else None + ) #: Whether this request may be filtered out by :ref:`components #: ` that support filtering out requests (``False``, #: default), or those components should not filter out this request #: (``True``). #: - #: This attribute is commonly set to ``True`` to prevent duplicate - #: requests from being filtered out. + #: The following built-in components check this attribute: + #: + #: - The :ref:`scheduler ` uses it to skip + #: duplicate request filtering (see + #: :setting:`DUPEFILTER_CLASS`). When set to ``True``, the + #: request is not checked against the duplicate filter, + #: allowing requests that would otherwise be considered duplicates + #: to be scheduled multiple times. + #: - :class:`~scrapy.downloadermiddlewares.offsite.OffsiteMiddleware` + #: uses it to allow requests to domains not in + #: :attr:`~scrapy.Spider.allowed_domains`. To skip only the offsite + #: filter without affecting other components, consider using the + #: :reqmeta:`allow_offsite` request meta key instead. + #: + #: Third-party components may also use this attribute to decide whether + #: to filter out a request. #: #: When defining the start URLs of a spider through #: :attr:`~scrapy.Spider.start_urls`, this attribute is enabled by #: default. See :meth:`~scrapy.Spider.start`. self.dont_filter: bool = dont_filter - self._meta: dict[str, Any] | None = dict(meta) if meta else None self._cb_kwargs: dict[str, Any] | None = dict(cb_kwargs) if cb_kwargs else None - self.flags: list[str] = [] if flags is None else list(flags) + self._flags: list[str] | None = list(flags) if flags else None @property def cb_kwargs(self) -> dict[str, Any]: @@ -224,11 +252,17 @@ class Request(object_ref): def url(self) -> str: return self._url + def _url_is_verbatim(self) -> bool: + return bool(self._meta and self._meta.get("verbatim_url")) + def _set_url(self, url: str) -> None: if not isinstance(url, str): raise TypeError(f"Request url must be str, got {type(url).__name__}") - self._url = safe_url_string(url, self.encoding) + if self._url_is_verbatim(): + self._url = url + else: + self._url = safe_url_string(url, self.encoding) if ( "://" not in self._url @@ -242,12 +276,49 @@ class Request(object_ref): return self._body def _set_body(self, body: str | bytes | None) -> None: - self._body = b"" if body is None else to_bytes(body, self.encoding) + self._body = b"" if not body else to_bytes(body, self.encoding) @property def encoding(self) -> str: return self._encoding + @property + def flags(self) -> list[str]: + if self._flags is None: + self._flags = [] + return self._flags + + @flags.setter + def flags(self, value: list[str] | None) -> None: + self._flags = value + + @property + def cookies(self) -> CookiesT: + if self._cookies is None: + self._cookies = {} + return self._cookies + + @cookies.setter + def cookies(self, value: CookiesT | None) -> None: + self._cookies = value + + @property + def headers(self) -> Headers: + if self._headers is None: + self._headers = Headers(encoding=self.encoding) + return self._headers + + @headers.setter + def headers( + self, value: Mapping[AnyStr, Any] | Iterable[tuple[AnyStr, Any]] | None + ) -> None: + if isinstance(value, Headers): + self._headers = value + else: + self._headers = ( + Headers(value, encoding=self.encoding) if value is not None else None + ) + def __repr__(self) -> str: return f"<{self.method} {self.url}>" diff --git a/scrapy/http/request/form.py b/scrapy/http/request/form.py index 7681419c4..4da595b22 100644 --- a/scrapy/http/request/form.py +++ b/scrapy/http/request/form.py @@ -8,35 +8,46 @@ See documentation in docs/topics/request-response.rst from __future__ import annotations from collections.abc import Iterable -from typing import TYPE_CHECKING, Any, Optional, Union, cast +from typing import TYPE_CHECKING, Any, ClassVar, TypeAlias, cast from urllib.parse import urlencode, urljoin, urlsplit, urlunsplit +from warnings import warn -from lxml.html import ( - FormElement, - InputElement, - MultipleSelectOptions, - SelectElement, - TextareaElement, -) +from parsel.csstranslator import HTMLTranslator from w3lib.html import strip_html5_whitespace +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http.request import Request from scrapy.utils.python import is_listlike, to_bytes if TYPE_CHECKING: # typing.Self requires Python 3.11 + from lxml.html import ( + FormElement, + InputElement, + MultipleSelectOptions, + SelectElement, + TextareaElement, + ) from typing_extensions import Self from scrapy.http.response.text import TextResponse +warn( + "The entire scrapy.http.request.form module is deprecated. Use the " + "form2request library instead.", + ScrapyDeprecationWarning, + stacklevel=2, +) -FormdataVType = Union[str, Iterable[str]] -FormdataKVType = tuple[str, FormdataVType] -FormdataType = Optional[Union[dict[str, FormdataVType], list[FormdataKVType]]] +FormdataVType: TypeAlias = str | Iterable[str] +FormdataKVType: TypeAlias = tuple[str, FormdataVType] +FormdataType: TypeAlias = dict[str, FormdataVType] | list[FormdataKVType] | None class FormRequest(Request): - valid_form_methods = ["GET", "POST"] + __slots__ = () + + valid_form_methods: ClassVar[list[str]] = ["GET", "POST"] def __init__( self, *args: Any, formdata: FormdataType = None, **kwargs: Any @@ -76,8 +87,6 @@ class FormRequest(Request): kwargs.setdefault("encoding", response.encoding) if formcss is not None: - from parsel.csstranslator import HTMLTranslator - formxpath = HTMLTranslator().css_to_xpath(formcss) form = _get_form(response, formname, formid, formnumber, formxpath) @@ -107,7 +116,7 @@ def _urlencode(seq: Iterable[FormdataKVType], enc: str) -> str: values = [ (to_bytes(k, enc), to_bytes(v, enc)) for k, vs in seq - for v in (cast(Iterable[str], vs) if is_listlike(vs) else [cast(str, vs)]) + for v in (vs if is_listlike(vs) else [cast("str", vs)]) ] return urlencode(values, doseq=True) @@ -128,12 +137,12 @@ def _get_form( if formname is not None: f = root.xpath(f'//form[@name="{formname}"]') if f: - return cast(FormElement, f[0]) + return cast("FormElement", f[0]) if formid is not None: f = root.xpath(f'//form[@id="{formid}"]') if f: - return cast(FormElement, f[0]) + return cast("FormElement", f[0]) # Get form element from xpath, if not found, go up if formxpath is not None: @@ -142,7 +151,7 @@ def _get_form( el = nodes[0] while True: if el.tag == "form": - return cast(FormElement, el) + return cast("FormElement", el) el = el.getparent() if el is None: break @@ -152,8 +161,8 @@ def _get_form( try: form = forms[formnumber] except IndexError: - raise IndexError(f"Form number {formnumber} not found in {response}") - return cast(FormElement, form) + raise IndexError(f"Form number {formnumber} not found in {response}") from None + return cast("FormElement", form) def _get_inputs( @@ -166,7 +175,7 @@ def _get_inputs( try: formdata_keys = dict(formdata or ()).keys() except (ValueError, TypeError): - raise ValueError("formdata should be a dict or iterable of tuples") + raise ValueError("formdata should be a dict or iterable of tuples") from None if not formdata: formdata = [] @@ -201,7 +210,7 @@ def _value( n = ele.name v = ele.value if ele.tag == "select": - return _select_value(cast(SelectElement, ele), n, v) + return _select_value(cast("SelectElement", ele), n, v) return n, v @@ -251,7 +260,7 @@ def _get_clickable( except IndexError: pass else: - return (el.get("name"), el.get("value") or "") + return (cast("str", el.get("name")), el.get("value") or "") # We didn't find it, so now we build an XPath expression out of the other # arguments, because they can be used as such diff --git a/scrapy/http/request/json_request.py b/scrapy/http/request/json_request.py index e26cbe05b..13fee06d8 100644 --- a/scrapy/http/request/json_request.py +++ b/scrapy/http/request/json_request.py @@ -20,6 +20,8 @@ if TYPE_CHECKING: class JsonRequest(Request): + __slots__ = ("_dumps_kwargs",) + attributes: tuple[str, ...] = (*Request.attributes, "dumps_kwargs") def __init__( @@ -34,7 +36,9 @@ class JsonRequest(Request): data_passed: bool = data is not None if body_passed and data_passed: - warnings.warn("Both body and data passed. data will be ignored") + warnings.warn( + "Both body and data passed. data will be ignored", stacklevel=2 + ) elif not body_passed and data_passed: kwargs["body"] = self._dumps(data) if "method" not in kwargs: @@ -66,7 +70,9 @@ class JsonRequest(Request): data_passed: bool = data is not None if body_passed and data_passed: - warnings.warn("Both body and data passed. data will be ignored") + warnings.warn( + "Both body and data passed. data will be ignored", stacklevel=2 + ) elif not body_passed and data_passed: kwargs["body"] = self._dumps(data) diff --git a/scrapy/http/request/rpc.py b/scrapy/http/request/rpc.py index 01fe740a8..c68c8aabd 100644 --- a/scrapy/http/request/rpc.py +++ b/scrapy/http/request/rpc.py @@ -21,6 +21,8 @@ DUMPS_ARGS = get_func_args(xmlrpclib.dumps) class XmlRpcRequest(Request): + __slots__ = () + def __init__(self, *args: Any, encoding: str | None = None, **kwargs: Any): if "body" not in kwargs and "params" in kwargs: kw = {k: kwargs.pop(k) for k in DUMPS_ARGS if k in kwargs} diff --git a/scrapy/http/response/__init__.py b/scrapy/http/response/__init__.py index de2188ceb..09b1c8b32 100644 --- a/scrapy/http/response/__init__.py +++ b/scrapy/http/response/__init__.py @@ -20,7 +20,6 @@ if TYPE_CHECKING: from collections.abc import Callable, Iterable, Mapping from ipaddress import IPv4Address, IPv6Address - from twisted.internet.ssl import Certificate from twisted.python.failure import Failure # typing.Self requires Python 3.11 @@ -38,17 +37,20 @@ class Response(object_ref): downloaded (by the Downloader) and fed to the Spiders for processing. """ - attributes: tuple[str, ...] = ( - "url", + __attrs_and_slots = ( "status", - "headers", - "body", - "flags", "request", "certificate", "ip_address", "protocol", ) + attributes: tuple[str, ...] = ( + "url", + "headers", + "body", + "flags", + *__attrs_and_slots, + ) """A tuple of :class:`str` objects containing the name of all public attributes of the class that are also keyword parameters of the ``__init__()`` method. @@ -56,6 +58,16 @@ class Response(object_ref): Currently used by :meth:`Response.replace`. """ + __slots__ = ( + "__weakref__", + "_url", + "_body", + "_headers", + "_flags", + *__attrs_and_slots, + ) + del __attrs_and_slots + def __init__( self, url: str, @@ -64,17 +76,17 @@ class Response(object_ref): body: bytes = b"", flags: list[str] | None = None, request: Request | None = None, - certificate: Certificate | None = None, + certificate: Any = None, ip_address: IPv4Address | IPv6Address | None = None, protocol: str | None = None, ): - self.headers: Headers = Headers(headers or {}) + self._headers: Headers | None = Headers(headers) if headers else None self.status: int = int(status) self._set_body(body) self._set_url(url) self.request: Request | None = request - self.flags: list[str] = [] if flags is None else list(flags) - self.certificate: Certificate | None = certificate + self._flags: list[str] | None = list(flags) if flags else None + self.certificate: Any = certificate self.ip_address: IPv4Address | IPv6Address | None = ip_address self.protocol: str | None = protocol @@ -86,7 +98,7 @@ class Response(object_ref): raise AttributeError( "Response.cb_kwargs not available, this response " "is not tied to any request" - ) + ) from None @property def meta(self) -> dict[str, Any]: @@ -95,7 +107,7 @@ class Response(object_ref): except AttributeError: raise AttributeError( "Response.meta not available, this response is not tied to any request" - ) + ) from None @property def url(self) -> str: @@ -125,6 +137,31 @@ class Response(object_ref): else: self._body = body + @property + def headers(self) -> Headers: + if self._headers is None: + self._headers = Headers() + return self._headers + + @headers.setter + def headers( + self, value: Mapping[AnyStr, Any] | Iterable[tuple[AnyStr, Any]] | None + ) -> None: + if isinstance(value, Headers): + self._headers = value + else: + self._headers = Headers(value) if value is not None else None + + @property + def flags(self) -> list[str]: + if self._flags is None: + self._flags = [] + return self._flags + + @flags.setter + def flags(self, value: list[str] | None) -> None: + self._flags = value + def __repr__(self) -> str: return f"<{self.status} {self.url}>" @@ -205,9 +242,6 @@ class Response(object_ref): :class:`~.TextResponse` provides a :meth:`~.TextResponse.follow` method which supports selectors in addition to absolute/relative URLs and Link objects. - - .. versionadded:: 2.0 - The *flags* parameter. """ if encoding is None: raise ValueError("encoding can't be None") @@ -250,8 +284,6 @@ class Response(object_ref): flags: list[str] | None = None, ) -> Iterable[Request]: """ - .. versionadded:: 2.0 - Return an iterable of :class:`~.Request` instances to follow all links in ``urls``. It accepts the same arguments as ``Request.__init__()`` method, but elements of ``urls`` can be relative URLs or :class:`~scrapy.link.Link` objects, diff --git a/scrapy/http/response/html.py b/scrapy/http/response/html.py index 7eed052c2..70c08c11d 100644 --- a/scrapy/http/response/html.py +++ b/scrapy/http/response/html.py @@ -9,4 +9,4 @@ from scrapy.http.response.text import TextResponse class HtmlResponse(TextResponse): - pass + __slots__ = () diff --git a/scrapy/http/response/json.py b/scrapy/http/response/json.py index 219691094..0428dde6e 100644 --- a/scrapy/http/response/json.py +++ b/scrapy/http/response/json.py @@ -9,4 +9,4 @@ from scrapy.http.response.text import TextResponse class JsonResponse(TextResponse): - pass + __slots__ = () diff --git a/scrapy/http/response/text.py b/scrapy/http/response/text.py index 081223882..6876e35e8 100644 --- a/scrapy/http/response/text.py +++ b/scrapy/http/response/text.py @@ -41,15 +41,22 @@ _NONE = object() class TextResponse(Response): _DEFAULT_ENCODING = "ascii" - _cached_decoded_json = _NONE attributes: tuple[str, ...] = (*Response.attributes, "encoding") + __slots__ = ( + "_cached_benc", + "_cached_decoded_json", + "_cached_selector", + "_cached_ubody", + "_encoding", + ) def __init__(self, *args: Any, **kwargs: Any): self._encoding: str | None = kwargs.pop("encoding", None) self._cached_benc: str | None = None self._cached_ubody: str | None = None self._cached_selector: Selector | None = None + self._cached_decoded_json: object = _NONE super().__init__(*args, **kwargs) def _set_body(self, body: str | bytes | None) -> None: @@ -77,11 +84,7 @@ class TextResponse(Response): ) def json(self) -> Any: - """ - .. versionadded:: 2.2 - - Deserialize a JSON document to a Python object. - """ + """Deserialize a JSON document to a Python object.""" if self._cached_decoded_json is _NONE: self._cached_decoded_json = json.loads(self.body) return self._cached_decoded_json @@ -104,13 +107,14 @@ class TextResponse(Response): @memoizemethod_noargs def _headers_encoding(self) -> str | None: - content_type = cast(bytes, self.headers.get(b"Content-Type", b"")) + content_type = self.headers.get(b"Content-Type") or b"" return http_content_type_encoding(to_unicode(content_type, encoding="latin-1")) def _body_inferred_encoding(self) -> str: if self._cached_benc is None: content_type = to_unicode( - cast(bytes, self.headers.get(b"Content-Type", b"")), encoding="latin-1" + cast("bytes", self.headers.get(b"Content-Type", b"")), + encoding="latin-1", ) benc, ubody = html_to_unicode( content_type, @@ -141,31 +145,25 @@ class TextResponse(Response): @property def selector(self) -> Selector: - from scrapy.selector import Selector - if self._cached_selector is None: + # circular import + from scrapy.selector import Selector # noqa: PLC0415 + self._cached_selector = Selector(self) return self._cached_selector def jmespath(self, query: str, **kwargs: Any) -> SelectorList: - from scrapy.selector import SelectorList - if not hasattr(self.selector, "jmespath"): raise AttributeError( "Please install parsel >= 1.8.1 to get jmespath support" ) - - return cast(SelectorList, self.selector.jmespath(query, **kwargs)) + return cast("SelectorList", self.selector.jmespath(query, **kwargs)) def xpath(self, query: str, **kwargs: Any) -> SelectorList: - from scrapy.selector import SelectorList - - return cast(SelectorList, self.selector.xpath(query, **kwargs)) + return cast("SelectorList", self.selector.xpath(query, **kwargs)) def css(self, query: str) -> SelectorList: - from scrapy.selector import SelectorList - - return cast(SelectorList, self.selector.css(query)) + return cast("SelectorList", self.selector.css(query)) def follow( self, @@ -222,7 +220,7 @@ class TextResponse(Response): def follow_all( self, - urls: Iterable[str | Link] | parsel.SelectorList | None = None, + urls: Iterable[str | Link] | parsel.SelectorList[Any] | None = None, callback: CallbackT | None = None, method: str = "GET", headers: Mapping[AnyStr, Any] | Iterable[tuple[AnyStr, Any]] | None = None, @@ -306,7 +304,7 @@ def _url_from_selector(sel: parsel.Selector) -> str: return strip_html5_whitespace(sel.root) if not hasattr(sel.root, "tag"): raise _InvalidSelector(f"Unsupported selector: {sel}") - if sel.root.tag not in ("a", "link"): + if sel.root.tag not in {"a", "link"}: raise _InvalidSelector( f"Only and elements are supported; got <{sel.root.tag}>" ) diff --git a/scrapy/http/response/xml.py b/scrapy/http/response/xml.py index abf474a2f..6d9c4cb73 100644 --- a/scrapy/http/response/xml.py +++ b/scrapy/http/response/xml.py @@ -9,4 +9,4 @@ from scrapy.http.response.text import TextResponse class XmlResponse(TextResponse): - pass + __slots__ = () diff --git a/scrapy/link.py b/scrapy/link.py index 9c272ab2f..046630403 100644 --- a/scrapy/link.py +++ b/scrapy/link.py @@ -39,7 +39,7 @@ class Link: def __eq__(self, other: object) -> bool: if not isinstance(other, Link): - raise NotImplementedError + return NotImplemented return ( self.url == other.url and self.text == other.text diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index 814e31fec..11fd62fb2 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -9,7 +9,7 @@ import operator import re from collections.abc import Callable, Iterable from functools import partial -from typing import TYPE_CHECKING, Any, Union, cast +from typing import TYPE_CHECKING, Any, TypeAlias, cast from urllib.parse import urljoin, urlparse from lxml import etree @@ -71,12 +71,12 @@ class LxmlParserLinkExtractor: self.scan_tag: Callable[[str], bool] = ( tag if callable(tag) - else cast(Callable[[str], bool], partial(operator.eq, tag)) + else cast("Callable[[str], bool]", partial(operator.eq, tag)) ) self.scan_attr: Callable[[str], bool] = ( attr if callable(attr) - else cast(Callable[[str], bool], partial(operator.eq, attr)) + else cast("Callable[[str], bool]", partial(operator.eq, attr)) ) self.process_attr: Callable[[Any], Any] = ( process if callable(process) else _identity @@ -84,7 +84,7 @@ class LxmlParserLinkExtractor: self.unique: bool = unique self.strip: bool = strip self.link_key: Callable[[Link], str] = ( - cast(Callable[[Link], str], operator.attrgetter("url")) + cast("Callable[[Link], str]", operator.attrgetter("url")) if canonicalized else _canonicalize_link_url ) @@ -110,12 +110,12 @@ class LxmlParserLinkExtractor: ) -> list[Link]: links: list[Link] = [] # hacky way to get the underlying lxml parsed document - for el, attr, attr_val in self._iter_links(selector.root): + for el, _, attr_val in self._iter_links(selector.root): # pseudo lxml.html.HtmlElement.make_links_absolute(base_url) try: if self.strip: - attr_val = strip_html5_whitespace(attr_val) - attr_val = urljoin(base_url, attr_val) + attr_val = strip_html5_whitespace(attr_val) # noqa: PLW2901 this is intended + attr_val = urljoin(base_url, attr_val) # noqa: PLW2901 except ValueError: continue # skipping bogus links else: @@ -157,8 +157,8 @@ class LxmlParserLinkExtractor: return links -_RegexT = Union[str, re.Pattern[str]] -_RegexOrSeveralT = Union[_RegexT, Iterable[_RegexT]] +_Regex: TypeAlias = str | re.Pattern[str] +_RegexOrSeveral: TypeAlias = _Regex | Iterable[_Regex] class LxmlLinkExtractor: @@ -166,8 +166,8 @@ class LxmlLinkExtractor: def __init__( self, - allow: _RegexOrSeveralT = (), - deny: _RegexOrSeveralT = (), + allow: _RegexOrSeveral = (), + deny: _RegexOrSeveral = (), allow_domains: str | Iterable[str] = (), deny_domains: str | Iterable[str] = (), restrict_xpaths: str | Iterable[str] = (), @@ -179,7 +179,7 @@ class LxmlLinkExtractor: deny_extensions: str | Iterable[str] | None = None, restrict_css: str | Iterable[str] = (), strip: bool = True, - restrict_text: _RegexOrSeveralT | None = None, + restrict_text: _RegexOrSeveral | None = None, ): tags, attrs = set(arg_to_iter(tags)), set(arg_to_iter(attrs)) self.link_extractor = LxmlParserLinkExtractor( @@ -208,7 +208,7 @@ class LxmlLinkExtractor: self.restrict_text: list[re.Pattern[str]] = self._compile_regexes(restrict_text) @staticmethod - def _compile_regexes(value: _RegexOrSeveralT | None) -> list[re.Pattern[str]]: + def _compile_regexes(value: _RegexOrSeveral | None) -> list[re.Pattern[str]]: return [ x if isinstance(x, re.Pattern) else re.compile(x) for x in arg_to_iter(value) @@ -245,7 +245,7 @@ class LxmlLinkExtractor: if self.allow_res else [True] ) - denied = (regex.search(url) for regex in self.deny_res) if self.deny_res else [] + denied = (regex.search(url) for regex in self.deny_res) if self.deny_res else () return any(allowed) and not any(denied) def _process_links(self, links: list[Link]) -> list[Link]: diff --git a/scrapy/loader/__init__.py b/scrapy/loader/__init__.py index 2f5c0343b..8ee7dc16c 100644 --- a/scrapy/loader/__init__.py +++ b/scrapy/loader/__init__.py @@ -27,7 +27,7 @@ class ItemLoader(itemloaders.ItemLoader): :param item: The item instance to populate using subsequent calls to :meth:`~ItemLoader.add_xpath`, :meth:`~ItemLoader.add_css`, or :meth:`~ItemLoader.add_value`. - :type item: scrapy.item.Item + :type item: :ref:`item object ` :param selector: The selector to extract data from, when using the :meth:`add_xpath`, :meth:`add_css`, :meth:`replace_xpath`, or diff --git a/scrapy/logformatter.py b/scrapy/logformatter.py index e81a9ec93..a50064e08 100644 --- a/scrapy/logformatter.py +++ b/scrapy/logformatter.py @@ -142,8 +142,6 @@ class LogFormatter: ) -> LogFormatterResult: """Logs a message when an item causes an error while it is passing through the item pipeline. - - .. versionadded:: 2.0 """ return { "level": logging.ERROR, @@ -160,10 +158,7 @@ class LogFormatter: response: Response | Failure, spider: Spider, ) -> LogFormatterResult: - """Logs an error message from a spider. - - .. versionadded:: 2.0 - """ + """Logs an error message from a spider.""" return { "level": logging.ERROR, "msg": SPIDERERRORMSG, @@ -182,8 +177,6 @@ class LogFormatter: ) -> LogFormatterResult: """Logs a download error message from a spider (typically coming from the engine). - - .. versionadded:: 2.0 """ args: dict[str, Any] = {"request": request} if errmsg: diff --git a/scrapy/mail.py b/scrapy/mail.py index be2423965..fbd11ad1d 100644 --- a/scrapy/mail.py +++ b/scrapy/mail.py @@ -23,6 +23,7 @@ from twisted.internet.defer import Deferred from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.misc import arg_to_iter from scrapy.utils.python import to_bytes +from scrapy.utils.reactorless import is_reactorless if TYPE_CHECKING: from collections.abc import Callable, Sequence @@ -35,7 +36,6 @@ if TYPE_CHECKING: from typing_extensions import Self from scrapy.crawler import Crawler - from scrapy.settings import BaseSettings logger = logging.getLogger(__name__) @@ -52,6 +52,14 @@ def _to_bytes_or_none(text: str | bytes | None) -> bytes | None: return to_bytes(text) +warnings.warn( + "The scrapy.mail module is deprecated and will be removed in a future release. " + "Please use a dedicated Python mail library instead.", + stacklevel=2, + category=ScrapyDeprecationWarning, +) + + class MailSender: def __init__( self, @@ -64,6 +72,8 @@ class MailSender: smtpssl: bool = False, debug: bool = False, ): + if is_reactorless(): # pragma: no cover + raise RuntimeError(f"{type(self).__name__} requires a Twisted reactor.") self.smtphost: str = smtphost self.smtpport: int = smtpport self.smtpuser: bytes | None = _to_bytes_or_none(smtpuser) @@ -74,20 +84,8 @@ class MailSender: self.debug: bool = debug @classmethod - def from_settings(cls, settings: BaseSettings) -> Self: - warnings.warn( - f"{cls.__name__}.from_settings() is deprecated, use from_crawler() instead.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - return cls._from_settings(settings) - - @classmethod - def from_crawler(cls, crawler: Crawler) -> Self: - return cls._from_settings(crawler.settings) - - @classmethod - def _from_settings(cls, settings: BaseSettings) -> Self: + def from_crawler(cls, crawler: Crawler) -> Self: # pragma: no cover + settings = crawler.settings return cls( smtphost=settings["MAIL_HOST"], mailfrom=settings["MAIL_FROM"], @@ -223,7 +221,8 @@ class MailSender: def _create_sender_factory( self, to_addrs: list[str], msg: IO[bytes], d: Deferred[Any] ) -> ESMTPSenderFactory: - from twisted.mail.smtp import ESMTPSenderFactory + # imports twisted.internet.reactor + from twisted.mail.smtp import ESMTPSenderFactory # noqa: PLC0415 factory_keywords: dict[str, Any] = { "heloFallback": True, diff --git a/scrapy/middleware.py b/scrapy/middleware.py index 2b67dcd21..37ec0f583 100644 --- a/scrapy/middleware.py +++ b/scrapy/middleware.py @@ -3,91 +3,96 @@ from __future__ import annotations import logging import pprint import warnings +from abc import ABC, abstractmethod from collections import defaultdict, deque -from typing import TYPE_CHECKING, Any, TypeVar, cast +from typing import TYPE_CHECKING, Any, Concatenate, ParamSpec, TypeVar, cast from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning -from scrapy.utils.defer import process_chain, process_parallel +from scrapy.utils.defer import ensure_awaitable +from scrapy.utils.deprecate import argument_is_required from scrapy.utils.misc import build_from_crawler, load_object +from scrapy.utils.python import global_object_name if TYPE_CHECKING: from collections.abc import Callable, Iterable from twisted.internet.defer import Deferred - # typing.Concatenate and typing.ParamSpec require Python 3.10 # typing.Self requires Python 3.11 - from typing_extensions import Concatenate, ParamSpec, Self + from typing_extensions import Self from scrapy import Spider from scrapy.crawler import Crawler - from scrapy.settings import BaseSettings, Settings - - _P = ParamSpec("_P") + from scrapy.settings import Settings logger = logging.getLogger(__name__) _T = TypeVar("_T") -_T2 = TypeVar("_T2") +_P = ParamSpec("_P") -class MiddlewareManager: +class MiddlewareManager(ABC): """Base class for implementing middleware managers""" - component_name = "foo middleware" + component_name: str + _compat_spider: Spider | None = None - def __init__(self, *middlewares: Any) -> None: - self.middlewares = middlewares + def __init__(self, *middlewares: Any, crawler: Crawler | None = None) -> None: + self.crawler: Crawler | None = crawler + if crawler is None: + warnings.warn( + f"MiddlewareManager.__init__() was called without the crawler argument" + f" when creating {global_object_name(self.__class__)}." + f" This is deprecated and the argument will be required in future Scrapy versions.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + self.middlewares: tuple[Any, ...] = middlewares # Only process_spider_output and process_spider_exception can be None. - # Only process_spider_output can be a tuple, and only until _async compatibility methods are removed. - self.methods: dict[str, deque[Callable | tuple[Callable, Callable] | None]] = ( - defaultdict(deque) - ) + self.methods: dict[str, deque[Callable[..., Any] | None]] = defaultdict(deque) + self._mw_methods_requiring_spider: set[Callable[..., Any]] = set() for mw in middlewares: self._add_middleware(mw) + @property + def _spider(self) -> Spider: + if self.crawler is not None: + if self.crawler.spider is None: + raise ValueError( + f"{type(self).__name__} needs to access self.crawler.spider but it is None." + ) + return self.crawler.spider + if self._compat_spider is not None: + return self._compat_spider + raise ValueError(f"{type(self).__name__} has no known Spider instance.") + + def _set_compat_spider(self, spider: Spider | None) -> None: + if spider is None or self.crawler is not None: + return + # printing a deprecation warning is the caller's responsibility + if self._compat_spider is None: + self._compat_spider = spider + elif self._compat_spider is not spider: + raise RuntimeError( + f"Different instances of Spider were passed to {type(self).__name__}:" + f" {self._compat_spider} and {spider}" + ) + @classmethod + @abstractmethod def _get_mwlist_from_settings(cls, settings: Settings) -> list[Any]: raise NotImplementedError - @staticmethod - def _build_from_settings(objcls: type[_T], settings: BaseSettings) -> _T: - if hasattr(objcls, "from_settings"): - instance = objcls.from_settings(settings) # type: ignore[attr-defined] - method_name = "from_settings" - else: - instance = objcls() - method_name = "__new__" - if instance is None: - raise TypeError(f"{objcls.__qualname__}.{method_name} returned None") - return cast(_T, instance) - - @classmethod - def from_settings(cls, settings: Settings, crawler: Crawler | None = None) -> Self: - warnings.warn( - f"{cls.__name__}.from_settings() is deprecated, use from_crawler() instead.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - return cls._from_settings(settings, crawler) - @classmethod def from_crawler(cls, crawler: Crawler) -> Self: - return cls._from_settings(crawler.settings, crawler) - - @classmethod - def _from_settings(cls, settings: Settings, crawler: Crawler | None = None) -> Self: - mwlist = cls._get_mwlist_from_settings(settings) + mwlist = cls._get_mwlist_from_settings(crawler.settings) middlewares = [] enabled = [] for clspath in mwlist: try: mwcls = load_object(clspath) - if crawler is not None: - mw = build_from_crawler(mwcls, crawler) - else: - mw = MiddlewareManager._build_from_settings(mwcls, settings) + mw = build_from_crawler(mwcls, crawler) middlewares.append(mw) enabled.append(clspath) except NotConfigured as e: @@ -106,30 +111,55 @@ class MiddlewareManager: }, extra={"crawler": crawler}, ) - return cls(*middlewares) + return cls(*middlewares, crawler=crawler) - def _add_middleware(self, mw: Any) -> None: - if hasattr(mw, "open_spider"): - self.methods["open_spider"].append(mw.open_spider) - if hasattr(mw, "close_spider"): - self.methods["close_spider"].appendleft(mw.close_spider) + def _add_middleware(self, mw: Any) -> None: # noqa: B027 + pass - def _process_parallel( - self, methodname: str, obj: _T, *args: Any - ) -> Deferred[list[_T2]]: - methods = cast( - "Iterable[Callable[Concatenate[_T, _P], _T2]]", self.methods[methodname] - ) - return process_parallel(methods, obj, *args) + def _check_mw_method_spider_arg(self, method: Callable[..., Any]) -> None: + if argument_is_required(method, "spider"): + warnings.warn( + f"{method.__qualname__}() requires a spider argument," + f" this is deprecated and the argument will not be passed in future Scrapy versions." + f" If you need to access the spider instance you can save the crawler instance" + f" passed to from_crawler() and use its spider attribute.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + self._mw_methods_requiring_spider.add(method) - def _process_chain(self, methodname: str, obj: _T, *args: Any) -> Deferred[_T]: + async def _process_chain( + self, + methodname: str, + obj: _T, + *args: Any, + add_spider: bool = False, + always_add_spider: bool = False, + warn_deferred: bool = False, + ) -> _T: methods = cast( "Iterable[Callable[Concatenate[_T, _P], _T]]", self.methods[methodname] ) - return process_chain(methods, obj, *args) + for method in methods: + warn = global_object_name(method) if warn_deferred else None + if always_add_spider or ( + add_spider and method in self._mw_methods_requiring_spider + ): + obj = await ensure_awaitable( + method(obj, *(*args, self._spider)), _warn=warn + ) + else: + obj = await ensure_awaitable(method(obj, *args), _warn=warn) + return obj - def open_spider(self, spider: Spider) -> Deferred[list[None]]: - return self._process_parallel("open_spider", spider) + def open_spider(self, spider: Spider) -> Deferred[list[None]]: # pragma: no cover + raise NotImplementedError( + "MiddlewareManager.open_spider() is no longer implemented" + " and will be removed in a future Scrapy version." + ) - def close_spider(self, spider: Spider) -> Deferred[list[None]]: - return self._process_parallel("close_spider", spider) + def close_spider(self, spider: Spider) -> Deferred[list[None]]: # pragma: no cover + raise NotImplementedError( + "MiddlewareManager.close_spider() is no longer implemented" + " and will be removed in a future Scrapy version." + ) diff --git a/scrapy/pipelines/__init__.py b/scrapy/pipelines/__init__.py index 01f8bd2c8..84fb5f85e 100644 --- a/scrapy/pipelines/__init__.py +++ b/scrapy/pipelines/__init__.py @@ -6,14 +6,23 @@ See documentation in docs/item-pipeline.rst from __future__ import annotations -from typing import TYPE_CHECKING, Any +import asyncio +import warnings +from typing import TYPE_CHECKING, Any, cast +from twisted.internet.defer import Deferred, DeferredList, FirstError + +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.middleware import MiddlewareManager +from scrapy.utils.asyncio import is_asyncio_available from scrapy.utils.conf import build_component_list -from scrapy.utils.defer import deferred_f_from_coro_f +from scrapy.utils.defer import _maybeDeferred_coro, deferred_from_coro, ensure_awaitable +from scrapy.utils.python import global_object_name if TYPE_CHECKING: - from twisted.internet.defer import Deferred + from collections.abc import Awaitable, Callable, Coroutine, Iterable + + from twisted.python.failure import Failure from scrapy import Spider from scrapy.settings import Settings @@ -24,14 +33,110 @@ class ItemPipelineManager(MiddlewareManager): @classmethod def _get_mwlist_from_settings(cls, settings: Settings) -> list[Any]: - return build_component_list(settings.getwithbase("ITEM_PIPELINES")) + return build_component_list( + settings.get_component_priority_dict_with_base("ITEM_PIPELINES") + ) - def _add_middleware(self, pipe: Any) -> None: - super()._add_middleware(pipe) - if hasattr(pipe, "process_item"): - self.methods["process_item"].append( - deferred_f_from_coro_f(pipe.process_item) - ) + def _add_middleware(self, mw: Any) -> None: + if hasattr(mw, "open_spider"): + self.methods["open_spider"].append(mw.open_spider) + self._check_mw_method_spider_arg(mw.open_spider) + if hasattr(mw, "close_spider"): + self.methods["close_spider"].appendleft(mw.close_spider) + self._check_mw_method_spider_arg(mw.close_spider) + if hasattr(mw, "process_item"): + self.methods["process_item"].append(mw.process_item) + self._check_mw_method_spider_arg(mw.process_item) def process_item(self, item: Any, spider: Spider) -> Deferred[Any]: - return self._process_chain("process_item", item, spider) + warnings.warn( + f"{global_object_name(type(self))}.process_item() is deprecated, use process_item_async() instead.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + self._set_compat_spider(spider) + return deferred_from_coro(self.process_item_async(item)) + + async def process_item_async(self, item: Any) -> Any: + return await self._process_chain( + "process_item", item, add_spider=True, warn_deferred=True + ) + + def _get_dfd( + self, + method: Callable[..., Coroutine[Any, Any, None] | Deferred[None] | None], + ) -> Deferred[None]: + if method in self._mw_methods_requiring_spider: + return _maybeDeferred_coro(method, True, self._spider) + return _maybeDeferred_coro(method, True) + + @staticmethod + def _eb(failure: Failure) -> Failure: + assert isinstance(failure.value, FirstError) + return failure.value.subFailure + + def _process_parallel_dfd(self, methodname: str) -> Deferred[list[None]]: + methods = cast( + "Iterable[Callable[..., Coroutine[Any, Any, None] | Deferred[None] | None]]", + self.methods[methodname], + ) + + dfds = [self._get_dfd(m) for m in methods] + d: Deferred[list[tuple[bool, None]]] = DeferredList( + dfds, fireOnOneErrback=True, consumeErrors=True + ) + d2: Deferred[list[None]] = d.addCallback(lambda r: [x[1] for x in r]) + + d2.addErrback(self._eb) + return d2 + + def get_awaitable( + self, + method: Callable[..., Coroutine[Any, Any, None] | Deferred[None] | None], + ) -> Awaitable[None]: + if method in self._mw_methods_requiring_spider: + result = method(self._spider) + else: + result = method() + return ensure_awaitable(result, _warn=global_object_name(method)) + + async def _process_parallel_asyncio(self, methodname: str) -> list[None]: + methods = cast( + "Iterable[Callable[..., Coroutine[Any, Any, None] | Deferred[None] | None]]", + self.methods[methodname], + ) + if not methods: + return [] + + awaitables = [self.get_awaitable(m) for m in methods] + await asyncio.gather(*awaitables) + return [None for _ in methods] + + async def _process_parallel(self, methodname: str) -> list[None]: + if is_asyncio_available(): + return await self._process_parallel_asyncio(methodname) + return await self._process_parallel_dfd(methodname) + + def open_spider(self, spider: Spider) -> Deferred[list[None]]: + warnings.warn( + f"{global_object_name(type(self))}.open_spider() is deprecated, use open_spider_async() instead.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + self._set_compat_spider(spider) + return deferred_from_coro(self._process_parallel("open_spider")) + + async def open_spider_async(self) -> None: + await self._process_parallel("open_spider") + + def close_spider(self, spider: Spider) -> Deferred[list[None]]: + warnings.warn( + f"{global_object_name(type(self))}.close_spider() is deprecated, use close_spider_async() instead.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + self._set_compat_spider(spider) + return deferred_from_coro(self._process_parallel("close_spider")) + + async def close_spider_async(self) -> None: + await self._process_parallel("close_spider") diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 888be81c3..0066fd38f 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -18,28 +18,28 @@ from contextlib import suppress from ftplib import FTP from io import BytesIO from pathlib import Path -from typing import IO, TYPE_CHECKING, Any, NoReturn, Protocol, TypedDict, cast +from typing import IO, TYPE_CHECKING, Any, ClassVar, NoReturn, Protocol, TypedDict, cast from urllib.parse import urlparse from itemadapter import ItemAdapter from twisted.internet.defer import Deferred, maybeDeferred -from twisted.internet.threads import deferToThread from scrapy.exceptions import IgnoreRequest, NotConfigured, ScrapyDeprecationWarning from scrapy.http import Request, Response from scrapy.http.request import NO_CALLBACK from scrapy.pipelines.media import FileInfo, FileInfoOrError, MediaPipeline -from scrapy.settings import BaseSettings, Settings +from scrapy.utils.asyncio import run_in_thread from scrapy.utils.boto import is_botocore_available from scrapy.utils.datatypes import CaseInsensitiveDict -from scrapy.utils.deprecate import method_is_overridden +from scrapy.utils.defer import deferred_from_coro, ensure_awaitable from scrapy.utils.ftp import ftp_store_file +from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.log import failure_to_exc_info -from scrapy.utils.python import get_func_args, global_object_name, to_bytes +from scrapy.utils.python import to_bytes from scrapy.utils.request import referer_str if TYPE_CHECKING: - from collections.abc import Callable + from collections.abc import Awaitable from os import PathLike from twisted.python.failure import Failure @@ -47,8 +47,8 @@ if TYPE_CHECKING: # typing.Self requires Python 3.11 from typing_extensions import Self - from scrapy import Spider from scrapy.crawler import Crawler + from scrapy.settings import BaseSettings logger = logging.getLogger(__name__) @@ -161,15 +161,15 @@ class S3FilesStore: AWS_USE_SSL = None AWS_VERIFY = None - POLICY = "private" # Overridden from settings.FILES_STORE_S3_ACL in FilesPipeline.from_settings - HEADERS = { + POLICY = "private" # Overridden from settings.FILES_STORE_S3_ACL in FilesPipeline.from_crawler() + HEADERS: ClassVar[dict[str, str]] = { "Cache-Control": "max-age=172800", } def __init__(self, uri: str): if not is_botocore_available(): raise NotConfigured("missing botocore library") - import botocore.session + import botocore.session # noqa: PLC0415 session = botocore.session.get_session() self.s3_client = session.create_client( @@ -186,26 +186,27 @@ class S3FilesStore: raise ValueError(f"Incorrect URI scheme in {uri}, expected 's3'") self.bucket, self.prefix = uri[5:].split("/", 1) + @staticmethod + def _onsuccess(boto_key: dict[str, Any]) -> StatInfo: + checksum = boto_key["ETag"].strip('"') + last_modified = boto_key["LastModified"] + modified_stamp = time.mktime(last_modified.timetuple()) + return {"checksum": checksum, "last_modified": modified_stamp} + def stat_file( self, path: str, info: MediaPipeline.SpiderInfo ) -> Deferred[StatInfo]: - def _onsuccess(boto_key: dict[str, Any]) -> StatInfo: - checksum = boto_key["ETag"].strip('"') - last_modified = boto_key["LastModified"] - modified_stamp = time.mktime(last_modified.timetuple()) - return {"checksum": checksum, "last_modified": modified_stamp} - return self._get_boto_key(path).addCallback(_onsuccess) + return self._get_boto_key(path).addCallback(self._onsuccess) def _get_boto_key(self, path: str) -> Deferred[dict[str, Any]]: key_name = f"{self.prefix}{path}" - return cast( - "Deferred[dict[str, Any]]", - deferToThread( + return deferred_from_coro( + run_in_thread( self.s3_client.head_object, # type: ignore[attr-defined] Bucket=self.bucket, Key=key_name, - ), + ) ) def persist_file( @@ -222,14 +223,16 @@ class S3FilesStore: extra = self._headers_to_botocore_kwargs(self.HEADERS) if headers: extra.update(self._headers_to_botocore_kwargs(headers)) - return deferToThread( - self.s3_client.put_object, # type: ignore[attr-defined] - Bucket=self.bucket, - Key=key_name, - Body=buf, - Metadata={k: str(v) for k, v in (meta or {}).items()}, - ACL=self.POLICY, - **extra, + return deferred_from_coro( + run_in_thread( + self.s3_client.put_object, # type: ignore[attr-defined] + Bucket=self.bucket, + Key=key_name, + Body=buf, + Metadata={k: str(v) for k, v in meta.items()} if meta else {}, + ACL=self.POLICY, + **extra, + ) ) def _headers_to_botocore_kwargs(self, headers: dict[str, Any]) -> dict[str, Any]: @@ -269,7 +272,9 @@ class S3FilesStore: try: kwarg = mapping[key] except KeyError: - raise TypeError(f'Header "{key}" is not supported by botocore') + raise TypeError( + f'Header "{key}" is not supported by botocore' + ) from None extra[kwarg] = value return extra @@ -280,11 +285,11 @@ class GCSFilesStore: CACHE_CONTROL = "max-age=172800" # The bucket's default object ACL will be applied to the object. - # Overridden from settings.FILES_STORE_GCS_ACL in FilesPipeline.from_settings. + # Overridden from settings.FILES_STORE_GCS_ACL in FilesPipeline.from_crawler(). POLICY = None def __init__(self, uri: str): - from google.cloud import storage + from google.cloud import storage # noqa: PLC0415 client = storage.Client(project=self.GCS_PROJECT_ID) bucket, prefix = uri[5:].split("/", 1) @@ -305,21 +310,23 @@ class GCSFilesStore: {"bucket": bucket}, ) + @staticmethod + def _onsuccess(blob: Any) -> StatInfo: + if blob: + checksum = base64.b64decode(blob.md5_hash).hex() + last_modified = time.mktime(blob.updated.timetuple()) + return {"checksum": checksum, "last_modified": last_modified} + return {} + def stat_file( self, path: str, info: MediaPipeline.SpiderInfo ) -> Deferred[StatInfo]: - def _onsuccess(blob) -> StatInfo: - if blob: - checksum = base64.b64decode(blob.md5_hash).hex() - last_modified = time.mktime(blob.updated.timetuple()) - return {"checksum": checksum, "last_modified": last_modified} - return {} blob_path = self._get_blob_path(path) - return cast( - Deferred[StatInfo], - deferToThread(self.bucket.get_blob, blob_path).addCallback(_onsuccess), + d: Deferred[Any] = deferred_from_coro( + run_in_thread(self.bucket.get_blob, blob_path) ) + return d.addCallback(self._onsuccess) def _get_content_type(self, headers: dict[str, str] | None) -> str: if headers and "Content-Type" in headers: @@ -340,12 +347,14 @@ class GCSFilesStore: blob_path = self._get_blob_path(path) blob = self.bucket.blob(blob_path) blob.cache_control = self.CACHE_CONTROL - blob.metadata = {k: str(v) for k, v in (meta or {}).items()} - return deferToThread( - blob.upload_from_string, - data=buf.getvalue(), - content_type=self._get_content_type(headers), - predefined_acl=self.POLICY, + blob.metadata = {k: str(v) for k, v in meta.items()} if meta else {} + return deferred_from_coro( + run_in_thread( + blob.upload_from_string, + data=buf.getvalue(), + content_type=self._get_content_type(headers), + predefined_acl=self.POLICY, + ) ) @@ -378,23 +387,22 @@ class FTPFilesStore: headers: dict[str, str] | None = None, ) -> Deferred[Any]: path = f"{self.basedir}/{path}" - return deferToThread( - ftp_store_file, - path=path, - file=buf, - host=self.host, - port=self.port, - username=self.username, - password=self.password, - use_active_mode=self.USE_ACTIVE_MODE, + return deferred_from_coro( + run_in_thread( + ftp_store_file, + path=path, + file=buf, + host=self.host, + port=self.port, + username=self.username, + password=self.password, + use_active_mode=bool(self.USE_ACTIVE_MODE), + ) ) - def stat_file( - self, path: str, info: MediaPipeline.SpiderInfo - ) -> Deferred[StatInfo]: - def _stat_file(path: str) -> StatInfo: - try: - ftp = FTP() + def _stat_file(self, path: str) -> StatInfo: + try: + with FTP() as ftp: ftp.connect(self.host, self.port) ftp.login(self.username, self.password) if self.USE_ACTIVE_MODE: @@ -403,12 +411,15 @@ class FTPFilesStore: last_modified = float(ftp.voidcmd(f"MDTM {file_path}")[4:].strip()) m = hashlib.md5() # noqa: S324 ftp.retrbinary(f"RETR {file_path}", m.update) - return {"last_modified": last_modified, "checksum": m.hexdigest()} - # The file doesn't exist - except Exception: - return {} + return {"last_modified": last_modified, "checksum": m.hexdigest()} + # The file doesn't exist + except Exception: + return {} - return cast("Deferred[StatInfo]", deferToThread(_stat_file, path)) + def stat_file( + self, path: str, info: MediaPipeline.SpiderInfo + ) -> Deferred[StatInfo]: + return deferred_from_coro(run_in_thread(self._stat_file, path)) class FilesPipeline(MediaPipeline): @@ -432,7 +443,7 @@ class FilesPipeline(MediaPipeline): MEDIA_NAME: str = "file" EXPIRES: int = 90 - STORE_SCHEMES: dict[str, type[FilesStoreProtocol]] = { + STORE_SCHEMES: ClassVar[dict[str, type[FilesStoreProtocol]]] = { "": FSFilesStore, "file": FSFilesStore, "s3": S3FilesStore, @@ -445,27 +456,30 @@ class FilesPipeline(MediaPipeline): def __init__( self, store_uri: str | PathLike[str], - download_func: Callable[[Request, Spider], Response] | None = None, - settings: Settings | dict[str, Any] | None = None, + download_func: None = None, *, - crawler: Crawler | None = None, + crawler: Crawler, ): - store_uri = _to_string(store_uri) - if not store_uri: - raise NotConfigured + if download_func is not None: # pragma: no cover + warnings.warn( + "The download_func argument of FilesPipeline.__init__() is ignored" + " and will be removed in a future Scrapy version.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) - if crawler is not None: - if settings is not None: - warnings.warn( - f"FilesPipeline.__init__() was called with a crawler instance and a settings instance" - f" when creating {global_object_name(self.__class__)}. The settings instance will be ignored" - f" and crawler.settings will be used. The settings argument will be removed in a future Scrapy version.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - settings = crawler.settings - elif isinstance(settings, dict) or settings is None: - settings = Settings(settings) + if not (store_uri and (store_uri := _to_string(store_uri))): + from scrapy.pipelines.images import ImagesPipeline # noqa: PLC0415 + + setting_name = ( + "IMAGES_STORE" if isinstance(self, ImagesPipeline) else "FILES_STORE" + ) + raise NotConfigured( + f"{setting_name} setting must be set to a valid path (not empty) " + f"to enable {self.__class__.__name__}." + ) + + settings = crawler.settings cls_name = "FilesPipeline" self.store: FilesStoreProtocol = self._get_store(store_uri) resolve = functools.partial( @@ -483,55 +497,20 @@ class FilesPipeline(MediaPipeline): resolve("FILES_RESULT_FIELD"), self.FILES_RESULT_FIELD ) - super().__init__( - download_func=download_func, - settings=settings if not crawler else None, - crawler=crawler, - ) - - @classmethod - def from_settings(cls, settings: Settings) -> Self: - warnings.warn( - f"{cls.__name__}.from_settings() is deprecated, use from_crawler() instead.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - return cls._from_settings(settings, None) + super().__init__(crawler=crawler) @classmethod def from_crawler(cls, crawler: Crawler) -> Self: - if method_is_overridden(cls, FilesPipeline, "from_settings"): - warnings.warn( - f"{global_object_name(cls)} overrides FilesPipeline.from_settings()." - f" This method is deprecated and won't be called in future Scrapy versions," - f" please update your code so that it overrides from_crawler() instead.", - category=ScrapyDeprecationWarning, - ) - o = cls.from_settings(crawler.settings) - o._finish_init(crawler) - return o - return cls._from_settings(crawler.settings, crawler) - - @classmethod - def _from_settings(cls, settings: Settings, crawler: Crawler | None) -> Self: + settings = crawler.settings cls._update_stores(settings) store_uri = settings["FILES_STORE"] - if "crawler" in get_func_args(cls.__init__): - o = cls(store_uri, crawler=crawler) - else: - o = cls(store_uri, settings=settings) - if crawler: - o._finish_init(crawler) - warnings.warn( - f"{global_object_name(cls)}.__init__() doesn't take a crawler argument." - " This is deprecated and the argument will be required in future Scrapy versions.", - category=ScrapyDeprecationWarning, - ) - return o + return cls(store_uri, crawler=crawler) @classmethod def _update_stores(cls, settings: BaseSettings) -> None: - s3store: type[S3FilesStore] = cast(type[S3FilesStore], cls.STORE_SCHEMES["s3"]) + s3store: type[S3FilesStore] = cast( + "type[S3FilesStore]", cls.STORE_SCHEMES["s3"] + ) s3store.AWS_ACCESS_KEY_ID = settings["AWS_ACCESS_KEY_ID"] s3store.AWS_SECRET_ACCESS_KEY = settings["AWS_SECRET_ACCESS_KEY"] s3store.AWS_SESSION_TOKEN = settings["AWS_SESSION_TOKEN"] @@ -542,13 +521,13 @@ class FilesPipeline(MediaPipeline): s3store.POLICY = settings["FILES_STORE_S3_ACL"] gcs_store: type[GCSFilesStore] = cast( - type[GCSFilesStore], cls.STORE_SCHEMES["gs"] + "type[GCSFilesStore]", cls.STORE_SCHEMES["gs"] ) gcs_store.GCS_PROJECT_ID = settings["GCS_PROJECT_ID"] gcs_store.POLICY = settings["FILES_STORE_GCS_ACL"] or None ftp_store: type[FTPFilesStore] = cast( - type[FTPFilesStore], cls.STORE_SCHEMES["ftp"] + "type[FTPFilesStore]", cls.STORE_SCHEMES["ftp"] ) ftp_store.FTP_USERNAME = settings["FTP_USER"] ftp_store.FTP_PASSWORD = settings["FTP_PASSWORD"] @@ -560,43 +539,51 @@ class FilesPipeline(MediaPipeline): store_cls = self.STORE_SCHEMES[scheme] return store_cls(uri) + def _onsuccess( + self, + result: StatInfo, + request: Request, + info: MediaPipeline.SpiderInfo, + path: str, + ) -> FileInfo | None: + if not result: + return None # returning None force download + + last_modified = result.get("last_modified", None) + if not last_modified: + return None # returning None force download + + age_seconds = time.time() - last_modified + age_days = age_seconds / 60 / 60 / 24 + if age_days > self.expires: + return None # returning None force download + + referer = referer_str(request) + logger.debug( + "File (uptodate): Downloaded %(medianame)s from %(request)s " + "referred in <%(referer)s>", + {"medianame": self.MEDIA_NAME, "request": request, "referer": referer}, + extra={"spider": info.spider}, + ) + self.inc_stats("uptodate") + + checksum = result.get("checksum", None) + return { + "url": request.url, + "path": path, + "checksum": checksum, + "status": "uptodate", + } + def media_to_download( self, request: Request, info: MediaPipeline.SpiderInfo, *, item: Any = None - ) -> Deferred[FileInfo | None]: - def _onsuccess(result: StatInfo) -> FileInfo | None: - if not result: - return None # returning None force download - - last_modified = result.get("last_modified", None) - if not last_modified: - return None # returning None force download - - age_seconds = time.time() - last_modified - age_days = age_seconds / 60 / 60 / 24 - if age_days > self.expires: - return None # returning None force download - - referer = referer_str(request) - logger.debug( - "File (uptodate): Downloaded %(medianame)s from %(request)s " - "referred in <%(referer)s>", - {"medianame": self.MEDIA_NAME, "request": request, "referer": referer}, - extra={"spider": info.spider}, - ) - self.inc_stats(info.spider, "uptodate") - - checksum = result.get("checksum", None) - return { - "url": request.url, - "path": path, - "checksum": checksum, - "status": "uptodate", - } - + ) -> Deferred[FileInfo | None] | None: path = self.file_path(request, info=info, item=item) # maybeDeferred() overloads don't seem to support a Union[_T, Deferred[_T]] return type dfd: Deferred[StatInfo] = maybeDeferred(self.store.stat_file, path, info) # type: ignore[call-overload] - dfd2: Deferred[FileInfo | None] = dfd.addCallback(_onsuccess) + dfd2: Deferred[FileInfo | None] = dfd.addCallback( + functools.partial(self._onsuccess, request=request, info=info, path=path) + ) dfd2.addErrback(lambda _: None) dfd2.addErrback( lambda f: logger.error( @@ -626,7 +613,7 @@ class FilesPipeline(MediaPipeline): raise FileException - def media_downloaded( + async def media_downloaded( self, response: Response, request: Request, @@ -661,11 +648,13 @@ class FilesPipeline(MediaPipeline): {"status": status, "request": request, "referer": referer}, extra={"spider": info.spider}, ) - self.inc_stats(info.spider, status) + self.inc_stats(status) try: path = self.file_path(request, response=response, info=info, item=item) - checksum = self.file_downloaded(response, request, info, item=item) + checksum: str = await ensure_awaitable( + self.file_downloaded(response, request, info, item=item) + ) except FileException as exc: logger.warning( "File (error): Error processing file from %(request)s " @@ -683,7 +672,7 @@ class FilesPipeline(MediaPipeline): exc_info=True, extra={"spider": info.spider}, ) - raise FileException(str(exc)) + raise FileException(str(exc)) from exc return { "url": request.url, @@ -692,19 +681,12 @@ class FilesPipeline(MediaPipeline): "status": status, } - def inc_stats(self, spider: Spider, status: str) -> None: - assert spider.crawler.stats - spider.crawler.stats.inc_value("file_count", spider=spider) - spider.crawler.stats.inc_value(f"file_status_count/{status}", spider=spider) + def inc_stats(self, status: str) -> None: + assert self.crawler.stats + self.crawler.stats.inc_value("file_count") + self.crawler.stats.inc_value(f"file_status_count/{status}") - # Overridable Interface - def get_media_requests( - self, item: Any, info: MediaPipeline.SpiderInfo - ) -> list[Request]: - urls = ItemAdapter(item).get(self.files_urls_field, []) - return [Request(u, callback=NO_CALLBACK) for u in urls] - - def file_downloaded( + async def _file_downloaded( self, response: Response, request: Request, @@ -716,9 +698,30 @@ class FilesPipeline(MediaPipeline): buf = BytesIO(response.body) checksum = _md5sum(buf) buf.seek(0) - self.store.persist_file(path, buf, info) + await ensure_awaitable(self.store.persist_file(path, buf, info)) return checksum + # Overridable Interface + def get_media_requests( + self, item: Any, info: MediaPipeline.SpiderInfo + ) -> list[Request]: + urls = ItemAdapter(item).get(self.files_urls_field, []) + if not isinstance(urls, list): + raise TypeError( + f"{self.files_urls_field} must be a list of URLs, got {type(urls).__name__}. " + ) + return [Request(u, callback=NO_CALLBACK) for u in urls] + + def file_downloaded( + self, + response: Response, + request: Request, + info: MediaPipeline.SpiderInfo, + *, + item: Any = None, + ) -> str | Awaitable[str]: + return self._file_downloaded(response, request, info, item=item) + def item_completed( self, results: list[FileInfoOrError], item: Any, info: MediaPipeline.SpiderInfo ) -> Any: @@ -735,12 +738,20 @@ class FilesPipeline(MediaPipeline): item: Any = None, ) -> str: media_guid = hashlib.sha1(to_bytes(request.url)).hexdigest() # noqa: S324 - media_ext = Path(request.url).suffix + + # clean it up and look at the path first + parsed_url = urlparse_cached(request) + media_ext = Path(parsed_url.path).suffix + + # if path has no extension look at the raw URL + if media_ext not in mimetypes.types_map: + media_ext = Path(request.url).suffix + # Handles empty and wild extensions by trying to guess the # mime type then extension or default to empty string otherwise if media_ext not in mimetypes.types_map: media_ext = "" media_type = mimetypes.guess_type(request.url)[0] if media_type: - media_ext = cast(str, mimetypes.guess_extension(media_type)) + media_ext = cast("str", mimetypes.guess_extension(media_type)) return f"full/{media_guid}{media_ext}" diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 63c6908dc..762b0fdf1 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -11,19 +11,25 @@ import hashlib import warnings from contextlib import suppress from io import BytesIO -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, ClassVar, cast from itemadapter import ItemAdapter from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.http import Request, Response from scrapy.http.request import NO_CALLBACK -from scrapy.pipelines.files import FileException, FilesPipeline, _md5sum -from scrapy.settings import Settings -from scrapy.utils.python import get_func_args, global_object_name, to_bytes +from scrapy.pipelines.files import ( + FileException, + FilesPipeline, + GCSFilesStore, + S3FilesStore, + _md5sum, +) +from scrapy.utils.defer import ensure_awaitable +from scrapy.utils.python import to_bytes if TYPE_CHECKING: - from collections.abc import Callable, Iterable + from collections.abc import Iterable from os import PathLike from PIL import Image @@ -31,9 +37,9 @@ if TYPE_CHECKING: # typing.Self requires Python 3.11 from typing_extensions import Self - from scrapy import Spider from scrapy.crawler import Crawler from scrapy.pipelines.media import FileInfoOrError, MediaPipeline + from scrapy.settings import BaseSettings class ImageException(FileException): @@ -50,47 +56,38 @@ class ImagesPipeline(FilesPipeline): MIN_WIDTH: int = 0 MIN_HEIGHT: int = 0 EXPIRES: int = 90 - THUMBS: dict[str, tuple[int, int]] = {} + THUMBS: ClassVar[dict[str, tuple[int, int]]] = {} DEFAULT_IMAGES_URLS_FIELD = "image_urls" DEFAULT_IMAGES_RESULT_FIELD = "images" def __init__( self, store_uri: str | PathLike[str], - download_func: Callable[[Request, Spider], Response] | None = None, - settings: Settings | dict[str, Any] | None = None, + download_func: None = None, *, - crawler: Crawler | None = None, + crawler: Crawler, ): - try: - from PIL import Image - - self._Image = Image - except ImportError: - raise NotConfigured( - "ImagesPipeline requires installing Pillow 8.0.0 or later" + if download_func is not None: # pragma: no cover + warnings.warn( + "The download_func argument of ImagesPipeline.__init__() is ignored" + " and will be removed in a future Scrapy version.", + category=ScrapyDeprecationWarning, + stacklevel=2, ) - super().__init__( - store_uri, - settings=settings if not crawler else None, - download_func=download_func, - crawler=crawler, - ) + try: + from PIL import Image, ImageOps # noqa: PLC0415 - if crawler is not None: - if settings is not None: - warnings.warn( - f"ImagesPipeline.__init__() was called with a crawler instance and a settings instance" - f" when creating {global_object_name(self.__class__)}. The settings instance will be ignored" - f" and crawler.settings will be used. The settings argument will be removed in a future Scrapy version.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - settings = crawler.settings - elif isinstance(settings, dict) or settings is None: - settings = Settings(settings) + self._Image = Image + self._ImageOps = ImageOps + except ImportError: + raise NotConfigured( + "ImagesPipeline requires installing Pillow 8.3.2 or later" + ) from None + super().__init__(store_uri, crawler=crawler) + + settings = crawler.settings resolve = functools.partial( self._key_for_pipe, base_class_name="ImagesPipeline", @@ -120,23 +117,13 @@ class ImagesPipeline(FilesPipeline): ) @classmethod - def _from_settings(cls, settings: Settings, crawler: Crawler | None) -> Self: + def from_crawler(cls, crawler: Crawler) -> Self: + settings = crawler.settings cls._update_stores(settings) store_uri = settings["IMAGES_STORE"] - if "crawler" in get_func_args(cls.__init__): - o = cls(store_uri, crawler=crawler) - else: - o = cls(store_uri, settings=settings) - if crawler: - o._finish_init(crawler) - warnings.warn( - f"{global_object_name(cls)}.__init__() doesn't take a crawler argument." - " This is deprecated and the argument will be required in future Scrapy versions.", - category=ScrapyDeprecationWarning, - ) - return o + return cls(store_uri, crawler=crawler) - def file_downloaded( + async def file_downloaded( self, response: Response, request: Request, @@ -144,9 +131,23 @@ class ImagesPipeline(FilesPipeline): *, item: Any = None, ) -> str: - return self.image_downloaded(response, request, info, item=item) + return await self.image_downloaded(response, request, info, item=item) - def image_downloaded( + @classmethod + def _update_stores(cls, settings: BaseSettings) -> None: + super()._update_stores(settings) + + s3store: type[S3FilesStore] = cast( + "type[S3FilesStore]", cls.STORE_SCHEMES["s3"] + ) + s3store.POLICY = settings["IMAGES_STORE_S3_ACL"] + + gcs_store: type[GCSFilesStore] = cast( + "type[GCSFilesStore]", cls.STORE_SCHEMES["gs"] + ) + gcs_store.POLICY = settings["IMAGES_STORE_GCS_ACL"] or None + + async def image_downloaded( self, response: Response, request: Request, @@ -160,12 +161,14 @@ class ImagesPipeline(FilesPipeline): buf.seek(0) checksum = _md5sum(buf) width, height = image.size - self.store.persist_file( - path, - buf, - info, - meta={"width": width, "height": height}, - headers={"Content-Type": "image/jpeg"}, + await ensure_awaitable( + self.store.persist_file( + path, + buf, + info, + meta={"width": width, "height": height}, + headers={"Content-Type": "image/jpeg"}, + ) ) assert checksum is not None return checksum @@ -180,8 +183,9 @@ class ImagesPipeline(FilesPipeline): ) -> Iterable[tuple[str, Image.Image, BytesIO]]: path = self.file_path(request, response=response, info=info, item=item) orig_image = self._Image.open(BytesIO(response.body)) + transposed_image = self._ImageOps.exif_transpose(orig_image) - width, height = orig_image.size + width, height = transposed_image.size if width < self.min_width or height < self.min_height: raise ImageException( "Image too small " @@ -190,7 +194,7 @@ class ImagesPipeline(FilesPipeline): ) image, buf = self.convert_image( - orig_image, response_body=BytesIO(response.body) + transposed_image, response_body=BytesIO(response.body) ) yield path, image, buf @@ -208,7 +212,7 @@ class ImagesPipeline(FilesPipeline): *, response_body: BytesIO, ) -> tuple[Image.Image, BytesIO]: - if image.format in ("PNG", "WEBP") and image.mode == "RGBA": + if image.format in {"PNG", "WEBP"} and image.mode == "RGBA": background = self._Image.new("RGBA", image.size, (255, 255, 255)) background.paste(image, image) image = background.convert("RGB") @@ -241,6 +245,10 @@ class ImagesPipeline(FilesPipeline): self, item: Any, info: MediaPipeline.SpiderInfo ) -> list[Request]: urls = ItemAdapter(item).get(self.images_urls_field, []) + if not isinstance(urls, list): + raise TypeError( + f"{self.images_urls_field} must be a list of URLs, got {type(urls).__name__}. " + ) return [Request(u, callback=NO_CALLBACK) for u in urls] def item_completed( diff --git a/scrapy/pipelines/media.py b/scrapy/pipelines/media.py index e66b86ce6..5b5d2dcb2 100644 --- a/scrapy/pipelines/media.py +++ b/scrapy/pipelines/media.py @@ -1,28 +1,35 @@ from __future__ import annotations +import asyncio import functools import logging import warnings from abc import ABC, abstractmethod from collections import defaultdict -from typing import TYPE_CHECKING, Any, Literal, NoReturn, TypedDict, Union, cast +from typing import TYPE_CHECKING, Any, Literal, TypeAlias, TypedDict, cast -from twisted import version as twisted_version from twisted.internet.defer import Deferred, DeferredList from twisted.python.failure import Failure -from twisted.python.versions import Version from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http.request import NO_CALLBACK, Request -from scrapy.settings import Settings +from scrapy.utils._deps_compat import TWISTED_FAILURE_HAS_STACK +from scrapy.utils.asyncio import call_later, is_asyncio_available from scrapy.utils.datatypes import SequenceExclude -from scrapy.utils.defer import defer_result, mustbe_deferred +from scrapy.utils.decorators import _warn_spider_arg +from scrapy.utils.defer import ( + _DEFER_DELAY, + _defer_sleep_async, + deferred_from_coro, + ensure_awaitable, + maybe_deferred_to_future, +) from scrapy.utils.log import failure_to_exc_info from scrapy.utils.misc import arg_to_iter -from scrapy.utils.python import get_func_args, global_object_name +from scrapy.utils.python import global_object_name if TYPE_CHECKING: - from collections.abc import Callable + from collections.abc import Awaitable, Callable # typing.Self requires Python 3.11 from typing_extensions import Self @@ -30,6 +37,7 @@ if TYPE_CHECKING: from scrapy import Spider from scrapy.crawler import Crawler from scrapy.http import Response + from scrapy.settings import Settings from scrapy.utils.request import RequestFingerprinterProtocol @@ -40,16 +48,14 @@ class FileInfo(TypedDict): status: str -FileInfoOrError = Union[tuple[Literal[True], FileInfo], tuple[Literal[False], Failure]] +FileInfoOrError: TypeAlias = ( + tuple[Literal[True], FileInfo] | tuple[Literal[False], Failure] +) logger = logging.getLogger(__name__) class MediaPipeline(ABC): - crawler: Crawler - _fingerprinter: RequestFingerprinterProtocol - _modern_init = False - LOG_FAILED_RESULTS: bool = True class SpiderInfo: @@ -63,25 +69,24 @@ class MediaPipeline(ABC): def __init__( self, - download_func: Callable[[Request, Spider], Response] | None = None, - settings: Settings | dict[str, Any] | None = None, + download_func: None = None, *, - crawler: Crawler | None = None, + crawler: Crawler, ): - self.download_func = download_func + if download_func is not None: # pragma: no cover + warnings.warn( + "The download_func argument of MediaPipeline.__init__() is ignored" + " and will be removed in a future Scrapy version.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + self.crawler: Crawler = crawler + assert crawler.request_fingerprinter + self._fingerprinter: RequestFingerprinterProtocol = ( + crawler.request_fingerprinter + ) - if crawler is not None: - if settings is not None: - warnings.warn( - f"MediaPipeline.__init__() was called with a crawler instance and a settings instance" - f" when creating {global_object_name(self.__class__)}. The settings instance will be ignored" - f" and crawler.settings will be used. The settings argument will be removed in a future Scrapy version.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - settings = crawler.settings - elif isinstance(settings, dict) or settings is None: - settings = Settings(settings) + settings = crawler.settings resolve = functools.partial( self._key_for_pipe, base_class_name="MediaPipeline", settings=settings ) @@ -90,27 +95,6 @@ class MediaPipeline(ABC): ) self._handle_statuses(self.allow_redirects) - if crawler: - self._finish_init(crawler) - self._modern_init = True - else: - warnings.warn( - f"MediaPipeline.__init__() was called without the crawler argument" - f" when creating {global_object_name(self.__class__)}." - f" This is deprecated and the argument will be required in future Scrapy versions.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - - def _finish_init(self, crawler: Crawler) -> None: - # This was done in from_crawler() before 2.12, now it's done in __init__() - # if the crawler was passed to it and may be needed to be called in other - # deprecated code paths explicitly too. After the crawler argument of __init__() - # becomes mandatory this should be inlined there. - self.crawler = crawler - assert crawler.request_fingerprinter - self._fingerprinter = crawler.request_fingerprinter - def _handle_statuses(self, allow_redirects: bool) -> None: self.handle_httpstatus_list = None if allow_redirects: @@ -134,59 +118,54 @@ class MediaPipeline(ABC): @classmethod def from_crawler(cls, crawler: Crawler) -> Self: - pipe: Self - if hasattr(cls, "from_settings"): - pipe = cls.from_settings(crawler.settings) # type: ignore[attr-defined] - warnings.warn( - f"{global_object_name(cls)} has from_settings() and either doesn't have" - " from_crawler() or calls MediaPipeline.from_crawler() from it," - " so from_settings() was used to create the instance of it." - " This is deprecated and calling from_settings() will be removed" - " in a future Scrapy version. Please move the initialization code into" - " from_crawler() or __init__().", - category=ScrapyDeprecationWarning, - ) - elif "crawler" in get_func_args(cls.__init__): - pipe = cls(crawler=crawler) - else: - pipe = cls() - warnings.warn( - f"{global_object_name(cls)}.__init__() doesn't take a crawler argument." - " This is deprecated and the argument will be required in future Scrapy versions.", - category=ScrapyDeprecationWarning, - ) - if not pipe._modern_init: - pipe._finish_init(crawler) - return pipe + return cls(crawler=crawler) - def open_spider(self, spider: Spider) -> None: - self.spiderinfo = self.SpiderInfo(spider) + @_warn_spider_arg + def open_spider(self, spider: Spider | None = None) -> None: + assert self.crawler.spider + self.spiderinfo = self.SpiderInfo(self.crawler.spider) - def process_item( - self, item: Any, spider: Spider - ) -> Deferred[list[FileInfoOrError]]: + @_warn_spider_arg + async def process_item(self, item: Any, spider: Spider | None = None) -> Any: info = self.spiderinfo requests = arg_to_iter(self.get_media_requests(item, info)) - dlist = [self._process_request(r, info, item) for r in requests] - dfd = cast( - "Deferred[list[FileInfoOrError]]", DeferredList(dlist, consumeErrors=True) - ) - return dfd.addCallback(self.item_completed, item, info) + coros = [self._process_request(r, info, item) for r in requests] + results: list[FileInfoOrError] = [] + if coros: + if is_asyncio_available(): + results_asyncio = await asyncio.gather(*coros, return_exceptions=True) + for res in results_asyncio: + if isinstance(res, BaseException): + results.append((False, Failure(res))) + else: + results.append((True, res)) + else: + results = await cast( + "Deferred[list[FileInfoOrError]]", + DeferredList( + (deferred_from_coro(coro) for coro in coros), consumeErrors=True + ), + ) + return self.item_completed(results, item, info) - def _process_request( + async def _process_request( self, request: Request, info: SpiderInfo, item: Any - ) -> Deferred[FileInfo]: + ) -> FileInfo: fp = self._fingerprinter.fingerprint(request) - eb = request.errback + + eb: Callable[[Failure], FileInfo] | None = request.errback request.callback = NO_CALLBACK request.errback = None # Return cached result if request was already seen if fp in info.downloaded: - d = defer_result(info.downloaded[fp]) - if eb: - d.addErrback(eb) - return d + await _defer_sleep_async() + cached_result = info.downloaded[fp] + if isinstance(cached_result, Failure): + if eb: + return eb(cached_result) + cached_result.raiseException() + return cached_result # Otherwise, wait for result wad: Deferred[FileInfo] = Deferred() @@ -196,23 +175,27 @@ class MediaPipeline(ABC): # Check if request is downloading right now to avoid doing it twice if fp in info.downloading: - return wad + return await maybe_deferred_to_future(wad) # Download request checking media_to_download hook output first info.downloading.add(fp) - dfd: Deferred[FileInfo | None] = mustbe_deferred( - self.media_to_download, request, info, item=item - ) - dfd2: Deferred[FileInfo] = dfd.addCallback( - self._check_media_to_download, request, info, item=item - ) - dfd2.addErrback(self._log_exception) - dfd2.addBoth(self._cache_result_and_execute_waiters, fp, info) - return dfd2.addBoth(lambda _: wad) # it must return wad at last - - def _log_exception(self, result: Failure) -> Failure: - logger.exception(result) - return result + await _defer_sleep_async() + result: FileInfo | Failure + try: + file_info: FileInfo | None = await ensure_awaitable( + self.media_to_download(request, info, item=item) + ) + if file_info: + # got a result without downloading + result = file_info + else: + # download the result + result = await self._check_media_to_download(request, info, item=item) + except Exception: + result = Failure() + logger.exception(result) + self._cache_result_and_execute_waiters(result, fp, info) + return await maybe_deferred_to_future(wad) # it must return wad at last def _modify_media_request(self, request: Request) -> None: if self.handle_httpstatus_list: @@ -220,24 +203,26 @@ class MediaPipeline(ABC): else: request.meta["handle_httpstatus_all"] = True - def _check_media_to_download( - self, result: FileInfo | None, request: Request, info: SpiderInfo, item: Any - ) -> FileInfo | Deferred[FileInfo]: - if result is not None: - return result - dfd: Deferred[Response] - if self.download_func: - # this ugly code was left only to support tests. TODO: remove - dfd = mustbe_deferred(self.download_func, request, info.spider) - else: + async def _check_media_to_download( + self, request: Request, info: SpiderInfo, item: Any + ) -> FileInfo: + try: self._modify_media_request(request) assert self.crawler.engine - dfd = self.crawler.engine.download(request) - dfd2: Deferred[FileInfo] = dfd.addCallback( - self.media_downloaded, request, info, item=item - ) - dfd2.addErrback(self.media_failed, request, info) - return dfd2 + response = await self.crawler.engine.download_async(request) + return await ensure_awaitable( + self.media_downloaded(response, request, info, item=item) + ) + except Exception: + failure = self.media_failed(Failure(), request, info) + if isinstance(failure, Failure): + warnings.warn( + f"{global_object_name(self.media_failed)} returned a Failure instance." + f" This is deprecated, please raise an exception instead, e.g. via failure.raiseException().", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + failure.raiseException() def _cache_result_and_execute_waiters( self, result: FileInfo | Failure, fp: bytes, info: SpiderInfo @@ -245,9 +230,9 @@ class MediaPipeline(ABC): if isinstance(result, Failure): # minimize cached information for failure result.cleanFailure() - result.frames = [] - if twisted_version < Version("twisted", 24, 10, 0): - result.stack = [] # type: ignore[method-assign] + result.frames.clear() + if TWISTED_FAILURE_HAS_STACK: + result.stack.clear() # This code fixes a memory leak by avoiding to keep references to # the Request and Response objects on the Media Pipeline cache. # @@ -268,18 +253,22 @@ class MediaPipeline(ABC): # the encapsulated exception when it is a StopIteration instance context = getattr(result.value, "__context__", None) if isinstance(context, StopIteration): + assert result.value is not None result.value.__context__ = None info.downloading.remove(fp) info.downloaded[fp] = result # cache result for wad in info.waiting.pop(fp): - defer_result(result).chainDeferred(wad) + if isinstance(result, Failure): + call_later(_DEFER_DELAY, wad.errback, result) + else: + call_later(_DEFER_DELAY, wad.callback, result) # Overridable Interface @abstractmethod def media_to_download( self, request: Request, info: SpiderInfo, *, item: Any = None - ) -> Deferred[FileInfo | None]: + ) -> Deferred[FileInfo | None] | None: """Check request before starting download""" raise NotImplementedError @@ -296,14 +285,14 @@ class MediaPipeline(ABC): info: SpiderInfo, *, item: Any = None, - ) -> FileInfo: + ) -> FileInfo | Awaitable[FileInfo]: """Handler for success downloads""" raise NotImplementedError @abstractmethod def media_failed( self, failure: Failure, request: Request, info: SpiderInfo - ) -> NoReturn: + ) -> Failure: """Handler for failed downloads""" raise NotImplementedError diff --git a/scrapy/pqueues.py b/scrapy/pqueues.py index 34b235d83..0ad0b5d78 100644 --- a/scrapy/pqueues.py +++ b/scrapy/pqueues.py @@ -4,7 +4,6 @@ import hashlib import logging from typing import TYPE_CHECKING, Protocol, cast -from scrapy import Request from scrapy.utils.misc import build_from_crawler if TYPE_CHECKING: @@ -13,6 +12,7 @@ if TYPE_CHECKING: # typing.Self requires Python 3.11 from typing_extensions import Self + from scrapy import Request from scrapy.core.downloader import Downloader from scrapy.crawler import Crawler @@ -51,16 +51,17 @@ class QueueProtocol(Protocol): class ScrapyPriorityQueue: """A priority queue implemented using multiple internal queues (typically, - FIFO queues). It uses one internal queue for each priority value. The internal - queue must implement the following methods: + FIFO queues). It uses one internal queue for each priority value. The + internal queue must implement the following methods: * push(obj) * pop() * close() * __len__() - Optionally, the queue could provide a ``peek`` method, that should return the - next object to be returned by ``pop``, but without removing it from the queue. + Optionally, the queue could provide a ``peek`` method, that should return + the next object to be returned by ``pop``, but without removing it from the + queue. ``__init__`` method of ScrapyPriorityQueue receives a downstream_queue_cls argument, which is a class used to instantiate a new (internal) queue when @@ -72,6 +73,28 @@ class ScrapyPriorityQueue: startprios is a sequence of priorities to start with. If the queue was previously closed leaving some priority buckets non-empty, those priorities should be passed in startprios. + + Disk persistence + ================ + + .. warning:: The files that this class generates on disk are an + implementation detail, and may change without a warning in a future + version of Scrapy. Do not rely on the following information for + anything other than debugging purposes. + + When a component instantiates this class with a non-empty *key* argument, + *key* is used as a persistence directory. + + For every request enqueued, this class checks: + + - Whether the request is a :ref:`start request ` or not. + + - The :data:`~scrapy.Request.priority` of the request. + + For each combination of the above seen, this class creates an instance of + *downstream_queue_cls* with *key* set to a subdirectory of the persistence + directory, named as the request priority (e.g. ``1``), with an ``s`` suffix + in case of a start request (e.g. ``1s``). """ @classmethod @@ -211,7 +234,7 @@ class ScrapyPriorityQueue: except KeyError: queue = self.queues[self.curprio] # Protocols can't declare optional members - return cast(Request, queue.peek()) # type: ignore[attr-defined] + return cast("Request", queue.peek()) # type: ignore[attr-defined] def close(self) -> list[int]: active: set[int] = set() @@ -255,6 +278,26 @@ class DownloaderAwarePriorityQueue: """PriorityQueue which takes Downloader activity into account: domains (slots) with the least amount of active downloads are dequeued first. + + Disk persistence + ================ + + .. warning:: The files that this class generates on disk are an + implementation detail, and may change without a warning in a future + version of Scrapy. Do not rely on the following information for + anything other than debugging purposes. + + When a component instantiates this class with a non-empty *key* argument, + *key* is used as a persistence directory, and inside that directory this + class creates a subdirectory per download slot (domain). + + Those subdirectories are named after the corresponding download slot, with + path-unsafe characters replaced by underscores and an MD5 hash suffix to + avoid collisions. + + For each download slot, this class creates an instance of + :class:`ScrapyPriorityQueue` with the download slot subdirectory as *key* + and its own *downstream_queue_cls*. """ @classmethod @@ -307,8 +350,37 @@ class DownloaderAwarePriorityQueue: self.crawler: Crawler = crawler self.pqueues: dict[str, ScrapyPriorityQueue] = {} # slot -> priority queue - for slot, startprios in (slot_startprios or {}).items(): - self.pqueues[slot] = self.pqfactory(slot, startprios) + self._last_selected_slot: str | None = None + if slot_startprios: + for slot, startprios in slot_startprios.items(): + self.pqueues[slot] = self.pqfactory(slot, startprios) + + def _next_slot(self, stats: list[tuple[int, str]], *, update_state: bool) -> str: + last = self._last_selected_slot + min_active: int | None = None + best_slot: str | None = None + best_slot_after_last: str | None = None + for active, slot in stats: + if min_active is None or active < min_active: + min_active = active + best_slot = slot + best_slot_after_last = None + if last is not None and slot > last: + best_slot_after_last = slot + elif active == min_active: + if best_slot is None or slot < best_slot: + best_slot = slot + if ( + last is not None + and slot > last + and (best_slot_after_last is None or slot < best_slot_after_last) + ): + best_slot_after_last = slot + assert best_slot is not None + slot = best_slot_after_last if best_slot_after_last is not None else best_slot + if update_state: + self._last_selected_slot = slot + return slot def pqfactory( self, slot: str, startprios: Iterable[int] = () @@ -327,7 +399,7 @@ class DownloaderAwarePriorityQueue: if not stats: return None - slot = min(stats)[1] + slot = self._next_slot(stats, update_state=True) queue = self.pqueues[slot] request = queue.pop() if len(queue) == 0: @@ -351,7 +423,7 @@ class DownloaderAwarePriorityQueue: stats = self._downloader_interface.stats(self.pqueues) if not stats: return None - slot = min(stats)[1] + slot = self._next_slot(stats, update_state=False) queue = self.pqueues[slot] return queue.peek() diff --git a/scrapy/resolver.py b/scrapy/resolver.py index f5f00ab0f..270a7fbf5 100644 --- a/scrapy/resolver.py +++ b/scrapy/resolver.py @@ -75,7 +75,7 @@ class HostResolution: def __init__(self, name: str): self.name: str = name - def cancel(self) -> None: + def cancel(self) -> None: # pragma: no cover raise NotImplementedError diff --git a/scrapy/responsetypes.py b/scrapy/responsetypes.py index 3f6f030a5..29e9b6bb7 100644 --- a/scrapy/responsetypes.py +++ b/scrapy/responsetypes.py @@ -8,7 +8,7 @@ from __future__ import annotations from io import StringIO from mimetypes import MimeTypes from pkgutil import get_data -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, ClassVar from scrapy.http import Response from scrapy.utils.misc import load_object @@ -19,7 +19,7 @@ if TYPE_CHECKING: class ResponseTypes: - CLASSES = { + CLASSES: ClassVar[dict[str, str]] = { "text/html": "scrapy.http.HtmlResponse", "application/atom+xml": "scrapy.http.XmlResponse", "application/rdf+xml": "scrapy.http.XmlResponse", @@ -40,21 +40,16 @@ class ResponseTypes: self.classes: dict[str, type[Response]] = {} self.mimetypes: MimeTypes = MimeTypes() mimedata = get_data("scrapy", "mime.types") - if not mimedata: - raise ValueError( - "The mime.types file is not found in the Scrapy installation" - ) + assert mimedata is not None self.mimetypes.readfp(StringIO(mimedata.decode("utf8"))) for mimetype, cls in self.CLASSES.items(): self.classes[mimetype] = load_object(cls) def from_mimetype(self, mimetype: str) -> type[Response]: """Return the most appropriate Response class for the given mimetype""" - if mimetype is None: - return Response if mimetype in self.classes: return self.classes[mimetype] - basetype = f"{mimetype.split('/')[0]}/*" + basetype = f"{mimetype.split('/', maxsplit=1)[0]}/*" return self.classes.get(basetype, Response) def from_content_type( diff --git a/scrapy/robotstxt.py b/scrapy/robotstxt.py index 417c9c142..0c64ea5a5 100644 --- a/scrapy/robotstxt.py +++ b/scrapy/robotstxt.py @@ -3,7 +3,10 @@ from __future__ import annotations import logging import sys from abc import ABCMeta, abstractmethod -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, cast +from urllib.robotparser import RobotFileParser + +from protego import Protego from scrapy.utils.python import to_unicode @@ -25,7 +28,7 @@ def decode_robotstxt( if to_native_str_type: body_decoded = to_unicode(robotstxt_body) else: - body_decoded = robotstxt_body.decode("utf-8", errors="ignore") + body_decoded = robotstxt_body.decode("utf-8-sig", errors="ignore") except UnicodeDecodeError: # If we found garbage or robots.txt in an encoding other than UTF-8, disregard it. # Switch to 'allow all' state. @@ -67,8 +70,6 @@ class RobotParser(metaclass=ABCMeta): class PythonRobotParser(RobotParser): def __init__(self, robotstxt_body: bytes, spider: Spider | None): - from urllib.robotparser import RobotFileParser - self.spider: Spider | None = spider body_decoded = decode_robotstxt(robotstxt_body, spider, to_native_str_type=True) self.rp: RobotFileParser = RobotFileParser() @@ -87,7 +88,7 @@ class PythonRobotParser(RobotParser): class RerpRobotParser(RobotParser): def __init__(self, robotstxt_body: bytes, spider: Spider | None): - from robotexclusionrulesparser import RobotExclusionRulesParser + from robotexclusionrulesparser import RobotExclusionRulesParser # noqa: PLC0415 self.spider: Spider | None = spider self.rp: RobotExclusionRulesParser = RobotExclusionRulesParser() @@ -102,13 +103,11 @@ class RerpRobotParser(RobotParser): def allowed(self, url: str | bytes, user_agent: str | bytes) -> bool: user_agent = to_unicode(user_agent) url = to_unicode(url) - return self.rp.is_allowed(user_agent, url) + return cast("bool", self.rp.is_allowed(user_agent, url)) class ProtegoRobotParser(RobotParser): def __init__(self, robotstxt_body: bytes, spider: Spider | None): - from protego import Protego - self.spider: Spider | None = spider body_decoded = decode_robotstxt(robotstxt_body, spider) self.rp = Protego.parse(body_decoded) diff --git a/scrapy/selector/unified.py b/scrapy/selector/unified.py index f8365a87b..99b22aca9 100644 --- a/scrapy/selector/unified.py +++ b/scrapy/selector/unified.py @@ -75,7 +75,7 @@ class Selector(_ParselSelector, object_ref): self, response: TextResponse | None = None, text: str | None = None, - type: str | None = None, + type: str | None = None, # noqa: A002 root: Any | None = _NOT_SET, **kwargs: Any, ): diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py index cc4853c8f..be298e9b1 100644 --- a/scrapy/settings/__init__.py +++ b/scrapy/settings/__init__.py @@ -2,17 +2,19 @@ from __future__ import annotations import copy import json +import warnings from collections.abc import Iterable, Iterator, Mapping, MutableMapping from importlib import import_module +from logging import getLogger from pprint import pformat -from typing import TYPE_CHECKING, Any, Union, cast +from typing import TYPE_CHECKING, Any, TypeAlias, cast +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.settings import default_settings from scrapy.utils.misc import load_object +from scrapy.utils.python import global_object_name -# The key types are restricted in BaseSettings._get_key() to ones supported by JSON, -# see https://github.com/scrapy/scrapy/issues/5383. -_SettingsKeyT = Union[bool, float, int, str, None] +logger = getLogger(__name__) if TYPE_CHECKING: from types import ModuleType @@ -23,7 +25,7 @@ if TYPE_CHECKING: # typing.Self requires Python 3.11 from typing_extensions import Self - _SettingsInputT = Union[SupportsItems[_SettingsKeyT, Any], str, None] + _SettingsInput: TypeAlias = SupportsItems[str, Any] | str | None SETTINGS_PRIORITIES: dict[str, int] = { @@ -74,7 +76,7 @@ class SettingsAttribute: return f"" -class BaseSettings(MutableMapping[_SettingsKeyT, Any]): +class BaseSettings(MutableMapping[str, Any]): """ Instances of this class behave like dictionaries, but store priorities along with their ``(key, value)`` pairs, and can be frozen (i.e. marked @@ -98,13 +100,13 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): __default = object() - def __init__(self, values: _SettingsInputT = None, priority: int | str = "project"): + def __init__(self, values: _SettingsInput = None, priority: int | str = "project"): self.frozen: bool = False - self.attributes: dict[_SettingsKeyT, SettingsAttribute] = {} + self.attributes: dict[str, SettingsAttribute] = {} if values: self.update(values, priority) - def __getitem__(self, opt_name: _SettingsKeyT) -> Any: + def __getitem__(self, opt_name: str) -> Any: if opt_name not in self: return None return self.attributes[opt_name].value @@ -112,7 +114,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): def __contains__(self, name: Any) -> bool: return name in self.attributes - def add_to_list(self, name: _SettingsKeyT, item: Any) -> None: + def add_to_list(self, name: str, item: Any) -> None: """Append *item* to the :class:`list` setting with the specified *name* if *item* is not already in that list. @@ -123,7 +125,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): if item not in value: self.set(name, [*value, item], self.getpriority(name) or 0) - def remove_from_list(self, name: _SettingsKeyT, item: Any) -> None: + def remove_from_list(self, name: str, item: Any) -> None: """Remove *item* from the :class:`list` setting with the specified *name*. @@ -137,7 +139,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): raise ValueError(f"{item!r} not found in the {name} setting ({value!r}).") self.set(name, [v for v in value if v != item], self.getpriority(name) or 0) - def get(self, name: _SettingsKeyT, default: Any = None) -> Any: + def get(self, name: str, default: Any = None) -> Any: # pylint: disable=arguments-renamed """ Get a setting value without affecting its original type. @@ -147,9 +149,26 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): :param default: the value to return if no setting is found :type default: object """ + if name == "CONCURRENT_REQUESTS_PER_IP" and ( + isinstance(self[name], int) and self[name] != 0 + ): + warnings.warn( + "The CONCURRENT_REQUESTS_PER_IP setting is deprecated, use CONCURRENT_REQUESTS_PER_DOMAIN instead.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + + if name == "DNS_RESOLVER": + warnings.warn( + "The DNS_RESOLVER setting is deprecated, please use " + "TWISTED_DNS_RESOLVER instead.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return self[name] if self[name] is not None else default - def getbool(self, name: _SettingsKeyT, default: bool = False) -> bool: + def getbool(self, name: str, default: bool = False) -> bool: """ Get a setting value as a boolean. @@ -169,17 +188,17 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): try: return bool(int(got)) except ValueError: - if got in ("True", "true"): + if got in {"True", "true"}: return True - if got in ("False", "false"): + if got in {"False", "false"}: return False raise ValueError( "Supported values for boolean settings " "are 0/1, True/False, '0'/'1', " "'True'/'False' and 'true'/'false'" - ) + ) from None - def getint(self, name: _SettingsKeyT, default: int = 0) -> int: + def getint(self, name: str, default: int = 0) -> int: """ Get a setting value as an int. @@ -191,7 +210,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): """ return int(self.get(name, default)) - def getfloat(self, name: _SettingsKeyT, default: float = 0.0) -> float: + def getfloat(self, name: str, default: float = 0.0) -> float: """ Get a setting value as a float. @@ -203,9 +222,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): """ return float(self.get(name, default)) - def getlist( - self, name: _SettingsKeyT, default: list[Any] | None = None - ) -> list[Any]: + def getlist(self, name: str, default: list[Any] | None = None) -> list[Any]: """ Get a setting value as a list. If the setting original type is a list, a copy of it will be returned. If it's a string it will be split by @@ -228,7 +245,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): return list(value) def getdict( - self, name: _SettingsKeyT, default: dict[Any, Any] | None = None + self, name: str, default: dict[Any, Any] | None = None ) -> dict[Any, Any]: """ Get a setting value as a dictionary. If the setting original type is a @@ -252,7 +269,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): def getdictorlist( self, - name: _SettingsKeyT, + name: str, default: dict[Any, Any] | list[Any] | tuple[Any] | None = None, ) -> dict[Any, Any] | list[Any]: """Get a setting value as either a :class:`dict` or a :class:`list`. @@ -282,19 +299,32 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): if isinstance(value, str): try: value_loaded = json.loads(value) - assert isinstance(value_loaded, (dict, list)) + if not isinstance(value_loaded, (dict, list)): + raise ValueError( + f"JSON string for setting '{name}' must evaluate to a dict or list, " + f"got {type(value_loaded).__name__}: {value_loaded!r}" + ) return value_loaded except ValueError: return value.split(",") if isinstance(value, tuple): return list(value) - assert isinstance(value, (dict, list)) + if not isinstance(value, (dict, list)): + raise ValueError( + f"Setting '{name}' must be a dict, list, tuple, or string, " + f"got {type(value).__name__}: {value!r}" + ) return copy.deepcopy(value) - def getwithbase(self, name: _SettingsKeyT) -> BaseSettings: - """Get a composition of a dictionary-like setting and its `_BASE` + def getwithbase(self, name: str) -> BaseSettings: + """Get a composition of a dictionary-like setting and its ``_BASE`` counterpart. + Use + :meth:`~scrapy.settings.BaseSettings.get_component_priority_dict_with_base` + instead if the setting is a :ref:`component priority dictionary + `. + :param name: name of the dictionary-like setting :type name: str """ @@ -305,7 +335,55 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): compbs.update(self[name]) return compbs - def getpriority(self, name: _SettingsKeyT) -> int | None: + def get_component_priority_dict_with_base(self, name: str) -> BaseSettings: + """Get a composition of a component priority dictionary setting and + its ``_BASE`` counterpart. + + Keys are resolved to their import path for deduplication and then + restored to their latest input representation. + + :param name: name of the component priority dictionary setting + :type name: str + """ + if not isinstance(name, str): + raise ValueError(f"Base setting key must be a string, got {name}") + + normalized_keys = {} + obj_keys = set() + + def track_loaded_key(k: Any) -> None: + if k not in obj_keys: + obj_keys.add(k) + return + logger.warning( + f"Setting {name} contains multiple keys that refer to the " + f"same object: {global_object_name(k)}. Only the last one will " + f"be kept." + ) + + def normalize_key(key: Any) -> Any: + try: + loaded_key = load_object(key) + except (NameError, TypeError, ValueError): + loaded_key = key + else: + import_path = global_object_name(loaded_key) + normalized_keys[import_path] = key + key = import_path + track_loaded_key(loaded_key) + return key + + def restore_key(k: str) -> Any: + return normalized_keys.get(k, k) + + result = dict(self[name + "_BASE"] or {}) + override = {normalize_key(k): v for k, v in (self[name] or {}).items()} + result.update(override) + return BaseSettings( + {restore_key(k): v for k, v in result.items() if v is not None} + ) + + def getpriority(self, name: str) -> int | None: """ Return the current numerical priority value of a setting, or ``None`` if the given ``name`` does not exist. @@ -325,12 +403,12 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): stored. """ if len(self) > 0: - return max(cast(int, self.getpriority(name)) for name in self) + return max(cast("int", self.getpriority(name)) for name in self) return get_settings_priority("default") def replace_in_component_priority_dict( self, - name: _SettingsKeyT, + name: str, old_cls: type, new_cls: type, priority: int | None = None, @@ -369,12 +447,10 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): ) self.set(name, component_priority_dict, priority=self.getpriority(name) or 0) - def __setitem__(self, name: _SettingsKeyT, value: Any) -> None: + def __setitem__(self, name: str, value: Any) -> None: self.set(name, value) - def set( - self, name: _SettingsKeyT, value: Any, priority: int | str = "project" - ) -> None: + def set(self, name: str, value: Any, priority: int | str = "project") -> None: """ Store a key/value attribute with a given priority. @@ -403,7 +479,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): self.attributes[name].set(value, priority) def set_in_component_priority_dict( - self, name: _SettingsKeyT, cls: type, priority: int | None + self, name: str, cls: type, priority: int | None ) -> None: """Set the *cls* component in the *name* :ref:`component priority dictionary ` setting with *priority*. @@ -426,9 +502,9 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): component_priority_dict[cls] = priority self.set(name, component_priority_dict, self.getpriority(name) or 0) - def setdefault( + def setdefault( # pylint: disable=arguments-renamed self, - name: _SettingsKeyT, + name: str, default: Any = None, priority: int | str = "project", ) -> Any: @@ -439,7 +515,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): return self.attributes[name].value def setdefault_in_component_priority_dict( - self, name: _SettingsKeyT, cls: type, priority: int | None + self, name: str, cls: type, priority: int | None ) -> None: """Set the *cls* component in the *name* :ref:`component priority dictionary ` setting with *priority* @@ -456,7 +532,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): component_priority_dict[cls] = priority self.set(name, component_priority_dict, self.getpriority(name) or 0) - def setdict(self, values: _SettingsInputT, priority: int | str = "project") -> None: + def setdict(self, values: _SettingsInput, priority: int | str = "project") -> None: self.update(values, priority) def setmodule( @@ -484,7 +560,7 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): self.set(key, getattr(module, key), priority) # BaseSettings.update() doesn't support all inputs that MutableMapping.update() supports - def update(self, values: _SettingsInputT, priority: int | str = "project") -> None: # type: ignore[override] + def update(self, values: _SettingsInput, priority: int | str = "project") -> None: # type: ignore[override] """ Store key/value pairs with a given priority. @@ -508,24 +584,24 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): """ self._assert_mutability() if isinstance(values, str): - values = cast(dict[_SettingsKeyT, Any], json.loads(values)) + values = cast("dict[str, Any]", json.loads(values)) if values is not None: if isinstance(values, BaseSettings): for name, value in values.items(): - self.set(name, value, cast(int, values.getpriority(name))) + self.set(name, value, cast("int", values.getpriority(name))) else: for name, value in values.items(): self.set(name, value, priority) - def delete(self, name: _SettingsKeyT, priority: int | str = "project") -> None: + def delete(self, name: str, priority: int | str = "project") -> None: if name not in self: raise KeyError(name) self._assert_mutability() priority = get_settings_priority(priority) - if priority >= cast(int, self.getpriority(name)): + if priority >= cast("int", self.getpriority(name)): del self.attributes[name] - def __delitem__(self, name: _SettingsKeyT) -> None: + def __delitem__(self, name: str) -> None: self._assert_mutability() del self.attributes[name] @@ -565,26 +641,19 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): copy.freeze() return copy - def __iter__(self) -> Iterator[_SettingsKeyT]: + def __iter__(self) -> Iterator[str]: return iter(self.attributes) def __len__(self) -> int: return len(self.attributes) - def _to_dict(self) -> dict[_SettingsKeyT, Any]: + def _to_dict(self) -> dict[str, Any]: return { - self._get_key(k): (v._to_dict() if isinstance(v, BaseSettings) else v) + str(k): (v._to_dict() if isinstance(v, BaseSettings) else v) for k, v in self.items() } - def _get_key(self, key_value: Any) -> _SettingsKeyT: - return ( - key_value - if isinstance(key_value, (bool, float, int, str, type(None))) - else str(key_value) - ) - - def copy_to_dict(self) -> dict[_SettingsKeyT, Any]: + def copy_to_dict(self) -> dict[str, Any]: """ Make a copy of current settings and convert to a dict. @@ -607,14 +676,14 @@ class BaseSettings(MutableMapping[_SettingsKeyT, Any]): else: p.text(pformat(self.copy_to_dict())) - def pop(self, name: _SettingsKeyT, default: Any = __default) -> Any: + def pop(self, name: str, default: Any = __default) -> Any: # pylint: disable=arguments-renamed try: value = self.attributes[name].value except KeyError: if default is self.__default: raise return default - self.__delitem__(name) + del self[name] return value @@ -629,7 +698,7 @@ class Settings(BaseSettings): described on :ref:`topics-settings-ref` already populated. """ - def __init__(self, values: _SettingsInputT = None, priority: int | str = "project"): + def __init__(self, values: _SettingsInput = None, priority: int | str = "project"): # Do not pass kwarg values here. We don't want to promote user-defined # dicts, and we want to update, not replace, default dicts with the # values given by the user @@ -651,7 +720,7 @@ def iter_default_settings() -> Iterable[tuple[str, Any]]: def overridden_settings( - settings: Mapping[_SettingsKeyT, Any], + settings: Mapping[str, Any], ) -> Iterable[tuple[str, Any]]: """Return an iterable of the settings that have been overridden""" for name, defvalue in iter_default_settings(): diff --git a/scrapy/settings/default_settings.py b/scrapy/settings/default_settings.py index b6f47f1c3..049921ba7 100644 --- a/scrapy/settings/default_settings.py +++ b/scrapy/settings/default_settings.py @@ -16,12 +16,209 @@ Scrapy developers, if you add a setting here remember to: import sys from importlib import import_module from pathlib import Path +from typing import Any + +__all__ = [ + "ADDONS", + "ASYNCIO_EVENT_LOOP", + "AUTOTHROTTLE_DEBUG", + "AUTOTHROTTLE_ENABLED", + "AUTOTHROTTLE_MAX_DELAY", + "AUTOTHROTTLE_START_DELAY", + "AUTOTHROTTLE_TARGET_CONCURRENCY", + "AWS_ACCESS_KEY_ID", + "AWS_ENDPOINT_URL", + "AWS_REGION_NAME", + "AWS_SECRET_ACCESS_KEY", + "AWS_SESSION_TOKEN", + "AWS_USE_SSL", + "AWS_VERIFY", + "BOT_NAME", + "CLOSESPIDER_ERRORCOUNT", + "CLOSESPIDER_ITEMCOUNT", + "CLOSESPIDER_PAGECOUNT", + "CLOSESPIDER_PAGECOUNT_NO_ITEM", + "CLOSESPIDER_TIMEOUT", + "CLOSESPIDER_TIMEOUT_NO_ITEM", + "COMMANDS_MODULE", + "COMPRESSION_ENABLED", + "CONCURRENT_ITEMS", + "CONCURRENT_REQUESTS", + "CONCURRENT_REQUESTS_PER_DOMAIN", + "COOKIES_DEBUG", + "COOKIES_ENABLED", + "CRAWLSPIDER_FOLLOW_LINKS", + "DEFAULT_DROPITEM_LOG_LEVEL", + "DEFAULT_ITEM_CLASS", + "DEFAULT_REQUEST_HEADERS", + "DEPTH_LIMIT", + "DEPTH_PRIORITY", + "DEPTH_STATS_VERBOSE", + "DNSCACHE_ENABLED", + "DNSCACHE_SIZE", + "DNS_TIMEOUT", + "DOWNLOADER", + "DOWNLOADER_CLIENTCONTEXTFACTORY", + "DOWNLOADER_CLIENT_TLS_CIPHERS", + "DOWNLOADER_CLIENT_TLS_METHOD", + "DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING", + "DOWNLOADER_MIDDLEWARES", + "DOWNLOADER_MIDDLEWARES_BASE", + "DOWNLOADER_STATS", + "DOWNLOAD_BIND_ADDRESS", + "DOWNLOAD_DELAY", + "DOWNLOAD_FAIL_ON_DATALOSS", + "DOWNLOAD_HANDLERS", + "DOWNLOAD_HANDLERS_BASE", + "DOWNLOAD_MAXSIZE", + "DOWNLOAD_SLOTS", + "DOWNLOAD_TIMEOUT", + "DOWNLOAD_TLS_MAX_VERSION", + "DOWNLOAD_TLS_MIN_VERSION", + "DOWNLOAD_VERIFY_CERTIFICATES", + "DOWNLOAD_WARNSIZE", + "DUPEFILTER_CLASS", + "DUPEFILTER_DEBUG", + "EDITOR", + "EXTENSIONS", + "EXTENSIONS_BASE", + "FEEDS", + "FEED_EXPORTERS", + "FEED_EXPORTERS_BASE", + "FEED_EXPORT_BATCH_ITEM_COUNT", + "FEED_EXPORT_ENCODING", + "FEED_EXPORT_FIELDS", + "FEED_EXPORT_INDENT", + "FEED_FORMAT", + "FEED_STORAGES", + "FEED_STORAGES_BASE", + "FEED_STORAGE_FTP_ACTIVE", + "FEED_STORAGE_GCS_ACL", + "FEED_STORAGE_S3_ACL", + "FEED_STORE_EMPTY", + "FEED_TEMPDIR", + "FEED_URI", + "FEED_URI_PARAMS", + "FILES_STORE", + "FILES_STORE_GCS_ACL", + "FILES_STORE_S3_ACL", + "FORCE_CRAWLER_PROCESS", + "FTP_PASSIVE_MODE", + "FTP_PASSWORD", + "FTP_USER", + "GCS_PROJECT_ID", + "HTTPAUTH_DOMAIN", + "HTTPAUTH_PASS", + "HTTPAUTH_USER", + "HTTPCACHE_ALWAYS_STORE", + "HTTPCACHE_DBM_MODULE", + "HTTPCACHE_DIR", + "HTTPCACHE_ENABLED", + "HTTPCACHE_EXPIRATION_SECS", + "HTTPCACHE_GZIP", + "HTTPCACHE_IGNORE_HTTP_CODES", + "HTTPCACHE_IGNORE_MISSING", + "HTTPCACHE_IGNORE_RESPONSE_CACHE_CONTROLS", + "HTTPCACHE_IGNORE_SCHEMES", + "HTTPCACHE_POLICY", + "HTTPCACHE_STORAGE", + "HTTPERROR_ALLOWED_CODES", + "HTTPERROR_ALLOW_ALL", + "HTTPPROXY_AUTH_ENCODING", + "HTTPPROXY_ENABLED", + "HTTPX_HTTP2_ENABLED", + "IMAGES_STORE", + "IMAGES_STORE_GCS_ACL", + "IMAGES_STORE_S3_ACL", + "ITEM_PIPELINES", + "ITEM_PIPELINES_BASE", + "ITEM_PROCESSOR", + "JOBDIR", + "LOGSTATS_INTERVAL", + "LOG_DATEFORMAT", + "LOG_ENABLED", + "LOG_ENCODING", + "LOG_FILE", + "LOG_FILE_APPEND", + "LOG_FORMAT", + "LOG_FORMATTER", + "LOG_LEVEL", + "LOG_SHORT_NAMES", + "LOG_STDOUT", + "LOG_VERSIONS", + "MAIL_FROM", + "MAIL_HOST", + "MAIL_PASS", + "MAIL_PORT", + "MAIL_SSL", + "MAIL_TLS", + "MAIL_USER", + "MEMDEBUG_ENABLED", + "MEMDEBUG_NOTIFY", + "MEMUSAGE_CHECK_INTERVAL_SECONDS", + "MEMUSAGE_ENABLED", + "MEMUSAGE_LIMIT_MB", + "MEMUSAGE_NOTIFY_MAIL", + "MEMUSAGE_WARNING_MB", + "METAREFRESH_ENABLED", + "METAREFRESH_IGNORE_TAGS", + "METAREFRESH_MAXDELAY", + "NEWSPIDER_MODULE", + "PERIODIC_LOG_DELTA", + "PERIODIC_LOG_STATS", + "PERIODIC_LOG_TIMING_ENABLED", + "RANDOMIZE_DOWNLOAD_DELAY", + "REACTOR_THREADPOOL_MAXSIZE", + "REDIRECT_ENABLED", + "REDIRECT_MAX_TIMES", + "REDIRECT_PRIORITY_ADJUST", + "REFERER_ENABLED", + "REFERRER_POLICIES", + "REFERRER_POLICY", + "REQUEST_FINGERPRINTER_CLASS", + "RETRY_ENABLED", + "RETRY_EXCEPTIONS", + "RETRY_GIVE_UP_LOG_LEVEL", + "RETRY_HTTP_CODES", + "RETRY_PRIORITY_ADJUST", + "RETRY_TIMES", + "ROBOTSTXT_OBEY", + "ROBOTSTXT_PARSER", + "ROBOTSTXT_USER_AGENT", + "SCHEDULER", + "SCHEDULER_DEBUG", + "SCHEDULER_DISK_QUEUE", + "SCHEDULER_MEMORY_QUEUE", + "SCHEDULER_PRIORITY_QUEUE", + "SCHEDULER_START_DISK_QUEUE", + "SCHEDULER_START_MEMORY_QUEUE", + "SCRAPER_SLOT_MAX_ACTIVE_SIZE", + "SPIDER_CONTRACTS", + "SPIDER_CONTRACTS_BASE", + "SPIDER_LOADER_CLASS", + "SPIDER_LOADER_WARN_ONLY", + "SPIDER_MIDDLEWARES", + "SPIDER_MIDDLEWARES_BASE", + "SPIDER_MODULES", + "STATSMAILER_RCPTS", + "STATS_CLASS", + "STATS_DUMP", + "TELNETCONSOLE_ENABLED", + "TELNETCONSOLE_HOST", + "TELNETCONSOLE_PASSWORD", + "TELNETCONSOLE_PORT", + "TELNETCONSOLE_USERNAME", + "TEMPLATES_DIR", + "TWISTED_DNS_RESOLVER", + "TWISTED_REACTOR", + "TWISTED_REACTOR_ENABLED", + "URLLENGTH_LIMIT", + "USER_AGENT", + "WARN_ON_GENERATOR_RETURN_VALUE", +] ADDONS = {} -AJAXCRAWL_ENABLED = False -AJAXCRAWL_MAXSIZE = 32768 - ASYNCIO_EVENT_LOOP = None AUTOTHROTTLE_ENABLED = False @@ -30,12 +227,22 @@ AUTOTHROTTLE_MAX_DELAY = 60.0 AUTOTHROTTLE_START_DELAY = 5.0 AUTOTHROTTLE_TARGET_CONCURRENCY = 1.0 +AWS_ACCESS_KEY_ID = None +AWS_SECRET_ACCESS_KEY = None +AWS_ENDPOINT_URL = None +AWS_REGION_NAME = None +AWS_SESSION_TOKEN = None +AWS_USE_SSL = None +AWS_VERIFY = None + BOT_NAME = "scrapybot" CLOSESPIDER_ERRORCOUNT = 0 CLOSESPIDER_ITEMCOUNT = 0 CLOSESPIDER_PAGECOUNT = 0 CLOSESPIDER_TIMEOUT = 0 +CLOSESPIDER_PAGECOUNT_NO_ITEM = 0 +CLOSESPIDER_TIMEOUT_NO_ITEM = 0 COMMANDS_MODULE = "" @@ -45,7 +252,6 @@ CONCURRENT_ITEMS = 100 CONCURRENT_REQUESTS = 16 CONCURRENT_REQUESTS_PER_DOMAIN = 8 -CONCURRENT_REQUESTS_PER_IP = 0 COOKIES_ENABLED = True COOKIES_DEBUG = False @@ -70,6 +276,8 @@ DNSCACHE_SIZE = 10000 DNS_RESOLVER = "scrapy.resolver.CachingThreadedResolver" DNS_TIMEOUT = 60 +DOWNLOAD_BIND_ADDRESS = None + DOWNLOAD_DELAY = 0 DOWNLOAD_FAIL_ON_DATALOSS = True @@ -78,8 +286,8 @@ DOWNLOAD_HANDLERS = {} DOWNLOAD_HANDLERS_BASE = { "data": "scrapy.core.downloader.handlers.datauri.DataURIDownloadHandler", "file": "scrapy.core.downloader.handlers.file.FileDownloadHandler", - "http": "scrapy.core.downloader.handlers.http.HTTPDownloadHandler", - "https": "scrapy.core.downloader.handlers.http.HTTPDownloadHandler", + "http": "scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler", + "https": "scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler", "s3": "scrapy.core.downloader.handlers.s3.S3DownloadHandler", "ftp": "scrapy.core.downloader.handlers.ftp.FTPDownloadHandler", } @@ -87,22 +295,22 @@ DOWNLOAD_HANDLERS_BASE = { DOWNLOAD_MAXSIZE = 1024 * 1024 * 1024 # 1024m DOWNLOAD_WARNSIZE = 32 * 1024 * 1024 # 32m +DOWNLOAD_SLOTS = {} + DOWNLOAD_TIMEOUT = 180 # 3mins +DOWNLOAD_TLS_MAX_VERSION = None +DOWNLOAD_TLS_MIN_VERSION = None + +DOWNLOAD_VERIFY_CERTIFICATES = False + DOWNLOADER = "scrapy.core.downloader.Downloader" -DOWNLOADER_CLIENTCONTEXTFACTORY = ( - "scrapy.core.downloader.contextfactory.ScrapyClientContextFactory" -) +DOWNLOADER_CLIENTCONTEXTFACTORY = "SENTINEL" DOWNLOADER_CLIENT_TLS_CIPHERS = "DEFAULT" -# Use highest TLS/SSL protocol version supported by the platform, also allowing negotiation: DOWNLOADER_CLIENT_TLS_METHOD = "TLS" DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING = False -DOWNLOADER_HTTPCLIENTFACTORY = ( - "scrapy.core.downloader.webclient.ScrapyHTTPClientFactory" -) - DOWNLOADER_MIDDLEWARES = {} DOWNLOADER_MIDDLEWARES_BASE = { # Engine side @@ -113,7 +321,6 @@ DOWNLOADER_MIDDLEWARES_BASE = { "scrapy.downloadermiddlewares.defaultheaders.DefaultHeadersMiddleware": 400, "scrapy.downloadermiddlewares.useragent.UserAgentMiddleware": 500, "scrapy.downloadermiddlewares.retry.RetryMiddleware": 550, - "scrapy.downloadermiddlewares.ajaxcrawl.AjaxCrawlMiddleware": 560, "scrapy.downloadermiddlewares.redirect.MetaRefreshMiddleware": 580, "scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware": 590, "scrapy.downloadermiddlewares.redirect.RedirectMiddleware": 600, @@ -127,6 +334,7 @@ DOWNLOADER_MIDDLEWARES_BASE = { DOWNLOADER_STATS = True DUPEFILTER_CLASS = "scrapy.dupefilters.RFPDupeFilter" +DUPEFILTER_DEBUG = False EDITOR = "vi" if sys.platform == "win32": @@ -135,6 +343,7 @@ if sys.platform == "win32": EXTENSIONS = {} EXTENSIONS_BASE = { "scrapy.extensions.corestats.CoreStats": 0, + "scrapy.extensions.logcount.LogCount": 0, "scrapy.extensions.telnet.TelnetConsole": 0, "scrapy.extensions.memusage.MemoryUsage": 0, "scrapy.extensions.memdebug.MemoryDebugger": 0, @@ -176,8 +385,10 @@ FEED_STORAGE_FTP_ACTIVE = False FEED_STORAGE_GCS_ACL = "" FEED_STORAGE_S3_ACL = "" FEED_TEMPDIR = None +FEED_URI = None FEED_URI_PARAMS = None # a function to extend uri arguments +FILES_STORE = None FILES_STORE_GCS_ACL = "" FILES_STORE_S3_ACL = "private" @@ -189,6 +400,10 @@ FTP_PASSWORD = "guest" # noqa: S105 GCS_PROJECT_ID = None +HTTPAUTH_USER = "" +HTTPAUTH_PASS = "" +HTTPAUTH_DOMAIN = None + HTTPCACHE_ENABLED = False HTTPCACHE_ALWAYS_STORE = False HTTPCACHE_DBM_MODULE = "dbm" @@ -202,9 +417,15 @@ HTTPCACHE_IGNORE_SCHEMES = ["file"] HTTPCACHE_POLICY = "scrapy.extensions.httpcache.DummyPolicy" HTTPCACHE_STORAGE = "scrapy.extensions.httpcache.FilesystemCacheStorage" +HTTPERROR_ALLOW_ALL = False +HTTPERROR_ALLOWED_CODES = [] + HTTPPROXY_ENABLED = True HTTPPROXY_AUTH_ENCODING = "latin-1" +HTTPX_HTTP2_ENABLED = False + +IMAGES_STORE = None IMAGES_STORE_GCS_ACL = "" IMAGES_STORE_S3_ACL = "private" @@ -245,6 +466,8 @@ MAIL_HOST = "localhost" MAIL_PORT = 25 MAIL_USER = None MAIL_PASS = None +MAIL_SSL = False +MAIL_TLS = False MEMDEBUG_ENABLED = False # enable memory debugging MEMDEBUG_NOTIFY = [] # send memory debugging report by mail at engine shutdown @@ -275,26 +498,26 @@ REDIRECT_PRIORITY_ADJUST = +2 REFERER_ENABLED = True REFERRER_POLICY = "scrapy.spidermiddlewares.referer.DefaultReferrerPolicy" +REFERRER_POLICIES = {} REQUEST_FINGERPRINTER_CLASS = "scrapy.utils.request.RequestFingerprinter" -REQUEST_FINGERPRINTER_IMPLEMENTATION = "SENTINEL" RETRY_ENABLED = True RETRY_EXCEPTIONS = [ - "twisted.internet.defer.TimeoutError", - "twisted.internet.error.TimeoutError", - "twisted.internet.error.DNSLookupError", - "twisted.internet.error.ConnectionRefusedError", + "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", - "twisted.internet.error.TCPTimedOutError", - "twisted.web.client.ResponseFailed", # OSError is raised by the HttpCompression middleware when trying to # decompress an empty response OSError, "scrapy.core.downloader.handlers.http11.TunnelError", ] +RETRY_GIVE_UP_LOG_LEVEL = "ERROR" RETRY_HTTP_CODES = [500, 502, 503, 504, 522, 524, 408, 429] RETRY_PRIORITY_ADJUST = -1 RETRY_TIMES = 2 # initial response + 2 retries = 3 requests @@ -307,7 +530,7 @@ SCHEDULER = "scrapy.core.scheduler.Scheduler" SCHEDULER_DEBUG = False SCHEDULER_DISK_QUEUE = "scrapy.squeues.PickleLifoDiskQueue" SCHEDULER_MEMORY_QUEUE = "scrapy.squeues.LifoMemoryQueue" -SCHEDULER_PRIORITY_QUEUE = "scrapy.pqueues.ScrapyPriorityQueue" +SCHEDULER_PRIORITY_QUEUE = "scrapy.pqueues.DownloaderAwarePriorityQueue" SCHEDULER_START_DISK_QUEUE = "scrapy.squeues.PickleFifoDiskQueue" SCHEDULER_START_MEMORY_QUEUE = "scrapy.squeues.FifoMemoryQueue" @@ -351,6 +574,9 @@ TELNETCONSOLE_PASSWORD = None TEMPLATES_DIR = str((Path(__file__).parent / ".." / "templates").resolve()) +TWISTED_DNS_RESOLVER = "scrapy.resolver.CachingThreadedResolver" + +TWISTED_REACTOR_ENABLED = True TWISTED_REACTOR = "twisted.internet.asyncioreactor.AsyncioSelectorReactor" URLLENGTH_LIMIT = 2083 @@ -358,3 +584,19 @@ URLLENGTH_LIMIT = 2083 USER_AGENT = f"Scrapy/{import_module('scrapy').__version__} (+https://scrapy.org)" WARN_ON_GENERATOR_RETURN_VALUE = True + + +def __getattr__(name: str) -> Any: + if name == "CONCURRENT_REQUESTS_PER_IP": + import warnings # noqa: PLC0415 + + from scrapy.exceptions import ScrapyDeprecationWarning # noqa: PLC0415 + + warnings.warn( + "The scrapy.settings.default_settings.CONCURRENT_REQUESTS_PER_IP attribute is deprecated, use scrapy.settings.default_settings.CONCURRENT_REQUESTS_PER_DOMAIN instead.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return 0 + + raise AttributeError(f"module {__name__!r} has no attribute {name!r}") diff --git a/scrapy/shell.py b/scrapy/shell.py index bb39eccc3..44dcd880e 100644 --- a/scrapy/shell.py +++ b/scrapy/shell.py @@ -6,18 +6,22 @@ See documentation in docs/topics/shell.rst from __future__ import annotations +import asyncio import contextlib import os import signal +import warnings from typing import TYPE_CHECKING, Any from itemadapter import is_item -from twisted.internet import defer, threads +from twisted.internet import threads +from twisted.internet.defer import Deferred from twisted.python import threadable from w3lib.url import any_to_uri +import scrapy from scrapy.crawler import Crawler -from scrapy.exceptions import IgnoreRequest +from scrapy.exceptions import IgnoreRequest, ScrapyDeprecationWarning from scrapy.http import Request, Response from scrapy.settings import Settings from scrapy.spiders import Spider @@ -26,12 +30,66 @@ from scrapy.utils.console import DEFAULT_PYTHON_SHELLS, start_python_console from scrapy.utils.datatypes import SequenceExclude from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future from scrapy.utils.misc import load_object -from scrapy.utils.reactor import is_asyncio_reactor_installed, set_asyncio_event_loop from scrapy.utils.response import open_in_browser if TYPE_CHECKING: from collections.abc import Callable +# Hopefully temporary architecture notes +# +# The Shell class is always instantiated in the "main" thread. There are two +# official ways to use it: +# 1. scrapy.commands.shell, which makes a secondary thread and calls +# CrawlerProcess.start() in it, which runs a reactor there. +# 2. scrapy.shell.inspect_response(), which just creates Shell() in the current +# thread. +# +# Shell._inthread is True when this class is run in a thread separate from the +# reactor, e.g. the 1st way (in other words, the reactor is in a secondary +# thread). +# Shell._inthread is False when this class is run in the same thread as the +# reactor, e.g. the 2nd way. +# The only thing that differs is availability of fetch() (it needs the +# reactor to be in a separate thread: the shell sends the request to +# the reactor and waits for the result synchronously). +# +# Thus the only thing Shell needs an event loop for is fetch(). More machinery +# is used for it to work. In chronological order: +# 1. scrapy.commands.shell.Command.run() creates a crawler and an engine, then +# calls +# _schedule_coro(crawler.engine.start_async(_start_request_processing=False)), +# which initializes the engine but doesn't start processing of requests. +# 2. scrapy.commands.shell.Command.run() calls crawler_process.start() in a +# thread which starts a reactor in that thread. +# 3. When fetch() is called, it prepares a request and calls Shell._schedule() +# in the reactor thread (via threads.blockingCallFromThread()). +# 4. Shell._schedule() calls Shell._open_spider() (on the first call). +# 5. Shell._open_spider() calls +# engine.open_spider_async(close_if_idle=False). +# 6. Shell._schedule() calls engine.crawl(request), scheduling the request. +# 7. Shell._schedule() via _request_deferred() waits until the request callback +# is called. When it's called, the response becomes available. +# +# In the reactorless mode this is slightly different, the engine initialization +# happens in the event loop thread as many things need either a reactor or a +# running event loop. +# +# Side note: it should be possible to remove _request_deferred() by using +# engine.download_async() instead of engine.schedule(), losing the usual stuff +# like spider middlewares (none of which should be important). +# +# Other architecture problems: +# * scrapy.cmdline.execute() creates an AsyncCrawlerProcess instance which +# immediately installs a reactor (which is maybe not thread-specific?) or an +# event loop (which *is* thread-specific, so the main thread will always have +# a (not running) loop installed. +# * scrapy.commands.shell.Command.run() calls _schedule_coro() in the main +# thread, and various engine init code also calls similar things, +# conceptually this shouldn't work (and doesn't in the reactorless mode, so +# there the initialization is moved to the event loop thread). +# * The engine has several code paths specifically for the shell, and the shell +# uses several private members of the engine and of AsyncCrawlerProcess. + class Shell: relevant_classes: tuple[type, ...] = (Crawler, Spider, Request, Response, Settings) @@ -41,17 +99,47 @@ class Shell: crawler: Crawler, update_vars: Callable[[dict[str, Any]], None] | None = None, code: str | None = None, + *, + loop: asyncio.AbstractEventLoop | None = None, ): + self._use_reactor = crawler.settings.getbool("TWISTED_REACTOR_ENABLED") + if not self._use_reactor and not loop: # pragma: no cover + raise RuntimeError( + "Shell needs the crawler loop reference when TWISTED_REACTOR_ENABLED=False." + ) + self._loop = loop self.crawler: Crawler = crawler self.update_vars: Callable[[dict[str, Any]], None] = update_vars or ( lambda x: None ) self.item_class: type = load_object(crawler.settings["DEFAULT_ITEM_CLASS"]) self.spider: Spider | None = None - self.inthread: bool = not threadable.isInIOThread() + if self._use_reactor: + self._inthread: bool = not threadable.isInIOThread() + else: + try: + # in case there is also a running loop in the main thread + current_loop = asyncio.get_running_loop() + self._inthread = current_loop is not self._loop + except RuntimeError: + self._inthread = True self.code: str | None = code self.vars: dict[str, Any] = {} + @property + def inthread(self) -> bool: # pragma: no cover + warnings.warn( + "Shell.inthread is deprecated, use Shell.fetch_available instead.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return self._inthread + + @property + def fetch_available(self) -> bool: + """Whether fetch() can be used.""" + return self._inthread + def start( self, url: str | None = None, @@ -72,7 +160,6 @@ class Shell: else: self.populate_vars() if self.code: - # pylint: disable-next=eval-used print(eval(self.code, globals(), self.vars)) # noqa: S307 else: # Detect interactive shell setting in scrapy.cfg @@ -98,37 +185,26 @@ class Shell: self.vars, shells=shells, banner=self.vars.pop("banner", "") ) - def _schedule(self, request: Request, spider: Spider | None) -> defer.Deferred[Any]: - if is_asyncio_reactor_installed(): - # set the asyncio event loop for the current thread - event_loop_path = self.crawler.settings["ASYNCIO_EVENT_LOOP"] - set_asyncio_event_loop(event_loop_path) + async def _schedule(self, request: Request, spider: Spider | None) -> Response: + """Send the request to the engine, wait for the result. - def crawl_request(_): - assert self.crawler.engine is not None - self.crawler.engine.crawl(request) - - d2 = self._open_spider(request, spider) - d2.addCallback(crawl_request) - - d = _request_deferred(request) - d.addCallback(lambda x: (x, spider)) - return d - - @deferred_f_from_coro_f - async def _open_spider(self, request: Request, spider: Spider | None) -> None: - if self.spider: - return + Runs in the reactor thread. + """ + if not self.spider: + await self._open_spider(spider) + assert self.crawler.engine is not None + # send the request to the engine + self.crawler.engine.crawl(request) + # this will fire when the request callback runs (via the callback hijacking in _request_deferred()) + return await maybe_deferred_to_future(_request_deferred(request)) + async def _open_spider(self, spider: Spider | None) -> None: if spider is None: spider = self.crawler.spider or self.crawler._create_spider() self.crawler.spider = spider assert self.crawler.engine - await maybe_deferred_to_future( - self.crawler.engine.open_spider(spider, close_if_idle=False) - ) - self.crawler.engine._start_request_processing() + await self.crawler.engine.open_spider_async(close_if_idle=False) self.spider = spider def fetch( @@ -138,8 +214,6 @@ class Shell: redirect: bool = True, **kwargs: Any, ) -> None: - from twisted.internet import reactor - if isinstance(request_or_url, Request): request = request_or_url else: @@ -151,12 +225,25 @@ class Shell: ) else: request.meta["handle_httpstatus_all"] = True - response = None - with contextlib.suppress(IgnoreRequest): - response, spider = threads.blockingCallFromThread( - reactor, self._schedule, request, spider - ) - self.populate_vars(response, request, spider) + response: Response | None = None + if self._use_reactor: + from twisted.internet import reactor + + with contextlib.suppress(IgnoreRequest): + response = threads.blockingCallFromThread( + reactor, + deferred_f_from_coro_f(self._schedule), # type: ignore[arg-type] + request, + spider, + ) + else: + assert self._loop + with contextlib.suppress(IgnoreRequest): + future = asyncio.run_coroutine_threadsafe( + self._schedule(request, spider), self._loop + ) + response = future.result() + self.populate_vars(response, request, self.spider) def populate_vars( self, @@ -164,8 +251,6 @@ class Shell: request: Request | None = None, spider: Spider | None = None, ) -> None: - import scrapy - self.vars["scrapy"] = scrapy self.vars["crawler"] = self.crawler self.vars["item"] = self.item_class() @@ -173,7 +258,7 @@ class Shell: self.vars["spider"] = spider self.vars["request"] = request self.vars["response"] = response - if self.inthread: + if self.fetch_available: self.vars["fetch"] = self.fetch self.vars["view"] = open_in_browser self.vars["shelp"] = self.print_help @@ -194,7 +279,7 @@ class Shell: if self._is_relevant(v): b.append(f" {k:<10} {v}") b.append("Useful shortcuts:") - if self.inthread: + if self.fetch_available: b.append( " fetch(url[, redirect=True]) " "Fetch URL and update local objects (by default, redirects are followed)" @@ -206,7 +291,7 @@ class Shell: b.append(" shelp() Shell help (print this help)") b.append(" view(response) View response in a browser") - return "\n".join(f"[s] {line}" for line in b) + return "\n".join(f"[s] {line}" for line in b) + "\n" def _is_relevant(self, value: Any) -> bool: return isinstance(value, self.relevant_classes) or is_item(value) @@ -217,11 +302,15 @@ def inspect_response(response: Response, spider: Spider) -> None: # Shell.start removes the SIGINT handler, so save it and re-add it after # the shell has closed sigint_handler = signal.getsignal(signal.SIGINT) - Shell(spider.crawler).start(response=response, spider=spider) + if not spider.crawler.settings.getbool("TWISTED_REACTOR_ENABLED"): + loop = asyncio.get_running_loop() + else: + loop = None + Shell(spider.crawler, loop=loop).start(response=response, spider=spider) signal.signal(signal.SIGINT, sigint_handler) -def _request_deferred(request: Request) -> defer.Deferred[Any]: +def _request_deferred(request: Request) -> Deferred[Any]: """Wrap a request inside a Deferred. This function is harmful, do not use it until you know what you are doing. @@ -240,7 +329,7 @@ def _request_deferred(request: Request) -> defer.Deferred[Any]: request.errback = request_errback return result - d: defer.Deferred[Any] = defer.Deferred() + d: Deferred[Any] = Deferred() d.addBoth(_restore_callbacks) if request.callback: d.addCallback(request.callback) diff --git a/scrapy/signalmanager.py b/scrapy/signalmanager.py index 283060074..ca3b5b7dd 100644 --- a/scrapy/signalmanager.py +++ b/scrapy/signalmanager.py @@ -1,10 +1,12 @@ from __future__ import annotations +import warnings from typing import Any from pydispatch import dispatcher from twisted.internet.defer import Deferred +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils import signal as _signal from scrapy.utils.defer import maybe_deferred_to_future @@ -51,7 +53,7 @@ class SignalManager: def send_catch_log_deferred( self, signal: Any, **kwargs: Any - ) -> Deferred[list[tuple[Any, Any]]]: + ) -> Deferred[list[tuple[Any, Any]]]: # pragma: no cover """ Like :meth:`send_catch_log` but supports :ref:`asynchronous signal handlers `. @@ -63,7 +65,12 @@ class SignalManager: through the :meth:`connect` method). """ kwargs.setdefault("sender", self.sender) - return _signal.send_catch_log_deferred(signal, **kwargs) + warnings.warn( + "send_catch_log_deferred() is deprecated, use send_catch_log_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return _signal._send_catch_log_deferred(signal, **kwargs) async def send_catch_log_async( self, signal: Any, **kwargs: Any @@ -77,7 +84,10 @@ class SignalManager: The keyword arguments are passed to the signal handlers (connected through the :meth:`connect` method). + + .. versionadded:: 2.14 """ + # note that this returns exceptions instead of Failures in the second tuple member kwargs.setdefault("sender", self.sender) return await _signal.send_catch_log_async(signal, **kwargs) @@ -91,14 +101,14 @@ class SignalManager: kwargs.setdefault("sender", self.sender) _signal.disconnect_all(signal, **kwargs) - async def wait_for(self, signal): + async def wait_for(self, signal: Any) -> None: """Await the next *signal*. See :ref:`start-requests-lazy` for an example. """ - d = Deferred() + d: Deferred[None] = Deferred() - def handle(): + def handle() -> None: self.disconnect(handle, signal) d.callback(None) diff --git a/scrapy/signals.py b/scrapy/signals.py index bdeec1ba0..972f4fd60 100644 --- a/scrapy/signals.py +++ b/scrapy/signals.py @@ -12,6 +12,7 @@ spider_opened = object() spider_idle = object() spider_closed = object() spider_error = object() +memusage_warning_reached = object() request_scheduled = object() request_dropped = object() request_reached_downloader = object() diff --git a/scrapy/spiderloader.py b/scrapy/spiderloader.py index 8eac188c8..8c980fd46 100644 --- a/scrapy/spiderloader.py +++ b/scrapy/spiderloader.py @@ -9,7 +9,7 @@ from zope.interface import implementer from zope.interface.verify import verifyClass from scrapy.interfaces import ISpiderLoader -from scrapy.utils.misc import load_object, walk_modules +from scrapy.utils.misc import load_object, walk_modules_iter from scrapy.utils.spider import iter_spider_classes if TYPE_CHECKING: @@ -77,6 +77,7 @@ class SpiderLoader: warnings.warn( "There are several spiders with the same name:\n\n" f"{dupes_string}\n\n This can cause unexpected behavior.", + stacklevel=2, category=UserWarning, ) @@ -88,7 +89,7 @@ class SpiderLoader: def _load_all_spiders(self) -> None: for name in self.spider_modules: try: - for module in walk_modules(name): + for module in walk_modules_iter(name): self._load_spiders(module) except (ImportError, SyntaxError): if self.warn_only: @@ -96,6 +97,7 @@ class SpiderLoader: f"\n{traceback.format_exc()}Could not load spiders " f"from module '{name}'. " "See above traceback for details.", + stacklevel=2, category=RuntimeWarning, ) else: @@ -114,7 +116,7 @@ class SpiderLoader: try: return self._spiders[spider_name] except KeyError: - raise KeyError(f"Spider not found: {spider_name}") + raise KeyError(f"Spider not found: {spider_name}") from None def find_by_request(self, request: Request) -> list[str]: """ diff --git a/scrapy/spidermiddlewares/base.py b/scrapy/spidermiddlewares/base.py index 196b84d0d..e09f2d10e 100644 --- a/scrapy/spidermiddlewares/base.py +++ b/scrapy/spidermiddlewares/base.py @@ -3,6 +3,7 @@ from __future__ import annotations from typing import TYPE_CHECKING, Any from scrapy import Request, Spider +from scrapy.utils.decorators import _warn_spider_arg if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterable @@ -40,27 +41,25 @@ class BaseSpiderMiddleware: def from_crawler(cls, crawler: Crawler) -> Self: return cls(crawler) - def process_start_requests( - self, start: Iterable[Any], spider: Spider - ) -> Iterable[Any]: - for o in start: - if (o := self._get_processed(o, None)) is not None: - yield o - async def process_start(self, start: AsyncIterator[Any]) -> AsyncIterator[Any]: async for o in start: if (o := self._get_processed(o, None)) is not None: yield o + @_warn_spider_arg def process_spider_output( - self, response: Response, result: Iterable[Any], spider: Spider + self, response: Response, result: Iterable[Any], spider: Spider | None = None ) -> Iterable[Any]: for o in result: if (o := self._get_processed(o, response)) is not None: yield o + @_warn_spider_arg async def process_spider_output_async( - self, response: Response, result: AsyncIterator[Any], spider: Spider + self, + response: Response, + result: AsyncIterator[Any], + spider: Spider | None = None, ) -> AsyncIterator[Any]: async for o in result: if (o := self._get_processed(o, response)) is not None: diff --git a/scrapy/spidermiddlewares/depth.py b/scrapy/spidermiddlewares/depth.py index 6b115ebe6..9c387530c 100644 --- a/scrapy/spidermiddlewares/depth.py +++ b/scrapy/spidermiddlewares/depth.py @@ -10,6 +10,7 @@ import logging from typing import TYPE_CHECKING, Any from scrapy.spidermiddlewares.base import BaseSpiderMiddleware +from scrapy.utils.decorators import _warn_spider_arg if TYPE_CHECKING: from collections.abc import AsyncIterator, Iterable @@ -52,25 +53,30 @@ class DepthMiddleware(BaseSpiderMiddleware): o.crawler = crawler return o + @_warn_spider_arg def process_spider_output( - self, response: Response, result: Iterable[Any], spider: Spider + self, response: Response, result: Iterable[Any], spider: Spider | None = None ) -> Iterable[Any]: - self._init_depth(response, spider) - yield from super().process_spider_output(response, result, spider) + self._init_depth(response) + yield from super().process_spider_output(response, result) + @_warn_spider_arg async def process_spider_output_async( - self, response: Response, result: AsyncIterator[Any], spider: Spider + self, + response: Response, + result: AsyncIterator[Any], + spider: Spider | None = None, ) -> AsyncIterator[Any]: - self._init_depth(response, spider) - async for o in super().process_spider_output_async(response, result, spider): + self._init_depth(response) + async for o in super().process_spider_output_async(response, result): yield o - def _init_depth(self, response: Response, spider: Spider) -> None: + def _init_depth(self, response: Response) -> None: # base case (depth=0) if "depth" not in response.meta: response.meta["depth"] = 0 if self.verbose_stats: - self.stats.inc_value("request_depth_count/0", spider=spider) + self.stats.inc_value("request_depth_count/0") def get_processed_request( self, request: Request, response: Response | None @@ -90,8 +96,6 @@ class DepthMiddleware(BaseSpiderMiddleware): ) return None if self.verbose_stats: - self.stats.inc_value( - f"request_depth_count/{depth}", spider=self.crawler.spider - ) - self.stats.max_value("request_depth_max", depth, spider=self.crawler.spider) + self.stats.inc_value(f"request_depth_count/{depth}") + self.stats.max_value("request_depth_max", depth) return request diff --git a/scrapy/spidermiddlewares/httperror.py b/scrapy/spidermiddlewares/httperror.py index 42619ec7f..94b6dfbb5 100644 --- a/scrapy/spidermiddlewares/httperror.py +++ b/scrapy/spidermiddlewares/httperror.py @@ -10,6 +10,7 @@ import logging from typing import TYPE_CHECKING, Any from scrapy.exceptions import IgnoreRequest +from scrapy.utils.decorators import _warn_spider_arg if TYPE_CHECKING: from collections.abc import Iterable @@ -35,9 +36,7 @@ class HttpError(IgnoreRequest): class HttpErrorMiddleware: - @classmethod - def from_crawler(cls, crawler: Crawler) -> Self: - return cls(crawler.settings) + crawler: Crawler def __init__(self, settings: BaseSettings): self.handle_httpstatus_all: bool = settings.getbool("HTTPERROR_ALLOW_ALL") @@ -45,7 +44,16 @@ class HttpErrorMiddleware: "HTTPERROR_ALLOWED_CODES" ) - def process_spider_input(self, response: Response, spider: Spider) -> None: + @classmethod + def from_crawler(cls, crawler: Crawler) -> Self: + o = cls(crawler.settings) + o.crawler = crawler + return o + + @_warn_spider_arg + def process_spider_input( + self, response: Response, spider: Spider | None = None + ) -> None: if 200 <= response.status < 300: # common case return meta = response.meta @@ -57,25 +65,28 @@ class HttpErrorMiddleware: return else: allowed_statuses = getattr( - spider, "handle_httpstatus_list", self.handle_httpstatus_list + self.crawler.spider, + "handle_httpstatus_list", + self.handle_httpstatus_list, ) if response.status in allowed_statuses: return raise HttpError(response, "Ignoring non-200 response") + @_warn_spider_arg def process_spider_exception( - self, response: Response, exception: Exception, spider: Spider + self, response: Response, exception: Exception, spider: Spider | None = None ) -> Iterable[Any] | None: if isinstance(exception, HttpError): - assert spider.crawler.stats - spider.crawler.stats.inc_value("httperror/response_ignored_count") - spider.crawler.stats.inc_value( + assert self.crawler.stats + self.crawler.stats.inc_value("httperror/response_ignored_count") + self.crawler.stats.inc_value( f"httperror/response_ignored_status_count/{response.status}" ) logger.info( "Ignoring response %(response)r: HTTP status code is not handled or not allowed", {"response": response}, - extra={"spider": spider}, + extra={"spider": self.crawler.spider}, ) - return [] + return () return None diff --git a/scrapy/spidermiddlewares/offsite.py b/scrapy/spidermiddlewares/offsite.py deleted file mode 100644 index 2463275d5..000000000 --- a/scrapy/spidermiddlewares/offsite.py +++ /dev/null @@ -1,120 +0,0 @@ -""" -Offsite Spider Middleware - -See documentation in docs/topics/spider-middleware.rst -""" - -from __future__ import annotations - -import logging -import re -import warnings -from typing import TYPE_CHECKING - -from scrapy import Spider, signals -from scrapy.exceptions import ScrapyDeprecationWarning -from scrapy.spidermiddlewares.base import BaseSpiderMiddleware -from scrapy.utils.httpobj import urlparse_cached - -warnings.warn( - "The scrapy.spidermiddlewares.offsite module is deprecated, use " - "scrapy.downloadermiddlewares.offsite instead.", - ScrapyDeprecationWarning, -) - -if TYPE_CHECKING: - # typing.Self requires Python 3.11 - from typing_extensions import Self - - from scrapy.crawler import Crawler - from scrapy.http import Request, Response - from scrapy.statscollectors import StatsCollector - - -logger = logging.getLogger(__name__) - - -class OffsiteMiddleware(BaseSpiderMiddleware): - crawler: Crawler - - def __init__(self, stats: StatsCollector): # pylint: disable=super-init-not-called - self.stats: StatsCollector = stats - - @classmethod - def from_crawler(cls, crawler: Crawler) -> Self: - assert crawler.stats - o = cls(crawler.stats) - o.crawler = crawler - crawler.signals.connect(o.spider_opened, signal=signals.spider_opened) - return o - - def get_processed_request( - self, request: Request, response: Response | None - ) -> Request | None: - if response is None: - # skip start requests for backward compatibility - return request - assert self.crawler.spider - if ( - request.dont_filter - or request.meta.get("allow_offsite") - or self.should_follow(request, self.crawler.spider) - ): - return request - domain = urlparse_cached(request).hostname - if domain and domain not in self.domains_seen: - self.domains_seen.add(domain) - logger.debug( - "Filtered offsite request to %(domain)r: %(request)s", - {"domain": domain, "request": request}, - extra={"spider": self.crawler.spider}, - ) - self.stats.inc_value("offsite/domains", spider=self.crawler.spider) - self.stats.inc_value("offsite/filtered", spider=self.crawler.spider) - return None - - def should_follow(self, request: Request, spider: Spider) -> bool: - regex = self.host_regex - # hostname can be None for wrong urls (like javascript links) - host = urlparse_cached(request).hostname or "" - return bool(regex.search(host)) - - def get_host_regex(self, spider: Spider) -> re.Pattern[str]: - """Override this method to implement a different offsite policy""" - allowed_domains = getattr(spider, "allowed_domains", None) - if not allowed_domains: - return re.compile("") # allow all by default - url_pattern = re.compile(r"^https?://.*$") - port_pattern = re.compile(r":\d+$") - domains = [] - for domain in allowed_domains: - if domain is None: - continue - if url_pattern.match(domain): - message = ( - "allowed_domains accepts only domains, not URLs. " - f"Ignoring URL entry {domain} in allowed_domains." - ) - warnings.warn(message, URLWarning) - elif port_pattern.search(domain): - message = ( - "allowed_domains accepts only domains without ports. " - f"Ignoring entry {domain} in allowed_domains." - ) - warnings.warn(message, PortWarning) - else: - domains.append(re.escape(domain)) - regex = rf"^(.*\.)?({'|'.join(domains)})$" - return re.compile(regex) - - def spider_opened(self, spider: Spider) -> None: - self.host_regex: re.Pattern[str] = self.get_host_regex(spider) - self.domains_seen: set[str] = set() - - -class URLWarning(Warning): - pass - - -class PortWarning(Warning): - pass diff --git a/scrapy/spidermiddlewares/referer.py b/scrapy/spidermiddlewares/referer.py index f5d406c13..2c9452174 100644 --- a/scrapy/spidermiddlewares/referer.py +++ b/scrapy/spidermiddlewares/referer.py @@ -6,26 +6,28 @@ originated it. from __future__ import annotations import warnings +from abc import ABC, abstractmethod from typing import TYPE_CHECKING, cast from urllib.parse import urlparse +from warnings import warn -from w3lib.url import safe_url_string - -from scrapy import Spider, signals -from scrapy.exceptions import NotConfigured +from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.http import Request, Response from scrapy.spidermiddlewares.base import BaseSpiderMiddleware from scrapy.utils.misc import load_object -from scrapy.utils.python import to_unicode +from scrapy.utils.python import _looks_like_import_path, to_unicode from scrapy.utils.url import strip_url if TYPE_CHECKING: # typing.Self requires Python 3.11 - from typing_extensions import Self + from typing_extensions import Self, TypedDict, Unpack from scrapy.crawler import Crawler from scrapy.settings import BaseSettings + class _PolicyKwargs(TypedDict, total=False): + resp_or_url: Response | str + LOCAL_SCHEMES: tuple[str, ...] = ( "about", @@ -45,10 +47,13 @@ POLICY_UNSAFE_URL = "unsafe-url" POLICY_SCRAPY_DEFAULT = "scrapy-default" -class ReferrerPolicy: +class ReferrerPolicy(ABC): + """Abstract base class for referrer policies.""" + NOREFERRER_SCHEMES: tuple[str, ...] = LOCAL_SCHEMES name: str + @abstractmethod def referrer(self, response_url: str, request_url: str) -> str | None: raise NotImplementedError @@ -93,12 +98,12 @@ class ReferrerPolicy: def potentially_trustworthy(self, url: str) -> bool: # Note: this does not follow https://w3c.github.io/webappsec-secure-contexts/#is-url-trustworthy parsed_url = urlparse(url) - if parsed_url.scheme in ("data",): + if parsed_url.scheme == "data": return False return self.tls_protected(url) def tls_protected(self, url: str) -> bool: - return urlparse(url).scheme in ("https", "ftps") + return urlparse(url).scheme in {"https", "ftps"} class NoReferrerPolicy(ReferrerPolicy): @@ -283,92 +288,145 @@ class DefaultReferrerPolicy(NoReferrerWhenDowngradePolicy): name: str = POLICY_SCRAPY_DEFAULT -_policy_classes: dict[str, type[ReferrerPolicy]] = { - p.name: p - for p in ( - NoReferrerPolicy, - NoReferrerWhenDowngradePolicy, - SameOriginPolicy, - OriginPolicy, - StrictOriginPolicy, - OriginWhenCrossOriginPolicy, - StrictOriginWhenCrossOriginPolicy, - UnsafeUrlPolicy, - DefaultReferrerPolicy, - ) -} - -# Reference: https://www.w3.org/TR/referrer-policy/#referrer-policy-empty-string -_policy_classes[""] = NoReferrerWhenDowngradePolicy - - -def _load_policy_class( - policy: str, warning_only: bool = False -) -> type[ReferrerPolicy] | None: - """ - Expect a string for the path to the policy class, - otherwise try to interpret the string as a standard value - from https://www.w3.org/TR/referrer-policy/#referrer-policies - """ - try: - return cast(type[ReferrerPolicy], load_object(policy)) - except ValueError: - tokens = [token.strip() for token in policy.lower().split(",")] - # https://www.w3.org/TR/referrer-policy/#parse-referrer-policy-from-header - for token in tokens[::-1]: - if token in _policy_classes: - return _policy_classes[token] - - msg = f"Could not load referrer policy {policy!r}" - if not warning_only: - raise RuntimeError(msg) - warnings.warn(msg, RuntimeWarning) - return None - - class RefererMiddleware(BaseSpiderMiddleware): def __init__(self, settings: BaseSettings | None = None): # pylint: disable=super-init-not-called self.default_policy: type[ReferrerPolicy] = DefaultReferrerPolicy - if settings is not None: - settings_policy = _load_policy_class(settings.get("REFERRER_POLICY")) - assert settings_policy - self.default_policy = settings_policy + self.policies: dict[str, type[ReferrerPolicy]] = { + p.name: p + for p in ( + NoReferrerPolicy, + NoReferrerWhenDowngradePolicy, + SameOriginPolicy, + OriginPolicy, + StrictOriginPolicy, + OriginWhenCrossOriginPolicy, + StrictOriginWhenCrossOriginPolicy, + UnsafeUrlPolicy, + DefaultReferrerPolicy, + ) + } + # Reference: https://www.w3.org/TR/referrer-policy/#referrer-policy-empty-string + self.policies[""] = NoReferrerWhenDowngradePolicy + if settings is None: + return + setting_policies = settings.getdict("REFERRER_POLICIES") + for policy_name, policy_class_import_path in setting_policies.items(): + if policy_class_import_path is None: + del self.policies[policy_name] + else: + self.policies[policy_name] = load_object(policy_class_import_path) + settings_policy = self._load_policy_class( + settings.get("REFERRER_POLICY"), allow_import_path=True + ) + assert settings_policy + self.default_policy = settings_policy @classmethod def from_crawler(cls, crawler: Crawler) -> Self: if not crawler.settings.getbool("REFERER_ENABLED"): raise NotConfigured - mw = cls(crawler.settings) + return cls(crawler.settings) - # Note: this hook is a bit of a hack to intercept redirections - crawler.signals.connect(mw.request_scheduled, signal=signals.request_scheduled) - - return mw - - def policy(self, resp_or_url: Response | str, request: Request) -> ReferrerPolicy: - """ - Determine Referrer-Policy to use from a parent Response (or URL), - and a Request to be sent. + def policy( + self, + response: Response | str | None = None, + request: Request | None = None, + **kwargs: Unpack[_PolicyKwargs], + ) -> ReferrerPolicy: + """Return the referrer policy to use for *request* based on *request* + meta, *response* and settings. - if a valid policy is set in Request meta, it is used. - - if the policy is set in meta but is wrong (e.g. a typo error), - the policy from settings is used - - if the policy is not set in Request meta, - but there is a Referrer-policy header in the parent response, - it is used if valid + - if the policy is set in meta but is wrong (e.g. a typo error), the + policy from settings is used + - if the policy is not set in Request meta, but there is a + Referrer-Policy header in the parent response, it is used if valid - otherwise, the policy from settings is used. """ + if "resp_or_url" in kwargs: + if response is not None: + raise TypeError("Cannot pass both 'response' and 'resp_or_url'") + response = kwargs.pop("resp_or_url") + warn( + "Passing 'resp_or_url' is deprecated, use 'response' instead.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + if response is None: + raise TypeError("Missing required argument: 'response'") + if request is None: + raise TypeError("Missing required argument: 'request'") + if isinstance(response, str): + warn( + "Passing a response URL to RefererMiddleware.policy() instead " + "of a Response object is deprecated.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + allow_import_path = True policy_name = request.meta.get("referrer_policy") - if policy_name is None and isinstance(resp_or_url, Response): - policy_header = resp_or_url.headers.get("Referrer-Policy") + if policy_name is None and isinstance(response, Response): + policy_header = response.headers.get("Referrer-Policy") if policy_header is not None: policy_name = to_unicode(policy_header.decode("latin1")) + allow_import_path = False if policy_name is None: return self.default_policy() - - cls = _load_policy_class(policy_name, warning_only=True) + cls = self._load_policy_class( + policy_name, warning_only=True, allow_import_path=allow_import_path + ) return cls() if cls else self.default_policy() + def _load_policy_class( + self, + policy: str, + warning_only: bool = False, + *, + allow_import_path: bool = False, + ) -> type[ReferrerPolicy] | None: + """Load the :class:`ReferrerPolicy` class to use for *policy*. + + *policy* may be any of the following: + + - A standard policy name, e.g. ``"no-referrer"``, + ``"origin-when-cross-origin"``, etc. + + - The special ``"scrapy-default"`` policy. + + - The import path of a :class:`ReferrerPolicy` subclass, e.g. + ``"scrapy.spidermiddlewares.referer.NoReferrerPolicy"`` or + ``"myproject.policies.CustomReferrerPolicy"``. + + If *warning_only* is ``False`` (default) and *policy* cannot be turned + into a :class:`ReferrerPolicy` subclass, a :exc:`RuntimeError` is + raised. If *warning_only* is ``True``, a warning is logged and ``None`` + is returned instead. + + If *allow_import_path* is ``False`` (default), import paths are not + allowed, resulting in :exc:`RuntimeError` or ``None``. If ``True``, + they are allowed. Use ``True`` only if you trust the source of the + *policy* value. + """ + if allow_import_path: + try: + return cast("type[ReferrerPolicy]", load_object(policy)) + except ValueError: + pass + policy_names = [ + policy_name.strip() for policy_name in policy.lower().split(",") + ] + # https://www.w3.org/TR/referrer-policy/#parse-referrer-policy-from-header + for policy_name in policy_names[::-1]: + if policy_name in self.policies: + return self.policies[policy_name] + msg = f"Could not load referrer policy {policy!r}" + if not allow_import_path and _looks_like_import_path(policy): + msg += " (import paths from the response Referrer-Policy header are not allowed)" + if not warning_only: + raise RuntimeError(msg) + warnings.warn(msg, RuntimeWarning, stacklevel=2) + return None + def get_processed_request( self, request: Request, response: Response | None ) -> Request | None: @@ -379,25 +437,3 @@ class RefererMiddleware(BaseSpiderMiddleware): if referrer is not None: request.headers.setdefault("Referer", referrer) return request - - def request_scheduled(self, request: Request, spider: Spider) -> None: - # check redirected request to patch "Referer" header if necessary - redirected_urls = request.meta.get("redirect_urls", []) - if redirected_urls: - request_referrer = request.headers.get("Referer") - # we don't patch the referrer value if there is none - if request_referrer is not None: - # the request's referrer header value acts as a surrogate - # for the parent response URL - # - # Note: if the 3xx response contained a Referrer-Policy header, - # the information is not available using this hook - parent_url = safe_url_string(request_referrer) - policy_referrer = self.policy(parent_url, request).referrer( - parent_url, request.url - ) - if policy_referrer != request_referrer.decode("latin1"): - if policy_referrer is None: - request.headers.pop("Referer") - else: - request.headers["Referer"] = policy_referrer diff --git a/scrapy/spidermiddlewares/urllength.py b/scrapy/spidermiddlewares/urllength.py index 5590165a5..f325ce7a0 100644 --- a/scrapy/spidermiddlewares/urllength.py +++ b/scrapy/spidermiddlewares/urllength.py @@ -49,7 +49,5 @@ class UrlLengthMiddleware(BaseSpiderMiddleware): extra={"spider": self.crawler.spider}, ) assert self.crawler.stats - self.crawler.stats.inc_value( - "urllength/request_ignored_count", spider=self.crawler.spider - ) + self.crawler.stats.inc_value("urllength/request_ignored_count") return None diff --git a/scrapy/spiders/__init__.py b/scrapy/spiders/__init__.py index a722dd83b..de527d04f 100644 --- a/scrapy/spiders/__init__.py +++ b/scrapy/spiders/__init__.py @@ -7,17 +7,15 @@ See documentation in docs/topics/spiders.rst from __future__ import annotations import logging -import warnings from typing import TYPE_CHECKING, Any, cast from scrapy import signals -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request, Response from scrapy.utils.trackref import object_ref from scrapy.utils.url import url_is_from_spider if TYPE_CHECKING: - from collections.abc import AsyncIterator, Iterable + from collections.abc import AsyncIterator from twisted.internet.defer import Deferred @@ -26,7 +24,7 @@ if TYPE_CHECKING: from scrapy.crawler import Crawler from scrapy.http.request import CallbackT - from scrapy.settings import BaseSettings, _SettingsKeyT + from scrapy.settings import BaseSettings from scrapy.utils.log import SpiderLoggerAdapter @@ -39,7 +37,7 @@ class Spider(object_ref): """ name: str - custom_settings: dict[_SettingsKeyT, Any] | None = None + custom_settings: dict[str, Any] | None = None #: Start URLs. See :meth:`start`. start_urls: list[str] @@ -55,7 +53,8 @@ class Spider(object_ref): @property def logger(self) -> SpiderLoggerAdapter: - from scrapy.utils.log import SpiderLoggerAdapter + # circular import + from scrapy.utils.log import SpiderLoggerAdapter # noqa: PLC0415 logger = logging.getLogger(self.name) return SpiderLoggerAdapter(logger, {"spider": self}) @@ -126,30 +125,6 @@ class Spider(object_ref): .. seealso:: :ref:`start-requests` """ - with warnings.catch_warnings(): - warnings.filterwarnings( - "ignore", category=ScrapyDeprecationWarning, module=r"^scrapy\.spiders$" - ) - for item_or_request in self.start_requests(): - yield item_or_request - - def start_requests(self) -> Iterable[Any]: - warnings.warn( - ( - "The Spider.start_requests() method is deprecated, use " - "Spider.start() instead. If you are calling " - "super().start_requests() from a Spider.start() override, " - "iterate super().start() instead." - ), - ScrapyDeprecationWarning, - stacklevel=2, - ) - if not self.start_urls and hasattr(self, "start_url"): - raise AttributeError( - "Crawling could not start: 'start_urls' not found " - "or empty (but found 'start_url' attribute instead, " - "did you miss an 's'?)" - ) for url in self.start_urls: yield Request(url, dont_filter=True) diff --git a/scrapy/spiders/crawl.py b/scrapy/spiders/crawl.py index 98e7b23c0..373c0b8b5 100644 --- a/scrapy/spiders/crawl.py +++ b/scrapy/spiders/crawl.py @@ -10,10 +10,9 @@ from __future__ import annotations import copy import warnings from collections.abc import AsyncIterator, Awaitable, Callable -from typing import TYPE_CHECKING, Any, Optional, TypeVar, cast - -from twisted.python.failure import Failure +from typing import TYPE_CHECKING, Any, TypeAlias, TypeVar, cast +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import HtmlResponse, Request, Response from scrapy.link import Link from scrapy.linkextractors import LinkExtractor @@ -26,6 +25,8 @@ from scrapy.utils.spider import iterate_spider_output if TYPE_CHECKING: from collections.abc import Iterable, Sequence + from twisted.python.failure import Failure + # typing.Self requires Python 3.11 from typing_extensions import Self @@ -34,8 +35,8 @@ if TYPE_CHECKING: _T = TypeVar("_T") -ProcessLinksT = Callable[[list[Link]], list[Link]] -ProcessRequestT = Callable[[Request, Response], Optional[Request]] +ProcessLinksT: TypeAlias = Callable[[list[Link]], list[Link]] +ProcessRequestT: TypeAlias = Callable[[Request, Response], Request | None] def _identity(x: _T) -> _T: @@ -46,7 +47,9 @@ def _identity_process_request(request: Request, response: Response) -> Request | return request -def _get_method(method: Callable | str | None, spider: Spider) -> Callable | None: +def _get_method( + method: Callable[..., Any] | str | None, spider: Spider +) -> Callable[..., Any] | None: if callable(method): return method if isinstance(method, str): @@ -81,12 +84,14 @@ class Rule: def _compile(self, spider: Spider) -> None: # this replaces method names with methods and we can't express this in type hints self.callback = cast("CallbackT", _get_method(self.callback, spider)) - self.errback = cast(Callable[[Failure], Any], _get_method(self.errback, spider)) + self.errback = cast( + "Callable[[Failure], Any]", _get_method(self.errback, spider) + ) self.process_links = cast( - ProcessLinksT, _get_method(self.process_links, spider) + "ProcessLinksT", _get_method(self.process_links, spider) ) self.process_request = cast( - ProcessRequestT, _get_method(self.process_request, spider) + "ProcessRequestT", _get_method(self.process_request, spider) ) @@ -100,11 +105,13 @@ class CrawlSpider(Spider): self._compile_rules() if method_is_overridden(self.__class__, CrawlSpider, "_parse_response"): warnings.warn( - f"The CrawlSpider._parse_response method, which the " + "The CrawlSpider._parse_response method, which the " f"{global_object_name(self.__class__)} class overrides, is " - f"deprecated: it will be removed in future Scrapy releases. " - f"Please override the CrawlSpider.parse_with_rules method " - f"instead." + "deprecated: it will be removed in future Scrapy releases. " + "Please override the CrawlSpider.parse_with_rules method " + "instead.", + ScrapyDeprecationWarning, + stacklevel=2, ) def _parse(self, response: Response, **kwargs: Any) -> Any: @@ -116,7 +123,7 @@ class CrawlSpider(Spider): ) def parse_start_url(self, response: Response, **kwargs: Any) -> Any: - return [] + return () def process_results( self, response: Response, results: Iterable[Any] @@ -141,13 +148,13 @@ class CrawlSpider(Spider): for lnk in rule.link_extractor.extract_links(response) if lnk not in seen ] - for link in cast(ProcessLinksT, rule.process_links)(links): + for link in cast("ProcessLinksT", rule.process_links)(links): seen.add(link) request = self._build_request(rule_index, link) - yield cast(ProcessRequestT, rule.process_request)(request, response) + yield cast("ProcessRequestT", rule.process_request)(request, response) def _callback(self, response: Response, **cb_kwargs: Any) -> Any: - rule = self._rules[cast(int, response.meta["rule"])] + rule = self._rules[cast("int", response.meta["rule"])] return self.parse_with_rules( response, cast("CallbackT", rule.callback), @@ -156,9 +163,9 @@ class CrawlSpider(Spider): ) def _errback(self, failure: Failure) -> Iterable[Any]: - rule = self._rules[cast(int, failure.request.meta["rule"])] # type: ignore[attr-defined] + rule = self._rules[cast("int", failure.request.meta["rule"])] # type: ignore[attr-defined] return self._handle_failure( - failure, cast(Callable[[Failure], Any], rule.errback) + failure, cast("Callable[[Failure], Any]", rule.errback) ) async def parse_with_rules( @@ -193,6 +200,7 @@ class CrawlSpider(Spider): "The CrawlSpider._parse_response method is deprecated: " "it will be removed in future Scrapy releases. " "Please use the CrawlSpider.parse_with_rules method instead.", + ScrapyDeprecationWarning, stacklevel=2, ) return self.parse_with_rules(response, callback, cb_kwargs, follow) @@ -207,11 +215,19 @@ class CrawlSpider(Spider): def _compile_rules(self) -> None: self._rules = [] for rule in self.rules: - self._rules.append(copy.copy(rule)) - self._rules[-1]._compile(self) + copied_rule = copy.copy(rule) + copied_rule._compile(self) + self._rules.append(copied_rule) @classmethod def from_crawler(cls, crawler: Crawler, *args: Any, **kwargs: Any) -> Self: spider = super().from_crawler(crawler, *args, **kwargs) spider._follow_links = crawler.settings.getbool("CRAWLSPIDER_FOLLOW_LINKS") + if not spider._follow_links: + warnings.warn( + "The CRAWLSPIDER_FOLLOW_LINKS setting is deprecated." + " You can set follow=False in your rules to achieve the same effect.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) return spider diff --git a/scrapy/spiders/init.py b/scrapy/spiders/init.py deleted file mode 100644 index e5548b9fa..000000000 --- a/scrapy/spiders/init.py +++ /dev/null @@ -1,63 +0,0 @@ -from __future__ import annotations - -import warnings -from collections.abc import AsyncIterator, Iterable -from typing import TYPE_CHECKING, Any, cast - -from scrapy import Request -from scrapy.exceptions import ScrapyDeprecationWarning -from scrapy.spiders import Spider -from scrapy.utils.spider import iterate_spider_output - -if TYPE_CHECKING: - from scrapy.http import Response - - -class InitSpider(Spider): - """Base Spider with initialization facilities - - .. warning:: This class is deprecated. Copy its code into your project if needed. - It will be removed in a future Scrapy version. - """ - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - warnings.warn( - "InitSpider is deprecated. Copy its code from Scrapy's source if needed. " - "Will be removed in a future version.", - ScrapyDeprecationWarning, - stacklevel=2, - ) - - async def start(self) -> AsyncIterator[Any]: - with warnings.catch_warnings(): - warnings.filterwarnings( - "ignore", category=ScrapyDeprecationWarning, module=r"^scrapy\.spiders$" - ) - for item_or_request in self.start_requests(): - yield item_or_request - - def start_requests(self) -> Iterable[Request]: - self._postinit_reqs: Iterable[Request] = super().start_requests() - return cast(Iterable[Request], iterate_spider_output(self.init_request())) - - def initialized(self, response: Response | None = None) -> Any: - """This method must be set as the callback of your last initialization - request. See self.init_request() docstring for more info. - """ - return self.__dict__.pop("_postinit_reqs") - - def init_request(self) -> Any: - """This function should return one initialization request, with the - self.initialized method as callback. When the self.initialized method - is called this spider is considered initialized. If you need to perform - several requests for initializing your spider, you can do so by using - different callbacks. The only requirement is that the final callback - (of the last initialization request) must be self.initialized. - - The default implementation calls self.initialized immediately, and - means that no initialization is needed. This method should be - overridden only when you need to perform requests to initialize your - spider - """ - return self.initialized() diff --git a/scrapy/spiders/sitemap.py b/scrapy/spiders/sitemap.py index 2813a32a0..2a80b8d24 100644 --- a/scrapy/spiders/sitemap.py +++ b/scrapy/spiders/sitemap.py @@ -49,15 +49,11 @@ class SitemapSpider(Spider): self._cbs: list[tuple[re.Pattern[str], CallbackT]] = [] for r, c in self.sitemap_rules: if isinstance(c, str): - c = cast("CallbackT", getattr(self, c)) + c = cast("CallbackT", getattr(self, c)) # noqa: PLW2901 self._cbs.append((regex(r), c)) self._follow: list[re.Pattern[str]] = [regex(x) for x in self.sitemap_follow] async def start(self) -> AsyncIterator[Any]: - for item_or_request in self.start_requests(): - yield item_or_request - - def start_requests(self) -> Iterable[Request]: for url in self.sitemap_urls: yield Request(url, self._parse_sitemap) @@ -72,31 +68,53 @@ class SitemapSpider(Spider): def _parse_sitemap(self, response: Response) -> Iterable[Request]: if response.url.endswith("/robots.txt"): - for url in sitemap_urls_from_robots(response.text, base_url=response.url): - yield Request(url, callback=self._parse_sitemap) - else: - body = self._get_sitemap_body(response) - if body is None: - logger.warning( - "Ignoring invalid sitemap: %(response)s", - {"response": response}, - extra={"spider": self}, - ) - return + urls = list(sitemap_urls_from_robots(response.body, base_url=response.url)) + return (Request(url, callback=self._parse_sitemap) for url in urls) - s = Sitemap(body) - it = self.sitemap_filter(s) + body = self._get_sitemap_body(response) + if not body: + logger.warning( + "Ignoring invalid sitemap: %(response)s", + {"response": response}, + extra={"spider": self}, + ) + return () - if s.type == "sitemapindex": - for loc in iterloc(it, self.sitemap_alternate_links): - if any(x.search(loc) for x in self._follow): - yield Request(loc, callback=self._parse_sitemap) - elif s.type == "urlset": - for loc in iterloc(it, self.sitemap_alternate_links): - for r, c in self._cbs: - if r.search(loc): - yield Request(loc, callback=c) - break + s = Sitemap(body) + + if s.type == "sitemapindex": + urls = list(self._get_urls_from_sitemapindex(self.sitemap_filter(s))) + return (Request(loc, callback=self._parse_sitemap) for loc in urls) + + if s.type == "urlset": + url_callback_pairs = list( + self._get_urls_and_callbacks_from_urlset(self.sitemap_filter(s)) + ) + return (Request(loc, callback=c) for loc, c in url_callback_pairs) + + logger.warning( + "Ignoring invalid sitemap: %(response)s", + {"response": response}, + extra={"spider": self}, + ) + + return () + + def _get_urls_from_sitemapindex( + self, it: Iterable[dict[str, Any]] + ) -> Iterable[str]: + for loc in iterloc(it, self.sitemap_alternate_links): + if any(x.search(loc) for x in self._follow): + yield loc + + def _get_urls_and_callbacks_from_urlset( + self, it: Iterable[dict[str, Any]] + ) -> Iterable[tuple[str, CallbackT]]: + for loc in iterloc(it, self.sitemap_alternate_links): + for r, c in self._cbs: + if r.search(loc): + yield loc, c + break def _get_sitemap_body(self, response: Response) -> bytes | None: """Return the sitemap body contained in the given response, @@ -140,8 +158,9 @@ def regex(x: re.Pattern[str] | str) -> re.Pattern[str]: def iterloc(it: Iterable[dict[str, Any]], alt: bool = False) -> Iterable[str]: for d in it: - yield d["loc"] + if loc := d["loc"]: + yield loc # Also consider alternate URLs (xhtml:link rel="alternate") - if alt and "alternate" in d: - yield from d["alternate"] + if alt and (alt_list := d.get("alternate")): + yield from alt_list diff --git a/scrapy/squeues.py b/scrapy/squeues.py index 7007cd4b8..e06e38e23 100644 --- a/scrapy/squeues.py +++ b/scrapy/squeues.py @@ -26,7 +26,7 @@ if TYPE_CHECKING: def _with_mkdir(queue_class: type[queue.BaseQueue]) -> type[queue.BaseQueue]: class DirectoriesCreated(queue_class): # type: ignore[valid-type,misc] - def __init__(self, path: str | PathLike, *args: Any, **kwargs: Any): + def __init__(self, path: str | PathLike[str], *args: Any, **kwargs: Any): dirname = Path(path).parent if not dirname.exists(): dirname.mkdir(parents=True, exist_ok=True) diff --git a/scrapy/statscollectors.py b/scrapy/statscollectors.py index f3dd0f8e7..1f9894519 100644 --- a/scrapy/statscollectors.py +++ b/scrapy/statscollectors.py @@ -8,6 +8,8 @@ import logging import pprint from typing import TYPE_CHECKING, Any +from scrapy.utils.decorators import _warn_spider_arg + if TYPE_CHECKING: from scrapy import Spider from scrapy.crawler import Crawler @@ -23,6 +25,34 @@ class StatsCollector: def __init__(self, crawler: Crawler): self._dump: bool = crawler.settings.getbool("STATS_DUMP") self._stats: StatsT = {} + self._crawler: Crawler = crawler + + def __getattribute__(self, name: str) -> Any: + cached_name = f"_cached_{name}" + try: + return super().__getattribute__(cached_name) + except AttributeError: + pass + + original_attr = super().__getattribute__(name) + + if name in { + "get_value", + "get_stats", + "set_value", + "set_stats", + "inc_value", + "max_value", + "min_value", + "clear_stats", + "open_spider", + "close_spider", + } and callable(original_attr): + wrapped = _warn_spider_arg(original_attr) + setattr(self, cached_name, wrapped) + return wrapped + + return original_attr def get_value( self, key: str, default: Any = None, spider: Spider | None = None @@ -53,18 +83,20 @@ class StatsCollector: def clear_stats(self, spider: Spider | None = None) -> None: self._stats.clear() - def open_spider(self, spider: Spider) -> None: + def open_spider(self, spider: Spider | None = None) -> None: pass - def close_spider(self, spider: Spider, reason: str) -> None: + def close_spider( + self, spider: Spider | None = None, reason: str | None = None + ) -> None: if self._dump: logger.info( "Dumping Scrapy stats:\n" + pprint.pformat(self._stats), - extra={"spider": spider}, + extra={"spider": self._crawler.spider}, ) - self._persist_stats(self._stats, spider) + self._persist_stats(self._stats) - def _persist_stats(self, stats: StatsT, spider: Spider) -> None: + def _persist_stats(self, stats: StatsT) -> None: pass @@ -73,8 +105,9 @@ class MemoryStatsCollector(StatsCollector): super().__init__(crawler) self.spider_stats: dict[str, StatsT] = {} - def _persist_stats(self, stats: StatsT, spider: Spider) -> None: - self.spider_stats[spider.name] = stats + def _persist_stats(self, stats: StatsT) -> None: + if self._crawler.spider: + self.spider_stats[self._crawler.spider.name] = stats class DummyStatsCollector(StatsCollector): diff --git a/scrapy/templates/project/module/items.py.tmpl b/scrapy/templates/project/module/items.py.tmpl index 88a18331c..e7d525f36 100644 --- a/scrapy/templates/project/module/items.py.tmpl +++ b/scrapy/templates/project/module/items.py.tmpl @@ -3,10 +3,11 @@ # See documentation in: # https://docs.scrapy.org/en/latest/topics/items.html -import scrapy +from dataclasses import dataclass -class ${ProjectName}Item(scrapy.Item): +@dataclass +class ${ProjectName}Item: # define the fields for your item here like: - # name = scrapy.Field() + # name: str | None = None pass diff --git a/scrapy/templates/project/module/middlewares.py.tmpl b/scrapy/templates/project/module/middlewares.py.tmpl index 3f0239832..a0b5910e0 100644 --- a/scrapy/templates/project/module/middlewares.py.tmpl +++ b/scrapy/templates/project/module/middlewares.py.tmpl @@ -45,7 +45,7 @@ class ${ProjectName}SpiderMiddleware: async def process_start(self, start): # Called with an async iterator over the spider start() method or the - # maching method of an earlier spider middleware. + # matching method of an earlier spider middleware. async for item_or_request in start: yield item_or_request diff --git a/scrapy/utils/_compression.py b/scrapy/utils/_compression.py index 6b09f36ff..4767c29f2 100644 --- a/scrapy/utils/_compression.py +++ b/scrapy/utils/_compression.py @@ -1,42 +1,12 @@ import contextlib import zlib from io import BytesIO -from warnings import warn -from scrapy.exceptions import ScrapyDeprecationWarning - -try: +with contextlib.suppress(ImportError): try: import brotli except ImportError: import brotlicffi as brotli -except ImportError: - pass -else: - try: - brotli.Decompressor.process - except AttributeError: - warn( - ( - "You have brotlipy installed, and Scrapy will use it, but " - "Scrapy support for brotlipy is deprecated and will stop " - "working in a future version of Scrapy. brotlipy itself is " - "deprecated, it has been superseded by brotlicffi. Please, " - "uninstall brotlipy and install brotli or brotlicffi instead. " - "brotlipy has the same import name as brotli, so keeping both " - "installed is strongly discouraged." - ), - ScrapyDeprecationWarning, - ) - - def _brotli_decompress(decompressor, data): - return decompressor.decompress(data) - - else: - - def _brotli_decompress(decompressor, data): - return decompressor.process(data) - with contextlib.suppress(ImportError): import zstandard @@ -46,62 +16,64 @@ _CHUNK_SIZE = 65536 # 64 KiB class _DecompressionMaxSizeExceeded(ValueError): - pass + def __init__(self, decompressed_size: int, max_size: int) -> None: + self.decompressed_size = decompressed_size + self.max_size = max_size + + def __str__(self) -> str: + return ( + f"The number of bytes decompressed so far " + f"({self.decompressed_size} B) exceeded the specified maximum " + f"({self.max_size} B)." + ) + + +def _check_max_size(decompressed_size: int, max_size: int) -> None: + if max_size and decompressed_size > max_size: + raise _DecompressionMaxSizeExceeded(decompressed_size, max_size) def _inflate(data: bytes, *, max_size: int = 0) -> bytes: decompressor = zlib.decompressobj() - raw_decompressor = zlib.decompressobj(wbits=-15) - input_stream = BytesIO(data) + try: + first_chunk = decompressor.decompress(data, max_length=_CHUNK_SIZE) + except zlib.error: + # to work with raw deflate content that may be sent by microsoft servers. + decompressor = zlib.decompressobj(wbits=-15) + first_chunk = decompressor.decompress(data, max_length=_CHUNK_SIZE) + decompressed_size = len(first_chunk) + _check_max_size(decompressed_size, max_size) output_stream = BytesIO() - output_chunk = b"." - decompressed_size = 0 - while output_chunk: - input_chunk = input_stream.read(_CHUNK_SIZE) - try: - output_chunk = decompressor.decompress(input_chunk) - except zlib.error: - if decompressor != raw_decompressor: - # ugly hack to work with raw deflate content that may - # be sent by microsoft servers. For more information, see: - # http://carsten.codimi.de/gzip.yaws/ - # http://www.port80software.com/200ok/archive/2005/10/31/868.aspx - # http://www.gzip.org/zlib/zlib_faq.html#faq38 - decompressor = raw_decompressor - output_chunk = decompressor.decompress(input_chunk) - else: - raise + output_stream.write(first_chunk) + while decompressor.unconsumed_tail: + output_chunk = decompressor.decompress( + decompressor.unconsumed_tail, max_length=_CHUNK_SIZE + ) decompressed_size += len(output_chunk) - if max_size and decompressed_size > max_size: - raise _DecompressionMaxSizeExceeded( - f"The number of bytes decompressed so far " - f"({decompressed_size} B) exceed the specified maximum " - f"({max_size} B)." - ) + _check_max_size(decompressed_size, max_size) output_stream.write(output_chunk) - output_stream.seek(0) - return output_stream.read() + if tail := decompressor.flush(): + decompressed_size += len(tail) + _check_max_size(decompressed_size, max_size) + output_stream.write(tail) + return output_stream.getvalue() def _unbrotli(data: bytes, *, max_size: int = 0) -> bytes: decompressor = brotli.Decompressor() - input_stream = BytesIO(data) + first_chunk = decompressor.process(data, output_buffer_limit=_CHUNK_SIZE) + decompressed_size = len(first_chunk) + _check_max_size(decompressed_size, max_size) output_stream = BytesIO() - output_chunk = b"." - decompressed_size = 0 - while output_chunk: - input_chunk = input_stream.read(_CHUNK_SIZE) - output_chunk = _brotli_decompress(decompressor, input_chunk) + output_stream.write(first_chunk) + while not decompressor.is_finished(): + output_chunk = decompressor.process(b"", output_buffer_limit=_CHUNK_SIZE) + if not output_chunk: + break decompressed_size += len(output_chunk) - if max_size and decompressed_size > max_size: - raise _DecompressionMaxSizeExceeded( - f"The number of bytes decompressed so far " - f"({decompressed_size} B) exceed the specified maximum " - f"({max_size} B)." - ) + _check_max_size(decompressed_size, max_size) output_stream.write(output_chunk) - output_stream.seek(0) - return output_stream.read() + return output_stream.getvalue() def _unzstd(data: bytes, *, max_size: int = 0) -> bytes: @@ -113,12 +85,6 @@ def _unzstd(data: bytes, *, max_size: int = 0) -> bytes: while output_chunk: output_chunk = stream_reader.read(_CHUNK_SIZE) decompressed_size += len(output_chunk) - if max_size and decompressed_size > max_size: - raise _DecompressionMaxSizeExceeded( - f"The number of bytes decompressed so far " - f"({decompressed_size} B) exceed the specified maximum " - f"({max_size} B)." - ) + _check_max_size(decompressed_size, max_size) output_stream.write(output_chunk) - output_stream.seek(0) - return output_stream.read() + return output_stream.getvalue() diff --git a/scrapy/utils/_deps_compat.py b/scrapy/utils/_deps_compat.py new file mode 100644 index 000000000..17957aba4 --- /dev/null +++ b/scrapy/utils/_deps_compat.py @@ -0,0 +1,28 @@ +import sys + +from OpenSSL import __version__ as PYOPENSSL_VERSION_STRING +from packaging.version import Version +from twisted import version as TWISTED_VERSION +from twisted.python.versions import Version as TxVersion +from w3lib import __version__ as W3LIB_VERSION_STRING + +# improved urllib.robotparser, https://github.com/python/cpython/pull/149374 +STDLIB_IMPROVED_ROBOTFILEPARSER = sys.version_info >= (3, 14, 5) or ( + (3, 13, 14) <= sys.version_info < (3, 14) +) + +TWISTED_FAILURE_HAS_STACK = TWISTED_VERSION < TxVersion("twisted", 24, 10, 0) +# changes to private _sslverify code, https://github.com/twisted/twisted/pull/12506 +TWISTED_TLS_NEW_IMPL = TWISTED_VERSION >= TxVersion("twisted", 26, 4, 0) +# lowerMaximumSecurityTo off-by-1, https://github.com/twisted/twisted/issues/10232 +TWISTED_TLS_LIMITS_OFFBY1 = TWISTED_VERSION < TxVersion("twisted", 26, 4, 0) + +PYOPENSSL_VERSION = Version(PYOPENSSL_VERSION_STRING) +# pyOpenSSL X.509 APIs are deprecated and cryptography-based ones are preferred +PYOPENSSL_X509_DEPRECATED = PYOPENSSL_VERSION >= Version("24.3.0") +# SSL.Context.set_cipher_list() creates a temporary connection, making the context immutable +PYOPENSSL_SET_CIPHER_LIST_TMP_CONN = PYOPENSSL_VERSION < Version("25.2.0") + +W3LIB_VERSION = Version(W3LIB_VERSION_STRING) +# safe_url_string() strips the input, https://github.com/scrapy/w3lib/pull/207 +W3LIB_STRIPS_URLS = W3LIB_VERSION >= Version("2.1.1") diff --git a/scrapy/utils/_download_handlers.py b/scrapy/utils/_download_handlers.py new file mode 100644 index 000000000..23b715ac6 --- /dev/null +++ b/scrapy/utils/_download_handlers.py @@ -0,0 +1,153 @@ +"""Utils for built-in HTTP download handlers.""" + +from __future__ import annotations + +from contextlib import contextmanager +from http.cookiejar import CookieJar +from typing import TYPE_CHECKING, Any + +from twisted.internet.defer import CancelledError +from twisted.internet.error import ConnectionRefusedError as TxConnectionRefusedError +from twisted.internet.error import DNSLookupError +from twisted.internet.error import TimeoutError as TxTimeoutError +from twisted.python.failure import Failure +from twisted.web.client import ResponseFailed +from twisted.web.error import SchemeNotSupported + +from scrapy import responsetypes +from scrapy.exceptions import ( + CannotResolveHostError, + DownloadCancelledError, + DownloadConnectionRefusedError, + DownloadFailedError, + DownloadTimeoutError, + StopDownload, + UnsupportedURLSchemeError, +) +from scrapy.utils.log import logger + +if TYPE_CHECKING: + from collections.abc import Iterator + from http.client import HTTPResponse + from http.cookiejar import Cookie + from ipaddress import IPv4Address, IPv6Address + from urllib.request import Request as ULRequest + + from scrapy import Request + from scrapy.crawler import Crawler + from scrapy.http import Headers, Response + + +class NullCookieJar(CookieJar): # pragma: no cover + """A CookieJar that rejects all cookies.""" + + def extract_cookies(self, response: HTTPResponse, request: ULRequest) -> None: + pass + + def set_cookie(self, cookie: Cookie) -> None: + pass + + +@contextmanager +def wrap_twisted_exceptions() -> Iterator[None]: + """Context manager that wraps Twisted exceptions into Scrapy exceptions.""" + try: + yield + except SchemeNotSupported as e: + raise UnsupportedURLSchemeError(str(e)) from e + except CancelledError as e: + raise DownloadCancelledError(str(e)) from e + except TxConnectionRefusedError as e: + raise DownloadConnectionRefusedError(str(e)) from e + except DNSLookupError as e: + raise CannotResolveHostError(str(e)) from e + except ResponseFailed as e: + raise DownloadFailedError(str(e)) from e + except TxTimeoutError as e: + raise DownloadTimeoutError(str(e)) from e + + +def check_stop_download( + signal: object, crawler: Crawler, request: Request, **kwargs: Any +) -> StopDownload | None: + """Send the given signal and check if any of its handlers raised + :exc:`~scrapy.exceptions.StopDownload`. + + Return the raised exception or ``None``. + """ + signal_result = crawler.signals.send_catch_log( + signal=signal, + request=request, + spider=crawler.spider, + **kwargs, + ) + for handler, result in signal_result: + if isinstance(result, Failure) and isinstance(result.value, StopDownload): + logger.debug( + f"Download stopped for {request} from signal handler {handler.__qualname__}" + ) + return result.value + + return None + + +def make_response( + url: str, + status: int, + headers: Headers, + body: bytes = b"", + flags: list[str] | None = None, + certificate: Any = None, + ip_address: IPv4Address | IPv6Address | None = None, + protocol: str | None = None, + stop_download: StopDownload | None = None, +) -> Response: + respcls = responsetypes.responsetypes.from_args(headers=headers, url=url, body=body) + response = respcls( + url=url, + status=status, + headers=headers, + body=body, + flags=flags, + certificate=certificate, + ip_address=ip_address, + protocol=protocol, + ) + if stop_download: + response.flags.append("download_stopped") + if stop_download.fail: + stop_download.response = response + raise stop_download + return response + + +def get_maxsize_msg(size: int, limit: int, request: Request, *, expected: bool) -> str: + prefix = "Expected to receive" if expected else "Received" + return ( + f"{prefix} {size} bytes which is larger than download " + f"max size ({limit}) in request {request}." + ) + + +def get_warnsize_msg(size: int, limit: int, request: Request, *, expected: bool) -> str: + prefix = "Expected to receive" if expected else "Received" + return ( + f"{prefix} {size} bytes which is larger than download " + f"warn size ({limit}) in request {request}." + ) + + +def get_dataloss_msg(url: str) -> str: + return ( + f"Got data loss in {url}. If you want to process broken " + f"responses set the setting DOWNLOAD_FAIL_ON_DATALOSS = False" + f" -- This message won't be shown in further requests" + ) + + +def normalize_bind_address( + value: str | tuple[str, int] | None, +) -> tuple[str, int] | None: + if isinstance(value, str): + return (value, 0) + return value diff --git a/scrapy/utils/asyncio.py b/scrapy/utils/asyncio.py index 8c5b843cb..44604c0fe 100644 --- a/scrapy/utils/asyncio.py +++ b/scrapy/utils/asyncio.py @@ -6,10 +6,11 @@ import asyncio import logging import time from collections.abc import AsyncIterator, Callable, Coroutine, Iterable -from typing import TYPE_CHECKING, Any, TypeVar +from typing import TYPE_CHECKING, Any, Concatenate, ParamSpec, TypeVar from twisted.internet.defer import Deferred from twisted.internet.task import LoopingCall +from twisted.internet.threads import deferToThread from scrapy.utils.asyncgen import as_async_generator from scrapy.utils.reactor import is_asyncio_reactor_installed, is_reactor_installed @@ -17,15 +18,14 @@ from scrapy.utils.reactor import is_asyncio_reactor_installed, is_reactor_instal if TYPE_CHECKING: from twisted.internet.base import DelayedCall - # typing.Concatenate and typing.ParamSpec require Python 3.10 # typing.Self, typing.TypeVarTuple and typing.Unpack require Python 3.11 - from typing_extensions import Concatenate, ParamSpec, Self, TypeVarTuple, Unpack + from typing_extensions import Self, TypeVarTuple, Unpack - _P = ParamSpec("_P") _Ts = TypeVarTuple("_Ts") _T = TypeVar("_T") +_P = ParamSpec("_P") logger = logging.getLogger(__name__) @@ -34,17 +34,18 @@ logger = logging.getLogger(__name__) def is_asyncio_available() -> bool: """Check if it's possible to call asyncio code that relies on the asyncio event loop. - .. versionadded:: VERSION + .. versionadded:: 2.14 - Currently this function is identical to - :func:`scrapy.utils.reactor.is_asyncio_reactor_installed`: it returns - ``True`` if the Twisted reactor that is installed is + This function returns ``True`` if there is a running asyncio event loop. If + there is no such loop, it returns ``True`` if the Twisted reactor that is + installed is :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor`, returns ``False`` if a different reactor is installed, and raises a - :exc:`RuntimeError` if no reactor is installed. In a future Scrapy version, - when Scrapy supports running without a Twisted reactor, this function will - also return ``True`` when running in that mode, so code that doesn't - directly require a Twisted reactor should use this function instead of + :exc:`RuntimeError` if no reactor is installed. + + Code that doesn't directly require a Twisted reactor should use this + function while code that requires + :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` should use :func:`~scrapy.utils.reactor.is_asyncio_reactor_installed`. When this returns ``True``, an asyncio loop is installed and used by @@ -57,10 +58,35 @@ def is_asyncio_available() -> bool: loop or await on :class:`asyncio.Future` objects in Scrapy-related code, but it's possible to await on :class:`~twisted.internet.defer.Deferred` objects. + + .. note:: As this function uses :func:`asyncio.get_running_loop()`, it will + only detect the event loop if called in the same thread and from the + code that runs inside that loop (this shouldn't be a problem when + calling it from code such as spiders and Scrapy components, if Scrapy + is run using one of the supported ways). + + .. versionchanged:: 2.15.0 + This function now also returns ``True`` if there is a running asyncio + loop, even if no Twisted reactor is installed. """ + + # Check if there is a running asyncio loop. + # Can't easily check for an installed but not running one, and if we + # checked that there could be false positives due to some 3rd-party code + # installing it as a side effect (e.g. by calling get_event_loop()). + try: + asyncio.get_running_loop() + except RuntimeError: + pass + else: + return True + + # Check if there is an installed asyncio reactor (it doesn't need to be + # running). if not is_reactor_installed(): raise RuntimeError( - "is_asyncio_available() called without an installed reactor." + "is_asyncio_available() called without an installed reactor" + " or running asyncio loop." ) return is_asyncio_reactor_installed() @@ -69,7 +95,7 @@ def is_asyncio_available() -> bool: async def _parallel_asyncio( iterable: Iterable[_T] | AsyncIterator[_T], count: int, - callable: Callable[Concatenate[_T, _P], Coroutine[Any, Any, None]], + callable_: Callable[Concatenate[_T, _P], Coroutine[Any, Any, None]], *args: _P.args, **kwargs: _P.kwargs, ) -> None: @@ -81,7 +107,7 @@ async def _parallel_asyncio( assumes that neither *callable* nor iterating *iterable* will raise an exception. """ - queue: asyncio.Queue[_T | None] = asyncio.Queue() + queue: asyncio.Queue[_T | None] = asyncio.Queue(count * 2) async def worker() -> None: while True: @@ -89,7 +115,7 @@ async def _parallel_asyncio( if item is None: break try: - await callable(item, *args, **kwargs) + await callable_(item, *args, **kwargs) finally: queue.task_done() @@ -106,20 +132,23 @@ async def _parallel_asyncio( class AsyncioLoopingCall: """A simple implementation of a periodic call using asyncio, keeping - some API and behavior compatibility with the Twisted ``LoopingCall``. + some API and behavior compatibility with + :class:`~twisted.internet.task.LoopingCall`. The function is called every *interval* seconds, independent of the finish time of the previous call. If the function is still running when it's time to call it again, calls are skipped until the function finishes. The function must not return a coroutine or a ``Deferred``. + + .. versionadded:: 2.14.0 """ def __init__(self, func: Callable[_P, _T], *args: _P.args, **kwargs: _P.kwargs): self._func: Callable[_P, _T] = func self._args: tuple[Any, ...] = args self._kwargs: dict[str, Any] = kwargs - self._task: asyncio.Task | None = None + self._task: asyncio.Task[None] | None = None self.interval: float | None = None self._start_time: float | None = None @@ -143,7 +172,7 @@ class AsyncioLoopingCall: raise ValueError("Interval must be greater than 0") self.interval = interval - self._start_time = time.time() + self._start_time = time.monotonic() if now: self._call() loop = asyncio.get_event_loop() @@ -153,7 +182,7 @@ class AsyncioLoopingCall: """Return the time to sleep until the next call.""" assert self.interval is not None assert self._start_time is not None - now = time.time() + now = time.monotonic() running_for = now - self._start_time return self.interval - (running_for % self.interval) @@ -190,8 +219,12 @@ def create_looping_call( ) -> AsyncioLoopingCall | LoopingCall: """Create an instance of a looping call class. - This creates an instance of :class:`AsyncioLoopingCall` or - :class:`LoopingCall`, depending on whether asyncio support is available. + This creates an instance of + :class:`~scrapy.utils.asyncio.AsyncioLoopingCall` or + :class:`~twisted.internet.task.LoopingCall`, depending on whether asyncio + support is available. + + .. versionadded:: 2.14.0 """ if is_asyncio_available(): return AsyncioLoopingCall(func, *args, **kwargs) @@ -203,8 +236,11 @@ def call_later( ) -> CallLaterResult: """Schedule a function to be called after a delay. - This uses either ``loop.call_later()`` or ``reactor.callLater()``, depending - on whether asyncio support is available. + This uses either :meth:`asyncio.loop.call_later` or + :meth:`reactor.callLater() `, + depending on whether asyncio support is available. + + .. versionadded:: 2.14.0 """ if is_asyncio_available(): loop = asyncio.get_event_loop() @@ -223,6 +259,8 @@ class CallLaterResult: no ``active()`` (as there is no such public API in :class:`asyncio.TimerHandle`) but ``cancel()`` can be called on already called or cancelled instances. + + .. versionadded:: 2.14.0 """ _timer_handle: asyncio.TimerHandle | None = None @@ -253,3 +291,23 @@ class CallLaterResult: elif self._delayed_call and self._delayed_call.active(): self._delayed_call.cancel() self._delayed_call = None + + +async def run_in_thread( + func: Callable[_P, _T], *args: _P.args, **kwargs: _P.kwargs +) -> _T: + """Call a function in a thread and return its result as a coroutine. + + This uses either :func:`asyncio.to_thread` or + :func:`twisted.internet.threads.deferToThread`, depending on whether + asyncio support is available. + + .. versionadded:: 2.15.0 + """ + if is_asyncio_available(): + return await asyncio.to_thread(func, *args, **kwargs) + + # circular import + from scrapy.utils.defer import maybe_deferred_to_future # noqa: PLC0415 + + return await maybe_deferred_to_future(deferToThread(func, *args, **kwargs)) diff --git a/scrapy/utils/benchserver.py b/scrapy/utils/benchserver.py index 923ec005e..403cd54a8 100644 --- a/scrapy/utils/benchserver.py +++ b/scrapy/utils/benchserver.py @@ -9,7 +9,7 @@ from twisted.web.server import Request, Site class Root(Resource): isLeaf = True - def getChild(self, name: str, request: Request) -> Resource: + def getChild(self, path: str, request: Request) -> Resource: return self def render(self, request: Request) -> bytes: @@ -27,14 +27,16 @@ class Root(Resource): return b"" -def _getarg(request, name: bytes, default: Any = None, type=str): - return type(request.args[name][0]) if name in request.args else default +def _getarg( + request: Request, name: bytes, default: Any = None, type_: type = str +) -> Any: + return type_(request.args[name][0]) if name in request.args else default if __name__ == "__main__": from twisted.internet import reactor - root = Root() + root = Root() # type: ignore[no-untyped-call] factory = Site(root) httpPort = reactor.listenTCP(8998, Site(root)) diff --git a/scrapy/utils/boto.py b/scrapy/utils/boto.py index 53cfeddd0..73f86bc71 100644 --- a/scrapy/utils/boto.py +++ b/scrapy/utils/boto.py @@ -3,7 +3,7 @@ def is_botocore_available() -> bool: try: - import botocore # noqa: F401 + import botocore # noqa: F401,PLC0415 return True except ImportError: diff --git a/scrapy/utils/conf.py b/scrapy/utils/conf.py index 891cbb485..4850b370b 100644 --- a/scrapy/utils/conf.py +++ b/scrapy/utils/conf.py @@ -6,7 +6,7 @@ import sys from configparser import ConfigParser from operator import itemgetter from pathlib import Path -from typing import TYPE_CHECKING, Any, Callable, cast +from typing import TYPE_CHECKING, Any, cast from scrapy.exceptions import UsageError from scrapy.settings import BaseSettings @@ -14,7 +14,7 @@ from scrapy.utils.deprecate import update_classpath from scrapy.utils.python import without_none_values if TYPE_CHECKING: - from collections.abc import Collection, Iterable, Mapping, MutableMapping + from collections.abc import Callable, Collection, Iterable, Mapping, MutableMapping def build_component_list( @@ -71,8 +71,8 @@ def arglist_to_dict(arglist: list[str]) -> dict[str, str]: def closest_scrapy_cfg( - path: str | os.PathLike = ".", - prevpath: str | os.PathLike | None = None, + path: str | os.PathLike[str] = ".", + prevpath: str | os.PathLike[str] | None = None, ) -> str: """Return the path to the closest scrapy.cfg file by traversing the current directory and its parents @@ -153,7 +153,7 @@ def feed_process_params_from_cli( suitable to be used as the FEEDS setting. """ valid_output_formats: Iterable[str] = without_none_values( - cast(dict[str, str], settings.getwithbase("FEED_EXPORTERS")) + cast("dict[str, str]", settings.getwithbase("FEED_EXPORTERS")) ).keys() def check_valid_format(output_format: str) -> None: diff --git a/scrapy/utils/console.py b/scrapy/utils/console.py index 7425543ff..93fbb9033 100644 --- a/scrapy/utils/console.py +++ b/scrapy/utils/console.py @@ -1,5 +1,6 @@ from __future__ import annotations +import code from collections.abc import Callable from functools import wraps from typing import TYPE_CHECKING, Any @@ -12,23 +13,23 @@ KnownShellsT = dict[str, Callable[..., EmbedFuncT]] def _embed_ipython_shell( - namespace: dict[str, Any] = {}, banner: str = "" + namespace: dict[str, Any] | None = None, banner: str = "" ) -> EmbedFuncT: """Start an IPython Shell""" try: - from IPython.terminal.embed import InteractiveShellEmbed # noqa: T100 - from IPython.terminal.ipapp import load_default_config + from IPython.terminal.embed import InteractiveShellEmbed # noqa: T100,PLC0415 + from IPython.terminal.ipapp import load_default_config # noqa: PLC0415 except ImportError: - from IPython.frontend.terminal.embed import ( # type: ignore[no-redef] # noqa: T100 + from IPython.frontend.terminal.embed import ( # type: ignore[import-not-found,no-redef] # noqa: T100,PLC0415 InteractiveShellEmbed, ) - from IPython.frontend.terminal.ipapp import ( # type: ignore[no-redef] + from IPython.frontend.terminal.ipapp import ( # type: ignore[import-not-found,no-redef] # noqa: PLC0415 load_default_config, ) @wraps(_embed_ipython_shell) - def wrapper(namespace: dict[str, Any] = namespace, banner: str = "") -> None: - config = load_default_config() + def wrapper(namespace: dict[str, Any] = namespace or {}, banner: str = "") -> None: + config = load_default_config() # type: ignore[no-untyped-call] # Always use .instance() to ensure _instance propagation to all parents # this is needed for completion works well for new imports # and clear the instance to always have the fresh env @@ -43,26 +44,26 @@ def _embed_ipython_shell( def _embed_bpython_shell( - namespace: dict[str, Any] = {}, banner: str = "" + namespace: dict[str, Any] | None = None, banner: str = "" ) -> EmbedFuncT: """Start a bpython shell""" - import bpython + import bpython # noqa: PLC0415 @wraps(_embed_bpython_shell) - def wrapper(namespace: dict[str, Any] = namespace, banner: str = "") -> None: + def wrapper(namespace: dict[str, Any] = namespace or {}, banner: str = "") -> None: bpython.embed(locals_=namespace, banner=banner) return wrapper def _embed_ptpython_shell( - namespace: dict[str, Any] = {}, banner: str = "" + namespace: dict[str, Any] | None = None, banner: str = "" ) -> EmbedFuncT: """Start a ptpython shell""" - import ptpython.repl # pylint: disable=import-error + import ptpython.repl # noqa: PLC0415 # pylint: disable=import-error @wraps(_embed_ptpython_shell) - def wrapper(namespace: dict[str, Any] = namespace, banner: str = "") -> None: + def wrapper(namespace: dict[str, Any] = namespace or {}, banner: str = "") -> None: print(banner) ptpython.repl.embed(locals=namespace) @@ -70,22 +71,20 @@ def _embed_ptpython_shell( def _embed_standard_shell( - namespace: dict[str, Any] = {}, banner: str = "" + namespace: dict[str, Any] | None = None, banner: str = "" ) -> EmbedFuncT: """Start a standard python shell""" - import code - try: # readline module is only available on unix systems - import readline + import readline # noqa: PLC0415 except ImportError: pass else: - import rlcompleter # noqa: F401 + import rlcompleter # noqa: F401,PLC0415 - readline.parse_and_bind("tab:complete") # type: ignore[attr-defined] + readline.parse_and_bind("tab:complete") # type: ignore[attr-defined,unused-ignore] @wraps(_embed_standard_shell) - def wrapper(namespace: dict[str, Any] = namespace, banner: str = "") -> None: + def wrapper(namespace: dict[str, Any] = namespace or {}, banner: str = "") -> None: code.interact(banner=banner, local=namespace) return wrapper diff --git a/scrapy/utils/curl.py b/scrapy/utils/curl.py index a40ee8997..646335fb1 100644 --- a/scrapy/utils/curl.py +++ b/scrapy/utils/curl.py @@ -106,7 +106,7 @@ def curl_to_request_kwargs( if argv: msg = f"Unrecognized options: {', '.join(argv)}" if ignore_unknown_options: - warnings.warn(msg) + warnings.warn(msg, stacklevel=2) else: raise ValueError(msg) diff --git a/scrapy/utils/datatypes.py b/scrapy/utils/datatypes.py index 3d0e0d3c7..4e65c062e 100644 --- a/scrapy/utils/datatypes.py +++ b/scrapy/utils/datatypes.py @@ -13,7 +13,7 @@ import warnings import weakref from collections import OrderedDict from collections.abc import Mapping -from typing import TYPE_CHECKING, Any, AnyStr, TypeVar +from typing import TYPE_CHECKING, Any, AnyStr, TypeVar, cast from scrapy.exceptions import ScrapyDeprecationWarning @@ -28,11 +28,12 @@ _KT = TypeVar("_KT") _VT = TypeVar("_VT") -class CaselessDict(dict): +class CaselessDict(dict): # type: ignore[type-arg] __slots__ = () def __new__(cls, *args: Any, **kwargs: Any) -> Self: - from scrapy.http.headers import Headers + # circular import + from scrapy.http.headers import Headers # noqa: PLC0415 if issubclass(cls, CaselessDict) and not issubclass(cls, Headers): warnings.warn( @@ -82,7 +83,7 @@ class CaselessDict(dict): return dict.get(self, self.normkey(key), self.normvalue(def_val)) def setdefault(self, key: AnyStr, def_val: Any = None) -> Any: - return dict.setdefault(self, self.normkey(key), self.normvalue(def_val)) # type: ignore[arg-type] + return dict.setdefault(self, self.normkey(key), self.normvalue(def_val)) # doesn't fully implement MutableMapping.update() def update(self, seq: Mapping[AnyStr, Any] | Iterable[tuple[AnyStr, Any]]) -> None: # type: ignore[override] @@ -98,20 +99,20 @@ class CaselessDict(dict): return dict.pop(self, self.normkey(key), *args) -class CaseInsensitiveDict(collections.UserDict): +class CaseInsensitiveDict(collections.UserDict[str | bytes, Any]): """A dict-like structure that accepts strings or bytes as keys and allows case-insensitive lookups. """ def __init__(self, *args: Any, **kwargs: Any) -> None: - self._keys: dict = {} + self._keys: dict[str | bytes, Any] = {} super().__init__(*args, **kwargs) - def __getitem__(self, key: AnyStr) -> Any: + def __getitem__(self, key: str | bytes) -> Any: normalized_key = self._normkey(key) return super().__getitem__(self._keys[normalized_key.lower()]) - def __setitem__(self, key: AnyStr, value: Any) -> None: + def __setitem__(self, key: str | bytes, value: Any) -> None: normalized_key = self._normkey(key) try: lower_key = self._keys[normalized_key.lower()] @@ -121,19 +122,19 @@ class CaseInsensitiveDict(collections.UserDict): super().__setitem__(normalized_key, self._normvalue(value)) self._keys[normalized_key.lower()] = normalized_key - def __delitem__(self, key: AnyStr) -> None: + def __delitem__(self, key: str | bytes) -> None: normalized_key = self._normkey(key) stored_key = self._keys.pop(normalized_key.lower()) super().__delitem__(stored_key) - def __contains__(self, key: AnyStr) -> bool: # type: ignore[override] + def __contains__(self, key: str | bytes) -> bool: # type: ignore[override] normalized_key = self._normkey(key) return normalized_key.lower() in self._keys def __repr__(self) -> str: return f"<{self.__class__.__name__}: {super().__repr__()}>" - def _normkey(self, key: AnyStr) -> AnyStr: + def _normkey(self, key: str | bytes) -> str | bytes: return key def _normvalue(self, value: Any) -> Any: @@ -157,7 +158,7 @@ class LocalCache(OrderedDict[_KT, _VT]): super().__setitem__(key, value) -class LocalWeakReferencedCache(weakref.WeakKeyDictionary): +class LocalWeakReferencedCache(weakref.WeakKeyDictionary[_KT, _VT | None]): """ A weakref.WeakKeyDictionary implementation that uses LocalCache as its underlying data structure, making it ordered and capable of being size-limited. @@ -171,16 +172,16 @@ class LocalWeakReferencedCache(weakref.WeakKeyDictionary): def __init__(self, limit: int | None = None): super().__init__() - self.data: LocalCache = LocalCache(limit=limit) + self.data: LocalCache[_KT, _VT] = LocalCache(limit=limit) - def __setitem__(self, key: _KT, value: _VT) -> None: + def __setitem__(self, key: _KT, value: _VT | None) -> None: # if raised, key is not weak-referenceable, skip caching with contextlib.suppress(TypeError): super().__setitem__(key, value) - def __getitem__(self, key: _KT) -> _VT | None: # type: ignore[override] + def __getitem__(self, key: _KT) -> _VT | None: try: - return super().__getitem__(key) + return cast("_VT", super().__getitem__(key)) except (TypeError, KeyError): return None # key is either not weak-referenceable or not cached diff --git a/scrapy/utils/decorators.py b/scrapy/utils/decorators.py index 0f4d0beda..a5bb6fa24 100644 --- a/scrapy/utils/decorators.py +++ b/scrapy/utils/decorators.py @@ -1,24 +1,22 @@ from __future__ import annotations +import inspect import warnings from functools import wraps -from typing import TYPE_CHECKING, Any, TypeVar +from typing import TYPE_CHECKING, Any, ParamSpec, TypeVar, cast, overload from twisted.internet.defer import Deferred, maybeDeferred -from twisted.internet.threads import deferToThread from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.utils.asyncio import run_in_thread +from scrapy.utils.defer import deferred_from_coro if TYPE_CHECKING: - from collections.abc import Callable - - # typing.ParamSpec requires Python 3.10 - from typing_extensions import ParamSpec - - _P = ParamSpec("_P") + from collections.abc import AsyncGenerator, Callable, Coroutine _T = TypeVar("_T") +_P = ParamSpec("_P") def deprecated( @@ -30,7 +28,7 @@ def deprecated( def deco(func: Callable[_P, _T]) -> Callable[_P, _T]: @wraps(func) - def wrapped(*args: _P.args, **kwargs: _P.kwargs) -> Any: + def wrapped(*args: _P.args, **kwargs: _P.kwargs) -> _T: message = f"Call to deprecated function {func.__name__}." if use_instead: message += f" Use {use_instead} instead." @@ -45,8 +43,13 @@ def deprecated( return deco -def defers(func: Callable[_P, _T]) -> Callable[_P, Deferred[_T]]: +def defers(func: Callable[_P, _T]) -> Callable[_P, Deferred[_T]]: # pragma: no cover """Decorator to make sure a function always returns a deferred""" + warnings.warn( + "@defers is deprecated, you can use maybeDeferred() directly if needed.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) @wraps(func) def wrapped(*a: _P.args, **kw: _P.kwargs) -> Deferred[_T]: @@ -57,11 +60,80 @@ def defers(func: Callable[_P, _T]) -> Callable[_P, Deferred[_T]]: def inthread(func: Callable[_P, _T]) -> Callable[_P, Deferred[_T]]: """Decorator to call a function in a thread and return a deferred with the - result + result. + + .. versionchanged:: 2.15.0 + Now uses :func:`asyncio.to_thread` if the asyncio support is available. """ @wraps(func) def wrapped(*a: _P.args, **kw: _P.kwargs) -> Deferred[_T]: - return deferToThread(func, *a, **kw) + return deferred_from_coro(run_in_thread(func, *a, **kw)) return wrapped + + +@overload +def _warn_spider_arg( + func: Callable[_P, Coroutine[Any, Any, _T]], +) -> Callable[_P, Coroutine[Any, Any, _T]]: ... + + +@overload +def _warn_spider_arg( + func: Callable[_P, AsyncGenerator[_T]], +) -> Callable[_P, AsyncGenerator[_T]]: ... + + +@overload +def _warn_spider_arg(func: Callable[_P, _T]) -> Callable[_P, _T]: ... + + +def _warn_spider_arg( + func: Callable[_P, _T], +) -> ( + Callable[_P, _T] + | Callable[_P, Coroutine[Any, Any, _T]] + | Callable[_P, AsyncGenerator[_T]] +): + """Decorator to warn if a ``spider`` argument is passed to a function.""" + + sig = inspect.signature(func) + + def check_args(*args: _P.args, **kwargs: _P.kwargs) -> None: + bound = sig.bind(*args, **kwargs) + if "spider" in bound.arguments: + warnings.warn( + f"Passing a 'spider' argument to {func.__qualname__}() is deprecated and " + "the argument will be removed in a future Scrapy version.", + category=ScrapyDeprecationWarning, + stacklevel=3, + ) + + if inspect.iscoroutinefunction(func): + + @wraps(func) + async def async_inner(*args: _P.args, **kwargs: _P.kwargs) -> _T: + check_args(*args, **kwargs) + return cast("_T", await func(*args, **kwargs)) + + return async_inner + + if inspect.isasyncgenfunction(func): + + @wraps(func) + async def asyncgen_inner( + *args: _P.args, **kwargs: _P.kwargs + ) -> AsyncGenerator[_T]: + check_args(*args, **kwargs) + async for item in func(*args, **kwargs): + yield item + + return asyncgen_inner + + @wraps(func) + def sync_inner(*args: _P.args, **kwargs: _P.kwargs) -> _T: + check_args(*args, **kwargs) + return func(*args, **kwargs) + + return sync_inner diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 2df82c8f2..29a34d4ef 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -8,47 +8,56 @@ import asyncio import inspect import warnings from asyncio import Future +from collections import deque from collections.abc import Awaitable, Coroutine, Iterable, Iterator from functools import wraps -from typing import TYPE_CHECKING, Any, Generic, TypeVar, cast, overload - -from twisted.internet.defer import ( - Deferred, - DeferredList, - fail, - succeed, +from typing import ( + TYPE_CHECKING, + Any, + Concatenate, + Generic, + ParamSpec, + TypeVar, + cast, + overload, ) + +from twisted.internet.defer import Deferred, DeferredList, FirstError, fail, succeed from twisted.internet.task import Cooperator from twisted.python import failure -from scrapy.exceptions import IgnoreRequest, ScrapyDeprecationWarning +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.asyncio import is_asyncio_available +from scrapy.utils.python import global_object_name if TYPE_CHECKING: from collections.abc import AsyncIterator, Callable from twisted.python.failure import Failure - # typing.Concatenate and typing.ParamSpec require Python 3.10 - from typing_extensions import Concatenate, ParamSpec - - _P = ParamSpec("_P") - _T = TypeVar("_T") _T2 = TypeVar("_T2") +_P = ParamSpec("_P") _DEFER_DELAY = 0.1 -def defer_fail(_failure: Failure) -> Deferred[Any]: +def defer_fail(_failure: Failure) -> Deferred[Any]: # pragma: no cover """Same as twisted.internet.defer.fail but delay calling errback until next reactor loop It delays by 100ms so reactor has a chance to go through readers and writers before attending pending delayed calls, so do not set delay to zero. """ + warnings.warn( + "scrapy.utils.defer.defer_fail() is deprecated, use" + " twisted.internet.defer.fail(), plus an explicit sleep if needed.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + from twisted.internet import reactor d: Deferred[Any] = Deferred() @@ -56,13 +65,20 @@ def defer_fail(_failure: Failure) -> Deferred[Any]: return d -def defer_succeed(result: _T) -> Deferred[_T]: +def defer_succeed(result: _T) -> Deferred[_T]: # pragma: no cover """Same as twisted.internet.defer.succeed but delay calling callback until next reactor loop It delays by 100ms so reactor has a chance to go through readers and writers before attending pending delayed calls, so do not set delay to zero. """ + warnings.warn( + "scrapy.utils.defer.defer_succeed() is deprecated, use" + " twisted.internet.defer.succeed(), plus an explicit sleep if needed.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + from twisted.internet import reactor d: Deferred[_T] = Deferred() @@ -70,21 +86,40 @@ def defer_succeed(result: _T) -> Deferred[_T]: return d -def _defer_sleep() -> Deferred[None]: - """Like ``defer_succeed`` and ``defer_fail`` but doesn't call any real callbacks.""" - from twisted.internet import reactor +async def _defer_sleep_async() -> None: + """Delay by _DEFER_DELAY so reactor has a chance to go through readers and writers + before attending pending delayed calls, so do not set delay to zero. + """ + if is_asyncio_available(): + await asyncio.sleep(_DEFER_DELAY) + else: + from twisted.internet import reactor - d: Deferred[None] = Deferred() - reactor.callLater(_DEFER_DELAY, d.callback, None) - return d + d: Deferred[None] = Deferred() + reactor.callLater(_DEFER_DELAY, d.callback, None) + await d -def defer_result(result: Any) -> Deferred[Any]: +def defer_result(result: Any) -> Deferred[Any]: # pragma: no cover + warnings.warn( + "scrapy.utils.defer.defer_result() is deprecated, use" + " twisted.internet.defer.success() and twisted.internet.defer.fail()," + " plus an explicit sleep if needed, or explicit reactor.callLater().", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + if isinstance(result, Deferred): return result + + from twisted.internet import reactor + + d: Deferred[Any] = Deferred() if isinstance(result, failure.Failure): - return defer_fail(result) - return defer_succeed(result) + reactor.callLater(_DEFER_DELAY, d.errback, result) + else: + reactor.callLater(_DEFER_DELAY, d.callback, result) + return d @overload @@ -93,14 +128,6 @@ def mustbe_deferred( ) -> Deferred[_T]: ... -@overload -def mustbe_deferred( - f: Callable[_P, Coroutine[Deferred[Any], Any, _T]], - *args: _P.args, - **kw: _P.kwargs, -) -> Deferred[_T]: ... - - @overload def mustbe_deferred( f: Callable[_P, _T], *args: _P.args, **kw: _P.kwargs @@ -108,29 +135,31 @@ def mustbe_deferred( def mustbe_deferred( - f: Callable[_P, Deferred[_T] | Coroutine[Deferred[Any], Any, _T] | _T], + f: Callable[_P, Deferred[_T] | _T], *args: _P.args, **kw: _P.kwargs, -) -> Deferred[_T]: +) -> Deferred[_T]: # pragma: no cover """Same as twisted.internet.defer.maybeDeferred, but delay calling callback/errback to next reactor loop """ + warnings.warn( + "scrapy.utils.defer.mustbe_deferred() is deprecated, use" + " twisted.internet.defer.maybeDeferred(), with an explicit sleep if needed.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + result: _T | Deferred[_T] | Failure try: result = f(*args, **kw) - # FIXME: Hack to avoid introspecting tracebacks. This to speed up - # processing of IgnoreRequest errors which are, by far, the most common - # exception in Scrapy - see #125 - except IgnoreRequest as e: - return defer_fail(failure.Failure(e)) except Exception: - return defer_fail(failure.Failure()) + result = failure.Failure() return defer_result(result) def parallel( iterable: Iterable[_T], count: int, - callable: Callable[Concatenate[_T, _P], _T2], + callable: Callable[Concatenate[_T, _P], _T2], # noqa: A002 *args: _P.args, **named: _P.kwargs, ) -> Deferred[list[tuple[bool, Iterator[_T2]]]]: @@ -144,7 +173,7 @@ def parallel( return DeferredList([coop.coiterate(work) for _ in range(count)]) -class _AsyncCooperatorAdapter(Iterator, Generic[_T]): +class _AsyncCooperatorAdapter(Iterator[Deferred[Any]], Generic[_T]): """A class that wraps an async iterable into a normal iterator suitable for using in Cooperator.coiterate(). As it's only needed for parallel_async(), it calls the callable directly in the callback, instead of providing a more @@ -193,16 +222,16 @@ class _AsyncCooperatorAdapter(Iterator, Generic[_T]): def __init__( self, aiterable: AsyncIterator[_T], - callable: Callable[Concatenate[_T, _P], Deferred[Any] | None], + callable_: Callable[Concatenate[_T, _P], Deferred[Any] | None], *callable_args: _P.args, **callable_kwargs: _P.kwargs, ): self.aiterator: AsyncIterator[_T] = aiterable.__aiter__() - self.callable: Callable[Concatenate[_T, _P], Deferred[Any] | None] = callable + self.callable: Callable[Concatenate[_T, _P], Deferred[Any] | None] = callable_ self.callable_args: tuple[Any, ...] = callable_args self.callable_kwargs: dict[str, Any] = callable_kwargs self.finished: bool = False - self.waiting_deferreds: list[Deferred[Any]] = [] + self.waiting_deferreds: deque[Deferred[Any]] = deque() self.anext_deferred: Deferred[_T] | None = None def _callback(self, result: _T) -> None: @@ -213,7 +242,7 @@ class _AsyncCooperatorAdapter(Iterator, Generic[_T]): callable_result = self.callable( result, *self.callable_args, **self.callable_kwargs ) - d = self.waiting_deferreds.pop(0) + d = self.waiting_deferreds.popleft() if isinstance(callable_result, Deferred): callable_result.chainDeferred(d) else: @@ -233,7 +262,7 @@ class _AsyncCooperatorAdapter(Iterator, Generic[_T]): def _call_anext(self) -> None: # This starts waiting for the next result from aiterator. # If aiterator is exhausted, _errback will be called. - self.anext_deferred = deferred_from_coro(self.aiterator.__anext__()) + self.anext_deferred = deferred_from_coro(anext(self.aiterator)) self.anext_deferred.addCallbacks(self._callback, self._errback) def __next__(self) -> Deferred[Any]: @@ -251,7 +280,7 @@ class _AsyncCooperatorAdapter(Iterator, Generic[_T]): def parallel_async( async_iterable: AsyncIterator[_T], count: int, - callable: Callable[Concatenate[_T, _P], Deferred[Any] | None], + callable: Callable[Concatenate[_T, _P], Deferred[Any] | None], # noqa: A002 *args: _P.args, **named: _P.kwargs, ) -> Deferred[list[tuple[bool, Iterator[Deferred[Any]]]]]: @@ -268,11 +297,16 @@ def parallel_async( def process_chain( callbacks: Iterable[Callable[Concatenate[_T, _P], _T]], - input: _T, + input: _T, # noqa: A002 *a: _P.args, **kw: _P.kwargs, -) -> Deferred[_T]: +) -> Deferred[_T]: # pragma: no cover """Return a Deferred built by chaining the given callbacks""" + warnings.warn( + "process_chain() is deprecated.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) d: Deferred[_T] = Deferred() for x in callbacks: d.addCallback(x, *a, **kw) @@ -280,40 +314,20 @@ def process_chain( return d -def process_chain_both( - callbacks: Iterable[Callable[Concatenate[_T, _P], Any]], - errbacks: Iterable[Callable[Concatenate[Failure, _P], Any]], - input: Any, - *a: _P.args, - **kw: _P.kwargs, -) -> Deferred: - """Return a Deferred built by chaining the given callbacks and errbacks""" - warnings.warn( - "process_chain_both() is deprecated and will be removed in a future" - " Scrapy version.", - ScrapyDeprecationWarning, - stacklevel=2, - ) - d: Deferred = Deferred() - for cb, eb in zip(callbacks, errbacks): - d.addCallback(cb, *a, **kw) - d.addErrback(eb, *a, **kw) - if isinstance(input, failure.Failure): - d.errback(input) - else: - d.callback(input) - return d - - def process_parallel( callbacks: Iterable[Callable[Concatenate[_T, _P], _T2]], - input: _T, + input: _T, # noqa: A002 *a: _P.args, **kw: _P.kwargs, -) -> Deferred[list[_T2]]: +) -> Deferred[list[_T2]]: # pragma: no cover """Return a Deferred with the output of all successful calls to the given callbacks """ + warnings.warn( + "process_parallel() is deprecated.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) dfds = [succeed(input).addCallback(x, *a, **kw) for x in callbacks] d: Deferred[list[tuple[bool, _T2]]] = DeferredList( dfds, fireOnOneErrback=True, consumeErrors=True @@ -321,6 +335,7 @@ def process_parallel( d2: Deferred[list[_T2]] = d.addCallback(lambda r: [x[1] for x in r]) def eb(failure: Failure) -> Failure: + assert isinstance(failure.value, FirstError) return failure.value.subFailure d2.addErrback(eb) @@ -333,7 +348,7 @@ def iter_errback( *a: _P.args, **kw: _P.kwargs, ) -> Iterable[_T]: - """Wraps an iterable calling an errback if an error is caught while + """Wrap an iterable calling an errback if an error is caught while iterating it. """ it = iter(iterable) @@ -352,13 +367,13 @@ async def aiter_errback( *a: _P.args, **kw: _P.kwargs, ) -> AsyncIterator[_T]: - """Wraps an async iterable calling an errback if an error is caught while + """Wrap an async iterable calling an errback if an error is caught while iterating it. Similar to :func:`scrapy.utils.defer.iter_errback`. """ - it = aiterable.__aiter__() + it = aiter(aiterable) while True: try: - yield await it.__anext__() + yield await anext(it) except StopAsyncIteration: break except Exception: @@ -374,15 +389,15 @@ def deferred_from_coro(o: _T2) -> _T2: ... def deferred_from_coro(o: Awaitable[_T] | _T2) -> Deferred[_T] | _T2: - """Converts a coroutine or other awaitable object into a Deferred, - or returns the object as is if it isn't a coroutine.""" + """Convert a coroutine or other awaitable object into a Deferred, + or return the object as is if it isn't a coroutine.""" if isinstance(o, Deferred): return o if inspect.isawaitable(o): if not is_asyncio_available(): # wrapping the coroutine directly into a Deferred, this doesn't work correctly with coroutines # that use asyncio, e.g. "await asyncio.sleep(1)" - return Deferred.fromCoroutine(cast(Coroutine[Deferred[Any], Any, _T], o)) + return Deferred.fromCoroutine(cast("Coroutine[Deferred[Any], Any, _T]", o)) # wrapping the coroutine into a Future and then into a Deferred, this requires AsyncioSelectorReactor return Deferred.fromFuture(asyncio.ensure_future(o)) return o @@ -391,7 +406,7 @@ def deferred_from_coro(o: Awaitable[_T] | _T2) -> Deferred[_T] | _T2: def deferred_f_from_coro_f( coro_f: Callable[_P, Awaitable[_T]], ) -> Callable[_P, Deferred[_T]]: - """Converts a coroutine function into a function that returns a Deferred. + """Convert a coroutine function into a function that returns a Deferred. The coroutine function will be called at the time when the wrapper is called. Wrapper args will be passed to it. This is useful for callback chains, as callback functions are called with the previous callback result. @@ -406,27 +421,53 @@ def deferred_f_from_coro_f( def maybeDeferred_coro( f: Callable[_P, Any], *args: _P.args, **kw: _P.kwargs +) -> Deferred[Any]: # pragma: no cover + """Copy of defer.maybeDeferred that also converts coroutines to Deferreds.""" + warnings.warn( + "maybeDeferred_coro() is deprecated and will be removed in a future Scrapy version.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return _maybeDeferred_coro(f, False, *args, **kw) + + +def _maybeDeferred_coro( + f: Callable[_P, Any], warn: bool, *args: _P.args, **kw: _P.kwargs ) -> Deferred[Any]: """Copy of defer.maybeDeferred that also converts coroutines to Deferreds.""" try: result = f(*args, **kw) - except: # noqa: E722 # pylint: disable=bare-except + except: # noqa: E722 return fail(failure.Failure(captureVars=Deferred.debug)) + # when the deprecation period has ended we need to make sure the behavior + # of the public maybeDeferred_coro() function isn't changed, or drop it in + # the same release if isinstance(result, Deferred): + if warn: + warnings.warn( + f"{global_object_name(f)} returned a Deferred, this is deprecated." + f" Please refactor this function to return a coroutine.", + ScrapyDeprecationWarning, + stacklevel=2, + ) return result if asyncio.isfuture(result) or inspect.isawaitable(result): return deferred_from_coro(result) - if isinstance(result, failure.Failure): + if isinstance(result, failure.Failure): # pragma: no cover + if warn: + warnings.warn( + f"{global_object_name(f)} returned a Failure, this is deprecated." + f" Please refactor this function to return a coroutine.", + ScrapyDeprecationWarning, + stacklevel=2, + ) return fail(result) return succeed(result) def deferred_to_future(d: Deferred[_T]) -> Future[_T]: - """ - .. versionadded:: 2.6.0 - - Return an :class:`asyncio.Future` object that wraps *d*. + """Return an :class:`asyncio.Future` object that wraps *d*. This function requires :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` to be @@ -445,7 +486,7 @@ def deferred_to_future(d: Deferred[_T]) -> Future[_T]: deferred = self.crawler.engine.download(additional_request) additional_response = await deferred_to_future(deferred) - .. versionchanged:: VERSION + .. versionchanged:: 2.14 This function no longer installs an asyncio loop if called before the Twisted asyncio reactor is installed. A :exc:`RuntimeError` is raised in this case. @@ -456,10 +497,7 @@ def deferred_to_future(d: Deferred[_T]) -> Future[_T]: def maybe_deferred_to_future(d: Deferred[_T]) -> Deferred[_T] | Future[_T]: - """ - .. versionadded:: 2.6.0 - - Return *d* as an object that can be awaited from a :ref:`Scrapy callable + """Return *d* as an object that can be awaited from a :ref:`Scrapy callable defined as a coroutine `. What you can await in Scrapy callables defined as coroutines depends on the @@ -484,3 +522,54 @@ def maybe_deferred_to_future(d: Deferred[_T]) -> Deferred[_T] | Future[_T]: if not is_asyncio_available(): return d return deferred_to_future(d) + + +def _schedule_coro(coro: Coroutine[Any, Any, Any]) -> None: + """Schedule the coroutine as a task or a Deferred. + + This doesn't store the reference to the task/Deferred, so a better + alternative is calling :func:`scrapy.utils.defer.deferred_from_coro`, + keeping the result, and adding proper exception handling (e.g. errbacks) to + it. + """ + if not is_asyncio_available(): + Deferred.fromCoroutine(coro) + return + loop = asyncio.get_event_loop() + loop.create_task(coro) # noqa: RUF006 + + +@overload +def ensure_awaitable(o: Awaitable[_T], _warn: str | None = None) -> Awaitable[_T]: ... + + +@overload +def ensure_awaitable(o: _T, _warn: str | None = None) -> Awaitable[_T]: ... + + +def ensure_awaitable(o: _T | Awaitable[_T], _warn: str | None = None) -> Awaitable[_T]: + """Convert any value to an awaitable object. + + For a :class:`~twisted.internet.defer.Deferred` object, use + :func:`maybe_deferred_to_future` to wrap it into a suitable object. For an + awaitable object of a different type, return it as is. For any other + value, return a coroutine that completes with that value. + + .. versionadded:: 2.14 + """ + if isinstance(o, Deferred): + if _warn: + warnings.warn( + f"{_warn} returned a Deferred, this is deprecated." + f" Please refactor this function to return a coroutine.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return maybe_deferred_to_future(o) + if inspect.isawaitable(o): + return o + + async def coro() -> _T: + return o + + return coro() diff --git a/scrapy/utils/deprecate.py b/scrapy/utils/deprecate.py index 20d03cae6..359f819d7 100644 --- a/scrapy/utils/deprecate.py +++ b/scrapy/utils/deprecate.py @@ -4,9 +4,13 @@ from __future__ import annotations import inspect import warnings -from typing import Any, overload +from typing import TYPE_CHECKING, Any, cast, overload from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.utils.python import get_func_args_dict + +if TYPE_CHECKING: + from collections.abc import Callable def attribute(obj: Any, oldattr: str, newattr: str, version: str = "0.12") -> None: @@ -56,7 +60,7 @@ def create_deprecated_class( """ # https://github.com/python/mypy/issues/4177 - class DeprecatedClass(new_class.__class__): # type: ignore[misc, name-defined] + class DeprecatedClass(new_class.__class__): # type: ignore[misc,name-defined] # pylint: disable=no-self-argument deprecated_class: type | None = None warned_on_subclass: bool = False @@ -64,7 +68,7 @@ def create_deprecated_class( def __new__( # pylint: disable=bad-classmethod-argument metacls, name: str, bases: tuple[type, ...], clsdict_: dict[str, Any] ) -> type: - cls = super().__new__(metacls, name, bases, clsdict_) + cls: type = super().__new__(metacls, name, bases, clsdict_) if metacls.deprecated_class is None: metacls.deprecated_class = cls return cls @@ -96,7 +100,7 @@ def create_deprecated_class( # is the deprecated class itself - subclasses of the # deprecated class should not use custom `__subclasscheck__` # method. - return super().__subclasscheck__(sub) + return cast("bool", super().__subclasscheck__(sub)) if not inspect.isclass(sub): raise TypeError("issubclass() arg 1 must be a class") @@ -126,7 +130,7 @@ def create_deprecated_class( # deprecated class is in jinja2 template). __module__ attribute is not # important enough to raise an exception as users may be unable # to fix inspect.stack() errors. - warnings.warn(f"Error detecting parent module: {e!r}") + warnings.warn(f"Error detecting parent module: {e!r}", stacklevel=2) return deprecated_cls @@ -156,6 +160,7 @@ def update_classpath(path: Any) -> Any: warnings.warn( f"`{path}` class is deprecated, use `{new_path}` instead", ScrapyDeprecationWarning, + stacklevel=2, ) return new_path return path @@ -179,6 +184,8 @@ def method_is_overridden(subclass: type, base_class: type, method_name: str) -> ... pass >>> class Sub4(Sub2): ... pass + >>> method_is_overridden(Base, Base, 'foo') + False >>> method_is_overridden(Sub1, Base, 'foo') False >>> method_is_overridden(Sub2, Base, 'foo') @@ -191,3 +198,35 @@ def method_is_overridden(subclass: type, base_class: type, method_name: str) -> base_method = getattr(base_class, method_name) sub_method = getattr(subclass, method_name) return base_method.__code__ is not sub_method.__code__ + + +def argument_is_required(func: Callable[..., Any], arg_name: str) -> bool: + """ + Check if a function argument is required (exists and doesn't have a default value). + + .. versionadded:: 2.14 + + >>> def func(a, b=1, c=None): + ... pass + >>> argument_is_required(func, 'a') + True + >>> argument_is_required(func, 'b') + False + >>> argument_is_required(func, 'c') + False + >>> argument_is_required(func, 'd') + False + """ + args = get_func_args_dict(func) + param = args.get(arg_name) + return param is not None and param.default is inspect.Parameter.empty + + +def warn_on_deprecated_spider_attribute(attribute_name: str, setting_name: str) -> None: + warnings.warn( + f"The '{attribute_name}' spider attribute is deprecated. " + "Use Spider.custom_settings or Spider.update_settings() instead. " + f"The corresponding setting name is '{setting_name}'.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) diff --git a/scrapy/utils/display.py b/scrapy/utils/display.py index 20744a604..08e89dc0d 100644 --- a/scrapy/utils/display.py +++ b/scrapy/utils/display.py @@ -34,11 +34,11 @@ def _colorize(text: str, colorize: bool = True) -> str: if not colorize or not sys.stdout.isatty() or not _tty_supports_color(): return text try: - from pygments import highlight + from pygments import highlight # noqa: PLC0415 except ImportError: return text - from pygments.formatters import TerminalFormatter - from pygments.lexers import PythonLexer + from pygments.formatters import TerminalFormatter # noqa: PLC0415 + from pygments.lexers import PythonLexer # noqa: PLC0415 return highlight(text, PythonLexer(), TerminalFormatter()) diff --git a/scrapy/utils/engine.py b/scrapy/utils/engine.py index 1e0c53212..085720f66 100644 --- a/scrapy/utils/engine.py +++ b/scrapy/utils/engine.py @@ -32,7 +32,7 @@ def get_engine_status(engine: ExecutionEngine) -> list[tuple[str, Any]]: checks: list[tuple[str, Any]] = [] for test in tests: try: - checks += [(test, eval(test))] # noqa: S307 # pylint: disable=eval-used + checks += [(test, eval(test))] # noqa: S307 except Exception as e: checks += [(test, f"{type(e).__name__} (exception)")] diff --git a/scrapy/utils/gz.py b/scrapy/utils/gz.py index 85324361c..5f95bccbd 100644 --- a/scrapy/utils/gz.py +++ b/scrapy/utils/gz.py @@ -5,7 +5,7 @@ from gzip import GzipFile from io import BytesIO from typing import TYPE_CHECKING -from ._compression import _CHUNK_SIZE, _DecompressionMaxSizeExceeded +from ._compression import _CHUNK_SIZE, _check_max_size if TYPE_CHECKING: from scrapy.http import Response @@ -31,15 +31,9 @@ def gunzip(data: bytes, *, max_size: int = 0) -> bytes: break raise decompressed_size += len(chunk) - if max_size and decompressed_size > max_size: - raise _DecompressionMaxSizeExceeded( - f"The number of bytes decompressed so far " - f"({decompressed_size} B) exceed the specified maximum " - f"({max_size} B)." - ) + _check_max_size(decompressed_size, max_size) output_stream.write(chunk) - output_stream.seek(0) - return output_stream.read() + return output_stream.getvalue() def gzip_magic_number(response: Response) -> bool: diff --git a/scrapy/utils/iterators.py b/scrapy/utils/iterators.py index c646fc218..9bb64c021 100644 --- a/scrapy/utils/iterators.py +++ b/scrapy/utils/iterators.py @@ -147,12 +147,12 @@ class _StreamReader: def _read_string(self, n: int = 65535) -> bytes: s, e = self._ptr, self._ptr + n self._ptr = e - return cast(bytes, self._text)[s:e] + return cast("bytes", self._text)[s:e] def _read_unicode(self, n: int = 65535) -> bytes: s, e = self._ptr, self._ptr + n self._ptr = e - return cast(str, self._text)[s:e].encode("utf-8") + return cast("str", self._text)[s:e].encode("utf-8") def csviter( @@ -177,7 +177,7 @@ def csviter( quotechar is the character used to enclosure fields on the given obj. """ - if encoding is not None: + if encoding is not None: # pragma: no cover warn( "The encoding argument of csviter() is ignored and will be removed" " in a future Scrapy version.", @@ -212,7 +212,7 @@ def csviter( }, ) continue - yield dict(zip(headers, row)) + yield dict(zip(headers, row, strict=False)) @overload diff --git a/scrapy/utils/log.py b/scrapy/utils/log.py index 24e17ecb6..09b67805d 100644 --- a/scrapy/utils/log.py +++ b/scrapy/utils/log.py @@ -5,17 +5,19 @@ import pprint import sys from collections.abc import MutableMapping from logging.config import dictConfig -from types import TracebackType -from typing import TYPE_CHECKING, Any, Optional, cast +from typing import TYPE_CHECKING, Any, cast +from twisted.internet import asyncioreactor from twisted.python import log as twisted_log from twisted.python.failure import Failure import scrapy -from scrapy.settings import Settings, _SettingsKeyT +from scrapy.settings import Settings from scrapy.utils.versions import get_versions if TYPE_CHECKING: + from types import TracebackType + from scrapy.crawler import Crawler from scrapy.logformatter import LogFormatterResult @@ -33,7 +35,7 @@ def failure_to_exc_info( return ( failure.type, failure.value, - cast(Optional[TracebackType], failure.getTracebackObject()), + cast("TracebackType | None", failure.getTracebackObject()), ) return None @@ -70,6 +72,12 @@ DEFAULT_LOGGING = { "hpack": { "level": "ERROR", }, + "httpcore": { + "level": "ERROR", + }, + "httpx": { + "level": "WARNING", + }, "scrapy": { "level": "DEBUG", }, @@ -81,7 +89,7 @@ DEFAULT_LOGGING = { def configure_logging( - settings: Settings | dict[_SettingsKeyT, Any] | None = None, + settings: Settings | dict[str, Any] | None = None, install_root_handler: bool = True, ) -> None: """ @@ -130,16 +138,23 @@ _scrapy_root_handler: logging.Handler | None = None def install_scrapy_root_handler(settings: Settings) -> None: - global _scrapy_root_handler # noqa: PLW0603 # pylint: disable=global-statement + global _scrapy_root_handler # noqa: PLW0603 + + _uninstall_scrapy_root_handler() + logging.root.setLevel(logging.NOTSET) + _scrapy_root_handler = _get_handler(settings) + logging.root.addHandler(_scrapy_root_handler) + + +def _uninstall_scrapy_root_handler() -> None: + global _scrapy_root_handler # noqa: PLW0603 if ( _scrapy_root_handler is not None and _scrapy_root_handler in logging.root.handlers ): logging.root.removeHandler(_scrapy_root_handler) - logging.root.setLevel(logging.NOTSET) - _scrapy_root_handler = _get_handler(settings) - logging.root.addHandler(_scrapy_root_handler) + _scrapy_root_handler = None def get_scrapy_root_handler() -> logging.Handler | None: @@ -174,7 +189,7 @@ def log_scrapy_info(settings: Settings) -> None: "Scrapy %(version)s started (bot: %(bot)s)", {"version": scrapy.__version__, "bot": settings["BOT_NAME"]}, ) - software = settings.getlist("LOG_VERSIONS") + software: list[str] = settings.getlist("LOG_VERSIONS") if not software: return versions = pprint.pformat(dict(get_versions(software)), sort_dicts=False) @@ -182,7 +197,7 @@ def log_scrapy_info(settings: Settings) -> None: def log_reactor_info() -> None: - from twisted.internet import asyncioreactor, reactor + from twisted.internet import reactor logger.debug("Using reactor: %s.%s", reactor.__module__, reactor.__class__.__name__) if isinstance(reactor, asyncioreactor.AsyncioSelectorReactor): @@ -240,12 +255,13 @@ def logformatter_adapter( message = logkws.get("msg") or "" # NOTE: This also handles 'args' being an empty dict, that case doesn't # play well in logger.log calls - args = cast(dict[str, Any], logkws) if not logkws.get("args") else logkws["args"] + args = cast("dict[str, Any]", logkws) if not logkws.get("args") else logkws["args"] return (level, message, args) -class SpiderLoggerAdapter(logging.LoggerAdapter): +# LoggerAdapter is only parameterized since Python 3.11 +class SpiderLoggerAdapter(logging.LoggerAdapter): # type: ignore[type-arg] def process( self, msg: str, kwargs: MutableMapping[str, Any] ) -> tuple[str, MutableMapping[str, Any]]: diff --git a/scrapy/utils/misc.py b/scrapy/utils/misc.py index b7b436260..20e7cb381 100644 --- a/scrapy/utils/misc.py +++ b/scrapy/utils/misc.py @@ -9,19 +9,18 @@ import os import re import warnings from collections import deque -from collections.abc import Iterable from contextlib import contextmanager from functools import partial from importlib import import_module from pkgutil import iter_modules -from typing import IO, TYPE_CHECKING, Any, TypeVar, cast +from typing import IO, TYPE_CHECKING, Any, ParamSpec, Protocol, TypeVar, cast, overload from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.item import Item from scrapy.utils.datatypes import LocalWeakReferencedCache if TYPE_CHECKING: - from collections.abc import Callable, Iterator + from collections.abc import Callable, Iterable, Iterator from types import ModuleType from scrapy import Spider @@ -29,9 +28,20 @@ if TYPE_CHECKING: _ITERABLE_SINGLE_VALUES = dict, Item, str, bytes -T = TypeVar("T") +_ITER_T = TypeVar("_ITER_T", bound=dict[Any, Any] | Item | str | bytes) +_T = TypeVar("_T") +_T_co = TypeVar("_T_co", covariant=True) +_P = ParamSpec("_P") +@overload +def arg_to_iter(arg: None) -> tuple[()]: ... +@overload +def arg_to_iter(arg: _ITER_T) -> Iterable[_ITER_T]: ... +@overload +def arg_to_iter(arg: Iterable[_T]) -> Iterable[_T]: ... +@overload +def arg_to_iter(arg: _T) -> Iterable[_T]: ... def arg_to_iter(arg: Any) -> Iterable[Any]: """Convert an argument to an iterable. The argument can be a None, single value, or an iterable. @@ -39,9 +49,9 @@ def arg_to_iter(arg: Any) -> Iterable[Any]: Exception: if arg is a dict, [arg] will be returned """ if arg is None: - return [] + return () if not isinstance(arg, _ITERABLE_SINGLE_VALUES) and hasattr(arg, "__iter__"): - return cast(Iterable[Any], arg) + return cast("Iterable[Any]", arg) return [arg] @@ -65,7 +75,7 @@ def load_object(path: str | Callable[..., Any]) -> Any: try: dot = path.rindex(".") except ValueError: - raise ValueError(f"Error loading object '{path}': not a full path") + raise ValueError(f"Error loading object '{path}': not a full path") from None module, name = path[:dot], path[dot + 1 :] mod = import_module(module) @@ -73,41 +83,61 @@ def load_object(path: str | Callable[..., Any]) -> Any: try: obj = getattr(mod, name) except AttributeError: - raise NameError(f"Module '{module}' doesn't define any object named '{name}'") + raise NameError( + f"Module '{module}' doesn't define any object named '{name}'" + ) from None return obj -def walk_modules(path: str) -> list[ModuleType]: +def walk_modules_iter(path: str) -> Iterable[ModuleType]: """Loads a module and all its submodules from the given module path and returns them. If *any* module throws an exception while importing, that exception is thrown back. - For example: walk_modules('scrapy.utils') + For example: + >>> list(walk_modules_iter('scrapy.utils')) + [, ...] + >>> gen = walk_modules_iter('scrapy.utils.nonexistent') # error not raised until the generator is consumed + >>> list(gen) + Traceback (most recent call last): + ... + ModuleNotFoundError: No module named 'scrapy.utils.nonexistent' """ - mods: list[ModuleType] = [] mod = import_module(path) - mods.append(mod) + yield mod if hasattr(mod, "__path__"): for _, subpath, ispkg in iter_modules(mod.__path__): fullpath = path + "." + subpath if ispkg: - mods += walk_modules(fullpath) + yield from walk_modules_iter(fullpath) else: - submod = import_module(fullpath) - mods.append(submod) - return mods + yield import_module(fullpath) -def md5sum(file: IO[bytes]) -> str: - """Calculate the md5 checksum of a file-like object without reading its - whole content in memory. - - >>> from io import BytesIO - >>> md5sum(BytesIO(b'file content to hash')) - '784406af91dd5a54fbb9c84c2236595a' +def walk_modules(path: str) -> list[ModuleType]: # pragma: no cover """ + Loads a module and all its submodules from the given module path and + returns them. If *any* module throws an exception while importing, that + exception is thrown back. + """ + warnings.warn( + ( + "The scrapy.utils.misc.walk_modules function is deprecated and will be " + "removed in a future version of Scrapy. " + "Use scrapy.utils.misc.walk_modules_iter instead." + ), + ScrapyDeprecationWarning, + stacklevel=2, + ) + + return list(walk_modules_iter(path)) + + +def md5sum(file: IO[bytes]) -> str: # pragma: no cover + """Calculate the md5 checksum of a file-like object without reading its + whole content in memory.""" warnings.warn( ( "The scrapy.utils.misc.md5sum function is deprecated and will be " @@ -127,55 +157,44 @@ def md5sum(file: IO[bytes]) -> str: def rel_has_nofollow(rel: str | None) -> bool: """Return True if link rel attribute has nofollow type""" - return rel is not None and "nofollow" in rel.replace(",", " ").split() + return rel is not None and "nofollow" in rel.lower().replace(",", " ").split() -def create_instance(objcls, settings, crawler, *args, **kwargs): - """Construct a class instance using its ``from_crawler`` or - ``from_settings`` constructors, if available. +class SupportsFromCrawler(Protocol[_T_co, _P]): + @classmethod + def from_crawler( + cls, crawler: Crawler, /, *args: _P.args, **kwargs: _P.kwargs + ) -> _T_co: ... - At least one of ``settings`` and ``crawler`` needs to be different from - ``None``. If ``settings `` is ``None``, ``crawler.settings`` will be used. - If ``crawler`` is ``None``, only the ``from_settings`` constructor will be - tried. - ``*args`` and ``**kwargs`` are forwarded to the constructors. +@overload +def build_from_crawler( + objcls: SupportsFromCrawler[_T_co, _P], + crawler: Crawler, + /, + *args: _P.args, + **kwargs: _P.kwargs, +) -> _T_co: ... - Raises ``ValueError`` if both ``settings`` and ``crawler`` are ``None``. - .. versionchanged:: 2.2 - Raises ``TypeError`` if the resulting instance is ``None`` (e.g. if an - extension has not been implemented correctly). - """ - warnings.warn( - "The create_instance() function is deprecated. " - "Please use build_from_crawler() instead.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - - if settings is None: - if crawler is None: - raise ValueError("Specify at least one of settings and crawler.") - settings = crawler.settings - if crawler and hasattr(objcls, "from_crawler"): - instance = objcls.from_crawler(crawler, *args, **kwargs) - method_name = "from_crawler" - elif hasattr(objcls, "from_settings"): - instance = objcls.from_settings(settings, *args, **kwargs) - method_name = "from_settings" - else: - instance = objcls(*args, **kwargs) - method_name = "__new__" - if instance is None: - raise TypeError(f"{objcls.__qualname__}.{method_name} returned None") - return instance +@overload +def build_from_crawler( + objcls: Callable[_P, _T_co], + crawler: Crawler, + /, + *args: _P.args, + **kwargs: _P.kwargs, +) -> _T_co: ... def build_from_crawler( - objcls: type[T], crawler: Crawler, /, *args: Any, **kwargs: Any -) -> T: - """Construct a class instance using its ``from_crawler`` or ``from_settings`` constructor. + objcls: Any, + crawler: Crawler, + /, + *args: Any, + **kwargs: Any, +) -> Any: + """Construct a class instance using its ``from_crawler()`` or ``__init__()`` constructor. .. versionadded:: 2.12 @@ -184,25 +203,14 @@ def build_from_crawler( Raises ``TypeError`` if the resulting instance is ``None``. """ if hasattr(objcls, "from_crawler"): - instance = objcls.from_crawler(crawler, *args, **kwargs) # type: ignore[attr-defined] + instance = objcls.from_crawler(crawler, *args, **kwargs) method_name = "from_crawler" - elif hasattr(objcls, "from_settings"): - warnings.warn( - f"{objcls.__qualname__} has from_settings() but not from_crawler()." - " This is deprecated and calling from_settings() will be removed in a future" - " Scrapy version. You can implement a simple from_crawler() that calls" - " from_settings() with crawler.settings.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - instance = objcls.from_settings(crawler.settings, *args, **kwargs) # type: ignore[attr-defined] - method_name = "from_settings" else: instance = objcls(*args, **kwargs) method_name = "__new__" if instance is None: raise TypeError(f"{objcls.__qualname__}.{method_name} returned None") - return cast(T, instance) + return instance @contextmanager @@ -239,10 +247,17 @@ def walk_callable(node: ast.AST) -> Iterable[ast.AST]: yield node -_generator_callbacks_cache = LocalWeakReferencedCache(limit=128) +_generator_callbacks_cache: LocalWeakReferencedCache[Callable[..., Any], bool] = ( + LocalWeakReferencedCache(limit=128) +) -def is_generator_with_return_value(callable: Callable[..., Any]) -> bool: +def _returns_none(return_node: ast.Return) -> bool: + value = return_node.value + return value is None or (isinstance(value, ast.Constant) and value.value is None) + + +def is_generator_with_return_value(callable: Callable[..., Any]) -> bool: # noqa: A002 """ Returns True if a callable is a generator function which includes a 'return' statement with a value different than None, False otherwise @@ -250,12 +265,6 @@ def is_generator_with_return_value(callable: Callable[..., Any]) -> bool: if callable in _generator_callbacks_cache: return bool(_generator_callbacks_cache[callable]) - def returns_none(return_node: ast.Return) -> bool: - value = return_node.value - return value is None or ( - isinstance(value, ast.Constant) and value.value is None - ) - if inspect.isgeneratorfunction(callable): func = callable while isinstance(func, partial): @@ -271,7 +280,7 @@ def is_generator_with_return_value(callable: Callable[..., Any]) -> bool: tree = ast.parse(code) for node in walk_callable(tree): - if isinstance(node, ast.Return) and not returns_none(node): + if isinstance(node, ast.Return) and not _returns_none(node): _generator_callbacks_cache[callable] = True return bool(_generator_callbacks_cache[callable]) @@ -280,7 +289,8 @@ def is_generator_with_return_value(callable: Callable[..., Any]) -> bool: def warn_on_generator_with_return_value( - spider: Spider, callable: Callable[..., Any] + spider: Spider, + callable: Callable[..., Any], # noqa: A002 ) -> None: """ Logs a warning if a callable is a generator function and includes diff --git a/scrapy/utils/ossignal.py b/scrapy/utils/ossignal.py index ad758b783..4eda29e25 100644 --- a/scrapy/utils/ossignal.py +++ b/scrapy/utils/ossignal.py @@ -3,12 +3,12 @@ from __future__ import annotations import signal from collections.abc import Callable from types import FrameType -from typing import Any, Optional, Union +from typing import Any, TypeAlias # copy of _HANDLER from typeshed/stdlib/signal.pyi -SignalHandlerT = Union[ - Callable[[int, Optional[FrameType]], Any], int, signal.Handlers, None -] +SignalHandlerT: TypeAlias = ( + Callable[[int, FrameType | None], Any] | int | signal.Handlers | None +) signal_names: dict[int, str] = {} for signame in dir(signal): diff --git a/scrapy/utils/project.py b/scrapy/utils/project.py index 0139720b7..3e75c7729 100644 --- a/scrapy/utils/project.py +++ b/scrapy/utils/project.py @@ -20,7 +20,8 @@ def inside_project() -> bool: import_module(scrapy_module) except ImportError as exc: warnings.warn( - f"Cannot import scrapy settings module {scrapy_module}: {exc}" + f"Cannot import scrapy settings module {scrapy_module}: {exc}", + stacklevel=2, ) else: return True diff --git a/scrapy/utils/python.py b/scrapy/utils/python.py index c859fbc2a..00cf818b7 100644 --- a/scrapy/utils/python.py +++ b/scrapy/utils/python.py @@ -13,7 +13,7 @@ import weakref from collections.abc import AsyncIterator, Iterable, Mapping from functools import partial, wraps from itertools import chain -from typing import TYPE_CHECKING, Any, TypeVar, overload +from typing import TYPE_CHECKING, Any, Concatenate, ParamSpec, TypeVar, overload from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.asyncgen import as_async_generator @@ -22,56 +22,14 @@ if TYPE_CHECKING: from collections.abc import Callable, Iterator from re import Pattern - # typing.Concatenate and typing.ParamSpec require Python 3.10 # typing.Self requires Python 3.11 - from typing_extensions import Concatenate, ParamSpec, Self + from typing_extensions import Self - _P = ParamSpec("_P") _T = TypeVar("_T") _KT = TypeVar("_KT") _VT = TypeVar("_VT") - - -def flatten(x: Iterable[Any]) -> list[Any]: - """flatten(sequence) -> list - - Returns a single, flat list which contains all elements retrieved - from the sequence and all recursively contained sub-sequences - (iterables). - - Examples: - >>> [1, 2, [3,4], (5,6)] - [1, 2, [3, 4], (5, 6)] - >>> flatten([[[1,2,3], (42,None)], [4,5], [6], 7, (8,9,10)]) - [1, 2, 3, 42, None, 4, 5, 6, 7, 8, 9, 10] - >>> flatten(["foo", "bar"]) - ['foo', 'bar'] - >>> flatten(["foo", ["baz", 42], "bar"]) - ['foo', 'baz', 42, 'bar'] - """ - warnings.warn( - "The flatten function is deprecated and will be removed in a future version of Scrapy.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - return list(iflatten(x)) - - -def iflatten(x: Iterable[Any]) -> Iterable[Any]: - """iflatten(sequence) -> iterator - - Similar to ``.flatten()``, but returns iterator instead""" - warnings.warn( - "The iflatten function is deprecated and will be removed in a future version of Scrapy.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - for el in x: - if is_listlike(el): - yield from iflatten(el) - else: - yield el +_P = ParamSpec("_P") def is_listlike(x: Any) -> bool: @@ -143,6 +101,16 @@ def to_bytes( return text.encode(encoding, errors) +def _chunk_iter(text: str, chunk_size: int) -> Iterable[tuple[str, int]]: + offset = len(text) + while True: + offset -= chunk_size * 1024 + if offset <= 0: + break + yield (text[offset:], offset) + yield (text, 0) + + def re_rsearch( pattern: str | Pattern[str], text: str, chunk_size: int = 1024 ) -> tuple[int, int] | None: @@ -159,19 +127,10 @@ def re_rsearch( the start position of the match, and the ending (regarding the entire text). """ - def _chunk_iter() -> Iterable[tuple[str, int]]: - offset = len(text) - while True: - offset -= chunk_size * 1024 - if offset <= 0: - break - yield (text[offset:], offset) - yield (text, 0) - if isinstance(pattern, str): pattern = re.compile(pattern) - for chunk, offset in _chunk_iter(): + for chunk, offset in _chunk_iter(text, chunk_size): matches = list(pattern.finditer(chunk)) if matches: start, end = matches[-1].span() @@ -213,35 +172,46 @@ def binary_is_text(data: bytes) -> bool: return all(c not in _BINARYCHARS for c in data) -def get_func_args(func: Callable[..., Any], stripself: bool = False) -> list[str]: - """Return the argument name list of a callable object""" +def get_func_args_dict( + func: Callable[..., Any], stripself: bool = False +) -> Mapping[str, inspect.Parameter]: + """Return the argument dict of a callable object. + + .. versionadded:: 2.14 + """ if not callable(func): raise TypeError(f"func must be callable, got '{type(func).__name__}'") - args: list[str] = [] + args: Mapping[str, inspect.Parameter] try: sig = inspect.signature(func) except ValueError: - return args + return {} if isinstance(func, partial): partial_args = func.args partial_kw = func.keywords + args = {} for name, param in sig.parameters.items(): - if param.name in partial_args: + if name in partial_args: continue - if partial_kw and param.name in partial_kw: + if partial_kw and name in partial_kw: continue - args.append(name) + args[name] = param else: - args = list(sig.parameters) + args = sig.parameters - if stripself and args and args[0] == "self": - args = args[1:] + if stripself and args and "self" in args: + args = {k: v for k, v in args.items() if k != "self"} return args +def get_func_args(func: Callable[..., Any], stripself: bool = False) -> list[str]: + """Return the argument name list of a callable object""" + return list(get_func_args_dict(func, stripself=stripself)) + + def get_spec(func: Callable[..., Any]) -> tuple[list[str], dict[str, Any]]: """Returns (args, kwargs) tuple for a function >>> import re @@ -275,35 +245,10 @@ def get_spec(func: Callable[..., Any]) -> tuple[list[str], dict[str, Any]]: firstdefault = len(spec.args) - len(defaults) args = spec.args[:firstdefault] - kwargs = dict(zip(spec.args[firstdefault:], defaults)) + kwargs = dict(zip(spec.args[firstdefault:], defaults, strict=False)) return args, kwargs -def equal_attributes( - obj1: Any, obj2: Any, attributes: list[str | Callable[[Any], Any]] | None -) -> bool: - """Compare two objects attributes""" - warnings.warn( - "The equal_attributes function is deprecated and will be removed in a future version of Scrapy.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - # not attributes given return False by default - if not attributes: - return False - - temp1, temp2 = object(), object() - for attr in attributes: - # support callables like itemgetter - if callable(attr): - if attr(obj1) != attr(obj2): - return False - elif getattr(obj1, attr, temp1) != getattr(obj2, attr, temp2): - return False - # all attributes equal - return True - - @overload def without_none_values(iterable: Mapping[_KT, _VT]) -> dict[_KT, _VT]: ... @@ -351,12 +296,13 @@ else: gc.collect() -class MutableChain(Iterable[_T]): - """ - Thin wrapper around itertools.chain, allowing to add iterables "in-place" - """ - +class MutableChain(Iterable[_T]): # pragma: no cover def __init__(self, *args: Iterable[_T]): + warnings.warn( + "MutableChain is deprecated and will be removed in a future Scrapy version.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) self.data: Iterator[_T] = chain.from_iterable(args) def extend(self, *iterables: Iterable[_T]) -> None: @@ -393,3 +339,33 @@ class MutableAsyncChain(AsyncIterator[_T]): async def __anext__(self) -> _T: return await self.data.__anext__() + + +def _looks_like_import_path(value: str) -> bool: + """Return True if **value** looks like a valid Python import path or False + otherwise.""" + if not value: + return False + if any(c.isspace() for c in value): + return False + allowed_chars = set( + "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_." + ) + if any(c not in allowed_chars for c in value): + return False + if value[0] == "." or value[-1] == ".": + return False + parts = value.split(".") + if any(part == "" for part in parts): + return False + return all(part.isidentifier() for part in parts) + + +def _iter_exc_causes(exc: BaseException) -> Iterable[BaseException]: + """Iterate over the exception causes/contexts.""" + seen: set[int] = set() + cur: BaseException | None = exc + while cur is not None and id(cur) not in seen: + seen.add(id(cur)) + yield cur + cur = cur.__cause__ or cur.__context__ diff --git a/scrapy/utils/reactor.py b/scrapy/utils/reactor.py index ce4c01731..5499e3f48 100644 --- a/scrapy/utils/reactor.py +++ b/scrapy/utils/reactor.py @@ -2,8 +2,9 @@ from __future__ import annotations import asyncio import sys +import warnings from contextlib import suppress -from typing import TYPE_CHECKING, Any, Generic, TypeVar +from typing import TYPE_CHECKING, Any, Generic, ParamSpec, TypeVar from warnings import catch_warnings, filterwarnings from twisted.internet import asyncioreactor, error @@ -13,35 +14,34 @@ from scrapy.utils.misc import load_object from scrapy.utils.python import global_object_name if TYPE_CHECKING: - from asyncio import AbstractEventLoop, AbstractEventLoopPolicy + from asyncio import AbstractEventLoop from collections.abc import Callable from twisted.internet.protocol import ServerFactory from twisted.internet.tcp import Port - # typing.ParamSpec requires Python 3.10 - from typing_extensions import ParamSpec - from scrapy.utils.asyncio import CallLaterResult - _P = ParamSpec("_P") _T = TypeVar("_T") +_P = ParamSpec("_P") -def listen_tcp(portrange: list[int], host: str, factory: ServerFactory) -> Port: # type: ignore[return] # pylint: disable=inconsistent-return-statements +def listen_tcp(portrange: list[int], host: str, factory: ServerFactory) -> Port: # type: ignore[return] # noqa: RET503 """Like reactor.listenTCP but tries different ports in a range.""" from twisted.internet import reactor if len(portrange) > 2: raise ValueError(f"invalid portrange: {portrange}") + if len(portrange) == 2 and portrange[0] > portrange[1]: + raise ValueError(f"invalid portrange: {portrange}") if not portrange: - return reactor.listenTCP(0, factory, interface=host) + return reactor.listenTCP(0, factory, interface=host) # type: ignore[no-any-return] if len(portrange) == 1: - return reactor.listenTCP(portrange[0], factory, interface=host) - for x in range(portrange[0], portrange[1] + 1): # noqa: RET503 + return reactor.listenTCP(portrange[0], factory, interface=host) # type: ignore[no-any-return] + for x in range(portrange[0], portrange[1] + 1): try: - return reactor.listenTCP(x, factory, interface=host) + return reactor.listenTCP(x, factory, interface=host) # type: ignore[no-any-return] except error.CannotListenError: if x == portrange[1]: raise @@ -57,10 +57,11 @@ class CallLaterOnce(Generic[_T]): self._a: tuple[Any, ...] = a self._kw: dict[str, Any] = kw self._call: CallLaterResult | None = None - self._deferreds: list[Deferred] = [] + self._deferreds: list[Deferred[None]] = [] def schedule(self, delay: float = 0) -> None: - from scrapy.utils.asyncio import call_later + # circular import + from scrapy.utils.asyncio import call_later # noqa: PLC0415 if self._call is None: self._call = call_later(delay, self) @@ -70,21 +71,23 @@ class CallLaterOnce(Generic[_T]): self._call.cancel() def __call__(self) -> _T: - from scrapy.utils.asyncio import call_later + # circular import + from scrapy.utils.asyncio import call_later # noqa: PLC0415 self._call = None result = self._func(*self._a, **self._kw) for d in self._deferreds: call_later(0, d.callback, None) - self._deferreds = [] + self._deferreds.clear() return result - async def wait(self): - from scrapy.utils.defer import maybe_deferred_to_future + async def wait(self) -> None: + # circular import + from scrapy.utils.defer import maybe_deferred_to_future # noqa: PLC0415 - d = Deferred() + d: Deferred[None] = Deferred() self._deferreds.append(d) await maybe_deferred_to_future(d) @@ -93,21 +96,19 @@ _asyncio_reactor_path = "twisted.internet.asyncioreactor.AsyncioSelectorReactor" def set_asyncio_event_loop_policy() -> None: - """The policy functions from asyncio often behave unexpectedly, - so we restrict their use to the absolutely essential case. - This should only be used to install the reactor. - """ - _get_asyncio_event_loop_policy() - - -def _get_asyncio_event_loop_policy() -> AbstractEventLoopPolicy: - policy = asyncio.get_event_loop_policy() - if sys.platform == "win32" and not isinstance( - policy, asyncio.WindowsSelectorEventLoopPolicy - ): - policy = asyncio.WindowsSelectorEventLoopPolicy() - asyncio.set_event_loop_policy(policy) - return policy + """Needed due to https://github.com/twisted/twisted/issues/12527.""" + if sys.platform != "win32": + return + with warnings.catch_warnings(): + warnings.filterwarnings( + "ignore", + message=r"'asyncio\.(get_event_loop_policy|WindowsSelectorEventLoopPolicy)' is deprecated", + category=DeprecationWarning, + ) + policy = asyncio.get_event_loop_policy() + if not isinstance(policy, asyncio.WindowsSelectorEventLoopPolicy): + policy = asyncio.WindowsSelectorEventLoopPolicy() # pylint: disable=deprecated-class + asyncio.set_event_loop_policy(policy) def install_reactor(reactor_path: str, event_loop_path: str | None = None) -> None: @@ -186,7 +187,7 @@ def verify_installed_reactor(reactor_path: str) -> None: def verify_installed_asyncio_event_loop(loop_path: str) -> None: - """Raise :exc:`RuntimeError` if the even loop of the installed + """Raise :exc:`RuntimeError` if the event loop of the installed :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` does not match the specified import path or if no reactor is installed.""" if not is_reactor_installed(): diff --git a/scrapy/utils/reactorless.py b/scrapy/utils/reactorless.py new file mode 100644 index 000000000..aca76951b --- /dev/null +++ b/scrapy/utils/reactorless.py @@ -0,0 +1,53 @@ +from __future__ import annotations + +import sys +from importlib.abc import MetaPathFinder +from typing import TYPE_CHECKING + +from scrapy.utils.asyncio import is_asyncio_available +from scrapy.utils.reactor import is_reactor_installed + +if TYPE_CHECKING: + from collections.abc import Sequence + from importlib.machinery import ModuleSpec + from types import ModuleType + + +def is_reactorless() -> bool: + """Check if we are running in the reactorless mode, i.e. with + :setting:`TWISTED_REACTOR_ENABLED` set to ``False``. + + As this checks the runtime state and not the setting itself, it can be + wrong when executed very early, before the reactor and/or the asyncio event + loop are initialized. + + .. note:: As this function uses + :func:`scrapy.utils.asyncio.is_asyncio_available()`, it has the same + limitations for detecting a running asyncio event loop as that one. + + .. versionadded:: 2.15.0 + """ + return is_asyncio_available() and not is_reactor_installed() + + +class ReactorImportHook(MetaPathFinder): + """Hook that prevents importing :mod:`twisted.internet.reactor`.""" + + def find_spec( + self, + fullname: str, + path: Sequence[str] | None, + target: ModuleType | None = None, + ) -> ModuleSpec | None: + if fullname == "twisted.internet.reactor": + raise ImportError( + f"Import of {fullname} is forbidden when running without a Twisted reactor," + f" as importing it installs the reactor, which can lead to unexpected behavior." + ) + return None + + +def install_reactor_import_hook() -> None: + """Prevent importing :mod:`twisted.internet.reactor`.""" + + sys.meta_path.insert(0, ReactorImportHook()) diff --git a/scrapy/utils/request.py b/scrapy/utils/request.py index 9c1161968..398403d90 100644 --- a/scrapy/utils/request.py +++ b/scrapy/utils/request.py @@ -7,16 +7,13 @@ from __future__ import annotations import hashlib import json -import warnings from typing import TYPE_CHECKING, Any, Protocol from urllib.parse import urlunparse from weakref import WeakKeyDictionary -from w3lib.http import basic_auth_header from w3lib.url import canonicalize_url from scrapy import Request, Spider -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.misc import load_object from scrapy.utils.python import to_bytes, to_unicode @@ -31,7 +28,7 @@ if TYPE_CHECKING: _fingerprint_cache: WeakKeyDictionary[ - Request, dict[tuple[tuple[bytes, ...] | None, bool], bytes] + Request, dict[tuple[tuple[bytes, ...] | None, bool, bool], bytes] ] = WeakKeyDictionary() @@ -74,8 +71,10 @@ def fingerprint( processed_include_headers = tuple( to_bytes(h.lower()) for h in sorted(include_headers) ) + verbatim_url = bool(request.meta.get("verbatim_url")) + effective_keep_fragments = keep_fragments and not verbatim_url cache = _fingerprint_cache.setdefault(request, {}) - cache_key = (processed_include_headers, keep_fragments) + cache_key = (processed_include_headers, effective_keep_fragments, verbatim_url) if cache_key not in cache: # To decode bytes reliably (JSON does not support bytes), regardless of # character encoding, we use bytes.hex() @@ -87,9 +86,13 @@ def fingerprint( header_value.hex() for header_value in request.headers.getlist(header) ] + if verbatim_url: + url = request.url + else: + url = canonicalize_url(request.url, keep_fragments=keep_fragments) fingerprint_data = { "method": to_unicode(request.method), - "url": canonicalize_url(request.url, keep_fragments=keep_fragments), + "url": url, "body": (request.body or b"").hex(), "headers": headers, } @@ -111,8 +114,9 @@ class RequestFingerprinter: (:func:`w3lib.url.canonicalize_url`) of :attr:`request.url ` and the values of :attr:`request.method ` and :attr:`request.body - `. It then generates an `SHA1 - `_ hash. + `, unless :reqmeta:`verbatim_url` is true for that + request. It then generates an `SHA1 `_ + hash. """ @classmethod @@ -120,41 +124,12 @@ class RequestFingerprinter: return cls(crawler) def __init__(self, crawler: Crawler | None = None): - if crawler: - implementation = crawler.settings.get( - "REQUEST_FINGERPRINTER_IMPLEMENTATION" - ) - else: - implementation = "SENTINEL" - - if implementation != "SENTINEL": - message = ( - "'REQUEST_FINGERPRINTER_IMPLEMENTATION' is a deprecated setting.\n" - "It will be removed in a future version of Scrapy." - ) - warnings.warn(message, category=ScrapyDeprecationWarning, stacklevel=2) self._fingerprint = fingerprint def fingerprint(self, request: Request) -> bytes: return self._fingerprint(request) -def request_authenticate( - request: Request, - username: str, - password: str, -) -> None: - """Authenticate the given request (in place) using the HTTP basic access - authentication mechanism (RFC 2617) and the given username and password - """ - warnings.warn( - "The request_authenticate function is deprecated and will be removed in a future version of Scrapy.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - request.headers["Authorization"] = basic_auth_header(username, password) - - def request_httprepr(request: Request) -> bytes: """Return the raw HTTP representation (as bytes) of the given request. This is provided only for reference since it's not the actual stream of @@ -201,7 +176,13 @@ def _get_method(obj: Any, name: Any) -> Any: try: return getattr(obj, name) except AttributeError: - raise ValueError(f"Method {name!r} not found in: {obj}") + raise ValueError(f"Method {name!r} not found in: {obj}") from None + + +def _cookie_value_to_unicode(value: str | bytes | float) -> str: + if isinstance(value, bytes): + return value.decode() + return str(value) def request_to_curl(request: Request) -> str: @@ -227,7 +208,9 @@ def request_to_curl(request: Request) -> str: cookies = f"--cookie '{cookie}'" elif isinstance(request.cookies, list): cookie = "; ".join( - f"{next(iter(c.keys()))}={next(iter(c.values()))}" + f"{_cookie_value_to_unicode(c['name'])}={_cookie_value_to_unicode(c['value'])}" + if "name" in c and "value" in c + else f"{next(iter(c.keys()))}={next(iter(c.values()))}" for c in request.cookies ) cookies = f"--cookie '{cookie}'" diff --git a/scrapy/utils/response.py b/scrapy/utils/response.py index 76a6b7de6..c068d9b1e 100644 --- a/scrapy/utils/response.py +++ b/scrapy/utils/response.py @@ -48,7 +48,7 @@ def get_meta_refresh( if response not in _metaref_cache: text = response.text[0:4096] _metaref_cache[response] = html.get_meta_refresh( - text, response.url, response.encoding, ignore_tags=ignore_tags + text, get_base_url(response), response.encoding, ignore_tags=ignore_tags ) return _metaref_cache[response] @@ -91,14 +91,14 @@ def open_in_browser( if "item name" not in response.body: open_in_browser(response) """ - from scrapy.http import HtmlResponse, TextResponse + # circular imports + from scrapy.http import HtmlResponse, TextResponse # noqa: PLC0415 # XXX: this implementation is a bit dirty and could be improved body = response.body if isinstance(response, HtmlResponse): - if b"' + if b"' body = re.sub(rb"]*?>)", to_bytes(repl), body, count=1) ext = ".html" elif isinstance(response, TextResponse): diff --git a/scrapy/utils/serialize.py b/scrapy/utils/serialize.py index bcfae0c00..5d06bbe30 100644 --- a/scrapy/utils/serialize.py +++ b/scrapy/utils/serialize.py @@ -1,13 +1,11 @@ import datetime import decimal import json -import warnings from typing import Any from itemadapter import ItemAdapter, is_item from twisted.internet import defer -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request, Response @@ -35,13 +33,3 @@ class ScrapyJSONEncoder(json.JSONEncoder): if is_item(o): return ItemAdapter(o).asdict() return super().default(o) - - -class ScrapyJSONDecoder(json.JSONDecoder): - def __init__(self, *args, **kwargs): - warnings.warn( - "The ScrapyJSONDecoder class is deprecated and will be removed in a future version of Scrapy.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - super().__init__(*args, **kwargs) diff --git a/scrapy/utils/signal.py b/scrapy/utils/signal.py index 552fbaa90..919f67240 100644 --- a/scrapy/utils/signal.py +++ b/scrapy/utils/signal.py @@ -2,9 +2,12 @@ from __future__ import annotations +import asyncio import logging -from collections.abc import Generator, Sequence +import warnings +from collections.abc import Awaitable, Callable, Generator, Sequence from typing import Any as TypingAny +from typing import cast from pydispatch.dispatcher import ( Anonymous, @@ -17,9 +20,15 @@ from pydispatch.robustapply import robustApply from twisted.internet.defer import Deferred, DeferredList, inlineCallbacks from twisted.python.failure import Failure -from scrapy.exceptions import StopDownload -from scrapy.utils.defer import maybe_deferred_to_future, maybeDeferred_coro +from scrapy.exceptions import ScrapyDeprecationWarning, StopDownload +from scrapy.utils.asyncio import is_asyncio_available +from scrapy.utils.defer import ( + _maybeDeferred_coro, + ensure_awaitable, + maybe_deferred_to_future, +) from scrapy.utils.log import failure_to_exc_info +from scrapy.utils.python import global_object_name logger = logging.getLogger(__name__) @@ -42,7 +51,7 @@ def send_catch_log( result: TypingAny try: response = robustApply( - receiver, signal=signal, sender=sender, *arguments, **named + receiver, *arguments, signal=signal, sender=sender, **named ) if isinstance(response, Deferred): logger.error( @@ -66,19 +75,32 @@ def send_catch_log( return responses -@inlineCallbacks def send_catch_log_deferred( signal: TypingAny = Any, sender: TypingAny = Anonymous, *arguments: TypingAny, **named: TypingAny, -) -> Generator[Deferred[TypingAny], TypingAny, list[tuple[TypingAny, TypingAny]]]: +) -> Deferred[list[tuple[TypingAny, TypingAny]]]: """Like :func:`send_catch_log` but supports :ref:`asynchronous signal handlers `. Returns a deferred that gets fired once all signal handlers have finished. """ + warnings.warn( + "send_catch_log_deferred() is deprecated, use send_catch_log_async() instead", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return _send_catch_log_deferred(signal, sender, *arguments, **named) + +@inlineCallbacks +def _send_catch_log_deferred( + signal: TypingAny, + sender: TypingAny, + *arguments: TypingAny, + **named: TypingAny, +) -> Generator[Deferred[TypingAny], TypingAny, list[tuple[TypingAny, TypingAny]]]: def logerror(failure: Failure, recv: TypingAny) -> Failure: if dont_log is None or not isinstance(failure.value, dont_log): logger.error( @@ -93,17 +115,21 @@ def send_catch_log_deferred( spider = named.get("spider") dfds: list[Deferred[tuple[TypingAny, TypingAny]]] = [] for receiver in liveReceivers(getAllReceivers(sender, signal)): - d: Deferred[TypingAny] = maybeDeferred_coro( - robustApply, receiver, signal=signal, sender=sender, *arguments, **named + d: Deferred[TypingAny] = _maybeDeferred_coro( + robustApply, + True, + receiver, + *arguments, + signal=signal, + sender=sender, + **named, ) d.addErrback(logerror, receiver) - # TODO https://pylint.readthedocs.io/en/latest/user_guide/messages/warning/cell-var-from-loop.html + d2: Deferred[tuple[TypingAny, TypingAny]] = d.addBoth( - lambda result: ( - receiver, # pylint: disable=cell-var-from-loop # noqa: B023 - result, - ) + lambda result, recv: (recv, result), receiver ) + dfds.append(d2) results = yield DeferredList(dfds) @@ -120,9 +146,72 @@ async def send_catch_log_async( `. Returns a coroutine that completes once all signal handlers have finished. + + .. versionadded:: 2.14 """ - return await maybe_deferred_to_future( - send_catch_log_deferred(signal, sender, *arguments, **named) + # note that this returns exceptions instead of Failures in the second tuple member + if is_asyncio_available(): + return await _send_catch_log_asyncio(signal, sender, *arguments, **named) + results = await maybe_deferred_to_future( + _send_catch_log_deferred(signal, sender, *arguments, **named) + ) + return [ + (receiver, result.value if isinstance(result, Failure) else result) + for receiver, result in results + ] + + +async def _send_catch_log_asyncio( + signal: TypingAny = Any, + sender: TypingAny = Anonymous, + *arguments: TypingAny, + **named: TypingAny, +) -> list[tuple[TypingAny, TypingAny]]: + """Like :func:`send_catch_log` but supports :ref:`asynchronous signal handlers + `. + + Returns a coroutine that completes once all signal handlers have finished. + + This function requires + :class:`~twisted.internet.asyncioreactor.AsyncioSelectorReactor` to be + installed. + + .. versionadded:: 2.14 + """ + dont_log = named.pop("dont_log", ()) + dont_log = tuple(dont_log) if isinstance(dont_log, Sequence) else (dont_log,) + spider = named.get("spider") + handlers: list[Awaitable[TypingAny]] = [] + for receiver in liveReceivers(getAllReceivers(sender, signal)): + + async def handler( + receiver: Callable[..., Any], + ) -> tuple[Callable[..., Any], TypingAny]: + result: TypingAny + try: + result = await ensure_awaitable( + robustApply( + receiver, *arguments, signal=signal, sender=sender, **named + ), + _warn=global_object_name(receiver), + ) + except dont_log as ex: # pylint: disable=catching-non-exception + result = ex + except Exception as ex: + logger.error( + "Error caught on signal handler: %(receiver)s", + {"receiver": receiver}, + exc_info=True, + extra={"spider": spider}, + ) + result = ex + return (receiver, result) + + handlers.append(handler(receiver)) + + return cast( + "list[tuple[TypingAny, TypingAny]]", + await asyncio.gather(*handlers, return_exceptions=True), ) diff --git a/scrapy/utils/sitemap.py b/scrapy/utils/sitemap.py index e0d9f4595..1520a4ff0 100644 --- a/scrapy/utils/sitemap.py +++ b/scrapy/utils/sitemap.py @@ -7,11 +7,15 @@ SitemapSpider, its API is subject to change without notice. from __future__ import annotations +import warnings +from io import BytesIO, StringIO from typing import TYPE_CHECKING, Any from urllib.parse import urljoin import lxml.etree +from scrapy.exceptions import ScrapyDeprecationWarning + if TYPE_CHECKING: from collections.abc import Iterable, Iterator @@ -20,40 +24,112 @@ class Sitemap: """Class to parse Sitemap (type=urlset) and Sitemap Index (type=sitemapindex) files""" + __slots__ = ("type", "xmliter") + def __init__(self, xmltext: str | bytes): - xmlp = lxml.etree.XMLParser( - recover=True, remove_comments=True, resolve_entities=False + if isinstance(xmltext, str): + warnings.warn( + "Passing `str` type as `xmltext` is deprecated, use `bytes`", + ScrapyDeprecationWarning, + stacklevel=2, + ) + xmltext = xmltext.encode() + + self.xmliter = lxml.etree.iterparse( + BytesIO(xmltext), + recover=True, + remove_comments=True, + resolve_entities=False, + remove_blank_text=True, + collect_ids=False, + remove_pis=True, + events=("start", "end"), ) - self._root = lxml.etree.fromstring(xmltext, parser=xmlp) # noqa: S320 - rt = self._root.tag - assert isinstance(rt, str) - self.type = rt.split("}", 1)[1] if "}" in rt else rt + _, root = next(self.xmliter) + self.type = self._get_tag_name(root) def __iter__(self) -> Iterator[dict[str, Any]]: - for elem in self._root.getchildren(): - d: dict[str, Any] = {} - for el in elem.getchildren(): - tag = el.tag - assert isinstance(tag, str) - name = tag.split("}", 1)[1] if "}" in tag else tag + for event, elem in self.xmliter: + if event == "start": + continue - if name == "link": - if "href" in el.attrib: - d.setdefault("alternate", []).append(el.get("href")) - else: - d[name] = el.text.strip() if el.text else "" + if self._get_tag_name(elem) not in {"url", "sitemap"}: + continue - if "loc" in d: + if d := self._process_sitemap_element(elem): yield d + def _process_sitemap_element( + self, elem: lxml.etree._Element + ) -> dict[str, Any] | None: + d: dict[str, Any] = {} + alternate: list[str] = [] + has_loc = False + + for el in elem: + try: + tag_name = self._get_tag_name(el) + if not tag_name: + continue + + if tag_name == "link": + if href := el.get("href"): + alternate.append(href) + else: + d[tag_name] = el.text.strip() if el.text else "" + if not has_loc and tag_name == "loc": + has_loc = True + finally: + el.clear() + elem.clear() + parent = elem.getparent() + if parent is not None: + while elem.getprevious() is not None: + del parent[0] + + if not has_loc: + return None + + if alternate: + d["alternate"] = alternate + + return d + + @staticmethod + def _get_tag_name(elem: lxml.etree._Element) -> str: + if TYPE_CHECKING: + assert isinstance(elem.tag, str) + _, _, localname = elem.tag.partition("}") + return localname or elem.tag + def sitemap_urls_from_robots( - robots_text: str, base_url: str | None = None + robots_text: str | bytes, + base_url: str | None = None, ) -> Iterable[str]: - """Return an iterator over all sitemap urls contained in the given - robots.txt file - """ - for line in robots_text.splitlines(): - if line.lstrip().lower().startswith("sitemap:"): - url = line.split(":", 1)[1].strip() + if isinstance(robots_text, bytes): + for line in BytesIO(robots_text): + if line.lstrip()[:8].lower() == b"sitemap:": + try: + url = line.partition(b":")[2].strip().decode() + except UnicodeDecodeError: + continue + yield urljoin(base_url or "", url) + + else: + warnings.warn( + "Passing `str` type as `robots_text` is deprecated, use `bytes`", + ScrapyDeprecationWarning, + stacklevel=2, + ) + yield from _sitemap_urls_from_robots_str(robots_text, base_url) + + +def _sitemap_urls_from_robots_str( + robots_text: str, + base_url: str | None = None, +) -> Iterable[str]: + for line in StringIO(robots_text): + if line.lstrip()[:8].lower() == "sitemap:": + url = line.partition(":")[2].strip() yield urljoin(base_url or "", url) diff --git a/scrapy/utils/spider.py b/scrapy/utils/spider.py index 74fd0e354..9f43df1ce 100644 --- a/scrapy/utils/spider.py +++ b/scrapy/utils/spider.py @@ -2,7 +2,7 @@ from __future__ import annotations import inspect import logging -from typing import TYPE_CHECKING, Any, Literal, TypeVar, overload +from typing import TYPE_CHECKING, Any, TypeVar, overload from scrapy.spiders import Spider from scrapy.utils.defer import deferred_from_coro @@ -41,11 +41,10 @@ def iterate_spider_output( ) -> Iterable[Any] | AsyncGenerator[_T] | Deferred[_T]: if inspect.isasyncgen(result): return result + d: Deferred[_T] = deferred_from_coro(result) if inspect.iscoroutine(result): - d = deferred_from_coro(result) - d.addCallback(iterate_spider_output) - return d - return arg_to_iter(deferred_from_coro(result)) + return d.addCallback(iterate_spider_output) + return arg_to_iter(d) def iter_spider_classes(module: ModuleType) -> Iterable[type[Spider]]: @@ -76,7 +75,7 @@ def spidercls_for_request( def spidercls_for_request( spider_loader: SpiderLoaderProtocol, request: Request, - default_spidercls: Literal[None], + default_spidercls: None, log_none: bool = ..., log_multiple: bool = ..., ) -> type[Spider] | None: ... diff --git a/scrapy/utils/ssl.py b/scrapy/utils/ssl.py index 7d46cbd4f..828a99e23 100644 --- a/scrapy/utils/ssl.py +++ b/scrapy/utils/ssl.py @@ -1,35 +1,162 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any +import logging +import ssl +import warnings +from typing import TYPE_CHECKING, Any, TypedDict, TypeVar import OpenSSL._util as pyOpenSSLutil import OpenSSL.SSL import OpenSSL.version +from twisted.internet.ssl import CertificateOptions, TLSVersion +from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.utils._deps_compat import ( + PYOPENSSL_X509_DEPRECATED, + TWISTED_TLS_LIMITS_OFFBY1, +) from scrapy.utils.python import to_unicode if TYPE_CHECKING: + from collections.abc import Callable + from OpenSSL.crypto import X509Name + from scrapy.settings import BaseSettings -def ffi_buf_to_string(buf: Any) -> str: +logger = logging.getLogger(__name__) + +_T = TypeVar("_T") + + +# common + + +def _get_tls_version_limit( + settings: BaseSettings, setting_name: str, converter: Callable[[str], _T] +) -> _T | None: + setting: str | None = settings[setting_name] + if setting is None: + return None + try: + return converter(setting) + except Exception as ex: + raise ValueError(f"Unknown {setting_name} value: {setting}") from ex + + +def _get_tls_version_limits( + settings: BaseSettings, converter: Callable[[str], _T] +) -> tuple[_T | None, _T | None]: + return ( + _get_tls_version_limit(settings, "DOWNLOAD_TLS_MIN_VERSION", converter), + _get_tls_version_limit(settings, "DOWNLOAD_TLS_MAX_VERSION", converter), + ) + + +# stdlib ssl module utils + +_STDLIB_VERSION_MAP: dict[str, ssl.TLSVersion] = { + "TLSv1.0": ssl.TLSVersion.TLSv1, + "TLSv1.1": ssl.TLSVersion.TLSv1_1, + "TLSv1.2": ssl.TLSVersion.TLSv1_2, + "TLSv1.3": ssl.TLSVersion.TLSv1_3, +} + + +def _make_ssl_context(settings: BaseSettings) -> ssl.SSLContext: + """Create an :class:`ssl.SSLContext` instance according to the settings. + + It's intended to be used in an HTTPS download handler. + """ + + tls_min_ver, tls_max_ver = _get_tls_version_limits( + settings, _STDLIB_VERSION_MAP.__getitem__ + ) + ciphers_setting: str | None = settings["DOWNLOADER_CLIENT_TLS_CIPHERS"] + verify_setting = settings.getbool("DOWNLOAD_VERIFY_CERTIFICATES") + + ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) + if verify_setting: + ctx.check_hostname = True + ctx.verify_mode = ssl.CERT_REQUIRED + ctx.load_default_certs() + else: + ctx.check_hostname = False + ctx.verify_mode = ssl.CERT_NONE + if tls_min_ver is not None: + ctx.minimum_version = tls_min_ver + if tls_max_ver is not None: + ctx.maximum_version = tls_max_ver + if ciphers_setting: + ctx.set_ciphers(ciphers_setting) + return ctx + + +def _make_insecure_ssl_ctx() -> ssl.SSLContext: + """Create an SSL context that doesn't verify certificates. + + Compared to :func:`~scrapy.utils.ssl._make_ssl_context` this is much more + simple. + """ + ctx = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) + ctx.check_hostname = False + ctx.verify_mode = ssl.CERT_NONE + return ctx + + +def _log_sslobj_debug_info(sslobj: ssl.SSLObject) -> None: + cipher = sslobj.cipher() + logger.debug( + f"SSL connection to {sslobj.server_hostname}" + f" using protocol {sslobj.version()}," + f" cipher {cipher[0] if cipher else None}" + ) + if cert := sslobj.getpeercert(): + # Not available without certificate verification + logger.debug( + f'SSL connection certificate: issuer "{cert["issuer"]}", subject "{cert["subject"]}"' + ) + + +# pyOpenSSL utils + + +def _ffi_buf_to_string(buf: Any) -> str: return to_unicode(pyOpenSSLutil.ffi.string(buf)) -def x509name_to_string(x509name: X509Name) -> str: +def ffi_buf_to_string(buf: Any) -> str: # pragma: no cover + warnings.warn( + "ffi_buf_to_string() is deprecated.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return ffi_buf_to_string(buf) + + +def _x509name_to_string(x509name: X509Name) -> str: # from OpenSSL.crypto.X509Name.__repr__ + # only used on pyOpenSSL < 24.3.0 result_buffer: Any = pyOpenSSLutil.ffi.new("char[]", 512) pyOpenSSLutil.lib.X509_NAME_oneline( x509name._name, result_buffer, len(result_buffer) ) - - return ffi_buf_to_string(result_buffer) + return _ffi_buf_to_string(result_buffer) -def get_temp_key_info(ssl_object: Any) -> str | None: +def x509name_to_string(x509name: X509Name) -> str: # pragma: no cover + warnings.warn( + "x509name_to_string() is deprecated.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return _x509name_to_string(x509name) + + +def _get_temp_key_info(ssl_object: Any) -> str | None: # adapted from OpenSSL apps/s_cb.c::ssl_print_tmp_key() if not hasattr(pyOpenSSLutil.lib, "SSL_get_server_tmp_key"): - # removed in cryptography 40.0.0 + # removed in cryptography 40.0.0 (required starting from pyOpenSSL 23.1.0) return None temp_key_p = pyOpenSSLutil.ffi.new("EVP_PKEY **") if not pyOpenSSLutil.lib.SSL_get_server_tmp_key(ssl_object, temp_key_p): @@ -54,14 +181,88 @@ def get_temp_key_info(ssl_object: Any) -> str | None: cname = pyOpenSSLutil.lib.EC_curve_nid2nist(nid) if cname == pyOpenSSLutil.ffi.NULL: cname = pyOpenSSLutil.lib.OBJ_nid2sn(nid) - key_info.append(ffi_buf_to_string(cname)) + key_info.append(_ffi_buf_to_string(cname)) else: - key_info.append(ffi_buf_to_string(pyOpenSSLutil.lib.OBJ_nid2sn(key_type))) + key_info.append(_ffi_buf_to_string(pyOpenSSLutil.lib.OBJ_nid2sn(key_type))) key_info.append(f"{pyOpenSSLutil.lib.EVP_PKEY_bits(temp_key)} bits") return ", ".join(key_info) +def get_temp_key_info(ssl_object: Any) -> str | None: # pragma: no cover + warnings.warn( + "get_temp_key_info() is deprecated. It's also a no-op with cryptography 40.0.0+.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return _get_temp_key_info(ssl_object) + + def get_openssl_version() -> str: system_openssl_bytes = OpenSSL.SSL.SSLeay_version(OpenSSL.SSL.SSLEAY_VERSION) system_openssl = system_openssl_bytes.decode("ascii", errors="replace") return f"{OpenSSL.version.__version__} ({system_openssl})" + + +def _log_ssl_conn_debug_info(hostname: str, connection: OpenSSL.SSL.Connection) -> None: + logger.debug( + "SSL connection to %s using protocol %s, cipher %s", + hostname, + connection.get_protocol_version_name(), + connection.get_cipher_name(), + ) + if PYOPENSSL_X509_DEPRECATED: + if server_cert := connection.get_peer_certificate(as_cryptography=True): + logger.debug( + 'SSL connection certificate: issuer "%s", subject "%s"', + server_cert.issuer.rfc4514_string(), + server_cert.subject.rfc4514_string(), + ) + else: # noqa: PLR5501 + if server_cert_pyopenssl := connection.get_peer_certificate(): + logger.debug( + 'SSL connection certificate: issuer "%s", subject "%s"', + _x509name_to_string(server_cert_pyopenssl.get_issuer()), + _x509name_to_string(server_cert_pyopenssl.get_subject()), + ) + key_info = _get_temp_key_info(connection._ssl) + if key_info: + logger.debug("SSL temp key: %s", key_info) + + +# Twisted-specific + + +class _CertificateOptionsVersionKwargs(TypedDict, total=False): + lowerMaximumSecurityTo: TLSVersion + insecurelyLowerMinimumTo: TLSVersion + raiseMinimumTo: TLSVersion + + +def _get_cert_options_version_kwargs( + min_version: TLSVersion | None, max_version: TLSVersion | None +) -> _CertificateOptionsVersionKwargs: + """Get TLS version kwargs for + :class:`~twisted.internet.ssl.CertificateOptions` for the given limits.""" + result: _CertificateOptionsVersionKwargs = {} + if max_version: + if TWISTED_TLS_LIMITS_OFFBY1: + # lowerMaximumSecurityTo is treated as 1 version lower than the passed one + versions = list(TLSVersion.iterconstants()) + max_index = versions.index(max_version) + if max_index + 1 >= len(versions): + raise ValueError( + f"Due to an error in Twisted < 26.4.0 cannot set the maximum TLS version to {max_version.name}" + ) + max_version = versions[max_index + 1] + result["lowerMaximumSecurityTo"] = max_version + if min_version: + # We cannot pass both insecurelyLowerMinimumTo and raiseMinimumTo, + # so we need to know the direction. + + # 1.0 in Twisted 22.8.0 and older, 1.2 in Twisted 22.10.0 and newer + default_min = CertificateOptions._defaultMinimumTLSVersion + if min_version < default_min: + result["insecurelyLowerMinimumTo"] = min_version + elif min_version > default_min: + result["raiseMinimumTo"] = min_version + return result diff --git a/scrapy/utils/template.py b/scrapy/utils/template.py index 3e4dae5c8..977d5a42a 100644 --- a/scrapy/utils/template.py +++ b/scrapy/utils/template.py @@ -11,7 +11,7 @@ if TYPE_CHECKING: from os import PathLike -def render_templatefile(path: str | PathLike, **kwargs: Any) -> None: +def render_templatefile(path: str | PathLike[str], **kwargs: Any) -> None: path_obj = Path(path) raw = path_obj.read_text("utf8") diff --git a/scrapy/utils/test.py b/scrapy/utils/test.py index 3780ad23e..b4e20c3c6 100644 --- a/scrapy/utils/test.py +++ b/scrapy/utils/test.py @@ -9,15 +9,12 @@ import os import warnings from importlib import import_module from pathlib import Path -from posixpath import split from typing import TYPE_CHECKING, Any, TypeVar, cast -from unittest import TestCase, mock -from twisted.trial.unittest import SkipTest +from twisted.web.client import Agent +from scrapy.crawler import AsyncCrawlerRunner, CrawlerRunner, CrawlerRunnerBase from scrapy.exceptions import ScrapyDeprecationWarning -from scrapy.utils.boto import is_botocore_available -from scrapy.utils.deprecate import create_deprecated_class from scrapy.utils.reactor import is_asyncio_reactor_installed, is_reactor_installed from scrapy.utils.spider import DefaultSpider @@ -34,97 +31,29 @@ if TYPE_CHECKING: _T = TypeVar("_T") -def assert_gcs_environ() -> None: - warnings.warn( - "The assert_gcs_environ() function is deprecated and will be removed in a future version of Scrapy." - " Check GCS_PROJECT_ID directly.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - if "GCS_PROJECT_ID" not in os.environ: - raise SkipTest("GCS_PROJECT_ID not found") - - -def skip_if_no_boto() -> None: - warnings.warn( - "The skip_if_no_boto() function is deprecated and will be removed in a future version of Scrapy." - " Check scrapy.utils.boto.is_botocore_available() directly.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - if not is_botocore_available(): - raise SkipTest("missing botocore library") - - -def get_gcs_content_and_delete( - bucket: Any, path: str -) -> tuple[bytes, list[dict[str, str]], Any]: - from google.cloud import storage - - warnings.warn( - "The get_gcs_content_and_delete() function is deprecated and will be removed in a future version of Scrapy.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - client = storage.Client(project=os.environ.get("GCS_PROJECT_ID")) - bucket = client.get_bucket(bucket) - blob = bucket.get_blob(path) - content = blob.download_as_string() - acl = list(blob.acl) # loads acl before it will be deleted - bucket.delete_blob(path) - return content, acl, blob - - -def get_ftp_content_and_delete( - path: str, - host: str, - port: int, - username: str, - password: str, - use_active_mode: bool = False, -) -> bytes: - from ftplib import FTP - - warnings.warn( - "The get_ftp_content_and_delete() function is deprecated and will be removed in a future version of Scrapy.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - ftp = FTP() - ftp.connect(host, port) - ftp.login(username, password) - if use_active_mode: - ftp.set_pasv(False) - ftp_data: list[bytes] = [] - - def buffer_data(data: bytes) -> None: - ftp_data.append(data) - - ftp.retrbinary(f"RETR {path}", buffer_data) - dirname, filename = split(path) - ftp.cwd(dirname) - ftp.delete(filename) - return b"".join(ftp_data) - - -TestSpider = create_deprecated_class("TestSpider", DefaultSpider) - - def get_reactor_settings() -> dict[str, Any]: """Return a settings dict that works with the installed reactor. ``Crawler._apply_settings()`` checks that the installed reactor matches the settings, so tests that run the crawler in the current process may need to - pass a correct ``"TWISTED_REACTOR"`` setting value when creating it. + pass a correct :setting:`TWISTED_REACTOR` setting value when creating it. """ - if not is_reactor_installed(): - raise RuntimeError( - "get_reactor_settings() called without an installed reactor," - " you may need to install a reactor explicitly when running your tests." - ) settings: dict[str, Any] = {} - if not is_asyncio_reactor_installed(): - settings["TWISTED_REACTOR"] = None + if is_reactor_installed(): + if not is_asyncio_reactor_installed(): + settings["TWISTED_REACTOR"] = None + else: + # We are either running Scrapy tests for the reactorless mode, or + # running some 3rd-party library tests for the reactorless mode, or + # running some 3rd-party library tests without initializing a reactor + # properly. The first two cases are fine, but we cannot distinguish the + # last one from them. + settings["TWISTED_REACTOR_ENABLED"] = False + settings["DOWNLOAD_HANDLERS"] = { + "ftp": None, + "http": "scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler", + "https": "scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler", + } return settings @@ -137,15 +66,17 @@ def get_crawler( will be used to populate the crawler settings with a project level priority. """ - from scrapy.crawler import CrawlerRunner - # When needed, useful settings can be added here, e.g. ones that prevent # deprecation warnings. settings: dict[str, Any] = { **get_reactor_settings(), **(settings_dict or {}), } - runner = CrawlerRunner(settings) + runner: CrawlerRunnerBase + if is_reactor_installed(): + runner = CrawlerRunner(settings) + else: + runner = AsyncCrawlerRunner(settings) crawler = runner.create_crawler(spidercls or DefaultSpider) crawler._apply_settings() return crawler @@ -167,20 +98,6 @@ def get_testenv() -> dict[str, str]: return env -def assert_samelines( - testcase: TestCase, text1: str, text2: str, msg: str | None = None -) -> None: - """Asserts text1 and text2 have the same lines, ignoring differences in - line endings between platforms - """ - warnings.warn( - "The assert_samelines function is deprecated and will be removed in a future version of Scrapy.", - category=ScrapyDeprecationWarning, - stacklevel=2, - ) - testcase.assertEqual(text1.splitlines(), text2.splitlines(), msg) # noqa: PT009 - - def get_from_asyncio_queue(value: _T) -> Awaitable[_T]: q: asyncio.Queue[_T] = asyncio.Queue() getter = q.get() @@ -188,32 +105,15 @@ def get_from_asyncio_queue(value: _T) -> Awaitable[_T]: return getter -def mock_google_cloud_storage() -> tuple[Any, Any, Any]: - """Creates autospec mocks for google-cloud-storage Client, Bucket and Blob - classes and set their proper return values. - """ - from google.cloud.storage import Blob, Bucket, Client - +def get_web_client_agent_req(url: str) -> Deferred[TxResponse]: # pragma: no cover warnings.warn( - "The mock_google_cloud_storage() function is deprecated and will be removed in a future version of Scrapy.", + "The get_web_client_agent_req() function is deprecated" + " and will be removed in a future version of Scrapy.", category=ScrapyDeprecationWarning, stacklevel=2, ) - client_mock = mock.create_autospec(Client) - - bucket_mock = mock.create_autospec(Bucket) - client_mock.get_bucket.return_value = bucket_mock - - blob_mock = mock.create_autospec(Blob) - bucket_mock.blob.return_value = blob_mock - - return (client_mock, bucket_mock, blob_mock) - - -def get_web_client_agent_req(url: str) -> Deferred[TxResponse]: from twisted.internet import reactor - from twisted.web.client import Agent # imports twisted.internet.reactor agent = Agent(reactor) return cast("Deferred[TxResponse]", agent.request(b"GET", url.encode("utf-8"))) diff --git a/scrapy/utils/testproc.py b/scrapy/utils/testproc.py deleted file mode 100644 index 10f764ab8..000000000 --- a/scrapy/utils/testproc.py +++ /dev/null @@ -1,76 +0,0 @@ -from __future__ import annotations - -import os -import sys -import warnings -from typing import TYPE_CHECKING, cast - -from twisted.internet.defer import Deferred -from twisted.internet.error import ProcessTerminated -from twisted.internet.protocol import ProcessProtocol - -from scrapy.exceptions import ScrapyDeprecationWarning - -if TYPE_CHECKING: - from collections.abc import Iterable - - from twisted.python.failure import Failure - - -warnings.warn( - "The scrapy.utils.testproc module is deprecated.", - ScrapyDeprecationWarning, -) - - -class ProcessTest: - command: str | None = None - prefix = [sys.executable, "-m", "scrapy.cmdline"] - cwd = os.getcwd() # trial chdirs to temp dir # noqa: PTH109 - - def execute( - self, - args: Iterable[str], - check_code: bool = True, - settings: str | None = None, - ) -> Deferred[TestProcessProtocol]: - from twisted.internet import reactor - - env = os.environ.copy() - if settings is not None: - env["SCRAPY_SETTINGS_MODULE"] = settings - assert self.command - cmd = [*self.prefix, self.command, *args] - pp = TestProcessProtocol() - pp.deferred.addCallback(self._process_finished, cmd, check_code) - reactor.spawnProcess(pp, cmd[0], cmd, env=env, path=self.cwd) - return pp.deferred - - def _process_finished( - self, pp: TestProcessProtocol, cmd: list[str], check_code: bool - ) -> tuple[int, bytes, bytes]: - if pp.exitcode and check_code: - msg = f"process {cmd} exit with code {pp.exitcode}" - msg += f"\n>>> stdout <<<\n{pp.out.decode()}" - msg += "\n" - msg += f"\n>>> stderr <<<\n{pp.err.decode()}" - raise RuntimeError(msg) - return cast(int, pp.exitcode), pp.out, pp.err - - -class TestProcessProtocol(ProcessProtocol): - def __init__(self) -> None: - self.deferred: Deferred[TestProcessProtocol] = Deferred() - self.out: bytes = b"" - self.err: bytes = b"" - self.exitcode: int | None = None - - def outReceived(self, data: bytes) -> None: - self.out += data - - def errReceived(self, data: bytes) -> None: - self.err += data - - def processEnded(self, status: Failure) -> None: - self.exitcode = cast(ProcessTerminated, status.value).exitCode - self.deferred.callback(self) diff --git a/scrapy/utils/testsite.py b/scrapy/utils/testsite.py deleted file mode 100644 index f12b301fd..000000000 --- a/scrapy/utils/testsite.py +++ /dev/null @@ -1,63 +0,0 @@ -import warnings -from urllib.parse import urljoin - -from twisted.web import resource, server, static, util - -from scrapy.exceptions import ScrapyDeprecationWarning - -warnings.warn( - "The scrapy.utils.testsite module is deprecated.", - ScrapyDeprecationWarning, -) - - -class SiteTest: - def setUp(self): - from twisted.internet import reactor - - super().setUp() - self.site = reactor.listenTCP(0, test_site(), interface="127.0.0.1") - self.baseurl = f"http://localhost:{self.site.getHost().port}/" - - def tearDown(self): - super().tearDown() - self.site.stopListening() - - def url(self, path: str) -> str: - return urljoin(self.baseurl, path) - - -class NoMetaRefreshRedirect(util.Redirect): - def render(self, request: server.Request) -> bytes: - content = util.Redirect.render(self, request) - return content.replace( - b'http-equiv="refresh"', b'http-no-equiv="do-not-refresh-me"' - ) - - -def test_site(): - r = resource.Resource() - r.putChild(b"text", static.Data(b"Works", "text/plain")) - r.putChild( - b"html", - static.Data( - b"

Works

World

", - "text/html", - ), - ) - r.putChild( - b"enc-gb18030", - static.Data(b"

gb18030 encoding

", "text/html; charset=gb18030"), - ) - r.putChild(b"redirect", util.Redirect(b"/redirected")) - r.putChild(b"redirect-no-meta-refresh", NoMetaRefreshRedirect(b"/redirected")) - r.putChild(b"redirected", static.Data(b"Redirected here", "text/plain")) - return server.Site(r) - - -if __name__ == "__main__": - from twisted.internet import reactor # pylint: disable=ungrouped-imports - - port = reactor.listenTCP(0, test_site(), interface="127.0.0.1") - print(f"http://localhost:{port.getHost().port}/") - reactor.run() diff --git a/scrapy/utils/trackref.py b/scrapy/utils/trackref.py index b04214c51..87df10a02 100644 --- a/scrapy/utils/trackref.py +++ b/scrapy/utils/trackref.py @@ -7,13 +7,19 @@ subclass from object_ref (instead of object). About performance: This library has a minimal performance impact when enabled, and no performance penalty at all when disabled (as object_ref becomes just an alias to object in that case). + +.. note:: PyPy uses a tracing garbage collector, so objects may + remain in the ``live_refs`` longer than expected, even after they + go out of scope. If deterministic behavior is required, you may need + to explicitly trigger garbage collection or call ``trackref.live_refs.clear()``. """ from __future__ import annotations from collections import defaultdict from operator import itemgetter -from time import time +from time import monotonic_ns +from types import NoneType from typing import TYPE_CHECKING, Any from weakref import WeakKeyDictionary @@ -24,8 +30,9 @@ if TYPE_CHECKING: from typing_extensions import Self -NoneType = type(None) -live_refs: defaultdict[type, WeakKeyDictionary] = defaultdict(WeakKeyDictionary) +live_refs: defaultdict[type, WeakKeyDictionary[object, float]] = defaultdict( + WeakKeyDictionary +) class object_ref: @@ -35,7 +42,7 @@ class object_ref: def __new__(cls, *args: Any, **kwargs: Any) -> Self: obj = object.__new__(cls) - live_refs[cls][obj] = time() + live_refs[cls][obj] = monotonic_ns() return obj @@ -43,14 +50,14 @@ class object_ref: def format_live_refs(ignore: Any = NoneType) -> str: """Return a tabular representation of tracked objects""" s = "Live References\n\n" - now = time() + now_ns = monotonic_ns() for cls, wdict in sorted(live_refs.items(), key=lambda x: x[0].__name__): if not wdict: continue if issubclass(cls, ignore): continue - oldest = min(wdict.values()) - s += f"{cls.__name__:<30} {len(wdict):6} oldest: {int(now - oldest)}s ago\n" + oldest_ns = min(wdict.values()) + s += f"{cls.__name__:<30} {len(wdict):6} oldest: {int((now_ns - oldest_ns) // 1e9)}s ago\n" return s @@ -74,4 +81,4 @@ def iter_all(class_name: str) -> Iterable[Any]: for cls, wdict in live_refs.items(): if cls.__name__ == class_name: return wdict.keys() - return [] + return () diff --git a/scrapy/utils/url.py b/scrapy/utils/url.py index 1348cc992..4d2bbdda2 100644 --- a/scrapy/utils/url.py +++ b/scrapy/utils/url.py @@ -6,95 +6,44 @@ library. from __future__ import annotations import re -import warnings -from importlib import import_module -from typing import TYPE_CHECKING, Union -from urllib.parse import ParseResult, urldefrag, urlparse, urlunparse -from warnings import warn - -from w3lib.url import __all__ as _public_w3lib_objects -from w3lib.url import add_or_replace_parameter as _add_or_replace_parameter -from w3lib.url import any_to_uri as _any_to_uri -from w3lib.url import parse_url as _parse_url - -from scrapy.exceptions import ScrapyDeprecationWarning - - -def __getattr__(name: str): - if name in ("_unquotepath", "_safe_chars", "parse_url", *_public_w3lib_objects): - obj_type = "attribute" if name == "_safe_chars" else "function" - warnings.warn( - f"The scrapy.utils.url.{name} {obj_type} is deprecated, use w3lib.url.{name} instead.", - ScrapyDeprecationWarning, - ) - return getattr(import_module("w3lib.url"), name) - - raise AttributeError +from typing import TYPE_CHECKING, TypeAlias +from urllib.parse import ParseResult, urlparse, urlunparse +from w3lib.url import any_to_uri, parse_url if TYPE_CHECKING: from collections.abc import Iterable from scrapy import Spider -UrlT = Union[str, bytes, ParseResult] +UrlT: TypeAlias = str | bytes | ParseResult def url_is_from_any_domain(url: UrlT, domains: Iterable[str]) -> bool: """Return True if the url belongs to any of the given domains""" - host = _parse_url(url).netloc.lower() + host = parse_url(url).netloc.lower() if not host: return False - domains = [d.lower() for d in domains] - return any((host == d) or (host.endswith(f".{d}")) for d in domains) + return any((host == d) or (host.endswith(f".{d}")) for d in map(str.lower, domains)) + + +def _spider_domains(spider: type[Spider]) -> Iterable[str]: + yield spider.name + if allowed_domains := getattr(spider, "allowed_domains", None): + yield from allowed_domains def url_is_from_spider(url: UrlT, spider: type[Spider]) -> bool: """Return True if the url belongs to the given spider""" - return url_is_from_any_domain( - url, [spider.name, *getattr(spider, "allowed_domains", [])] - ) + return url_is_from_any_domain(url, _spider_domains(spider)) def url_has_any_extension(url: UrlT, extensions: Iterable[str]) -> bool: """Return True if the url ends with one of the extensions provided""" - lowercase_path = _parse_url(url).path.lower() + lowercase_path = parse_url(url).path.lower() return any(lowercase_path.endswith(ext) for ext in extensions) -def escape_ajax(url: str) -> str: - """ - Return the crawlable url - - >>> escape_ajax("www.example.com/ajax.html#!key=value") - 'www.example.com/ajax.html?_escaped_fragment_=key%3Dvalue' - >>> escape_ajax("www.example.com/ajax.html?k1=v1&k2=v2#!key=value") - 'www.example.com/ajax.html?k1=v1&k2=v2&_escaped_fragment_=key%3Dvalue' - >>> escape_ajax("www.example.com/ajax.html?#!key=value") - 'www.example.com/ajax.html?_escaped_fragment_=key%3Dvalue' - >>> escape_ajax("www.example.com/ajax.html#!") - 'www.example.com/ajax.html?_escaped_fragment_=' - - URLs that are not "AJAX crawlable" (according to Google) returned as-is: - - >>> escape_ajax("www.example.com/ajax.html#key=value") - 'www.example.com/ajax.html#key=value' - >>> escape_ajax("www.example.com/ajax.html#") - 'www.example.com/ajax.html#' - >>> escape_ajax("www.example.com/ajax.html") - 'www.example.com/ajax.html' - """ - warn( - "escape_ajax() is deprecated and will be removed in a future Scrapy version.", - ScrapyDeprecationWarning, - stacklevel=2, - ) - defrag, frag = urldefrag(url) - if not frag.startswith("!"): - return url - return _add_or_replace_parameter(defrag, "_escaped_fragment_", frag[1:]) - - def add_http_if_no_scheme(url: str) -> str: """Add http as the default scheme if it is missing from the url.""" match = re.match(r"^\w+://", url, flags=re.IGNORECASE) @@ -152,7 +101,7 @@ def guess_scheme(url: str) -> str: """Add an URL scheme if missing: file:// for filepath-like input or http:// otherwise.""" if _is_filesystem_path(url): - return _any_to_uri(url) + return any_to_uri(url) return add_http_if_no_scheme(url) @@ -184,13 +133,14 @@ def strip_url( strip_default_port and parsed_url.port and (parsed_url.scheme, parsed_url.port) - in ( + in { ("http", 80), ("https", 443), ("ftp", 21), - ) + } ): - netloc = netloc.replace(f":{parsed_url.port}", "") + port_suffix = f":{parsed_url.port}" + netloc = netloc.removesuffix(port_suffix) return urlunparse( ( diff --git a/scrapy/utils/versions.py b/scrapy/utils/versions.py index 052321ae3..6bd96a215 100644 --- a/scrapy/utils/versions.py +++ b/scrapy/utils/versions.py @@ -3,18 +3,16 @@ from __future__ import annotations import platform import sys from importlib.metadata import version -from warnings import warn import lxml.etree -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.settings.default_settings import LOG_VERSIONS from scrapy.utils.ssl import get_openssl_version -_DEFAULT_SOFTWARE = ["Scrapy", *LOG_VERSIONS] +_DEFAULT_SOFTWARE: list[str] = ["Scrapy", *LOG_VERSIONS] -def _version(item): +def _version(item: str) -> str: lowercase_item = item.lower() if lowercase_item == "libxml2": return ".".join(map(str, lxml.etree.LIBXML_VERSION)) @@ -28,19 +26,7 @@ def _version(item): def get_versions( - software: list | None = None, + software: list[str] | None = None, ) -> list[tuple[str, str]]: software = software or _DEFAULT_SOFTWARE return [(item, _version(item)) for item in software] - - -def scrapy_components_versions() -> list[tuple[str, str]]: - warn( - ( - "scrapy.utils.versions.scrapy_components_versions() is deprecated, " - "use scrapy.utils.versions.get_versions() instead." - ), - ScrapyDeprecationWarning, - stacklevel=2, - ) - return get_versions() diff --git a/tests/AsyncCrawlerProcess/asyncio_deferred_signal.py b/tests/AsyncCrawlerProcess/asyncio_deferred_signal.py index c32aaf37d..e000a23db 100644 --- a/tests/AsyncCrawlerProcess/asyncio_deferred_signal.py +++ b/tests/AsyncCrawlerProcess/asyncio_deferred_signal.py @@ -16,7 +16,7 @@ class UppercasePipeline: def open_spider(self, spider): return deferred_from_coro(self._open_spider(spider)) - def process_item(self, item, spider): + def process_item(self, item): return {"url": item["url"].upper()} diff --git a/tests/AsyncCrawlerProcess/caching_hostname_resolver.py b/tests/AsyncCrawlerProcess/caching_hostname_resolver.py index 5f75d5e17..a6520ca22 100644 --- a/tests/AsyncCrawlerProcess/caching_hostname_resolver.py +++ b/tests/AsyncCrawlerProcess/caching_hostname_resolver.py @@ -28,7 +28,7 @@ if __name__ == "__main__": process = AsyncCrawlerProcess( settings={ "RETRY_ENABLED": False, - "DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", + "TWISTED_DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", } ) process.crawl(CachingHostnameResolverSpider, url=sys.argv[1]) diff --git a/tests/AsyncCrawlerProcess/caching_hostname_resolver_ipv6.py b/tests/AsyncCrawlerProcess/caching_hostname_resolver_ipv6.py index c43f0a9c2..55d2ef711 100644 --- a/tests/AsyncCrawlerProcess/caching_hostname_resolver_ipv6.py +++ b/tests/AsyncCrawlerProcess/caching_hostname_resolver_ipv6.py @@ -4,7 +4,7 @@ from scrapy.crawler import AsyncCrawlerProcess class CachingHostnameResolverSpider(scrapy.Spider): """ - Finishes without a twisted.internet.error.DNSLookupError exception + Finishes without a scrapy.exceptions.CannotResolveHostError exception """ name = "caching_hostname_resolver_spider" @@ -15,7 +15,7 @@ if __name__ == "__main__": process = AsyncCrawlerProcess( settings={ "RETRY_ENABLED": False, - "DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", + "TWISTED_DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", } ) process.crawl(CachingHostnameResolverSpider) diff --git a/tests/AsyncCrawlerProcess/default_name_resolver.py b/tests/AsyncCrawlerProcess/default_name_resolver.py index af56ccd01..4c8897f8f 100644 --- a/tests/AsyncCrawlerProcess/default_name_resolver.py +++ b/tests/AsyncCrawlerProcess/default_name_resolver.py @@ -4,7 +4,7 @@ from scrapy.crawler import AsyncCrawlerProcess class IPv6Spider(scrapy.Spider): """ - Raises a twisted.internet.error.DNSLookupError: + Raises a scrapy.exceptions.CannotResolveHostError: the default name resolver does not handle IPv6 addresses. """ diff --git a/tests/AsyncCrawlerProcess/reactorless_custom_settings.py b/tests/AsyncCrawlerProcess/reactorless_custom_settings.py new file mode 100644 index 000000000..f49741441 --- /dev/null +++ b/tests/AsyncCrawlerProcess/reactorless_custom_settings.py @@ -0,0 +1,36 @@ +from __future__ import annotations + +import logging +from typing import TYPE_CHECKING + +import scrapy +from scrapy.crawler import AsyncCrawlerProcess +from scrapy.utils.reactorless import is_reactorless + +if TYPE_CHECKING: + from asyncio import Task + + +class NoRequestsSpider(scrapy.Spider): + name = "no_request" + custom_settings = { + "TWISTED_REACTOR_ENABLED": False, + } + + async def start(self): + self.logger.info(f"is_reactorless(): {is_reactorless()}") + return + yield + + +def log_task_exception(task: Task[None]) -> None: + try: + task.result() + except Exception: + logging.exception("Crawl task failed") # noqa: LOG015 + + +process = AsyncCrawlerProcess() +task = process.crawl(NoRequestsSpider) +task.add_done_callback(log_task_exception) +process.start() diff --git a/tests/AsyncCrawlerProcess/reactorless_datauri.py b/tests/AsyncCrawlerProcess/reactorless_datauri.py new file mode 100644 index 000000000..5270b7b83 --- /dev/null +++ b/tests/AsyncCrawlerProcess/reactorless_datauri.py @@ -0,0 +1,18 @@ +from scrapy import Request, Spider +from scrapy.crawler import AsyncCrawlerProcess + + +class DataSpider(Spider): + name = "data" + + async def start(self): + yield Request("data:,foo") + + def parse(self, response): + return {"data": response.text} + + +process = AsyncCrawlerProcess(settings={"TWISTED_REACTOR_ENABLED": False}) + +process.crawl(DataSpider) +process.start() diff --git a/tests/AsyncCrawlerProcess/reactorless_import_hook.py b/tests/AsyncCrawlerProcess/reactorless_import_hook.py new file mode 100644 index 000000000..57e2a5c26 --- /dev/null +++ b/tests/AsyncCrawlerProcess/reactorless_import_hook.py @@ -0,0 +1,18 @@ +import scrapy +from scrapy.crawler import AsyncCrawlerProcess + + +class NoRequestsSpider(scrapy.Spider): + name = "no_request" + + async def start(self): + import twisted.internet.reactor # noqa: F401 + + return + yield + + +process = AsyncCrawlerProcess(settings={"TWISTED_REACTOR_ENABLED": False}) + +process.crawl(NoRequestsSpider) +process.start() diff --git a/tests/AsyncCrawlerProcess/reactorless_reactor.py b/tests/AsyncCrawlerProcess/reactorless_reactor.py new file mode 100644 index 000000000..481112ca7 --- /dev/null +++ b/tests/AsyncCrawlerProcess/reactorless_reactor.py @@ -0,0 +1,6 @@ +from scrapy.crawler import AsyncCrawlerProcess +from scrapy.utils.reactor import install_reactor + +install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor") + +AsyncCrawlerProcess(settings={"TWISTED_REACTOR_ENABLED": False}) diff --git a/tests/AsyncCrawlerProcess/reactorless_simple.py b/tests/AsyncCrawlerProcess/reactorless_simple.py new file mode 100644 index 000000000..33b4e8cb2 --- /dev/null +++ b/tests/AsyncCrawlerProcess/reactorless_simple.py @@ -0,0 +1,18 @@ +import scrapy +from scrapy.crawler import AsyncCrawlerProcess +from scrapy.utils.reactorless import is_reactorless + + +class NoRequestsSpider(scrapy.Spider): + name = "no_request" + + async def start(self): + self.logger.info(f"is_reactorless(): {is_reactorless()}") + return + yield + + +process = AsyncCrawlerProcess(settings={"TWISTED_REACTOR_ENABLED": False}) + +process.crawl(NoRequestsSpider) +process.start() diff --git a/tests/AsyncCrawlerProcess/reactorless_sleeping.py b/tests/AsyncCrawlerProcess/reactorless_sleeping.py new file mode 100644 index 000000000..12101d221 --- /dev/null +++ b/tests/AsyncCrawlerProcess/reactorless_sleeping.py @@ -0,0 +1,20 @@ +import asyncio +import sys + +import scrapy +from scrapy.crawler import AsyncCrawlerProcess + + +class SleepingSpider(scrapy.Spider): + name = "sleeping" + + start_urls = ["data:,;"] + + async def parse(self, response): + await asyncio.sleep(int(sys.argv[1])) + + +process = AsyncCrawlerProcess(settings={"TWISTED_REACTOR_ENABLED": False}) + +process.crawl(SleepingSpider) +process.start() diff --git a/tests/AsyncCrawlerProcess/reactorless_telnetconsole_disabled.py b/tests/AsyncCrawlerProcess/reactorless_telnetconsole_disabled.py new file mode 100644 index 000000000..e59a365bc --- /dev/null +++ b/tests/AsyncCrawlerProcess/reactorless_telnetconsole_disabled.py @@ -0,0 +1,21 @@ +import scrapy +from scrapy.crawler import AsyncCrawlerProcess + + +class NoRequestsSpider(scrapy.Spider): + name = "no_request" + + async def start(self): + return + yield + + +process = AsyncCrawlerProcess( + settings={ + "TWISTED_REACTOR_ENABLED": False, + "TELNETCONSOLE_ENABLED": False, + } +) + +process.crawl(NoRequestsSpider) +process.start() diff --git a/tests/AsyncCrawlerProcess/reactorless_telnetconsole_enabled.py b/tests/AsyncCrawlerProcess/reactorless_telnetconsole_enabled.py new file mode 100644 index 000000000..34daf8779 --- /dev/null +++ b/tests/AsyncCrawlerProcess/reactorless_telnetconsole_enabled.py @@ -0,0 +1,21 @@ +import scrapy +from scrapy.crawler import AsyncCrawlerProcess + + +class NoRequestsSpider(scrapy.Spider): + name = "no_request" + + async def start(self): + return + yield + + +process = AsyncCrawlerProcess( + settings={ + "TWISTED_REACTOR_ENABLED": False, + "TELNETCONSOLE_ENABLED": True, + } +) + +process.crawl(NoRequestsSpider) +process.start() diff --git a/tests/AsyncCrawlerProcess/simple.py b/tests/AsyncCrawlerProcess/simple.py index d24b4f193..368e05608 100644 --- a/tests/AsyncCrawlerProcess/simple.py +++ b/tests/AsyncCrawlerProcess/simple.py @@ -1,11 +1,13 @@ import scrapy from scrapy.crawler import AsyncCrawlerProcess +from scrapy.utils.reactorless import is_reactorless class NoRequestsSpider(scrapy.Spider): name = "no_request" async def start(self): + self.logger.info(f"is_reactorless(): {is_reactorless()}") return yield diff --git a/tests/AsyncCrawlerProcess/twisted_reactor_custom_settings_select.py b/tests/AsyncCrawlerProcess/twisted_reactor_custom_settings_select.py index 68239e651..b85f60f87 100644 --- a/tests/AsyncCrawlerProcess/twisted_reactor_custom_settings_select.py +++ b/tests/AsyncCrawlerProcess/twisted_reactor_custom_settings_select.py @@ -17,11 +17,11 @@ class AsyncioReactorSpider(scrapy.Spider): } -def log_task_exception(task: Task) -> None: +def log_task_exception(task: Task[None]) -> None: try: task.result() except Exception: - logging.exception("Crawl task failed") + logging.exception("Crawl task failed") # noqa: LOG015 process = AsyncCrawlerProcess() diff --git a/tests/AsyncCrawlerRunner/no_reactor.py b/tests/AsyncCrawlerRunner/no_reactor.py new file mode 100644 index 000000000..6a473e5e8 --- /dev/null +++ b/tests/AsyncCrawlerRunner/no_reactor.py @@ -0,0 +1,22 @@ +import asyncio + +from scrapy import Spider +from scrapy.crawler import AsyncCrawlerRunner +from scrapy.utils.log import configure_logging + + +class NoRequestsSpider(Spider): + name = "no_request" + + async def start(self): + return + yield + + +async def main() -> None: + configure_logging() + runner = AsyncCrawlerRunner() + await runner.crawl(NoRequestsSpider) + + +asyncio.run(main()) diff --git a/tests/AsyncCrawlerRunner/reactorless_custom_settings.py b/tests/AsyncCrawlerRunner/reactorless_custom_settings.py new file mode 100644 index 000000000..9b5efc3f9 --- /dev/null +++ b/tests/AsyncCrawlerRunner/reactorless_custom_settings.py @@ -0,0 +1,27 @@ +import asyncio + +from scrapy import Spider +from scrapy.crawler import AsyncCrawlerRunner +from scrapy.utils.log import configure_logging +from scrapy.utils.reactorless import is_reactorless + + +class NoRequestsSpider(Spider): + name = "no_request" + custom_settings = { + "TWISTED_REACTOR_ENABLED": False, + } + + async def start(self): + self.logger.info(f"is_reactorless(): {is_reactorless()}") + return + yield + + +async def main() -> None: + configure_logging() + runner = AsyncCrawlerRunner() + await runner.crawl(NoRequestsSpider) + + +asyncio.run(main()) diff --git a/tests/AsyncCrawlerRunner/reactorless_datauri.py b/tests/AsyncCrawlerRunner/reactorless_datauri.py new file mode 100644 index 000000000..d964f9c1c --- /dev/null +++ b/tests/AsyncCrawlerRunner/reactorless_datauri.py @@ -0,0 +1,24 @@ +import asyncio + +from scrapy import Request, Spider +from scrapy.crawler import AsyncCrawlerRunner +from scrapy.utils.log import configure_logging + + +class DataSpider(Spider): + name = "data" + + async def start(self): + yield Request("data:,foo") + + def parse(self, response): + return {"data": response.text} + + +async def main() -> None: + configure_logging() + runner = AsyncCrawlerRunner(settings={"TWISTED_REACTOR_ENABLED": False}) + await runner.crawl(DataSpider) + + +asyncio.run(main()) diff --git a/tests/AsyncCrawlerRunner/reactorless_reactor.py b/tests/AsyncCrawlerRunner/reactorless_reactor.py new file mode 100644 index 000000000..4889b2ddc --- /dev/null +++ b/tests/AsyncCrawlerRunner/reactorless_reactor.py @@ -0,0 +1,24 @@ +import asyncio + +from scrapy import Spider +from scrapy.crawler import AsyncCrawlerRunner +from scrapy.utils.log import configure_logging +from scrapy.utils.reactor import install_reactor + + +class NoRequestsSpider(Spider): + name = "no_request" + + async def start(self): + return + yield + + +async def main() -> None: + configure_logging() + runner = AsyncCrawlerRunner(settings={"TWISTED_REACTOR_ENABLED": False}) + await runner.crawl(NoRequestsSpider) + + +install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor") +asyncio.run(main()) diff --git a/tests/AsyncCrawlerRunner/reactorless_simple.py b/tests/AsyncCrawlerRunner/reactorless_simple.py new file mode 100644 index 000000000..e91c7c89b --- /dev/null +++ b/tests/AsyncCrawlerRunner/reactorless_simple.py @@ -0,0 +1,24 @@ +import asyncio + +from scrapy import Spider +from scrapy.crawler import AsyncCrawlerRunner +from scrapy.utils.log import configure_logging +from scrapy.utils.reactorless import is_reactorless + + +class NoRequestsSpider(Spider): + name = "no_request" + + async def start(self): + self.logger.info(f"is_reactorless(): {is_reactorless()}") + return + yield + + +async def main() -> None: + configure_logging() + runner = AsyncCrawlerRunner(settings={"TWISTED_REACTOR_ENABLED": False}) + await runner.crawl(NoRequestsSpider) + + +asyncio.run(main()) diff --git a/tests/AsyncCrawlerRunner/simple.py b/tests/AsyncCrawlerRunner/simple.py index 140777b4f..29b132d75 100644 --- a/tests/AsyncCrawlerRunner/simple.py +++ b/tests/AsyncCrawlerRunner/simple.py @@ -5,12 +5,14 @@ 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 scrapy.utils.reactorless import is_reactorless class NoRequestsSpider(Spider): name = "no_request" async def start(self): + self.logger.info(f"is_reactorless(): {is_reactorless()}") return yield diff --git a/tests/CrawlerProcess/asyncio_deferred_signal.py b/tests/CrawlerProcess/asyncio_deferred_signal.py index 028e3a08a..eb2e1105c 100644 --- a/tests/CrawlerProcess/asyncio_deferred_signal.py +++ b/tests/CrawlerProcess/asyncio_deferred_signal.py @@ -16,7 +16,7 @@ class UppercasePipeline: def open_spider(self, spider): return deferred_from_coro(self._open_spider(spider)) - def process_item(self, item, spider): + def process_item(self, item): return {"url": item["url"].upper()} diff --git a/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py b/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py index 578e0029d..a2e63a0d0 100644 --- a/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py +++ b/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py @@ -9,8 +9,9 @@ from scrapy.crawler import CrawlerProcess if sys.platform == "win32": asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) -asyncio.set_event_loop(Loop()) -asyncioreactor.install() +loop = Loop() +asyncio.set_event_loop(loop) +asyncioreactor.install(loop) class NoRequestsSpider(scrapy.Spider): diff --git a/tests/CrawlerProcess/caching_hostname_resolver.py b/tests/CrawlerProcess/caching_hostname_resolver.py index 53d427061..7f687e7d9 100644 --- a/tests/CrawlerProcess/caching_hostname_resolver.py +++ b/tests/CrawlerProcess/caching_hostname_resolver.py @@ -28,7 +28,7 @@ if __name__ == "__main__": process = CrawlerProcess( settings={ "RETRY_ENABLED": False, - "DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", + "TWISTED_DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", } ) process.crawl(CachingHostnameResolverSpider, url=sys.argv[1]) diff --git a/tests/CrawlerProcess/caching_hostname_resolver_ipv6.py b/tests/CrawlerProcess/caching_hostname_resolver_ipv6.py index d5d19e27e..da9c16cb8 100644 --- a/tests/CrawlerProcess/caching_hostname_resolver_ipv6.py +++ b/tests/CrawlerProcess/caching_hostname_resolver_ipv6.py @@ -4,7 +4,7 @@ from scrapy.crawler import CrawlerProcess class CachingHostnameResolverSpider(scrapy.Spider): """ - Finishes without a twisted.internet.error.DNSLookupError exception + Finishes without a scrapy.exceptions.CannotResolveHostError exception """ name = "caching_hostname_resolver_spider" @@ -15,7 +15,7 @@ if __name__ == "__main__": process = CrawlerProcess( settings={ "RETRY_ENABLED": False, - "DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", + "TWISTED_DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", } ) process.crawl(CachingHostnameResolverSpider) diff --git a/tests/CrawlerProcess/default_name_resolver.py b/tests/CrawlerProcess/default_name_resolver.py index cfc4b38b7..f4c129fdf 100644 --- a/tests/CrawlerProcess/default_name_resolver.py +++ b/tests/CrawlerProcess/default_name_resolver.py @@ -4,7 +4,7 @@ from scrapy.crawler import CrawlerProcess class IPv6Spider(scrapy.Spider): """ - Raises a twisted.internet.error.DNSLookupError: + Raises a scrapy.exceptions.CannotResolveHostError: the default name resolver does not handle IPv6 addresses. """ diff --git a/tests/CrawlerProcess/reactorless.py b/tests/CrawlerProcess/reactorless.py new file mode 100644 index 000000000..c9384010e --- /dev/null +++ b/tests/CrawlerProcess/reactorless.py @@ -0,0 +1,3 @@ +from scrapy.crawler import CrawlerProcess + +CrawlerProcess(settings={"TWISTED_REACTOR_ENABLED": False}) diff --git a/tests/CrawlerProcess/simple.py b/tests/CrawlerProcess/simple.py index 9e4ad70d9..d5a7ec53a 100644 --- a/tests/CrawlerProcess/simple.py +++ b/tests/CrawlerProcess/simple.py @@ -1,11 +1,13 @@ import scrapy from scrapy.crawler import CrawlerProcess +from scrapy.utils.reactorless import is_reactorless class NoRequestsSpider(scrapy.Spider): name = "no_request" async def start(self): + self.logger.info(f"is_reactorless(): {is_reactorless()}") return yield diff --git a/tests/CrawlerRunner/ip_address.py b/tests/CrawlerRunner/ip_address.py index 207fc86ad..fae206610 100644 --- a/tests/CrawlerRunner/ip_address.py +++ b/tests/CrawlerRunner/ip_address.py @@ -1,10 +1,15 @@ # ruff: noqa: E402 +from __future__ import annotations + +from typing import TYPE_CHECKING + from scrapy.utils.reactor import install_reactor +from tests.mockserver.dns import MockDNSServer +from tests.mockserver.http import MockServer install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor") -from urllib.parse import urlparse from twisted.names import cache, resolve from twisted.names import hosts as hostsModule @@ -15,14 +20,15 @@ from scrapy import Request, Spider from scrapy.crawler import CrawlerRunner from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.log import configure_logging -from tests.mockserver import MockDNSServer, MockServer + +if TYPE_CHECKING: + from twisted.names.common import ResolverBase # https://stackoverflow.com/a/32784190 -def createResolver(servers=None, resolvconf=None, hosts=None): - if hosts is None: - hosts = b"/etc/hosts" if platform.getType() == "posix" else r"c:\windows\hosts" - theResolver = Resolver(resolvconf, servers) +def createResolver(servers: list[tuple[str, int]]) -> ResolverBase: + hosts = b"/etc/hosts" if platform.getType() == "posix" else r"c:\windows\hosts" + theResolver = Resolver(None, servers) hostResolver = hostsModule.Resolver(hosts) chain = [hostResolver, cache.CacheResolver(), theResolver] return resolve.ResolverChain(chain) @@ -46,7 +52,7 @@ if __name__ == "__main__": from twisted.internet import reactor with MockServer() as mock_http_server, MockDNSServer() as mock_dns_server: - port = urlparse(mock_http_server.http_address).port + port = mock_http_server.http_port url = f"http://not.a.real.domain:{port}/echo" servers = [(mock_dns_server.host, mock_dns_server.port)] diff --git a/tests/CrawlerRunner/no_reactor.py b/tests/CrawlerRunner/no_reactor.py new file mode 100644 index 000000000..1405de00f --- /dev/null +++ b/tests/CrawlerRunner/no_reactor.py @@ -0,0 +1,19 @@ +from twisted.python import log + +from scrapy import Spider +from scrapy.crawler import CrawlerRunner +from scrapy.utils.log import configure_logging + + +class NoRequestsSpider(Spider): + name = "no_request" + + async def start(self): + return + yield + + +configure_logging() +runner = CrawlerRunner() +d = runner.crawl(NoRequestsSpider) +d.addErrback(log.err) diff --git a/tests/CrawlerRunner/reactorless.py b/tests/CrawlerRunner/reactorless.py new file mode 100644 index 000000000..bad2ae8d9 --- /dev/null +++ b/tests/CrawlerRunner/reactorless.py @@ -0,0 +1,3 @@ +from scrapy.crawler import CrawlerRunner + +CrawlerRunner(settings={"TWISTED_REACTOR_ENABLED": False}) diff --git a/tests/CrawlerRunner/simple.py b/tests/CrawlerRunner/simple.py index d154dcde4..47c0fe04f 100644 --- a/tests/CrawlerRunner/simple.py +++ b/tests/CrawlerRunner/simple.py @@ -4,12 +4,14 @@ from scrapy import Spider from scrapy.crawler import CrawlerRunner from scrapy.utils.log import configure_logging from scrapy.utils.reactor import install_reactor +from scrapy.utils.reactorless import is_reactorless class NoRequestsSpider(Spider): name = "no_request" async def start(self): + self.logger.info(f"is_reactorless(): {is_reactorless()}") return yield diff --git a/tests/__init__.py b/tests/__init__.py index ccfabb0da..cd52ade58 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -8,9 +8,6 @@ import os import socket from pathlib import Path -from twisted import version as TWISTED_VERSION -from twisted.python.versions import Version - # ignore system-wide proxies for tests # which would send requests to a totally unsuspecting server # (e.g. because urllib does not fully understand the proxy spec) @@ -33,6 +30,3 @@ except socket.gaierror: def get_testdata(*paths: str) -> bytes: """Return test data""" return Path(tests_datadir, *paths).read_bytes() - - -TWISTED_KEEPS_TRACEBACKS = TWISTED_VERSION >= Version("twisted", 24, 10, 0) diff --git a/tests/ftpserver.py b/tests/ftpserver.py deleted file mode 100644 index 0c6ca3621..000000000 --- a/tests/ftpserver.py +++ /dev/null @@ -1,24 +0,0 @@ -from argparse import ArgumentParser - -from pyftpdlib.authorizers import DummyAuthorizer -from pyftpdlib.handlers import FTPHandler -from pyftpdlib.servers import FTPServer - - -def main(): - parser = ArgumentParser() - parser.add_argument("-d", "--directory") - args = parser.parse_args() - - authorizer = DummyAuthorizer() - full_permissions = "elradfmwMT" - authorizer.add_anonymous(args.directory, perm=full_permissions) - handler = FTPHandler - handler.authorizer = authorizer - address = ("127.0.0.1", 2121) - server = FTPServer(address, handler) - server.serve_forever() - - -if __name__ == "__main__": - main() diff --git a/tests/ignores.txt b/tests/ignores.txt index 222288841..3717bbc95 100644 --- a/tests/ignores.txt +++ b/tests/ignores.txt @@ -1,3 +1,3 @@ -scrapy/downloadermiddlewares/cookies.py +scrapy/core/downloader/handlers/http.py scrapy/extensions/statsmailer.py -scrapy/extensions/memusage.py +scrapy/mail.py diff --git a/tests/keys/example-com.gen.README b/tests/keys/example-com.gen.README index 955e7b057..026226b2c 100644 --- a/tests/keys/example-com.gen.README +++ b/tests/keys/example-com.gen.README @@ -21,4 +21,3 @@ Locality Name (eg, city) [New York]:The Internet Organization Name (eg, company) [Example, LLC]:Scrapy Common Name (e.g. server FQDN or YOUR name) [Example Company]:www.example.com Email Address [test@example.com]: - diff --git a/tests/keys/localhost-ip.gen.README b/tests/keys/localhost-ip.gen.README index 8e94e1217..6424ad83e 100644 --- a/tests/keys/localhost-ip.gen.README +++ b/tests/keys/localhost-ip.gen.README @@ -18,4 +18,3 @@ Organization Name (eg, company) [Internet Widgits Pty Ltd]:Scrapy Organizational Unit Name (eg, section) []:. Common Name (e.g. server FQDN or YOUR name) []:127.0.0.1 Email Address []:. - diff --git a/tests/keys/localhost.gen.README b/tests/keys/localhost.gen.README index 19c29a725..65f3a2d5c 100644 --- a/tests/keys/localhost.gen.README +++ b/tests/keys/localhost.gen.README @@ -18,4 +18,3 @@ Organization Name (eg, company) [Internet Widgits Pty Ltd]:Scrapy Organizational Unit Name (eg, section) []:. Common Name (e.g. server FQDN or YOUR name) []:localhost Email Address []:. - diff --git a/tests/mocks/dummydbm.py b/tests/mocks/dummydbm.py index a7f7f1356..98fe58860 100644 --- a/tests/mocks/dummydbm.py +++ b/tests/mocks/dummydbm.py @@ -4,7 +4,7 @@ from collections import defaultdict from typing import Any -class DummyDB(dict): +class DummyDB(dict): # type: ignore[type-arg] """Provide dummy DBM-like interface.""" def close(self): @@ -17,7 +17,7 @@ error = KeyError _DATABASES: defaultdict[Any, DummyDB] = defaultdict(DummyDB) -def open(file, flag="r", mode=0o666): +def open(file, flag="r", mode=0o666): # noqa: A001 """Open or create a dummy database compatible. Arguments ``flag`` and ``mode`` are ignored. diff --git a/tests/mockserver.py b/tests/mockserver.py deleted file mode 100644 index 841a2cfe4..000000000 --- a/tests/mockserver.py +++ /dev/null @@ -1,436 +0,0 @@ -from __future__ import annotations - -import argparse -import json -import os -import random -import sys -from pathlib import Path -from shutil import rmtree -from subprocess import PIPE, Popen -from tempfile import mkdtemp -from typing import TYPE_CHECKING -from urllib.parse import urlencode - -from OpenSSL import SSL -from twisted.internet import defer, ssl -from twisted.internet.task import deferLater -from twisted.names import dns, error -from twisted.names.server import DNSServerFactory -from twisted.web import resource, server -from twisted.web.server import NOT_DONE_YET, Site -from twisted.web.static import Data, File -from twisted.web.util import Redirect, redirectTo - -from scrapy.utils.python import to_bytes, to_unicode -from tests import tests_datadir - -if TYPE_CHECKING: - from twisted.internet.protocol import ServerFactory - - -def getarg(request, name, default=None, type=None): - if name in request.args: - value = request.args[name][0] - if type is not None: - value = type(value) - return value - return default - - -def get_mockserver_env() -> dict[str, str]: - """Return a OS environment dict suitable to run mockserver processes.""" - - tests_path = Path(__file__).parent.parent - pythonpath = str(tests_path) + os.pathsep + os.environ.get("PYTHONPATH", "") - env = os.environ.copy() - env["PYTHONPATH"] = pythonpath - return env - - -# most of the following resources are copied from twisted.web.test.test_webclient -class ForeverTakingResource(resource.Resource): - """ - L{ForeverTakingResource} is a resource which never finishes responding - to requests. - """ - - def __init__(self, write=False): - resource.Resource.__init__(self) - self._write = write - - def render(self, request): - if self._write: - request.write(b"some bytes") - return server.NOT_DONE_YET - - -class ErrorResource(resource.Resource): - def render(self, request): - request.setResponseCode(401) - if request.args.get(b"showlength"): - request.setHeader(b"content-length", b"0") - return b"" - - -class NoLengthResource(resource.Resource): - def render(self, request): - return b"nolength" - - -class HostHeaderResource(resource.Resource): - """ - A testing resource which renders itself as the value of the host header - from the request. - """ - - def render(self, request): - return request.requestHeaders.getRawHeaders(b"host")[0] - - -class PayloadResource(resource.Resource): - """ - A testing resource which renders itself as the contents of the request body - as long as the request body is 100 bytes long, otherwise which renders - itself as C{"ERROR"}. - """ - - def render(self, request): - data = request.content.read() - contentLength = request.requestHeaders.getRawHeaders(b"content-length")[0] - if len(data) != 100 or int(contentLength) != 100: - return b"ERROR" - return data - - -class BrokenDownloadResource(resource.Resource): - def render(self, request): - # only sends 3 bytes even though it claims to send 5 - request.setHeader(b"content-length", b"5") - request.write(b"abc") - return b"" - - -class LeafResource(resource.Resource): - isLeaf = True - - def deferRequest(self, request, delay, f, *a, **kw): - from twisted.internet import reactor - - def _cancelrequest(_): - # silence CancelledError - d.addErrback(lambda _: None) - d.cancel() - - d = deferLater(reactor, delay, f, *a, **kw) - request.notifyFinish().addErrback(_cancelrequest) - return d - - -class Follow(LeafResource): - def render(self, request): - total = getarg(request, b"total", 100, type=int) - show = getarg(request, b"show", 1, type=int) - order = getarg(request, b"order", b"desc") - maxlatency = getarg(request, b"maxlatency", 0, type=float) - n = getarg(request, b"n", total, type=int) - if order == b"rand": - nlist = [random.randint(1, total) for _ in range(show)] - else: # order == "desc" - nlist = range(n, max(n - show, 0), -1) - - lag = random.random() * maxlatency - self.deferRequest(request, lag, self.renderRequest, request, nlist) - return NOT_DONE_YET - - def renderRequest(self, request, nlist): - s = """ """ - args = request.args.copy() - for nl in nlist: - args[b"n"] = [to_bytes(str(nl))] - argstr = urlencode(args, doseq=True) - s += f"follow {nl}
" - s += """""" - request.write(to_bytes(s)) - request.finish() - - -class Delay(LeafResource): - def render_GET(self, request): - n = getarg(request, b"n", 1, type=float) - b = getarg(request, b"b", 1, type=int) - if b: - # send headers now and delay body - request.write("") - self.deferRequest(request, n, self._delayedRender, request, n) - return NOT_DONE_YET - - def _delayedRender(self, request, n): - request.write(to_bytes(f"Response delayed for {n:.3f} seconds\n")) - request.finish() - - -class Status(LeafResource): - def render_GET(self, request): - n = getarg(request, b"n", 200, type=int) - request.setResponseCode(n) - return b"" - - -class Raw(LeafResource): - def render_GET(self, request): - request.startedWriting = 1 - self.deferRequest(request, 0, self._delayedRender, request) - return NOT_DONE_YET - - render_POST = render_GET - - def _delayedRender(self, request): - raw = getarg(request, b"raw", b"HTTP 1.1 200 OK\n") - request.startedWriting = 1 - request.write(raw) - request.channel.transport.loseConnection() - request.finish() - - -class Echo(LeafResource): - def render_GET(self, request): - output = { - "headers": { - to_unicode(k): [to_unicode(v) for v in vs] - for k, vs in request.requestHeaders.getAllRawHeaders() - }, - "body": to_unicode(request.content.read()), - } - return to_bytes(json.dumps(output)) - - render_POST = render_GET - - -class RedirectTo(LeafResource): - def render(self, request): - goto = getarg(request, b"goto", b"/") - # we force the body content, otherwise Twisted redirectTo() - # returns HTML with bytes: - content = Redirect.render(self, request) - return content.replace( - b'http-equiv="refresh"', b'http-no-equiv="do-not-refresh-me"' - ) - - -class Root(resource.Resource): - def __init__(self): - resource.Resource.__init__(self) - self.putChild(b"status", Status()) - self.putChild(b"follow", Follow()) - self.putChild(b"delay", Delay()) - self.putChild(b"partial", Partial()) - self.putChild(b"drop", Drop()) - self.putChild(b"raw", Raw()) - self.putChild(b"echo", Echo()) - self.putChild(b"payload", PayloadResource()) - self.putChild(b"alpayload", ArbitraryLengthPayloadResource()) - self.putChild(b"files", File(str(Path(tests_datadir, "test_site/files/")))) - self.putChild(b"redirect-to", RedirectTo()) - self.putChild(b"text", Data(b"Works", "text/plain")) - self.putChild( - b"html", - Data( - b"

Works

World

", - "text/html", - ), - ) - self.putChild( - b"enc-gb18030", - Data(b"

gb18030 encoding

", "text/html; charset=gb18030"), - ) - self.putChild(b"redirect", Redirect(b"/redirected")) - self.putChild( - b"redirect-no-meta-refresh", NoMetaRefreshRedirect(b"/redirected") - ) - self.putChild(b"redirected", Data(b"Redirected here", "text/plain")) - - def getChild(self, name, request): - return self - - def render(self, request): - return b"Scrapy mock HTTP server\n" - - -class MockServer: - def __enter__(self): - self.proc = Popen( - [sys.executable, "-u", "-m", "tests.mockserver", "-t", "http"], - stdout=PIPE, - env=get_mockserver_env(), - ) - http_address = self.proc.stdout.readline().strip().decode("ascii") - https_address = self.proc.stdout.readline().strip().decode("ascii") - - self.http_address = http_address - self.https_address = https_address - - return self - - def __exit__(self, exc_type, exc_value, traceback): - self.proc.kill() - self.proc.communicate() - - def url(self, path, is_secure=False): - host = self.https_address if is_secure else self.http_address - host = host.replace("0.0.0.0", "127.0.0.1") - return host + path - - -class MockDNSResolver: - """ - Implements twisted.internet.interfaces.IResolver partially - """ - - def _resolve(self, name): - record = dns.Record_A(address=b"127.0.0.1") - answer = dns.RRHeader(name=name, payload=record) - return [answer], [], [] - - def query(self, query, timeout=None): - if query.type == dns.A: - return defer.succeed(self._resolve(query.name.name)) - return defer.fail(error.DomainError()) - - def lookupAllRecords(self, name, timeout=None): - return defer.succeed(self._resolve(name)) - - -class MockDNSServer: - def __enter__(self): - self.proc = Popen( - [sys.executable, "-u", "-m", "tests.mockserver", "-t", "dns"], - stdout=PIPE, - env=get_mockserver_env(), - ) - self.host = "127.0.0.1" - self.port = int( - self.proc.stdout.readline().strip().decode("ascii").split(":")[1] - ) - return self - - def __exit__(self, exc_type, exc_value, traceback): - self.proc.kill() - self.proc.communicate() - - -class MockFTPServer: - """Creates an FTP server on port 2121 with a default passwordless user - (anonymous) and a temporary root path that you can read from the - :attr:`path` attribute.""" - - def __enter__(self): - self.path = Path(mkdtemp()) - self.proc = Popen( - [sys.executable, "-u", "-m", "tests.ftpserver", "-d", str(self.path)], - stderr=PIPE, - env=get_mockserver_env(), - ) - for line in self.proc.stderr: - if b"starting FTP server" in line: - break - return self - - def __exit__(self, exc_type, exc_value, traceback): - rmtree(str(self.path)) - self.proc.kill() - self.proc.communicate() - - def url(self, path): - return "ftp://127.0.0.1:2121/" + path - - -def ssl_context_factory( - keyfile="keys/localhost.key", certfile="keys/localhost.crt", cipher_string=None -): - factory = ssl.DefaultOpenSSLContextFactory( - str(Path(__file__).parent / keyfile), - str(Path(__file__).parent / certfile), - ) - if cipher_string: - ctx = factory.getContext() - # disabling TLS1.3 because it unconditionally enables some strong ciphers - ctx.set_options(SSL.OP_CIPHER_SERVER_PREFERENCE | SSL.OP_NO_TLSv1_3) - ctx.set_cipher_list(to_bytes(cipher_string)) - return factory - - -if __name__ == "__main__": - from twisted.internet import reactor - - parser = argparse.ArgumentParser() - parser.add_argument( - "-t", "--type", type=str, choices=("http", "dns"), default="http" - ) - args = parser.parse_args() - - factory: ServerFactory - - if args.type == "http": - root = Root() - factory = Site(root) - httpPort = reactor.listenTCP(0, factory) - contextFactory = ssl_context_factory() - httpsPort = reactor.listenSSL(0, factory, contextFactory) - - def print_listening(): - httpHost = httpPort.getHost() - httpsHost = httpsPort.getHost() - httpAddress = f"http://{httpHost.host}:{httpHost.port}" - httpsAddress = f"https://{httpsHost.host}:{httpsHost.port}" - print(httpAddress) - print(httpsAddress) - - elif args.type == "dns": - clients = [MockDNSResolver()] - factory = DNSServerFactory(clients=clients) - protocol = dns.DNSDatagramProtocol(controller=factory) - listener = reactor.listenUDP(0, protocol) - - def print_listening(): - host = listener.getHost() - print(f"{host.host}:{host.port}") - - reactor.callWhenRunning(print_listening) - reactor.run() diff --git a/tests/mockserver/__init__.py b/tests/mockserver/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/mockserver/dns.py b/tests/mockserver/dns.py new file mode 100644 index 000000000..e19a2e61a --- /dev/null +++ b/tests/mockserver/dns.py @@ -0,0 +1,66 @@ +from __future__ import annotations + +import sys +from subprocess import PIPE, Popen + +from twisted.internet import defer +from twisted.names import dns, error +from twisted.names.server import DNSServerFactory + +from tests.utils import get_script_run_env + + +class MockDNSResolver: + """ + Implements twisted.internet.interfaces.IResolver partially + """ + + def _resolve(self, name): + record = dns.Record_A(address=b"127.0.0.1") + answer = dns.RRHeader(name=name, payload=record) + return [answer], [], [] + + def query(self, query, timeout=None): + if query.type == dns.A: + return defer.succeed(self._resolve(query.name.name)) + return defer.fail(error.DomainError()) + + def lookupAllRecords(self, name, timeout=None): + return defer.succeed(self._resolve(name)) + + +class MockDNSServer: + def __enter__(self): + self.proc = Popen( + [sys.executable, "-u", "-m", "tests.mockserver.dns"], + stdout=PIPE, + env=get_script_run_env(), + text=True, + ) + self.host = "127.0.0.1" + self.port = int(self.proc.stdout.readline().strip().split(":")[1]) + return self + + def __exit__(self, exc_type, exc_value, traceback): + self.proc.kill() + self.proc.communicate() + + +def main() -> None: + from twisted.internet import reactor + + clients = [MockDNSResolver()] + factory = DNSServerFactory(clients=clients) + protocol = dns.DNSDatagramProtocol(controller=factory) + listener = reactor.listenUDP(0, protocol) + + def print_listening(): + host = listener.getHost() + print(f"{host.host}:{host.port}") + + reactor.callWhenRunning(print_listening) + reactor.run() + + +if __name__ == "__main__": + main() diff --git a/tests/mockserver/ftp.py b/tests/mockserver/ftp.py new file mode 100644 index 000000000..22efc966b --- /dev/null +++ b/tests/mockserver/ftp.py @@ -0,0 +1,76 @@ +from __future__ import annotations + +import re +import sys +from argparse import ArgumentParser +from pathlib import Path +from shutil import rmtree +from subprocess import PIPE, Popen +from tempfile import mkdtemp + +from pyftpdlib.authorizers import DummyAuthorizer +from pyftpdlib.handlers import FTPHandler +from pyftpdlib.servers import FTPServer + +from tests.utils import get_script_run_env + + +class MockFTPServer: + """Creates an FTP server on a random port with a default passwordless user + (anonymous) and a temporary root path that you can read from the + :attr:`path` attribute.""" + + def __init__(self) -> None: + self.proc: Popen[str] | None = None + self.host: str = "127.0.0.1" + self.port: int | None = None + self.path: Path | None = None + + def __enter__(self): + self.path = Path(mkdtemp()) + self.proc = Popen( + [sys.executable, "-u", "-m", "tests.mockserver.ftp", "-d", str(self.path)], + stderr=PIPE, + env=get_script_run_env(), + text=True, + ) + for line in self.proc.stderr: + if "starting FTP server" in line and ( + m := re.search(r"starting FTP server on ([^ :]+):(\d+),", line) + ): + self.port = int(m.group(2)) + break + else: + self.proc.kill() + self.proc.communicate() + raise RuntimeError( + "The FTP server failed to start or the output is unrecognized" + ) + return self + + def __exit__(self, exc_type, exc_value, traceback): + rmtree(str(self.path)) + self.proc.kill() + self.proc.communicate() + + def url(self, path): + return f"ftp://{self.host}:{self.port}/{path}" + + +def main() -> None: + parser = ArgumentParser() + parser.add_argument("-d", "--directory", required=True) + args = parser.parse_args() + + authorizer = DummyAuthorizer() + full_permissions = "elradfmwMT" + authorizer.add_anonymous(args.directory, perm=full_permissions) + handler = FTPHandler + handler.authorizer = authorizer + address = ("127.0.0.1", 0) + server = FTPServer(address, handler) + server.serve_forever() + + +if __name__ == "__main__": + main() diff --git a/tests/mockserver/http.py b/tests/mockserver/http.py new file mode 100644 index 000000000..7ad873c02 --- /dev/null +++ b/tests/mockserver/http.py @@ -0,0 +1,105 @@ +from __future__ import annotations + +from pathlib import Path + +from twisted.web import resource +from twisted.web.static import Data, File +from twisted.web.util import Redirect + +from tests import tests_datadir + +from .http_base import BaseMockServer, main_factory +from .http_resources import ( + ArbitraryLengthPayloadResource, + BrokenChunkedResource, + BrokenDownloadResource, + ChunkedResource, + ClientIPResource, + Compress, + ContentLengthHeaderResource, + Delay, + Drop, + DuplicateHeaderResource, + Echo, + EmptyContentTypeHeaderResource, + Follow, + ForeverTakingResource, + HostHeaderResource, + LargeChunkedFileResource, + NoMetaRefreshRedirect, + Partial, + PayloadResource, + Raw, + RedirectTo, + ResponseHeadersResource, + SetCookie, + Status, + UriResource, +) + + +class Root(resource.Resource): + def __init__(self): + super().__init__() + self.putChild(b"status", Status()) + self.putChild(b"follow", Follow()) + self.putChild(b"delay", Delay()) + self.putChild(b"partial", Partial()) + self.putChild(b"drop", Drop()) + self.putChild(b"raw", Raw()) + self.putChild(b"echo", Echo()) + self.putChild(b"payload", PayloadResource()) + self.putChild(b"alpayload", ArbitraryLengthPayloadResource()) + self.putChild(b"static", File(str(Path(tests_datadir, "test_site/")))) + self.putChild(b"redirect-to", RedirectTo()) + self.putChild(b"text", Data(b"Works", "text/plain")) + self.putChild( + b"html", + Data( + b"

Works

World

", + "text/html", + ), + ) + self.putChild( + b"enc-gb18030", + Data(b"

gb18030 encoding

", "text/html; charset=gb18030"), + ) + self.putChild(b"redirect", Redirect(b"/redirected")) + self.putChild( + b"redirect-no-meta-refresh", NoMetaRefreshRedirect(b"/redirected") + ) + self.putChild(b"redirected", Data(b"Redirected here", "text/plain")) + numbers = [str(x).encode("utf8") for x in range(2**18)] + self.putChild(b"numbers", Data(b"".join(numbers), "text/plain")) + self.putChild(b"wait", ForeverTakingResource()) + self.putChild(b"hang-after-headers", ForeverTakingResource(write=True)) + self.putChild(b"host", HostHeaderResource()) + self.putChild(b"client-ip", ClientIPResource()) + self.putChild(b"broken", BrokenDownloadResource()) + self.putChild(b"chunked", ChunkedResource()) + self.putChild(b"broken-chunked", BrokenChunkedResource()) + self.putChild(b"contentlength", ContentLengthHeaderResource()) + self.putChild(b"nocontenttype", EmptyContentTypeHeaderResource()) + self.putChild(b"largechunkedfile", LargeChunkedFileResource()) + self.putChild(b"compress", Compress()) + self.putChild(b"duplicate-header", DuplicateHeaderResource()) + self.putChild(b"response-headers", ResponseHeadersResource()) + self.putChild(b"set-cookie", SetCookie()) + self.putChild(b"uri", UriResource()) + + def getChild(self, path, request): + return self + + def render(self, request): + return b"Scrapy mock HTTP server\n" + + +class MockServer(BaseMockServer): + module_name = "tests.mockserver.http" + + +main = main_factory(Root) + + +if __name__ == "__main__": + main() diff --git a/tests/mockserver/http_base.py b/tests/mockserver/http_base.py new file mode 100644 index 000000000..7b38409ff --- /dev/null +++ b/tests/mockserver/http_base.py @@ -0,0 +1,147 @@ +"""Base classes and functions for HTTP mockservers.""" + +from __future__ import annotations + +import argparse +import sys +from abc import ABC, abstractmethod +from subprocess import PIPE, Popen +from typing import TYPE_CHECKING +from urllib.parse import urlparse + +from twisted.web.server import Site + +from tests.utils import get_script_run_env + +from .utils import ssl_context_factory + +if TYPE_CHECKING: + from collections.abc import Callable + + from twisted.web import resource + + +class BaseMockServer(ABC): + listen_http: bool = True + listen_https: bool = True + + @property + @abstractmethod + def module_name(self) -> str: + raise NotImplementedError + + def __init__(self) -> None: + if not self.listen_http and not self.listen_https: + raise ValueError("At least one of listen_http and listen_https must be set") + + self.proc: Popen[str] | None = None + self.host: str = "127.0.0.1" + self.http_port: int | None = None + self.https_port: int | None = None + + def __enter__(self): + self.proc = Popen( + [sys.executable, "-u", "-m", self.module_name, *self.get_additional_args()], + stdout=PIPE, + env=get_script_run_env(), + text=True, + ) + if self.listen_http: + http_address = self.proc.stdout.readline().strip() + http_parsed = urlparse(http_address) + self.http_port = http_parsed.port + if self.listen_https: + https_address = self.proc.stdout.readline().strip() + https_parsed = urlparse(https_address) + self.https_port = https_parsed.port + return self + + def __exit__(self, exc_type, exc_value, traceback): + if self.proc: + self.proc.kill() + self.proc.communicate() + + def get_additional_args(self) -> list[str]: + return [] + + def port(self, is_secure: bool = False) -> int: + if not is_secure and not self.listen_http: + raise ValueError("This server doesn't provide HTTP") + if is_secure and not self.listen_https: + raise ValueError("This server doesn't provide HTTPS") + port = self.https_port if is_secure else self.http_port + assert port is not None + return port + + def url(self, path: str, is_secure: bool = False) -> str: + port = self.port(is_secure) + scheme = "https" if is_secure else "http" + return f"{scheme}://{self.host}:{port}{path}" + + +def main_factory( + resource_class: type[resource.Resource], + *, + listen_http: bool = True, + listen_https: bool = True, +) -> Callable[[], None]: + if not listen_http and not listen_https: + raise ValueError("At least one of listen_http and listen_https must be set") + + def main() -> None: + from twisted.internet import reactor + + root = resource_class() + factory = Site(root) + + if listen_http: + http_port = reactor.listenTCP(0, factory) + + if listen_https: + parser = argparse.ArgumentParser() + parser.add_argument("--keyfile", help="SSL key file") + parser.add_argument("--certfile", help="SSL certificate file") + parser.add_argument( + "--cipher-string", + default=None, + help="SSL cipher string (optional)", + ) + parser.add_argument( + "--tls-min-version", + default=None, + help="Minimum accepted TLS version (optional)", + ) + parser.add_argument( + "--tls-max-version", + default=None, + help="Maximum accepted TLS version (optional)", + ) + args = parser.parse_args() + context_factory_kw = {} + if args.keyfile: + context_factory_kw["keyfile"] = args.keyfile + if args.certfile: + context_factory_kw["certfile"] = args.certfile + if args.cipher_string: + context_factory_kw["cipher_string"] = args.cipher_string + if args.tls_min_version: + context_factory_kw["tls_min_version"] = args.tls_min_version + if args.tls_max_version: + context_factory_kw["tls_max_version"] = args.tls_max_version + context_factory = ssl_context_factory(**context_factory_kw) + https_port = reactor.listenSSL(0, factory, context_factory) + + def print_listening(): + if listen_http: + http_host = http_port.getHost() + http_address = f"http://{http_host.host}:{http_host.port}" + print(http_address) + if listen_https: + https_host = https_port.getHost() + https_address = f"https://{https_host.host}:{https_host.port}" + print(https_address) + + reactor.callWhenRunning(print_listening) + reactor.run() + + return main diff --git a/tests/mockserver/http_resources.py b/tests/mockserver/http_resources.py new file mode 100644 index 000000000..98ac6cf6a --- /dev/null +++ b/tests/mockserver/http_resources.py @@ -0,0 +1,381 @@ +from __future__ import annotations + +import gzip +import json +import random +from typing import TYPE_CHECKING, ParamSpec, TypeVar +from urllib.parse import urlencode + +from twisted.internet.task import deferLater +from twisted.web import resource, server +from twisted.web.server import NOT_DONE_YET +from twisted.web.util import Redirect, redirectTo + +from scrapy.utils.python import to_bytes, to_unicode + +if TYPE_CHECKING: + from collections.abc import Callable + + from twisted.internet.defer import Deferred + from twisted.web.http import Request + + +_T = TypeVar("_T") +_P = ParamSpec("_P") + + +def getarg(request, name, default=None, type_=None): + if name in request.args: + value = request.args[name][0] + if type_ is not None: + value = type_(value) + return value + return default + + +def close_connection(request): + # We have to force a disconnection for HTTP/1.1 clients. Otherwise + # client keeps the connection open waiting for more data. + request.channel.loseConnection() + request.finish() + + +# most of the following resources are copied from twisted.web.test.test_webclient +class ForeverTakingResource(resource.Resource): + """ + L{ForeverTakingResource} is a resource which never finishes responding + to requests. + """ + + def __init__(self, write=False): + resource.Resource.__init__(self) + self._write = write + + def render(self, request): + if self._write: + request.write(b"some bytes") + return server.NOT_DONE_YET + + +class HostHeaderResource(resource.Resource): + """ + A testing resource which renders itself as the value of the host header + from the request. + """ + + def render(self, request): + return request.requestHeaders.getRawHeaders(b"host")[0] + + +class ClientIPResource(resource.Resource): + """ + A testing resource which renders itself as the request client IP address. + """ + + def render(self, request): + client_address = request.getClientAddress() + if client_address is None or client_address.host is None: + return b"" + return to_bytes(client_address.host) + + +class PayloadResource(resource.Resource): + """ + A testing resource which renders itself as the contents of the request body + as long as the request body is 100 bytes long, otherwise which renders + itself as C{"ERROR"}. + """ + + def render(self, request): + data = request.content.read() + contentLength = request.requestHeaders.getRawHeaders(b"content-length")[0] + if len(data) != 100 or int(contentLength) != 100: + return b"ERROR" + return data + + +class LeafResource(resource.Resource): + isLeaf = True + + def deferRequest( + self, + request: Request, + delay: float, + f: Callable[_P, _T], + *a: _P.args, + **kw: _P.kwargs, + ) -> Deferred[_T]: + from twisted.internet import reactor + + def _cancelrequest(_): + # silence CancelledError + d.addErrback(lambda _: None) + d.cancel() + + d = deferLater(reactor, delay, f, *a, **kw) + request.notifyFinish().addErrback(_cancelrequest) + return d + + +class Follow(LeafResource): + def render(self, request): + total = getarg(request, b"total", 100, type_=int) + show = getarg(request, b"show", 1, type_=int) + order = getarg(request, b"order", b"desc") + maxlatency = getarg(request, b"maxlatency", 0, type_=float) + n = getarg(request, b"n", total, type_=int) + if order == b"rand": + nlist = [random.randint(1, total) for _ in range(show)] + else: # order == "desc" + nlist = range(n, max(n - show, 0), -1) + + lag = random.random() * maxlatency + self.deferRequest(request, lag, self.renderRequest, request, nlist) + return NOT_DONE_YET + + def renderRequest(self, request, nlist): + s = """ """ + args = request.args.copy() + for nl in nlist: + args[b"n"] = [to_bytes(str(nl))] + argstr = urlencode(args, doseq=True) + s += f"follow {nl}
" + s += """""" + request.write(to_bytes(s)) + request.finish() + + +class Delay(LeafResource): + def render_GET(self, request): + n = getarg(request, b"n", 1, type_=float) + b = getarg(request, b"b", 1, type_=int) + if b: + # send headers now and delay body + request.write("") + self.deferRequest(request, n, self._delayedRender, request, n) + return NOT_DONE_YET + + def _delayedRender(self, request, n): + request.write(to_bytes(f"Response delayed for {n:.3f} seconds\n")) + request.finish() + + +class Status(LeafResource): + def render_GET(self, request): + n = getarg(request, b"n", 200, type_=int) + request.setResponseCode(n) + return b"" + + +class Raw(LeafResource): + def render_GET(self, request): + request.startedWriting = 1 + self.deferRequest(request, 0, self._delayedRender, request) + return NOT_DONE_YET + + render_POST = render_GET + + def _delayedRender(self, request): + raw = getarg(request, b"raw", b"HTTP 1.1 200 OK\n") + request.startedWriting = 1 + request.write(raw) + request.channel.transport.loseConnection() + request.finish() + + +class Echo(LeafResource): + def render_GET(self, request): + output = { + "headers": { + to_unicode(k): [to_unicode(v) for v in vs] + for k, vs in request.requestHeaders.getAllRawHeaders() + }, + "body": to_unicode(request.content.read()), + } + return to_bytes(json.dumps(output)) + + render_POST = render_GET + + +class RedirectTo(LeafResource): + def render(self, request): + goto = getarg(request, b"goto", b"/") + # we force the body content, otherwise Twisted redirectTo() + # returns HTML with bytes: + content: bytes = Redirect.render(self, request) + return content.replace( + b'http-equiv="refresh"', b'http-no-equiv="do-not-refresh-me"' + ) + + +class ContentLengthHeaderResource(resource.Resource): + """ + A testing resource which renders itself as the value of the Content-Length + header from the request. + """ + + def render(self, request): + return request.requestHeaders.getRawHeaders(b"content-length")[0] + + +class ChunkedResource(resource.Resource): + def render(self, request): + from twisted.internet import reactor + + def response(): + request.write(b"chunked ") + request.write(b"content\n") + request.finish() + + reactor.callLater(0, response) + return server.NOT_DONE_YET + + +class BrokenChunkedResource(resource.Resource): + def render(self, request): + from twisted.internet import reactor + + def response(): + request.write(b"chunked ") + request.write(b"content\n") + # Disable terminating chunk on finish. + request.chunked = False + close_connection(request) + + reactor.callLater(0, response) + return server.NOT_DONE_YET + + +class BrokenDownloadResource(resource.Resource): + def render(self, request): + from twisted.internet import reactor + + def response(): + request.setHeader(b"Content-Length", b"20") + request.write(b"partial") + close_connection(request) + + reactor.callLater(0, response) + return server.NOT_DONE_YET + + +class EmptyContentTypeHeaderResource(resource.Resource): + """ + A testing resource which renders itself as the value of request body + without content-type header in response. + """ + + def render(self, request): + request.setHeader("content-type", "") + return request.content.read() + + +class LargeChunkedFileResource(resource.Resource): + def render(self, request): + from twisted.internet import reactor + + def response(): + for _ in range(1024): + request.write(b"x" * 1024) + request.finish() + + reactor.callLater(0, response) + return server.NOT_DONE_YET + + +class DuplicateHeaderResource(resource.Resource): + def render(self, request): + request.responseHeaders.setRawHeaders(b"Set-Cookie", [b"a=b", b"c=d"]) + return b"" + + +class UriResource(resource.Resource): + """Return the full uri that was requested""" + + def getChild(self, path, request): + return self + + def render(self, request): + # Note: this is an ugly hack for CONNECT request timeout test. + # Returning some data here fail SSL/TLS handshake + # ToDo: implement proper HTTPS proxy tests, not faking them. + if request.method != b"CONNECT": + return request.uri + request.transport.write(b"HTTP/1.1 200 Connection established\r\n\r\n") + return NOT_DONE_YET + + +class ResponseHeadersResource(resource.Resource): + """Return a response with headers set from the JSON request body""" + + def render(self, request): + body = json.loads(request.content.read().decode()) + for header_name, header_value in body.items(): + request.responseHeaders.setRawHeaders(header_name, [header_value]) + return json.dumps(body).encode("utf-8") + + +class Compress(resource.Resource): + """Compress the data sent in the request url params and set Content-Encoding header""" + + def render(self, request): + data = request.args.get(b"data")[0] + + accept_encoding_header = request.getHeader(b"accept-encoding") + + # include common encoding schemes here + if accept_encoding_header == b"gzip": + request.setHeader(b"Content-Encoding", b"gzip") + return gzip.compress(data) + + # just set this to trigger a test failure if no valid accept-encoding header was set + request.setResponseCode(500) + return b"Did not receive a valid accept-encoding header" + + +class SetCookie(resource.Resource): + """Return a response with a Set-Cookie header for each request url parameter""" + + def render(self, request): + for cookie_name, cookie_values in request.args.items(): + for cookie_value in cookie_values: + cookie = (cookie_name.decode() + "=" + cookie_value.decode()).encode() + request.setHeader(b"Set-Cookie", cookie) + return b"" diff --git a/tests/mockserver/mitm_proxy.py b/tests/mockserver/mitm_proxy.py new file mode 100644 index 000000000..56620f84e --- /dev/null +++ b/tests/mockserver/mitm_proxy.py @@ -0,0 +1,70 @@ +from __future__ import annotations + +import re +import sys +from pathlib import Path +from subprocess import PIPE, Popen +from urllib.parse import urlsplit, urlunsplit + + +class MitmProxy: + auth_user = "scrapy" + auth_pass = "scrapy" + + def __init__(self, mode: str | None = None) -> None: + self.mode = mode + + def start(self) -> str: + script = """ +import sys +from mitmproxy.tools.main import mitmdump +sys.argv[0] = "mitmdump" +sys.exit(mitmdump()) + """ + cert_path = Path(__file__).parent.parent.resolve() / "keys" + args = [ + "--listen-host", + "127.0.0.1", + "--listen-port", + "0", + "--proxyauth", + f"{self.auth_user}:{self.auth_pass}", + "--set", + f"confdir={cert_path}", + "--ssl-insecure", + "-s", + str(Path(__file__).with_name("mitm_proxy_addon.py")), + ] + if self.mode: + args += ["--mode", self.mode] + self.proc: Popen[str] = Popen( + [ + sys.executable, + "-u", + "-c", + script, + *args, + ], + stdout=PIPE, + text=True, + ) + assert self.proc.stdout is not None + scheme = "socks5" if self.mode == "socks5" else "http" + line = "" + for line in self.proc.stdout: + m = re.search(r"listening at (?:\w+://)?([^:]+:\d+)", line) + if m: + host_port = m.group(1) + return f"{scheme}://{self.auth_user}:{self.auth_pass}@{host_port}" + self.stop() + raise RuntimeError(f"Failed to parse mitmdump output: {line}") + + def stop(self) -> None: + self.proc.kill() + self.proc.communicate() + + +def wrong_credentials(proxy_url: str) -> str: + bad_auth_proxy = list(urlsplit(proxy_url)) + bad_auth_proxy[1] = bad_auth_proxy[1].replace("scrapy:scrapy@", "wrong:wronger@") + return urlunsplit(bad_auth_proxy) diff --git a/tests/mockserver/mitm_proxy_addon.py b/tests/mockserver/mitm_proxy_addon.py new file mode 100644 index 000000000..04ba2e4a1 --- /dev/null +++ b/tests/mockserver/mitm_proxy_addon.py @@ -0,0 +1,5 @@ +def response(flow) -> None: + # add custom headers to be able to check that the request went through the proxy + flow.response.headers["X-Via-Mitmproxy"] = "1" + if flow.client_conn.tls_established: + flow.response.headers["X-Via-Mitmproxy-TLS"] = "1" diff --git a/tests/mockserver/proxy_echo.py b/tests/mockserver/proxy_echo.py new file mode 100644 index 000000000..6345726b6 --- /dev/null +++ b/tests/mockserver/proxy_echo.py @@ -0,0 +1,17 @@ +# This is only used by tests.test_downloader_handlers_http_base.TestHttpProxyBase + +from __future__ import annotations + +from .http_base import BaseMockServer, main_factory +from .http_resources import UriResource + + +class ProxyEchoMockServer(BaseMockServer): + module_name = "tests.mockserver.proxy_echo" + + +main = main_factory(UriResource) + + +if __name__ == "__main__": + main() diff --git a/tests/mockserver/simple_https.py b/tests/mockserver/simple_https.py new file mode 100644 index 000000000..fdea666e1 --- /dev/null +++ b/tests/mockserver/simple_https.py @@ -0,0 +1,60 @@ +# This is only used by tests.test_downloader_handlers_http_base.TestSimpleHttpsBase + +from __future__ import annotations + +from twisted.web import resource +from twisted.web.static import Data + +from .http_base import BaseMockServer, main_factory + + +class Root(resource.Resource): + def __init__(self): + resource.Resource.__init__(self) + self.putChild(b"file", Data(b"0123456789", "text/plain")) + + def getChild(self, path, request): + return self + + +class SimpleMockServer(BaseMockServer): + listen_http = False + module_name = "tests.mockserver.simple_https" + + def __init__( + self, + keyfile: str, + certfile: str, + *, + cipher_string: str | None = None, + tls_min_version: str | None = None, + tls_max_version: str | None = None, + ): + super().__init__() + self.keyfile = keyfile + self.certfile = certfile + self.cipher_string = cipher_string + self.tls_min_version = tls_min_version + self.tls_max_version = tls_max_version + + def get_additional_args(self) -> list[str]: + args = [ + "--keyfile", + self.keyfile, + "--certfile", + self.certfile, + ] + if self.cipher_string is not None: + args.extend(["--cipher-string", self.cipher_string]) + if self.tls_min_version is not None: + args.extend(["--tls-min-version", self.tls_min_version]) + if self.tls_max_version is not None: + args.extend(["--tls-max-version", self.tls_max_version]) + return args + + +main = main_factory(Root, listen_http=False) + + +if __name__ == "__main__": + main() diff --git a/tests/mockserver/utils.py b/tests/mockserver/utils.py new file mode 100644 index 000000000..5c4ca7457 --- /dev/null +++ b/tests/mockserver/utils.py @@ -0,0 +1,53 @@ +from __future__ import annotations + +from pathlib import Path +from typing import TYPE_CHECKING, cast + +from cryptography.hazmat.primitives.serialization import load_pem_private_key +from cryptography.x509 import load_pem_x509_certificate +from OpenSSL import SSL +from OpenSSL.crypto import FILETYPE_PEM, load_certificate, load_privatekey +from twisted.internet.ssl import CertificateOptions, ContextFactory + +from scrapy.core.downloader.tls import _TWISTED_VERSION_MAP +from scrapy.utils._deps_compat import PYOPENSSL_X509_DEPRECATED +from scrapy.utils.python import to_bytes +from scrapy.utils.ssl import _get_cert_options_version_kwargs + +if TYPE_CHECKING: + from twisted.internet.interfaces import IOpenSSLContextFactory + + +def ssl_context_factory( + keyfile: str = "keys/localhost.key", + certfile: str = "keys/localhost.crt", + *, + cipher_string: str | None = None, + tls_min_version: str | None = None, + tls_max_version: str | None = None, +) -> IOpenSSLContextFactory: + keyfile_path = Path(__file__).parent.parent / keyfile + certfile_path = Path(__file__).parent.parent / certfile + + if PYOPENSSL_X509_DEPRECATED: + cert = load_pem_x509_certificate(certfile_path.read_bytes()) + key = load_pem_private_key(keyfile_path.read_bytes(), password=None) + else: + cert = load_certificate(FILETYPE_PEM, certfile_path.read_bytes()) # type: ignore[assignment] + key = load_privatekey(FILETYPE_PEM, keyfile_path.read_bytes()) # type: ignore[assignment] + + tls_min = _TWISTED_VERSION_MAP.get(tls_min_version) if tls_min_version else None + tls_max = _TWISTED_VERSION_MAP.get(tls_max_version) if tls_max_version else None + tls_version_kwargs = _get_cert_options_version_kwargs(tls_min, tls_max) + # https://github.com/twisted/twisted/issues/12638 + factory: CertificateOptions = CertificateOptions( + privateKey=key, # type: ignore[arg-type] + certificate=cert, # type: ignore[arg-type] + **tls_version_kwargs, + ) + if cipher_string: + ctx = factory.getContext() + # disabling TLS1.3 because it unconditionally enables some strong ciphers + ctx.set_options(SSL.OP_CIPHER_SERVER_PREFERENCE | SSL.OP_NO_TLSv1_3) + ctx.set_cipher_list(to_bytes(cipher_string)) + return cast("ContextFactory", factory) diff --git a/tests/pipelines.py b/tests/pipelines.py index d9fc12676..4f00d6919 100644 --- a/tests/pipelines.py +++ b/tests/pipelines.py @@ -4,13 +4,13 @@ Some pipelines used for testing class ZeroDivisionErrorPipeline: - def open_spider(self, spider): + def open_spider(self): 1 / 0 - def process_item(self, item, spider): + def process_item(self, item): return item class ProcessWithZeroDivisionErrorPipeline: - def process_item(self, item, spider): + def process_item(self, item): 1 / 0 diff --git a/tests/spiders.py b/tests/spiders.py index 43cdcaef3..612dc11c9 100644 --- a/tests/spiders.py +++ b/tests/spiders.py @@ -6,6 +6,7 @@ from __future__ import annotations import asyncio import time +from typing import TYPE_CHECKING, Any from urllib.parse import urlencode from twisted.internet import defer @@ -18,21 +19,31 @@ from scrapy.linkextractors import LinkExtractor from scrapy.spiders import Spider from scrapy.spiders.crawl import CrawlSpider, Rule from scrapy.utils.defer import deferred_to_future, maybe_deferred_to_future -from scrapy.utils.test import get_from_asyncio_queue, get_web_client_agent_req +from scrapy.utils.test import get_from_asyncio_queue + +if TYPE_CHECKING: + from tests.mockserver.http import MockServer class MockServerSpider(Spider): - def __init__(self, mockserver=None, *args, **kwargs): + def __init__( + self, + *args, + mockserver: MockServer | None = None, + is_secure: bool = False, + **kwargs: Any, + ): super().__init__(*args, **kwargs) self.mockserver = mockserver + self.is_secure = is_secure class MetaSpider(MockServerSpider): name = "meta" - def __init__(self, *args, **kwargs): + def __init__(self, *args: Any, **kwargs: Any): super().__init__(*args, **kwargs) - self.meta = {} + self.meta: dict[str, Any] = {} def closed(self, reason): self.meta["close_reason"] = reason @@ -83,19 +94,19 @@ class DelaySpider(MetaSpider): class LogSpider(MetaSpider): name = "log_spider" - def log_debug(self, message: str, extra: dict | None = None): + def log_debug(self, message: str, extra: dict[str, Any] | None = None): self.logger.debug(message, extra=extra) - def log_info(self, message: str, extra: dict | None = None): + def log_info(self, message: str, extra: dict[str, Any] | None = None): self.logger.info(message, extra=extra) - def log_warning(self, message: str, extra: dict | None = None): + def log_warning(self, message: str, extra: dict[str, Any] | None = None): self.logger.warning(message, extra=extra) - def log_error(self, message: str, extra: dict | None = None): + def log_error(self, message: str, extra: dict[str, Any] | None = None): self.logger.error(message, extra=extra) - def log_critical(self, message: str, extra: dict | None = None): + def log_critical(self, message: str, extra: dict[str, Any] | None = None): self.logger.critical(message, extra=extra) def parse(self, response): @@ -198,28 +209,24 @@ class AsyncDefDeferredDirectSpider(SimpleSpider): name = "asyncdef_deferred_direct" async def parse(self, response): - resp = await get_web_client_agent_req(self.mockserver.url("/status?n=200")) - yield {"code": resp.code} + await defer.succeed(None) + yield {"code": 200} class AsyncDefDeferredWrappedSpider(SimpleSpider): name = "asyncdef_deferred_wrapped" async def parse(self, response): - resp = await deferred_to_future( - get_web_client_agent_req(self.mockserver.url("/status?n=200")) - ) - yield {"code": resp.code} + await deferred_to_future(defer.succeed(None)) + yield {"code": 200} class AsyncDefDeferredMaybeWrappedSpider(SimpleSpider): - name = "asyncdef_deferred_wrapped" + name = "asyncdef_deferred_maybe_wrapped" async def parse(self, response): - resp = await maybe_deferred_to_future( - get_web_client_agent_req(self.mockserver.url("/status?n=200")) - ) - yield {"code": resp.code} + await maybe_deferred_to_future(defer.succeed(None)) + yield {"code": 200} class AsyncDefAsyncioGenSpider(SimpleSpider): @@ -392,7 +399,7 @@ class DuplicateStartSpider(MockServerSpider): async def start(self): for i in range(self.distinct_urls): - for j in range(self.dupe_factor): + for _ in range(self.dupe_factor): url = self.mockserver.url(f"/echo?headers=1&body=test{i}") yield Request(url, dont_filter=self.dont_filter) @@ -410,7 +417,7 @@ class CrawlSpiderWithParseMethod(MockServerSpider, CrawlSpider): """ name = "crawl_spider_with_parse_method" - custom_settings: dict = { + custom_settings: dict[str, Any] = { "RETRY_HTTP_CODES": [], # no need to retry } rules = (Rule(LinkExtractor(), callback="parse", follow=True),) @@ -516,7 +523,7 @@ class BytesReceivedCallbackSpider(MetaSpider): async def start(self): body = b"a" * self.full_response_length - url = self.mockserver.url("/alpayload") + url = self.mockserver.url("/alpayload", is_secure=self.is_secure) yield Request(url, method="POST", body=body, errback=self.errback) def parse(self, response): @@ -544,7 +551,10 @@ class HeadersReceivedCallbackSpider(MetaSpider): return spider async def start(self): - yield Request(self.mockserver.url("/status"), errback=self.errback) + yield Request( + self.mockserver.url("/status", is_secure=self.is_secure), + errback=self.errback, + ) def parse(self, response): self.meta["response"] = response diff --git a/tests/test_addons.py b/tests/test_addons.py index b4294c815..14ebddda8 100644 --- a/tests/test_addons.py +++ b/tests/test_addons.py @@ -2,14 +2,12 @@ import itertools from typing import Any from unittest.mock import patch -from twisted.internet.defer import inlineCallbacks -from twisted.trial import unittest - from scrapy import Spider -from scrapy.crawler import Crawler, CrawlerRunner +from scrapy.crawler import AsyncCrawlerRunner, Crawler, CrawlerRunner from scrapy.exceptions import NotConfigured from scrapy.settings import BaseSettings, Settings from scrapy.utils.test import get_crawler, get_reactor_settings +from tests.utils.decorators import inline_callbacks_test class SimpleAddon: @@ -52,7 +50,7 @@ class TestAddon: assert settings["KEY3"] == "addon" -class TestAddonManager(unittest.TestCase): +class TestAddonManager: def test_load_settings(self): settings_dict = { "ADDONS": {"tests.test_addons.SimpleAddon": 0}, @@ -73,6 +71,37 @@ class TestAddonManager(unittest.TestCase): manager = crawler.addons assert not manager.addons + def test_notconfigured_with_args(self): + class NotConfiguredAddon: + def update_settings(self, settings): + raise NotConfigured("addon disabled reason") + + settings_dict = { + "ADDONS": {NotConfiguredAddon: 0}, + } + with patch("scrapy.addons.logger") as logger_mock: + crawler = get_crawler(settings_dict=settings_dict) + assert not crawler.addons.addons + logger_mock.warning.assert_called_once_with( + "Disabled %(clspath)s: %(eargs)s", + {"clspath": NotConfiguredAddon, "eargs": "addon disabled reason"}, + extra={"crawler": crawler}, + ) + + def test_no_update_settings(self): + class PreCrawlerOnlyAddon: + @classmethod + def update_pre_crawler_settings(cls, settings): + settings.set("PRE_CRAWLER_KEY", "value", priority="addon") + + settings_dict = { + "ADDONS": {PreCrawlerOnlyAddon: 0}, + } + crawler = get_crawler(settings_dict=settings_dict) + manager = crawler.addons + assert len(manager.addons) == 1 + assert isinstance(manager.addons[0], PreCrawlerOnlyAddon) + def test_load_settings_order(self): # Get three addons with different settings addonlist = [] @@ -110,9 +139,15 @@ class TestAddonManager(unittest.TestCase): crawler = get_crawler(settings_dict=settings_dict) assert crawler.settings.getint("KEY") == 15 + runner_cls = ( + CrawlerRunner + if settings_dict.get("TWISTED_REACTOR_ENABLED", True) + else AsyncCrawlerRunner + ) + settings = Settings(settings_dict) settings.set("KEY", 0, priority="default") - runner = CrawlerRunner(settings) + runner = runner_cls(settings) crawler = runner.create_crawler(Spider) crawler._apply_settings() assert crawler.settings.getint("KEY") == 15 @@ -124,44 +159,40 @@ class TestAddonManager(unittest.TestCase): } settings = Settings(settings_dict) settings.set("KEY", 0, priority="default") - runner = CrawlerRunner(settings) + runner = runner_cls(settings) crawler = runner.create_crawler(Spider) + crawler._apply_settings() assert crawler.settings.getint("KEY") == 20 def test_fallback_workflow(self): - FALLBACK_SETTING = "MY_FALLBACK_DOWNLOAD_HANDLER" + FALLBACK_SETTING = "MY_FALLBACK_SCHEDULER" class AddonWithFallback: def update_settings(self, settings): if not settings.get(FALLBACK_SETTING): settings.set( FALLBACK_SETTING, - settings.getwithbase("DOWNLOAD_HANDLERS")["https"], + settings.get("SCHEDULER"), "addon", ) - settings["DOWNLOAD_HANDLERS"]["https"] = "AddonHandler" + settings["SCHEDULER"] = "AddonScheduler" settings_dict = { "ADDONS": {AddonWithFallback: 1}, } crawler = get_crawler(settings_dict=settings_dict) + assert crawler.settings.get("SCHEDULER") == "AddonScheduler" assert ( - crawler.settings.getwithbase("DOWNLOAD_HANDLERS")["https"] == "AddonHandler" - ) - assert ( - crawler.settings.get(FALLBACK_SETTING) - == "scrapy.core.downloader.handlers.http.HTTPDownloadHandler" + crawler.settings.get(FALLBACK_SETTING) == "scrapy.core.scheduler.Scheduler" ) settings_dict = { "ADDONS": {AddonWithFallback: 1}, - "DOWNLOAD_HANDLERS": {"https": "UserHandler"}, + "SCHEDULER": "UserScheduler", } crawler = get_crawler(settings_dict=settings_dict) - assert ( - crawler.settings.getwithbase("DOWNLOAD_HANDLERS")["https"] == "AddonHandler" - ) - assert crawler.settings.get(FALLBACK_SETTING) == "UserHandler" + assert crawler.settings.get("SCHEDULER") == "AddonScheduler" + assert crawler.settings.get(FALLBACK_SETTING) == "UserScheduler" def test_logging_message(self): class LoggedAddon: @@ -184,7 +215,7 @@ class TestAddonManager(unittest.TestCase): extra={"crawler": crawler}, ) - @inlineCallbacks + @inline_callbacks_test def test_enable_addon_in_spider(self): class MySpider(Spider): name = "myspider" @@ -200,7 +231,12 @@ class TestAddonManager(unittest.TestCase): settings = Settings() settings.setdict(get_reactor_settings()) settings.set("KEY", "default", priority="default") - runner = CrawlerRunner(settings) + runner_cls = ( + CrawlerRunner + if settings.getbool("TWISTED_REACTOR_ENABLED", True) + else AsyncCrawlerRunner + ) + runner = runner_cls(settings) crawler = runner.create_crawler(MySpider) assert crawler.settings.get("KEY") == "default" yield crawler.crawl() diff --git a/tests/test_closespider.py b/tests/test_closespider.py index c6ec690a1..9a7447e16 100644 --- a/tests/test_closespider.py +++ b/tests/test_closespider.py @@ -1,8 +1,5 @@ -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase - from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer from tests.spiders import ( ErrorSpider, FollowAllSpider, @@ -10,19 +7,20 @@ from tests.spiders import ( MaxItemsAndRequestsSpider, SlowSpider, ) +from tests.utils.decorators import inline_callbacks_test -class TestCloseSpider(TestCase): +class TestCloseSpider: @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) - @inlineCallbacks + @inline_callbacks_test def test_closespider_itemcount(self): close_on = 5 crawler = get_crawler(ItemSpider, {"CLOSESPIDER_ITEMCOUNT": close_on}) @@ -32,7 +30,7 @@ class TestCloseSpider(TestCase): itemcount = crawler.stats.get_value("item_scraped_count") assert itemcount >= close_on - @inlineCallbacks + @inline_callbacks_test def test_closespider_pagecount(self): close_on = 5 crawler = get_crawler(FollowAllSpider, {"CLOSESPIDER_PAGECOUNT": close_on}) @@ -42,7 +40,7 @@ class TestCloseSpider(TestCase): pagecount = crawler.stats.get_value("response_received_count") assert pagecount >= close_on - @inlineCallbacks + @inline_callbacks_test def test_closespider_pagecount_no_item(self): close_on = 5 max_items = 5 @@ -62,7 +60,7 @@ class TestCloseSpider(TestCase): itemcount = crawler.stats.get_value("item_scraped_count") assert pagecount <= close_on + itemcount - @inlineCallbacks + @inline_callbacks_test def test_closespider_pagecount_no_item_with_pagecount(self): close_on_pagecount_no_item = 5 close_on_pagecount = 20 @@ -79,7 +77,7 @@ class TestCloseSpider(TestCase): pagecount = crawler.stats.get_value("response_received_count") assert pagecount < close_on_pagecount - @inlineCallbacks + @inline_callbacks_test def test_closespider_errorcount(self): close_on = 5 crawler = get_crawler(ErrorSpider, {"CLOSESPIDER_ERRORCOUNT": close_on}) @@ -91,7 +89,7 @@ class TestCloseSpider(TestCase): assert crawler.stats.get_value("spider_exceptions/count") >= close_on assert errorcount >= close_on - @inlineCallbacks + @inline_callbacks_test def test_closespider_timeout(self): close_on = 0.1 crawler = get_crawler(FollowAllSpider, {"CLOSESPIDER_TIMEOUT": close_on}) @@ -101,7 +99,7 @@ class TestCloseSpider(TestCase): total_seconds = crawler.stats.get_value("elapsed_time_seconds") assert total_seconds >= close_on - @inlineCallbacks + @inline_callbacks_test def test_closespider_timeout_no_item(self): timeout = 1 crawler = get_crawler(SlowSpider, {"CLOSESPIDER_TIMEOUT_NO_ITEM": timeout}) diff --git a/tests/test_cmdline/extensions.py b/tests/test_cmdline/extensions.py index 11c821f8d..ef1e50c0c 100644 --- a/tests/test_cmdline/extensions.py +++ b/tests/test_cmdline/extensions.py @@ -1,14 +1,2 @@ -"""A test extension used to check the settings loading order""" - - -class TestExtension: - def __init__(self, settings): - settings.set("TEST1", f"{settings['TEST1']} + started") - - @classmethod - def from_crawler(cls, crawler): - return cls(crawler.settings) - - class DummyExtension: pass diff --git a/tests/test_cmdline/settings.py b/tests/test_cmdline/settings.py index 32b15e191..ec71bba0c 100644 --- a/tests/test_cmdline/settings.py +++ b/tests/test_cmdline/settings.py @@ -1,7 +1,7 @@ from pathlib import Path EXTENSIONS = { - "tests.test_cmdline.extensions.TestExtension": 0, + "tests.test_cmdline.extensions.DummyExtension": 0, } TEST1 = "default" diff --git a/tests/test_cmdline_crawl_with_pipeline/__init__.py b/tests/test_cmdline_crawl_with_pipeline/__init__.py index c6fdb13ea..f17543575 100644 --- a/tests/test_cmdline_crawl_with_pipeline/__init__.py +++ b/tests/test_cmdline_crawl_with_pipeline/__init__.py @@ -2,8 +2,6 @@ import sys from pathlib import Path from subprocess import PIPE, Popen -from tests import TWISTED_KEEPS_TRACEBACKS - class TestCmdlineCrawlPipeline: def _execute(self, spname): @@ -14,14 +12,10 @@ class TestCmdlineCrawlPipeline: return proc.returncode, stderr def test_open_spider_normally_in_pipeline(self): - returncode, stderr = self._execute("normal") + returncode, _ = self._execute("normal") assert returncode == 0 def test_exception_at_open_spider_in_pipeline(self): - returncode, stderr = self._execute("exception") - # An unhandled exception in a pipeline should not stop the crawl - assert returncode == 0 - if TWISTED_KEEPS_TRACEBACKS: - assert b'RuntimeError("exception")' in stderr - else: - assert b"RuntimeError: exception" in stderr + returncode, _ = self._execute("exception") + # An exception in pipeline's open_spider should result in a non-zero exit code + assert returncode == 1 diff --git a/tests/test_cmdline_crawl_with_pipeline/test_spider/pipelines.py b/tests/test_cmdline_crawl_with_pipeline/test_spider/pipelines.py index 3e29c70ed..577ecd686 100644 --- a/tests/test_cmdline_crawl_with_pipeline/test_spider/pipelines.py +++ b/tests/test_cmdline_crawl_with_pipeline/test_spider/pipelines.py @@ -2,7 +2,7 @@ class TestSpiderPipeline: def open_spider(self, spider): pass - def process_item(self, item, spider): + def process_item(self, item): return item @@ -10,5 +10,5 @@ class TestSpiderExceptionPipeline: def open_spider(self, spider): raise RuntimeError("exception") - def process_item(self, item, spider): + def process_item(self, item): return item diff --git a/tests/test_command_check.py b/tests/test_command_check.py index 97bd9d726..815f87026 100644 --- a/tests/test_command_check.py +++ b/tests/test_command_check.py @@ -1,19 +1,29 @@ +from __future__ import annotations + import sys from io import StringIO -from unittest.mock import Mock, PropertyMock, call, patch +from typing import TYPE_CHECKING +from unittest import TestCase +from unittest.mock import MagicMock, Mock, PropertyMock, call, patch from scrapy.commands.check import Command, TextTestResult -from tests.test_commands import TestCommandBase +from tests.test_commands import TestProjectBase +from tests.utils.cmdline import proc + +if TYPE_CHECKING: + from pathlib import Path -class TestCheckCommand(TestCommandBase): - def setup_method(self): - super().setup_method() - self.spider_name = "check_spider" - self.spider = (self.proj_mod_path / "spiders" / "checkspider.py").resolve() +class DummyTestCase(TestCase): + pass - def _write_contract(self, contracts, parse_def): - self.spider.write_text( + +class TestCheckCommand(TestProjectBase): + spider_name = "check_spider" + + def _write_contract(self, proj_path: Path, contracts: str, parse_def: str) -> None: + spider = proj_path / self.project_name / "spiders" / "checkspider.py" + spider.write_text( f""" import scrapy @@ -21,6 +31,10 @@ class CheckSpider(scrapy.Spider): name = '{self.spider_name}' start_urls = ['data:,'] + custom_settings = {{ + "DOWNLOAD_DELAY": 0, + }} + def parse(self, response, **cb_kwargs): \"\"\" @url data:, @@ -31,32 +45,50 @@ class CheckSpider(scrapy.Spider): encoding="utf-8", ) - def _test_contract(self, contracts="", parse_def="pass"): - self._write_contract(contracts, parse_def) - p, out, err = self.proc("check") + def _test_contract( + self, + proj_path: Path, + contracts: str = "", + parse_def: str = "pass", + use_reactor: bool = True, + ) -> None: + self._write_contract(proj_path, contracts, parse_def) + args = ["check"] + if not use_reactor: + args += ["-s", "TWISTED_REACTOR_ENABLED=False"] + ret, out, err = proc(*args, cwd=proj_path) assert "F" not in out assert "OK" in err - assert p.returncode == 0 + assert ret == 0 - def test_check_returns_requests_contract(self): + def test_check_returns_requests_contract(self, proj_path: Path) -> None: contracts = """ @returns requests 1 """ parse_def = """ yield scrapy.Request(url='http://next-url.com') """ - self._test_contract(contracts, parse_def) + self._test_contract(proj_path, contracts, parse_def) - def test_check_returns_items_contract(self): + def test_check_no_reactor(self, proj_path: Path) -> None: + contracts = """ + @returns requests 1 + """ + parse_def = """ + yield scrapy.Request(url='http://next-url.com') + """ + self._test_contract(proj_path, contracts, parse_def, use_reactor=False) + + def test_check_returns_items_contract(self, proj_path: Path) -> None: contracts = """ @returns items 1 """ parse_def = """ yield {'key1': 'val1', 'key2': 'val2'} """ - self._test_contract(contracts, parse_def) + self._test_contract(proj_path, contracts, parse_def) - def test_check_cb_kwargs_contract(self): + def test_check_cb_kwargs_contract(self, proj_path: Path) -> None: contracts = """ @cb_kwargs {"arg1": "val1", "arg2": "val2"} """ @@ -64,18 +96,18 @@ class CheckSpider(scrapy.Spider): if len(cb_kwargs.items()) == 0: raise Exception("Callback args not set") """ - self._test_contract(contracts, parse_def) + self._test_contract(proj_path, contracts, parse_def) - def test_check_scrapes_contract(self): + def test_check_scrapes_contract(self, proj_path: Path) -> None: contracts = """ @scrapes key1 key2 """ parse_def = """ yield {'key1': 'val1', 'key2': 'val2'} """ - self._test_contract(contracts, parse_def) + self._test_contract(proj_path, contracts, parse_def) - def test_check_all_default_contracts(self): + def test_check_all_default_contracts(self, proj_path: Path) -> None: contracts = """ @returns items 1 @returns requests 1 @@ -88,71 +120,75 @@ class CheckSpider(scrapy.Spider): if len(cb_kwargs.items()) == 0: raise Exception("Callback args not set") """ - self._test_contract(contracts, parse_def) + self._test_contract(proj_path, contracts, parse_def) - def test_SCRAPY_CHECK_set(self): + def test_SCRAPY_CHECK_set(self, proj_path: Path) -> None: parse_def = """ import os if not os.environ.get('SCRAPY_CHECK'): raise Exception('SCRAPY_CHECK not set') """ - self._test_contract(parse_def=parse_def) + self._test_contract(proj_path, parse_def=parse_def) def test_printSummary_with_unsuccessful_test_result_without_errors_and_without_failures( self, - ): - result = TextTestResult(Mock(), descriptions=False, verbosity=1) + ) -> None: + result = TextTestResult(MagicMock(), descriptions=False, verbosity=1) start_time = 1.0 stop_time = 2.0 result.testsRun = 5 result.failures = [] result.errors = [] - result.unexpectedSuccesses = ["a", "b"] + result.unexpectedSuccesses = [DummyTestCase(), DummyTestCase()] with patch.object(result.stream, "write") as mock_write: result.printSummary(start_time, stop_time) mock_write.assert_has_calls([call("FAILED"), call("\n")]) - def test_printSummary_with_unsuccessful_test_result_with_only_failures(self): - result = TextTestResult(Mock(), descriptions=False, verbosity=1) + def test_printSummary_with_unsuccessful_test_result_with_only_failures( + self, + ) -> None: + result = TextTestResult(MagicMock(), descriptions=False, verbosity=1) start_time = 1.0 stop_time = 2.0 result.testsRun = 5 - result.failures = [(self, "failure")] + result.failures = [(DummyTestCase(), "failure")] result.errors = [] with patch.object(result.stream, "writeln") as mock_write: result.printSummary(start_time, stop_time) mock_write.assert_called_with(" (failures=1)") - def test_printSummary_with_unsuccessful_test_result_with_only_errors(self): - result = TextTestResult(Mock(), descriptions=False, verbosity=1) + def test_printSummary_with_unsuccessful_test_result_with_only_errors(self) -> None: + result = TextTestResult(MagicMock(), descriptions=False, verbosity=1) start_time = 1.0 stop_time = 2.0 result.testsRun = 5 result.failures = [] - result.errors = [(self, "error")] + result.errors = [(DummyTestCase(), "error")] with patch.object(result.stream, "writeln") as mock_write: result.printSummary(start_time, stop_time) mock_write.assert_called_with(" (errors=1)") def test_printSummary_with_unsuccessful_test_result_with_both_failures_and_errors( self, - ): - result = TextTestResult(Mock(), descriptions=False, verbosity=1) + ) -> None: + result = TextTestResult(MagicMock(), descriptions=False, verbosity=1) start_time = 1.0 stop_time = 2.0 result.testsRun = 5 - result.failures = [(self, "failure")] - result.errors = [(self, "error")] + result.failures = [(DummyTestCase(), "failure")] + result.errors = [(DummyTestCase(), "error")] with patch.object(result.stream, "writeln") as mock_write: result.printSummary(start_time, stop_time) mock_write.assert_called_with(" (failures=1, errors=1)") @patch("scrapy.commands.check.ContractsManager") - def test_run_with_opts_list_prints_spider(self, cm_cls_mock): + def test_run_with_opts_list_prints_spider(self, cm_cls_mock) -> None: output = StringIO() sys.stdout = output cmd = Command() - cmd.settings = Mock(getwithbase=Mock(return_value={})) + cmd.settings = Mock( + get_component_priority_dict_with_base=Mock(return_value={}), + ) cm_cls_mock.return_value = cm_mock = Mock() spider_loader_mock = Mock() cmd.crawler_process = Mock(spider_loader=spider_loader_mock) @@ -175,9 +211,11 @@ class CheckSpider(scrapy.Spider): @patch("scrapy.commands.check.ContractsManager") def test_run_without_opts_list_does_not_crawl_spider_with_no_tested_methods( self, cm_cls_mock - ): + ) -> None: cmd = Command() - cmd.settings = Mock(getwithbase=Mock(return_value={})) + cmd.settings = Mock( + get_component_priority_dict_with_base=Mock(return_value={}), + ) cm_cls_mock.return_value = cm_mock = Mock() spider_loader_mock = Mock() cmd.crawler_process = Mock(spider_loader=spider_loader_mock) @@ -186,7 +224,7 @@ class CheckSpider(scrapy.Spider): spider_loader_mock.load.side_effect = lambda x: {spider_name: spider_cls_mock}[ x ] - tested_methods = [] + tested_methods: list[str] = [] cm_mock.tested_methods_from_spidercls.side_effect = lambda x: { spider_cls_mock: tested_methods }[x] diff --git a/tests/test_command_crawl.py b/tests/test_command_crawl.py index 0ab0659b2..dd69d36ba 100644 --- a/tests/test_command_crawl.py +++ b/tests/test_command_crawl.py @@ -1,22 +1,29 @@ from __future__ import annotations -from pathlib import Path +from typing import TYPE_CHECKING -from tests.test_commands import TestCommandBase +from tests.test_commands import TestProjectBase +from tests.utils.cmdline import proc + +if TYPE_CHECKING: + from collections.abc import Iterable + from pathlib import Path -class TestCrawlCommand(TestCommandBase): - def crawl(self, code, args=()): - Path(self.proj_mod_path, "spiders", "myspider.py").write_text( +class TestCrawlCommand(TestProjectBase): + def crawl( + self, code: str, proj_path: Path, args: Iterable[str] = () + ) -> tuple[int, str, str]: + (proj_path / self.project_name / "spiders" / "myspider.py").write_text( code, encoding="utf-8" ) - return self.proc("crawl", "myspider", *args) + return proc("crawl", "myspider", *args, cwd=proj_path) - def get_log(self, code, args=()): - _, _, stderr = self.crawl(code, args=args) + def get_log(self, code: str, proj_path: Path, args: Iterable[str] = ()) -> str: + _, _, stderr = self.crawl(code, proj_path, args=args) return stderr - def test_no_output(self): + def test_no_output(self, proj_path: Path) -> None: spider_code = """ import scrapy @@ -28,7 +35,7 @@ class MySpider(scrapy.Spider): return yield """ - log = self.get_log(spider_code) + log = self.get_log(spider_code, proj_path) assert "[myspider] DEBUG: It works!" in log assert ( "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" @@ -36,7 +43,7 @@ class MySpider(scrapy.Spider): ) assert "Spider closed (finished)" in log - def test_output(self): + def test_output(self, proj_path: Path) -> None: spider_code = """ import scrapy @@ -49,10 +56,10 @@ class MySpider(scrapy.Spider): yield """ args = ["-o", "example.json"] - log = self.get_log(spider_code, args=args) + log = self.get_log(spider_code, proj_path, args=args) assert "[myspider] DEBUG: FEEDS: {'example.json': {'format': 'json'}}" in log - def test_overwrite_output(self): + def test_overwrite_output(self, proj_path: Path) -> None: spider_code = """ import json import scrapy @@ -69,18 +76,19 @@ class MySpider(scrapy.Spider): return yield """ - Path(self.cwd, "example.json").write_text("not empty", encoding="utf-8") + j = proj_path / "example.json" + j.write_text("not empty", encoding="utf-8") args = ["-O", "example.json"] - log = self.get_log(spider_code, args=args) + log = self.get_log(spider_code, proj_path, args=args) assert ( '[myspider] DEBUG: FEEDS: {"example.json": {"format": "json", "overwrite": true}}' in log ) - with Path(self.cwd, "example.json").open(encoding="utf-8") as f2: + with j.open(encoding="utf-8") as f2: first_line = f2.readline() assert first_line != "not empty" - def test_output_and_overwrite_output(self): + def test_output_and_overwrite_output(self, proj_path: Path) -> None: spider_code = """ import scrapy @@ -92,12 +100,12 @@ class MySpider(scrapy.Spider): yield """ args = ["-o", "example1.json", "-O", "example2.json"] - log = self.get_log(spider_code, args=args) + log = self.get_log(spider_code, proj_path, args=args) assert ( "error: Please use only one of -o/--output and -O/--overwrite-output" in log ) - def test_default_reactor(self): + def test_default_reactor(self, proj_path: Path) -> None: spider_code = """ import scrapy @@ -109,10 +117,29 @@ class MySpider(scrapy.Spider): return yield """ - log = self.get_log(spider_code, args=("-s", "TWISTED_REACTOR=")) + log = self.get_log(spider_code, proj_path, args=("-s", "TWISTED_REACTOR=")) assert "[myspider] DEBUG: It works!" in log assert ( "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" not in log ) assert "Spider closed (finished)" in log + + def test_no_reactor(self, proj_path: Path) -> None: + spider_code = """ +import scrapy + +class MySpider(scrapy.Spider): + name = 'myspider' + + async def start(self): + self.logger.debug('It works!') + return + yield +""" + log = self.get_log( + spider_code, proj_path, args=("-s", "TWISTED_REACTOR_ENABLED=False") + ) + assert "[myspider] DEBUG: It works!" in log + assert "Not using a Twisted reactor" in log + assert "Spider closed (finished)" in log diff --git a/tests/test_command_fetch.py b/tests/test_command_fetch.py index c83594361..d98dac968 100644 --- a/tests/test_command_fetch.py +++ b/tests/test_command_fetch.py @@ -1,35 +1,38 @@ -from tests.mockserver import MockServer -from tests.test_commands import TestProjectBase +from __future__ import annotations + +from typing import TYPE_CHECKING + +from tests.utils.cmdline import proc + +if TYPE_CHECKING: + from tests.mockserver.http import MockServer -class TestFetchCommand(TestProjectBase): - @classmethod - def setup_class(cls): - cls.mockserver = MockServer() - cls.mockserver.__enter__() - - @classmethod - def teardown_class(cls): - cls.mockserver.__exit__(None, None, None) - - def test_output(self): - _, out, _ = self.proc("fetch", self.mockserver.url("/text")) +class TestFetchCommand: + def test_output(self, mockserver: MockServer) -> None: + _, out, _ = proc("fetch", mockserver.url("/text")) assert out.strip() == "Works" - def test_redirect_default(self): - _, out, _ = self.proc("fetch", self.mockserver.url("/redirect")) + def test_redirect_default(self, mockserver: MockServer) -> None: + _, out, _ = proc("fetch", mockserver.url("/redirect")) assert out.strip() == "Redirected here" - def test_redirect_disabled(self): - _, _, err = self.proc( - "fetch", "--no-redirect", self.mockserver.url("/redirect-no-meta-refresh") + def test_redirect_disabled(self, mockserver: MockServer) -> None: + _, _, err = proc( + "fetch", "--no-redirect", mockserver.url("/redirect-no-meta-refresh") ) err = err.strip() - assert "downloader/response_status_count/302" in err, err - assert "downloader/response_status_count/200" not in err, err + assert "downloader/response_status_count/302" in err + assert "downloader/response_status_count/200" not in err - def test_headers(self): - _, out, _ = self.proc("fetch", self.mockserver.url("/text"), "--headers") + def test_headers(self, mockserver: MockServer) -> None: + _, out, _ = proc("fetch", mockserver.url("/text"), "--headers") out = out.replace("\r", "") # required on win32 - assert "Server: TwistedWeb" in out, out + assert "Server: TwistedWeb" in out assert "Content-Type: text/plain" in out + + def test_no_reactor(self, mockserver: MockServer) -> None: + _, out, _ = proc( + "fetch", "-s", "TWISTED_REACTOR_ENABLED=False", mockserver.url("/text") + ) + assert out.strip() == "Works" diff --git a/tests/test_command_genspider.py b/tests/test_command_genspider.py index 18ec81fed..67e3eb50a 100644 --- a/tests/test_command_genspider.py +++ b/tests/test_command_genspider.py @@ -1,66 +1,81 @@ from __future__ import annotations -import os +import re from pathlib import Path -from tests.test_commands import TestCommandBase, TestProjectBase +import pytest + +from tests.test_commands import TestProjectBase +from tests.utils.cmdline import call, proc -class TestGenspiderCommand(TestCommandBase): - def test_arguments(self): +def find_in_file(filename: Path, regex: str) -> re.Match[str] | None: + """Find first pattern occurrence in file""" + pattern = re.compile(regex) + with filename.open("r", encoding="utf-8") as f: + for line in f: + match = pattern.search(line) + if match is not None: + return match + return None + + +class TestGenspiderCommand(TestProjectBase): + def test_arguments(self, proj_path: Path) -> None: + spider = proj_path / self.project_name / "spiders" / "test_name.py" # only pass one argument. spider script shouldn't be created - assert self.call("genspider", "test_name") == 2 - assert not Path(self.proj_mod_path, "spiders", "test_name.py").exists() + assert call("genspider", "test_name", cwd=proj_path) == 2 + assert not spider.exists() # pass two arguments . spider script should be created - assert self.call("genspider", "test_name", "test.com") == 0 - assert Path(self.proj_mod_path, "spiders", "test_name.py").exists() + assert call("genspider", "test_name", "test.com", cwd=proj_path) == 0 + assert spider.exists() - def test_template(self, tplname="crawl"): + @pytest.mark.parametrize( + "tplname", + [ + "basic", + "crawl", + "xmlfeed", + "csvfeed", + ], + ) + def test_template(self, tplname: str, proj_path: Path) -> None: args = [f"--template={tplname}"] if tplname else [] spname = "test_spider" spmodule = f"{self.project_name}.spiders.{spname}" - p, out, err = self.proc("genspider", spname, "test.com", *args) + spfile = proj_path / self.project_name / "spiders" / f"{spname}.py" + _, out, _ = proc("genspider", spname, "test.com", *args, cwd=proj_path) assert ( - f"Created spider {spname!r} using template {tplname!r} in module:{os.linesep} {spmodule}" + f"Created spider {spname!r} using template {tplname!r} in module:\n {spmodule}" in out ) - assert Path(self.proj_mod_path, "spiders", "test_spider.py").exists() - modify_time_before = ( - Path(self.proj_mod_path, "spiders", "test_spider.py").stat().st_mtime - ) - p, out, err = self.proc("genspider", spname, "test.com", *args) + assert spfile.exists() + modify_time_before = spfile.stat().st_mtime + _, out, _ = proc("genspider", spname, "test.com", *args, cwd=proj_path) assert f"Spider {spname!r} already exists in module" in out - modify_time_after = ( - Path(self.proj_mod_path, "spiders", "test_spider.py").stat().st_mtime - ) + modify_time_after = spfile.stat().st_mtime assert modify_time_after == modify_time_before - def test_template_basic(self): - self.test_template("basic") + def test_list(self, proj_path: Path) -> None: + assert call("genspider", "--list", cwd=proj_path) == 0 - def test_template_csvfeed(self): - self.test_template("csvfeed") + def test_dump(self, proj_path: Path) -> None: + assert call("genspider", "--dump=basic", cwd=proj_path) == 0 + assert call("genspider", "-d", "basic", cwd=proj_path) == 0 - def test_template_xmlfeed(self): - self.test_template("xmlfeed") - - def test_list(self): - assert self.call("genspider", "--list") == 0 - - def test_dump(self): - assert self.call("genspider", "--dump=basic") == 0 - assert self.call("genspider", "-d", "basic") == 0 - - def test_same_name_as_project(self): - assert self.call("genspider", self.project_name) == 2 - assert not Path( - self.proj_mod_path, "spiders", f"{self.project_name}.py" + def test_same_name_as_project(self, proj_path: Path) -> None: + assert call("genspider", self.project_name, cwd=proj_path) == 2 + assert not ( + proj_path / self.project_name / "spiders" / f"{self.project_name}.py" ).exists() - def test_same_filename_as_existing_spider(self, force=False): + @pytest.mark.parametrize("force", [True, False]) + def test_same_filename_as_existing_spider( + self, force: bool, proj_path: Path + ) -> None: file_name = "example" - file_path = Path(self.proj_mod_path, "spiders", f"{file_name}.py") - assert self.call("genspider", file_name, "example.com") == 0 + file_path = proj_path / self.project_name / "spiders" / f"{file_name}.py" + assert call("genspider", file_name, "example.com", cwd=proj_path) == 0 assert file_path.exists() # change name of spider but not its file name @@ -74,7 +89,9 @@ class TestGenspiderCommand(TestCommandBase): file_contents_before = file_data if force: - p, out, err = self.proc("genspider", "--force", file_name, "example.com") + _, out, _ = proc( + "genspider", "--force", file_name, "example.com", cwd=proj_path + ) assert ( f"Created spider {file_name!r} using template 'basic' in module" in out ) @@ -83,101 +100,79 @@ class TestGenspiderCommand(TestCommandBase): file_contents_after = file_path.read_text(encoding="utf-8") assert file_contents_after != file_contents_before else: - p, out, err = self.proc("genspider", file_name, "example.com") + _, out, _ = proc("genspider", file_name, "example.com", cwd=proj_path) assert f"{file_path.resolve()} already exists" in out modify_time_after = file_path.stat().st_mtime assert modify_time_after == modify_time_before file_contents_after = file_path.read_text(encoding="utf-8") assert file_contents_after == file_contents_before - def test_same_filename_as_existing_spider_force(self): - self.test_same_filename_as_existing_spider(force=True) - - def test_url(self, url="test.com", domain="test.com"): - assert self.call("genspider", "--force", "test_name", url) == 0 - assert ( - self.find_in_file( - Path(self.proj_mod_path, "spiders", "test_name.py"), - r"allowed_domains\s*=\s*\[['\"](.+)['\"]\]", - ).group(1) - == domain - ) - assert ( - self.find_in_file( - Path(self.proj_mod_path, "spiders", "test_name.py"), - r"start_urls\s*=\s*\[['\"](.+)['\"]\]", - ).group(1) - == f"https://{domain}" - ) - - def test_url_schema(self): - self.test_url("https://test.com", "test.com") + @pytest.mark.parametrize( + ("url", "domain"), + [ + ("test.com", "test.com"), + ("https://test.com", "test.com"), + ], + ) + def test_url(self, url: str, domain: str, proj_path: Path) -> None: + assert call("genspider", "--force", "test_name", url, cwd=proj_path) == 0 + spider = proj_path / self.project_name / "spiders" / "test_name.py" + m = find_in_file(spider, r"allowed_domains\s*=\s*\[['\"](.+)['\"]\]") + assert m is not None + assert m.group(1) == domain + m = find_in_file(spider, r"start_urls\s*=\s*\[['\"](.+)['\"]\]") + assert m is not None + assert m.group(1) == f"https://{domain}" + @pytest.mark.parametrize( + ("url", "expected", "template"), + [ + # basic + ("https://test.com", "https://test.com", "basic"), + ("http://test.com", "http://test.com", "basic"), + ("http://test.com/other/path", "http://test.com/other/path", "basic"), + ("test.com/other/path", "https://test.com/other/path", "basic"), + # crawl + ("https://test.com", "https://test.com", "crawl"), + ("http://test.com", "http://test.com", "crawl"), + ("http://test.com/other/path", "http://test.com/other/path", "crawl"), + ("test.com/other/path", "https://test.com/other/path", "crawl"), + ("test.com", "https://test.com", "crawl"), + # xmlfeed + ("https://test.com/feed.xml", "https://test.com/feed.xml", "xmlfeed"), + ("http://test.com/feed.xml", "http://test.com/feed.xml", "xmlfeed"), + ("test.com/feed.xml", "https://test.com/feed.xml", "xmlfeed"), + # csvfeed + ("https://test.com/feed.csv", "https://test.com/feed.csv", "csvfeed"), + ("http://test.com/feed.xml", "http://test.com/feed.xml", "csvfeed"), + ("test.com/feed.csv", "https://test.com/feed.csv", "csvfeed"), + ], + ) def test_template_start_urls( - self, url="test.com", expected="https://test.com", template="basic" - ): - assert self.call("genspider", "-t", template, "--force", "test_name", url) == 0 + self, url: str, expected: str, template: str, proj_path: Path + ) -> None: assert ( - self.find_in_file( - Path(self.proj_mod_path, "spiders", "test_name.py"), - r"start_urls\s*=\s*\[['\"](.+)['\"]\]", - ).group(1) - == expected - ) - - def test_genspider_basic_start_urls(self): - self.test_template_start_urls("https://test.com", "https://test.com", "basic") - self.test_template_start_urls("http://test.com", "http://test.com", "basic") - self.test_template_start_urls( - "http://test.com/other/path", "http://test.com/other/path", "basic" - ) - self.test_template_start_urls( - "test.com/other/path", "https://test.com/other/path", "basic" - ) - - def test_genspider_crawl_start_urls(self): - self.test_template_start_urls("https://test.com", "https://test.com", "crawl") - self.test_template_start_urls("http://test.com", "http://test.com", "crawl") - self.test_template_start_urls( - "http://test.com/other/path", "http://test.com/other/path", "crawl" - ) - self.test_template_start_urls( - "test.com/other/path", "https://test.com/other/path", "crawl" - ) - self.test_template_start_urls("test.com", "https://test.com", "crawl") - - def test_genspider_xmlfeed_start_urls(self): - self.test_template_start_urls( - "https://test.com/feed.xml", "https://test.com/feed.xml", "xmlfeed" - ) - self.test_template_start_urls( - "http://test.com/feed.xml", "http://test.com/feed.xml", "xmlfeed" - ) - self.test_template_start_urls( - "test.com/feed.xml", "https://test.com/feed.xml", "xmlfeed" - ) - - def test_genspider_csvfeed_start_urls(self): - self.test_template_start_urls( - "https://test.com/feed.csv", "https://test.com/feed.csv", "csvfeed" - ) - self.test_template_start_urls( - "http://test.com/feed.xml", "http://test.com/feed.xml", "csvfeed" - ) - self.test_template_start_urls( - "test.com/feed.csv", "https://test.com/feed.csv", "csvfeed" + call( + "genspider", "-t", template, "--force", "test_name", url, cwd=proj_path + ) + == 0 ) + spider = proj_path / self.project_name / "spiders" / "test_name.py" + m = find_in_file(spider, r"start_urls\s*=\s*\[['\"](.+)['\"]\]") + assert m is not None + assert m.group(1) == expected -class TestGenspiderStandaloneCommand(TestProjectBase): - def test_generate_standalone_spider(self): - self.call("genspider", "example", "example.com") - assert Path(self.temp_path, "example.py").exists() +class TestGenspiderStandaloneCommand: + def test_generate_standalone_spider(self, tmp_path: Path) -> None: + call("genspider", "example", "example.com", cwd=tmp_path) + assert Path(tmp_path, "example.py").exists() - def test_same_name_as_existing_file(self, force=False): + @pytest.mark.parametrize("force", [True, False]) + def test_same_name_as_existing_file(self, force: bool, tmp_path: Path) -> None: file_name = "example" - file_path = Path(self.temp_path, file_name + ".py") - p, out, err = self.proc("genspider", file_name, "example.com") + file_path = Path(tmp_path, file_name + ".py") + _, out, _ = proc("genspider", file_name, "example.com", cwd=tmp_path) assert f"Created spider {file_name!r} using template 'basic' " in out assert file_path.exists() modify_time_before = file_path.stat().st_mtime @@ -185,8 +180,14 @@ class TestGenspiderStandaloneCommand(TestProjectBase): if force: # use different template to ensure contents were changed - p, out, err = self.proc( - "genspider", "--force", "-t", "crawl", file_name, "example.com" + _, out, _ = proc( + "genspider", + "--force", + "-t", + "crawl", + file_name, + "example.com", + cwd=tmp_path, ) assert f"Created spider {file_name!r} using template 'crawl' " in out modify_time_after = file_path.stat().st_mtime @@ -194,15 +195,11 @@ class TestGenspiderStandaloneCommand(TestProjectBase): file_contents_after = file_path.read_text(encoding="utf-8") assert file_contents_after != file_contents_before else: - p, out, err = self.proc("genspider", file_name, "example.com") + _, out, _ = proc("genspider", file_name, "example.com", cwd=tmp_path) assert ( - f"{Path(self.temp_path, file_name + '.py').resolve()} already exists" - in out + f"{Path(tmp_path, file_name + '.py').resolve()} already exists" in out ) modify_time_after = file_path.stat().st_mtime assert modify_time_after == modify_time_before file_contents_after = file_path.read_text(encoding="utf-8") assert file_contents_after == file_contents_before - - def test_same_name_as_existing_file_force(self): - self.test_same_name_as_existing_file(force=True) diff --git a/tests/test_command_parse.py b/tests/test_command_parse.py index 5c3120c21..c210a06e8 100644 --- a/tests/test_command_parse.py +++ b/tests/test_command_parse.py @@ -1,27 +1,29 @@ +from __future__ import annotations + import argparse import re -from pathlib import Path +from typing import TYPE_CHECKING + +import pytest from scrapy.commands import parse from scrapy.settings import Settings -from tests.mockserver import MockServer -from tests.test_commands import TestCommandBase +from tests.test_commands import TestProjectBase +from tests.utils.cmdline import call, proc + +if TYPE_CHECKING: + from pathlib import Path + + from tests.mockserver.http import MockServer -class TestParseCommand(TestCommandBase): - @classmethod - def setup_class(cls): - cls.mockserver = MockServer() - cls.mockserver.__enter__() +class TestParseCommand(TestProjectBase): + spider_name = "parse_spider" - @classmethod - def teardown_class(cls): - cls.mockserver.__exit__(None, None, None) - - def setup_method(self): - super().setup_method() - self.spider_name = "parse_spider" - (self.proj_mod_path / "spiders" / "myspider.py").write_text( + @pytest.fixture(autouse=True) + def create_files(self, proj_path: Path) -> None: + proj_mod_path = proj_path / self.project_name + (proj_mod_path / "spiders" / "myspider.py").write_text( f""" import scrapy from scrapy.linkextractors import LinkExtractor @@ -30,7 +32,13 @@ from scrapy.utils.test import get_from_asyncio_queue import asyncio -class AsyncDefAsyncioReturnSpider(scrapy.Spider): +class BaseSpider(scrapy.Spider): + custom_settings = {{ + "DOWNLOAD_DELAY": 0, + }} + + +class AsyncDefAsyncioReturnSpider(BaseSpider): name = "asyncdef_asyncio_return" async def parse(self, response): @@ -39,7 +47,7 @@ class AsyncDefAsyncioReturnSpider(scrapy.Spider): self.logger.info(f"Got response {{status}}") return [{{'id': 1}}, {{'id': 2}}] -class AsyncDefAsyncioReturnSingleElementSpider(scrapy.Spider): +class AsyncDefAsyncioReturnSingleElementSpider(BaseSpider): name = "asyncdef_asyncio_return_single_element" async def parse(self, response): @@ -48,7 +56,7 @@ class AsyncDefAsyncioReturnSingleElementSpider(scrapy.Spider): self.logger.info(f"Got response {{status}}") return {{'foo': 42}} -class AsyncDefAsyncioGenLoopSpider(scrapy.Spider): +class AsyncDefAsyncioGenLoopSpider(BaseSpider): name = "asyncdef_asyncio_gen_loop" async def parse(self, response): @@ -57,7 +65,7 @@ class AsyncDefAsyncioGenLoopSpider(scrapy.Spider): yield {{'foo': i}} self.logger.info(f"Got response {{response.status}}") -class AsyncDefAsyncioSpider(scrapy.Spider): +class AsyncDefAsyncioSpider(BaseSpider): name = "asyncdef_asyncio" async def parse(self, response): @@ -65,7 +73,7 @@ class AsyncDefAsyncioSpider(scrapy.Spider): status = await get_from_asyncio_queue(response.status) self.logger.debug(f"Got response {{status}}") -class AsyncDefAsyncioGenExcSpider(scrapy.Spider): +class AsyncDefAsyncioGenExcSpider(BaseSpider): name = "asyncdef_asyncio_gen_exc" async def parse(self, response): @@ -87,7 +95,8 @@ class MySpider(scrapy.Spider): custom_settings = {{ "DOWNLOADER_MIDDLEWARES": {{ CallbackSignatureDownloaderMiddleware: 0, - }} + }}, + "DOWNLOAD_DELAY": 0, }} def parse(self, response): @@ -120,6 +129,10 @@ class MySpider(scrapy.Spider): class MyGoodCrawlSpider(CrawlSpider): name = 'goodcrawl{self.spider_name}' + custom_settings = {{ + "DOWNLOAD_DELAY": 0, + }} + rules = ( Rule(LinkExtractor(allow=r'/html'), callback='parse_item', follow=True), Rule(LinkExtractor(allow=r'/text'), follow=True), @@ -136,6 +149,10 @@ class MyBadCrawlSpider(CrawlSpider): '''Spider which doesn't define a parse_item callback while using it in a rule.''' name = 'badcrawl{self.spider_name}' + custom_settings = {{ + "DOWNLOAD_DELAY": 0, + }} + rules = ( Rule(LinkExtractor(allow=r'/html'), callback='parse_item', follow=True), ) @@ -146,29 +163,29 @@ class MyBadCrawlSpider(CrawlSpider): encoding="utf-8", ) - (self.proj_mod_path / "pipelines.py").write_text( + (proj_mod_path / "pipelines.py").write_text( """ import logging class MyPipeline: component_name = 'my_pipeline' - def process_item(self, item, spider): + def process_item(self, item): logging.info('It Works!') return item """, encoding="utf-8", ) - with (self.proj_mod_path / "settings.py").open("a", encoding="utf-8") as f: + with (proj_mod_path / "settings.py").open("a", encoding="utf-8") as f: f.write( f""" ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} """ ) - def test_spider_arguments(self): - _, _, stderr = self.proc( + def test_spider_arguments(self, proj_path: Path, mockserver: MockServer) -> None: + _, _, stderr = proc( "parse", "--spider", self.spider_name, @@ -177,13 +194,14 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} "-c", "parse", "--verbose", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "DEBUG: It Works!" in stderr - def test_request_with_meta(self): + def test_request_with_meta(self, proj_path: Path, mockserver: MockServer) -> None: raw_json_string = '{"foo" : "baz"}' - _, _, stderr = self.proc( + _, _, stderr = proc( "parse", "--spider", self.spider_name, @@ -192,11 +210,12 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} "-c", "parse_request_with_meta", "--verbose", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "DEBUG: It Works!" in stderr - _, _, stderr = self.proc( + _, _, stderr = proc( "parse", "--spider", self.spider_name, @@ -205,13 +224,16 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} "-c", "parse_request_with_meta", "--verbose", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "DEBUG: It Works!" in stderr - def test_request_with_cb_kwargs(self): + def test_request_with_cb_kwargs( + self, proj_path: Path, mockserver: MockServer + ) -> None: raw_json_string = '{"foo" : "bar", "key": "value"}' - _, _, stderr = self.proc( + _, _, stderr = proc( "parse", "--spider", self.spider_name, @@ -220,7 +242,8 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} "-c", "parse_request_with_cb_kwargs", "--verbose", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "DEBUG: It Works!" in stderr assert ( @@ -228,20 +251,23 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} in stderr ) - def test_request_without_meta(self): - _, _, stderr = self.proc( + def test_request_without_meta( + self, proj_path: Path, mockserver: MockServer + ) -> None: + _, _, stderr = proc( "parse", "--spider", self.spider_name, "-c", "parse_request_without_meta", "--nolinks", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "DEBUG: It Works!" in stderr - def test_pipelines(self): - _, _, stderr = self.proc( + def test_pipelines(self, proj_path: Path, mockserver: MockServer) -> None: + _, _, stderr = proc( "parse", "--spider", self.spider_name, @@ -249,163 +275,210 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} "-c", "parse", "--verbose", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "INFO: It Works!" in stderr - def test_async_def_asyncio_parse_items_list(self): - _, out, stderr = self.proc( + def test_async_def_asyncio_parse_items_list( + self, proj_path: Path, mockserver: MockServer + ) -> None: + _, out, stderr = proc( "parse", "--spider", "asyncdef_asyncio_return", "-c", "parse", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "INFO: Got response 200" in stderr assert "{'id': 1}" in out assert "{'id': 2}" in out - def test_async_def_asyncio_parse_items_single_element(self): - _, out, stderr = self.proc( + def test_async_def_asyncio_parse_items_single_element( + self, proj_path: Path, mockserver: MockServer + ) -> None: + _, out, stderr = proc( "parse", "--spider", "asyncdef_asyncio_return_single_element", "-c", "parse", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "INFO: Got response 200" in stderr assert "{'foo': 42}" in out - def test_async_def_asyncgen_parse_loop(self): - _, out, stderr = self.proc( + def test_async_def_asyncgen_parse_loop( + self, proj_path: Path, mockserver: MockServer + ) -> None: + _, out, stderr = proc( "parse", "--spider", "asyncdef_asyncio_gen_loop", "-c", "parse", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "INFO: Got response 200" in stderr for i in range(10): assert f"{{'foo': {i}}}" in out - def test_async_def_asyncgen_parse_exc(self): - _, out, stderr = self.proc( + def test_async_def_asyncgen_parse_exc( + self, proj_path: Path, mockserver: MockServer + ) -> None: + _, out, stderr = proc( "parse", "--spider", "asyncdef_asyncio_gen_exc", "-c", "parse", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "ValueError" in stderr for i in range(7): assert f"{{'foo': {i}}}" in out - def test_async_def_asyncio_parse(self): - _, _, stderr = self.proc( + def test_async_def_asyncio_parse( + self, proj_path: Path, mockserver: MockServer + ) -> None: + _, _, stderr = proc( "parse", "--spider", "asyncdef_asyncio", "-c", "parse", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "DEBUG: Got response 200" in stderr - def test_parse_items(self): - _, out, _ = self.proc( + def test_parse_items(self, proj_path: Path, mockserver: MockServer) -> None: + _, out, _ = proc( "parse", "--spider", self.spider_name, "-c", "parse", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "[{}, {'foo': 'bar'}]" in out - def test_parse_items_no_callback_passed(self): - _, out, _ = self.proc( - "parse", "--spider", self.spider_name, self.mockserver.url("/html") + def test_parse_items_no_callback_passed( + self, proj_path: Path, mockserver: MockServer + ) -> None: + _, out, _ = proc( + "parse", + "--spider", + self.spider_name, + mockserver.url("/html"), + cwd=proj_path, ) assert "[{}, {'foo': 'bar'}]" in out - def test_wrong_callback_passed(self): - _, out, stderr = self.proc( + def test_wrong_callback_passed( + self, proj_path: Path, mockserver: MockServer + ) -> None: + _, out, stderr = proc( "parse", "--spider", self.spider_name, "-c", "dummy", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert re.search(r"# Scraped Items -+\r?\n\[\]", out) assert "Cannot find callback" in stderr - def test_crawlspider_matching_rule_callback_set(self): + def test_crawlspider_matching_rule_callback_set( + self, proj_path: Path, mockserver: MockServer + ) -> None: """If a rule matches the URL, use it's defined callback.""" - _, out, _ = self.proc( + _, out, _ = proc( "parse", "--spider", "goodcrawl" + self.spider_name, "-r", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert "[{}, {'foo': 'bar'}]" in out - def test_crawlspider_matching_rule_default_callback(self): + def test_crawlspider_matching_rule_default_callback( + self, proj_path: Path, mockserver: MockServer + ) -> None: """If a rule match but it has no callback set, use the 'parse' callback.""" - _, out, _ = self.proc( + _, out, _ = proc( "parse", "--spider", "goodcrawl" + self.spider_name, "-r", - self.mockserver.url("/text"), + mockserver.url("/text"), + cwd=proj_path, ) assert "[{}, {'nomatch': 'default'}]" in out - def test_spider_with_no_rules_attribute(self): + def test_spider_with_no_rules_attribute( + self, proj_path: Path, mockserver: MockServer + ) -> None: """Using -r with a spider with no rule should not produce items.""" - _, out, stderr = self.proc( - "parse", "--spider", self.spider_name, "-r", self.mockserver.url("/html") + _, out, stderr = proc( + "parse", + "--spider", + self.spider_name, + "-r", + mockserver.url("/html"), + cwd=proj_path, ) assert re.search(r"# Scraped Items -+\r?\n\[\]", out) assert "No CrawlSpider rules found" in stderr - def test_crawlspider_missing_callback(self): - _, out, _ = self.proc( + def test_crawlspider_missing_callback( + self, proj_path: Path, mockserver: MockServer + ) -> None: + _, out, _ = proc( "parse", "--spider", "badcrawl" + self.spider_name, "-r", - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert re.search(r"# Scraped Items -+\r?\n\[\]", out) - def test_crawlspider_no_matching_rule(self): + def test_crawlspider_no_matching_rule( + self, proj_path: Path, mockserver: MockServer + ) -> None: """The requested URL has no matching rule, so no items should be scraped""" - _, out, stderr = self.proc( + _, out, stderr = proc( "parse", "--spider", "badcrawl" + self.spider_name, "-r", - self.mockserver.url("/enc-gb18030"), + mockserver.url("/enc-gb18030"), + cwd=proj_path, ) assert re.search(r"# Scraped Items -+\r?\n\[\]", out) assert "Cannot find a rule that matches" in stderr - def test_crawlspider_not_exists_with_not_matched_url(self): - assert self.call("parse", self.mockserver.url("/invalid_url")) == 0 + def test_crawlspider_not_exists_with_not_matched_url( + self, proj_path: Path, mockserver: MockServer + ) -> None: + assert call("parse", mockserver.url("/invalid_url"), cwd=proj_path) == 0 - def test_output_flag(self): + def test_output_flag(self, proj_path: Path, mockserver: MockServer) -> None: """Checks if a file was created successfully having correct format containing correct data in it. """ file_name = "data.json" - file_path = Path(self.proj_path, file_name) - self.proc( + file_path = proj_path / file_name + proc( "parse", "--spider", self.spider_name, @@ -413,7 +486,8 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} "parse", "-o", file_name, - self.mockserver.url("/html"), + mockserver.url("/html"), + cwd=proj_path, ) assert file_path.exists() @@ -439,3 +513,19 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} assert namespace.depth == 2 assert namespace.spider == self.spider_name assert namespace.verbose + + def test_no_reactor(self, proj_path: Path, mockserver: MockServer) -> None: + _, out, stderr = proc( + "parse", + "--spider", + "asyncdef_asyncio_return", + "-c", + "parse", + mockserver.url("/html"), + "-s", + "TWISTED_REACTOR_ENABLED=False", + cwd=proj_path, + ) + assert "INFO: Got response 200" in stderr + assert "{'id': 1}" in out + assert "{'id': 2}" in out diff --git a/tests/test_command_runspider.py b/tests/test_command_runspider.py index c1a6d9b18..b1455611e 100644 --- a/tests/test_command_runspider.py +++ b/tests/test_command_runspider.py @@ -1,23 +1,22 @@ from __future__ import annotations +import asyncio import inspect import platform import sys -from contextlib import contextmanager -from pathlib import Path -from tempfile import TemporaryDirectory, mkdtemp from typing import TYPE_CHECKING import pytest -from tests.test_commands import TestCommandBase from tests.test_crawler import ExceptionSpider, NoRequestsSpider +from tests.utils.cmdline import proc if TYPE_CHECKING: - from collections.abc import Iterator + from collections.abc import Iterable + from pathlib import Path -class TestRunSpiderCommand(TestCommandBase): +class TestRunSpiderCommand: spider_filename = "myspider.py" debug_log_spider = """ @@ -42,26 +41,21 @@ class BadSpider(scrapy.Spider): yield """ - @contextmanager - def _create_file(self, content: str, name: str | None = None) -> Iterator[str]: - with TemporaryDirectory() as tmpdir: - if name: - fname = Path(tmpdir, name).resolve() - else: - fname = Path(tmpdir, self.spider_filename).resolve() - fname.write_text(content, encoding="utf-8") - yield str(fname) + def runspider( + self, cwd: Path, code: str, name: str | None = None, args: Iterable[str] = () + ) -> tuple[int, str, str]: + fname = cwd / (name or self.spider_filename) + fname.write_text(code, encoding="utf-8") + return proc("runspider", str(fname), *args, cwd=cwd) - def runspider(self, code, name=None, args=()): - with self._create_file(code, name) as fname: - return self.proc("runspider", fname, *args) - - def get_log(self, code, name=None, args=()): - _, _, stderr = self.runspider(code, name, args=args) + def get_log( + self, cwd: Path, code: str, name: str | None = None, args: Iterable[str] = () + ) -> str: + _, _, stderr = self.runspider(cwd, code, name, args=args) return stderr - def test_runspider(self): - log = self.get_log(self.debug_log_spider) + def test_runspider(self, tmp_path: Path) -> None: + log = self.get_log(tmp_path, self.debug_log_spider) assert "DEBUG: It Works!" in log assert ( "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" @@ -69,27 +63,29 @@ class BadSpider(scrapy.Spider): ) assert "INFO: Spider closed (finished)" in log - def test_run_fail_spider(self): - proc, _, _ = self.runspider( - "import scrapy\n" + inspect.getsource(ExceptionSpider) + def test_run_fail_spider(self, tmp_path: Path) -> None: + ret, _, _ = self.runspider( + tmp_path, "import scrapy\n" + inspect.getsource(ExceptionSpider) ) - ret = proc.returncode assert ret != 0 - def test_run_good_spider(self): - proc, _, _ = self.runspider( - "import scrapy\n" + inspect.getsource(NoRequestsSpider) + def test_run_good_spider(self, tmp_path: Path) -> None: + ret, _, _ = self.runspider( + tmp_path, "import scrapy\n" + inspect.getsource(NoRequestsSpider) ) - ret = proc.returncode assert ret == 0 - def test_runspider_log_level(self): - log = self.get_log(self.debug_log_spider, args=("-s", "LOG_LEVEL=INFO")) + def test_runspider_log_level(self, tmp_path: Path) -> None: + log = self.get_log( + tmp_path, self.debug_log_spider, args=("-s", "LOG_LEVEL=INFO") + ) assert "DEBUG: It Works!" not in log assert "INFO: Spider opened" in log - def test_runspider_default_reactor(self): - log = self.get_log(self.debug_log_spider, args=("-s", "TWISTED_REACTOR=")) + def test_runspider_default_reactor(self, tmp_path: Path) -> None: + log = self.get_log( + tmp_path, self.debug_log_spider, args=("-s", "TWISTED_REACTOR=") + ) assert "DEBUG: It Works!" in log assert ( "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" @@ -99,7 +95,7 @@ class BadSpider(scrapy.Spider): assert "INFO: Closing spider (finished)" in log assert "INFO: Spider closed (finished)" in log - def test_runspider_dnscache_disabled(self): + def test_runspider_dnscache_disabled(self, tmp_path: Path) -> None: # see https://github.com/scrapy/scrapy/issues/2811 # The spider below should not be able to connect to localhost:12345, # which is intended, @@ -112,43 +108,49 @@ class MySpider(scrapy.Spider): name = 'myspider' start_urls = ['http://localhost:12345'] + custom_settings = { + "ROBOTSTXT_OBEY": False, + "RETRY_ENABLED": False, + } + def parse(self, response): return {'test': 'value'} """ - log = self.get_log(dnscache_spider, args=("-s", "DNSCACHE_ENABLED=False")) - assert "DNSLookupError" not in log + log = self.get_log( + tmp_path, dnscache_spider, args=("-s", "DNSCACHE_ENABLED=False") + ) + assert "CannotResolveHostError" not in log assert "INFO: Spider opened" in log - def test_runspider_log_short_names(self): - log1 = self.get_log(self.debug_log_spider, args=("-s", "LOG_SHORT_NAMES=1")) + @pytest.mark.parametrize("value", [False, True]) + def test_runspider_log_short_names(self, tmp_path: Path, value: bool) -> None: + log1 = self.get_log( + tmp_path, self.debug_log_spider, args=("-s", f"LOG_SHORT_NAMES={value}") + ) assert "[myspider] DEBUG: It Works!" in log1 - assert "[scrapy]" in log1 - assert "[scrapy.core.engine]" not in log1 + assert ("[scrapy]" in log1) is value + assert ("[scrapy.core.engine]" in log1) is not value - log2 = self.get_log(self.debug_log_spider, args=("-s", "LOG_SHORT_NAMES=0")) - assert "[myspider] DEBUG: It Works!" in log2 - assert "[scrapy]" not in log2 - assert "[scrapy.core.engine]" in log2 - - def test_runspider_no_spider_found(self): - log = self.get_log("from scrapy.spiders import Spider\n") + def test_runspider_no_spider_found(self, tmp_path: Path) -> None: + log = self.get_log(tmp_path, "from scrapy.spiders import Spider\n") assert "No spider found in file" in log - def test_runspider_file_not_found(self): - _, _, log = self.proc("runspider", "some_non_existent_file") + def test_runspider_file_not_found(self) -> None: + _, _, log = proc("runspider", "some_non_existent_file") assert "File not found: some_non_existent_file" in log - def test_runspider_unable_to_load(self): - log = self.get_log("", name="myspider.txt") + def test_runspider_unable_to_load(self, tmp_path: Path) -> None: + log = self.get_log(tmp_path, "", name="myspider.txt") assert "Unable to load" in log - def test_start_errors(self): - log = self.get_log(self.badspider, name="badspider.py") + def test_start_errors(self, tmp_path: Path) -> None: + log = self.get_log(tmp_path, self.badspider, name="badspider.py") assert "start" in log assert "badspider.py" in log, log - def test_asyncio_enabled_true(self): + def test_asyncio_enabled_true(self, tmp_path: Path) -> None: log = self.get_log( + tmp_path, self.debug_log_spider, args=[ "-s", @@ -160,15 +162,16 @@ class MySpider(scrapy.Spider): in log ) - def test_asyncio_enabled_default(self): - log = self.get_log(self.debug_log_spider, args=[]) + def test_asyncio_enabled_default(self, tmp_path: Path) -> None: + log = self.get_log(tmp_path, self.debug_log_spider) assert ( "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" in log ) - def test_asyncio_enabled_false(self): + def test_asyncio_enabled_false(self, tmp_path: Path) -> None: log = self.get_log( + tmp_path, self.debug_log_spider, args=["-s", "TWISTED_REACTOR=twisted.internet.selectreactor.SelectReactor"], ) @@ -179,8 +182,9 @@ class MySpider(scrapy.Spider): ) @pytest.mark.requires_uvloop - def test_custom_asyncio_loop_enabled_true(self): + def test_custom_asyncio_loop_enabled_true(self, tmp_path: Path) -> None: log = self.get_log( + tmp_path, self.debug_log_spider, args=[ "-s", @@ -191,16 +195,15 @@ class MySpider(scrapy.Spider): ) assert "Using asyncio event loop: uvloop.Loop" in log - def test_custom_asyncio_loop_enabled_false(self): + def test_custom_asyncio_loop_enabled_false(self, tmp_path: Path) -> None: log = self.get_log( + tmp_path, self.debug_log_spider, args=[ "-s", "TWISTED_REACTOR=twisted.internet.asyncioreactor.AsyncioSelectorReactor", ], ) - import asyncio - if sys.platform != "win32": loop = asyncio.new_event_loop() else: @@ -210,7 +213,18 @@ class MySpider(scrapy.Spider): in log ) - def test_output(self): + def test_no_reactor(self, tmp_path: Path) -> None: + log = self.get_log( + tmp_path, + self.debug_log_spider, + args=[ + "-s", + "TWISTED_REACTOR_ENABLED=False", + ], + ) + assert "Not using a Twisted reactor" in log + + def test_output(self, tmp_path: Path) -> None: spider_code = """ import scrapy @@ -223,10 +237,10 @@ class MySpider(scrapy.Spider): yield """ args = ["-o", "example.json"] - log = self.get_log(spider_code, args=args) + log = self.get_log(tmp_path, spider_code, args=args) assert "[myspider] DEBUG: FEEDS: {'example.json': {'format': 'json'}}" in log - def test_overwrite_output(self): + def test_overwrite_output(self, tmp_path: Path) -> None: spider_code = """ import json import scrapy @@ -243,18 +257,18 @@ class MySpider(scrapy.Spider): return yield """ - Path(self.cwd, "example.json").write_text("not empty", encoding="utf-8") + (tmp_path / "example.json").write_text("not empty", encoding="utf-8") args = ["-O", "example.json"] - log = self.get_log(spider_code, args=args) + log = self.get_log(tmp_path, spider_code, args=args) assert ( '[myspider] DEBUG: FEEDS: {"example.json": {"format": "json", "overwrite": true}}' in log ) - with Path(self.cwd, "example.json").open(encoding="utf-8") as f2: + with (tmp_path / "example.json").open(encoding="utf-8") as f2: first_line = f2.readline() assert first_line != "not empty" - def test_output_and_overwrite_output(self): + def test_output_and_overwrite_output(self, tmp_path: Path) -> None: spider_code = """ import scrapy @@ -266,12 +280,12 @@ class MySpider(scrapy.Spider): yield """ args = ["-o", "example1.json", "-O", "example2.json"] - log = self.get_log(spider_code, args=args) + log = self.get_log(tmp_path, spider_code, args=args) assert ( "error: Please use only one of -o/--output and -O/--overwrite-output" in log ) - def test_output_stdout(self): + def test_output_stdout(self, tmp_path: Path) -> None: spider_code = """ import scrapy @@ -284,11 +298,11 @@ class MySpider(scrapy.Spider): yield """ args = ["-o", "-:json"] - log = self.get_log(spider_code, args=args) + log = self.get_log(tmp_path, spider_code, args=args) assert "[myspider] DEBUG: FEEDS: {'stdout:': {'format': 'json'}}" in log - @pytest.mark.skipif(platform.system() == "Windows", reason="Linux only") - def test_absolute_path_linux(self): + @pytest.mark.parametrize("arg", ["output.json:json", "output.json"]) + def test_absolute_path(self, tmp_path: Path, arg: str) -> None: spider_code = """ import scrapy @@ -300,52 +314,15 @@ class MySpider(scrapy.Spider): def parse(self, response): yield {"hello": "world"} """ - temp_dir = mkdtemp() - args = ["-o", f"{temp_dir}/output1.json:json"] - log = self.get_log(spider_code, args=args) + args = ["-o", str(tmp_path / arg)] + log = self.get_log(tmp_path, spider_code, args=args) assert ( - f"[scrapy.extensions.feedexport] INFO: Stored json feed (1 items) in: {temp_dir}/output1.json" + f"[scrapy.extensions.feedexport] INFO: Stored json feed (1 items) in: {tmp_path / 'output.json'}" in log ) - args = ["-o", f"{temp_dir}/output2.json"] - log = self.get_log(spider_code, args=args) - assert ( - f"[scrapy.extensions.feedexport] INFO: Stored json feed (1 items) in: {temp_dir}/output2.json" - in log - ) - - @pytest.mark.skipif(platform.system() != "Windows", reason="Windows only") - def test_absolute_path_windows(self): - spider_code = """ -import scrapy - -class MySpider(scrapy.Spider): - name = 'myspider' - - start_urls = ["data:,"] - - def parse(self, response): - yield {"hello": "world"} - """ - temp_dir = mkdtemp() - - args = ["-o", f"{temp_dir}\\output1.json:json"] - log = self.get_log(spider_code, args=args) - assert ( - f"[scrapy.extensions.feedexport] INFO: Stored json feed (1 items) in: {temp_dir}\\output1.json" - in log - ) - - args = ["-o", f"{temp_dir}\\output2.json"] - log = self.get_log(spider_code, args=args) - assert ( - f"[scrapy.extensions.feedexport] INFO: Stored json feed (1 items) in: {temp_dir}\\output2.json" - in log - ) - - def test_args_change_settings(self): + def test_args_change_settings(self, tmp_path: Path) -> None: spider_code = """ import scrapy @@ -364,7 +341,7 @@ class MySpider(scrapy.Spider): yield """ args = ["-a", "foo=42"] - log = self.get_log(spider_code, args=args) + log = self.get_log(tmp_path, spider_code, args=args) assert "Spider closed (finished)" in log assert "The value of FOO is 42" in log @@ -375,10 +352,10 @@ class MySpider(scrapy.Spider): class TestWindowsRunSpiderCommand(TestRunSpiderCommand): spider_filename = "myspider.pyw" - def test_start_errors(self): - log = self.get_log(self.badspider, name="badspider.pyw") + def test_start_errors(self, tmp_path: Path) -> None: + log = self.get_log(tmp_path, self.badspider, name="badspider.pyw") assert "start" in log assert "badspider.pyw" in log - def test_runspider_unable_to_load(self): + def test_runspider_unable_to_load(self, tmp_path: Path) -> None: pytest.skip("Already Tested in 'RunSpiderCommandTest'") diff --git a/tests/test_command_shell.py b/tests/test_command_shell.py index 76c1eb663..1585835cc 100644 --- a/tests/test_command_shell.py +++ b/tests/test_command_shell.py @@ -1,145 +1,147 @@ +from __future__ import annotations + import os import sys from io import BytesIO from pathlib import Path +from typing import TYPE_CHECKING import pytest from pexpect.popen_spawn import PopenSpawn from scrapy.utils.reactor import _asyncio_reactor_path from tests import NON_EXISTING_RESOLVABLE, tests_datadir -from tests.mockserver import MockServer -from tests.test_commands import TestProjectBase +from tests.utils.cmdline import proc + +if TYPE_CHECKING: + from tests.mockserver.http import MockServer -class TestShellCommand(TestProjectBase): - @classmethod - def setup_class(cls): - cls.mockserver = MockServer() - cls.mockserver.__enter__() - - @classmethod - def teardown_class(cls): - cls.mockserver.__exit__(None, None, None) - - def test_empty(self): - _, out, _ = self.proc("shell", "-c", "item") +class TestShellCommand: + def test_empty(self) -> None: + _, out, _ = proc("shell", "-c", "item") assert "{}" in out - def test_response_body(self): - _, out, _ = self.proc( - "shell", self.mockserver.url("/text"), "-c", "response.body" + def test_empty_no_reactor(self) -> None: + _, out, _ = proc( + "shell", "-c", "item", "--set", "TWISTED_REACTOR_ENABLED=False" ) + assert "{}" in out + + def test_response_body(self, mockserver: MockServer) -> None: + _, out, _ = proc("shell", mockserver.url("/text"), "-c", "response.body") assert "Works" in out - def test_response_type_text(self): - _, out, _ = self.proc( - "shell", self.mockserver.url("/text"), "-c", "type(response)" - ) + def test_response_type_text(self, mockserver: MockServer) -> None: + _, out, _ = proc("shell", mockserver.url("/text"), "-c", "type(response)") assert "TextResponse" in out - def test_response_type_html(self): - _, out, _ = self.proc( - "shell", self.mockserver.url("/html"), "-c", "type(response)" - ) + def test_response_type_html(self, mockserver: MockServer) -> None: + _, out, _ = proc("shell", mockserver.url("/html"), "-c", "type(response)") assert "HtmlResponse" in out - def test_response_selector_html(self): + def test_response_selector_html(self, mockserver: MockServer) -> None: xpath = "response.xpath(\"//p[@class='one']/text()\").get()" - _, out, _ = self.proc("shell", self.mockserver.url("/html"), "-c", xpath) + _, out, _ = proc("shell", mockserver.url("/html"), "-c", xpath) assert out.strip() == "Works" - def test_response_encoding_gb18030(self): - _, out, _ = self.proc( - "shell", self.mockserver.url("/enc-gb18030"), "-c", "response.encoding" + def test_response_encoding_gb18030(self, mockserver: MockServer) -> None: + _, out, _ = proc( + "shell", mockserver.url("/enc-gb18030"), "-c", "response.encoding" ) assert out.strip() == "gb18030" - def test_redirect(self): - _, out, _ = self.proc( - "shell", self.mockserver.url("/redirect"), "-c", "response.url" - ) + def test_redirect(self, mockserver: MockServer) -> None: + _, out, _ = proc("shell", mockserver.url("/redirect"), "-c", "response.url") assert out.strip().endswith("/redirected") - def test_redirect_follow_302(self): - _, out, _ = self.proc( + def test_redirect_follow_302(self, mockserver: MockServer) -> None: + _, out, _ = proc( "shell", - self.mockserver.url("/redirect-no-meta-refresh"), + mockserver.url("/redirect-no-meta-refresh"), "-c", "response.status", ) assert out.strip().endswith("200") - def test_redirect_not_follow_302(self): - _, out, _ = self.proc( + def test_redirect_not_follow_302(self, mockserver: MockServer) -> None: + _, out, _ = proc( "shell", "--no-redirect", - self.mockserver.url("/redirect-no-meta-refresh"), + mockserver.url("/redirect-no-meta-refresh"), "-c", "response.status", ) assert out.strip().endswith("302") - def test_fetch_redirect_follow_302(self): + def test_fetch_redirect_follow_302(self, mockserver: MockServer) -> None: """Test that calling ``fetch(url)`` follows HTTP redirects by default.""" - url = self.mockserver.url("/redirect-no-meta-refresh") + url = mockserver.url("/redirect-no-meta-refresh") code = f"fetch('{url}')" - p, out, errout = self.proc("shell", "-c", code) - assert p.returncode == 0, out - assert "Redirecting (302)" in errout - assert "Crawled (200)" in errout + ret, out, err = proc("shell", "-c", code) + assert ret == 0, out + assert "Redirecting (302)" in err + assert "Crawled (200)" in err - def test_fetch_redirect_not_follow_302(self): + def test_fetch_redirect_not_follow_302(self, mockserver: MockServer) -> None: """Test that calling ``fetch(url, redirect=False)`` disables automatic redirects.""" - url = self.mockserver.url("/redirect-no-meta-refresh") + url = mockserver.url("/redirect-no-meta-refresh") code = f"fetch('{url}', redirect=False)" - p, out, errout = self.proc("shell", "-c", code) - assert p.returncode == 0, out - assert "Crawled (302)" in errout + ret, out, err = proc("shell", "-c", code) + assert ret == 0, out + assert "Crawled (302)" in err - def test_request_replace(self): - url = self.mockserver.url("/text") + def test_request_replace(self, mockserver: MockServer) -> None: + url = mockserver.url("/text") code = f"fetch('{url}') or fetch(response.request.replace(method='POST'))" - p, out, _ = self.proc("shell", "-c", code) - assert p.returncode == 0, out + ret, out, _ = proc("shell", "-c", code) + assert ret == 0, out - def test_scrapy_import(self): - url = self.mockserver.url("/text") + def test_scrapy_import(self, mockserver: MockServer) -> None: + url = mockserver.url("/text") code = f"fetch(scrapy.Request('{url}'))" - p, out, _ = self.proc("shell", "-c", code) - assert p.returncode == 0, out + ret, out, _ = proc("shell", "-c", code) + assert ret == 0, out - def test_local_file(self): + def test_local_file(self) -> None: filepath = Path(tests_datadir, "test_site", "index.html") - _, out, _ = self.proc("shell", str(filepath), "-c", "item") + _, out, _ = proc("shell", str(filepath), "-c", "item") assert "{}" in out - def test_local_nofile(self): + def test_local_nofile(self) -> None: filepath = "file:///tests/sample_data/test_site/nothinghere.html" - p, out, err = self.proc("shell", filepath, "-c", "item") - assert p.returncode == 1, out or err + ret, out, err = proc("shell", filepath, "-c", "item") + assert ret == 1, out or err assert "No such file or directory" in err - def test_dns_failures(self): + def test_dns_failures(self, mockserver: MockServer) -> None: if NON_EXISTING_RESOLVABLE: pytest.skip("Non-existing hosts are resolvable") url = "www.somedomainthatdoesntexi.st" - p, out, err = self.proc("shell", url, "-c", "item") - assert p.returncode == 1, out or err - assert "DNS lookup failed" in err + ret, out, err = proc("shell", url, "-c", "item") + assert ret == 1, out or err + assert "CannotResolveHostError" in err - def test_shell_fetch_async(self): - url = self.mockserver.url("/html") + def test_shell_fetch_async(self, mockserver: MockServer) -> None: + url = mockserver.url("/html") code = f"fetch('{url}')" - p, _, err = self.proc( + ret, _, err = proc( "shell", "-c", code, "--set", f"TWISTED_REACTOR={_asyncio_reactor_path}" ) - assert p.returncode == 0, err + assert ret == 0, err assert "RuntimeError: There is no current event loop in thread" not in err + def test_shell_fetch_no_reactor(self, mockserver: MockServer) -> None: + url = mockserver.url("/html") + code = f"fetch('{url}')" + ret, _, err = proc( + "shell", "-c", code, "--set", "TWISTED_REACTOR_ENABLED=False" + ) + assert ret == 0, err + class TestInteractiveShell: - def test_fetch(self): + def test_fetch(self, mockserver: MockServer) -> None: args = ( sys.executable, "-m", @@ -152,11 +154,10 @@ class TestInteractiveShell: p = PopenSpawn(args, env=env, timeout=5) p.logfile_read = logfile p.expect_exact("Available Scrapy objects") - with MockServer() as mockserver: - p.sendline(f"fetch('{mockserver.url('/')}')") - p.sendline("type(response)") - p.expect_exact("HtmlResponse") + p.sendline(f"fetch('{mockserver.url('/')}')") + p.sendline("type(response)") + p.expect_exact("HtmlResponse") p.sendeof() - p.wait() + p.wait() # type: ignore[no-untyped-call] logfile.seek(0) assert "Traceback" not in logfile.read().decode() diff --git a/tests/test_command_startproject.py b/tests/test_command_startproject.py index 1edef0b4a..7ac6c4fb0 100644 --- a/tests/test_command_startproject.py +++ b/tests/test_command_startproject.py @@ -8,78 +8,78 @@ from itertools import chain from pathlib import Path from shutil import copytree from stat import S_IWRITE as ANYONE_WRITE_PERMISSION -from tempfile import mkdtemp import scrapy from scrapy.commands.startproject import IGNORE -from tests.test_commands import TestProjectBase +from scrapy.utils.test import get_testenv +from tests.utils.cmdline import call, proc -class TestStartprojectCommand(TestProjectBase): - def test_startproject(self): - p, out, err = self.proc("startproject", self.project_name) - print(out) - print(err, file=sys.stderr) - assert p.returncode == 0 +class TestStartprojectCommand: + project_name = "testproject" - assert Path(self.proj_path, "scrapy.cfg").exists() - assert Path(self.proj_path, "testproject").exists() - assert Path(self.proj_mod_path, "__init__.py").exists() - assert Path(self.proj_mod_path, "items.py").exists() - assert Path(self.proj_mod_path, "pipelines.py").exists() - assert Path(self.proj_mod_path, "settings.py").exists() - assert Path(self.proj_mod_path, "spiders", "__init__.py").exists() + @staticmethod + def _assert_files_exist(project_dir: Path, project_name: str) -> None: + assert (project_dir / "scrapy.cfg").exists() + assert (project_dir / project_name).exists() + assert (project_dir / project_name / "__init__.py").exists() + assert (project_dir / project_name / "items.py").exists() + assert (project_dir / project_name / "pipelines.py").exists() + assert (project_dir / project_name / "settings.py").exists() + assert (project_dir / project_name / "spiders" / "__init__.py").exists() - assert self.call("startproject", self.project_name) == 1 - assert self.call("startproject", "wrong---project---name") == 1 - assert self.call("startproject", "sys") == 1 + def test_startproject(self, tmp_path: Path) -> None: + # with no dir argument creates the project in the "self.project_name" subdir of cwd + assert call("startproject", self.project_name, cwd=tmp_path) == 0 + self._assert_files_exist(tmp_path / self.project_name, self.project_name) - def test_startproject_with_project_dir(self): - project_dir = mkdtemp() - assert self.call("startproject", self.project_name, project_dir) == 0 + assert call("startproject", self.project_name, cwd=tmp_path) == 1 + assert call("startproject", "wrong---project---name") == 1 + assert call("startproject", "sys") == 1 - assert Path(project_dir, "scrapy.cfg").exists() - assert Path(project_dir, "testproject").exists() - assert Path(project_dir, self.project_name, "__init__.py").exists() - assert Path(project_dir, self.project_name, "items.py").exists() - assert Path(project_dir, self.project_name, "pipelines.py").exists() - assert Path(project_dir, self.project_name, "settings.py").exists() - assert Path(project_dir, self.project_name, "spiders", "__init__.py").exists() - - assert self.call("startproject", self.project_name, project_dir + "2") == 0 - - assert self.call("startproject", self.project_name, project_dir) == 1 - assert self.call("startproject", self.project_name + "2", project_dir) == 1 - assert self.call("startproject", "wrong---project---name") == 1 - assert self.call("startproject", "sys") == 1 - assert self.call("startproject") == 2 + def test_startproject_with_project_dir(self, tmp_path: Path) -> None: + # with a dir arg creates the project in the specified dir + project_dir = tmp_path / "project" assert ( - self.call("startproject", self.project_name, project_dir, "another_params") + call("startproject", self.project_name, str(project_dir), cwd=tmp_path) == 0 + ) + self._assert_files_exist(project_dir, self.project_name) + + assert ( + call( + "startproject", self.project_name, str(project_dir) + "2", cwd=tmp_path + ) + == 0 + ) + + assert ( + call("startproject", self.project_name, str(project_dir), cwd=tmp_path) == 1 + ) + assert ( + call( + "startproject", self.project_name + "2", str(project_dir), cwd=tmp_path + ) + == 1 + ) + assert call("startproject", "wrong---project---name") == 1 + assert call("startproject", "sys") == 1 + assert call("startproject") == 2 + assert ( + call("startproject", self.project_name, str(project_dir), "another_params") == 2 ) - def test_existing_project_dir(self): - project_dir = mkdtemp() + def test_existing_project_dir(self, tmp_path: Path) -> None: project_name = self.project_name + "_existing" - project_path = Path(project_dir, project_name) + project_path = tmp_path / project_name project_path.mkdir() - p, out, err = self.proc("startproject", project_name, cwd=project_dir) - print(out) - print(err, file=sys.stderr) - assert p.returncode == 0 - - assert Path(project_path, "scrapy.cfg").exists() - assert Path(project_path, project_name).exists() - assert Path(project_path, project_name, "__init__.py").exists() - assert Path(project_path, project_name, "items.py").exists() - assert Path(project_path, project_name, "pipelines.py").exists() - assert Path(project_path, project_name, "settings.py").exists() - assert Path(project_path, project_name, "spiders", "__init__.py").exists() + assert call("startproject", project_name, cwd=tmp_path) == 0 + self._assert_files_exist(project_path, project_name) def get_permissions_dict( - path: str | os.PathLike, renamings=None, ignore=None + path: str | os.PathLike[str], renamings=None, ignore=None ) -> dict[str, str]: def get_permissions(path: Path) -> str: return oct(path.stat().st_mode) @@ -105,26 +105,22 @@ def get_permissions_dict( return permissions_dict -class TestStartprojectTemplates(TestProjectBase): - def setup_method(self): - super().setup_method() - self.tmpl = str(Path(self.temp_path, "templates")) - self.tmpl_proj = str(Path(self.tmpl, "project")) +class TestStartprojectTemplates: + def test_startproject_template_override(self, tmp_path: Path) -> None: + tmpl = tmp_path / "templates" + tmpl_proj = tmpl / "project" + project_name = "testproject" - def test_startproject_template_override(self): - copytree(Path(scrapy.__path__[0], "templates"), self.tmpl) - Path(self.tmpl_proj, "root_template").write_bytes(b"") - assert Path(self.tmpl_proj, "root_template").exists() + copytree(Path(scrapy.__path__[0], "templates"), tmpl) + (tmpl_proj / "root_template").write_bytes(b"") - args = ["--set", f"TEMPLATES_DIR={self.tmpl}"] - p, out, err = self.proc("startproject", self.project_name, *args) - assert ( - f"New Scrapy project '{self.project_name}', using template directory" in out - ) - assert self.tmpl_proj in out - assert Path(self.proj_path, "root_template").exists() + args = ["--set", f"TEMPLATES_DIR={tmpl}"] + _, out, _ = proc("startproject", project_name, *args, cwd=tmp_path) + assert f"New Scrapy project '{project_name}', using template directory" in out + assert str(tmpl_proj) in out + assert (tmp_path / project_name / "root_template").exists() - def test_startproject_permissions_from_writable(self): + def test_startproject_permissions_from_writable(self, tmp_path: Path) -> None: """Check that generated files have the right permissions when the template folder has the same permissions as in the project, i.e. everything is writable.""" @@ -141,7 +137,8 @@ class TestStartprojectTemplates(TestProjectBase): IGNORE, ) - destination = mkdtemp() + destination = tmp_path / "proj" + destination.mkdir() process = subprocess.Popen( ( sys.executable, @@ -151,16 +148,18 @@ class TestStartprojectTemplates(TestProjectBase): project_name, ), cwd=destination, - env=self.env, + stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL, + env=get_testenv(), ) process.wait() - project_dir = Path(destination, project_name) + project_dir = destination / project_name actual_permissions = get_permissions_dict(project_dir) assert actual_permissions == expected_permissions - def test_startproject_permissions_from_read_only(self): + def test_startproject_permissions_from_read_only(self, tmp_path: Path) -> None: """Check that generated files have the right permissions when the template folder has been made read-only, which is something that some systems do. @@ -185,35 +184,34 @@ class TestStartprojectTemplates(TestProjectBase): current_permissions = path.stat().st_mode path.chmod(current_permissions & ~ANYONE_WRITE_PERMISSION) - read_only_templates_dir = str(Path(mkdtemp()) / "templates") + read_only_templates_dir = tmp_path / "templates" copytree(templates_dir, read_only_templates_dir) for root, dirs, files in os.walk(read_only_templates_dir): for node in chain(dirs, files): _make_read_only(Path(root, node)) - destination = mkdtemp() - process = subprocess.Popen( - ( - sys.executable, - "-m", - "scrapy.cmdline", + destination = tmp_path / "proj" + destination.mkdir() + assert ( + call( "startproject", project_name, "--set", f"TEMPLATES_DIR={read_only_templates_dir}", - ), - cwd=destination, - env=self.env, + cwd=destination, + ) + == 0 ) - process.wait() - project_dir = Path(destination, project_name) + project_dir = destination / project_name actual_permissions = get_permissions_dict(project_dir) assert actual_permissions == expected_permissions - def test_startproject_permissions_unchanged_in_destination(self): + def test_startproject_permissions_unchanged_in_destination( + self, tmp_path: Path + ) -> None: """Check that preexisting folders and files in the destination folder do not see their permissions modified.""" scrapy_path = scrapy.__path__[0] @@ -229,11 +227,12 @@ class TestStartprojectTemplates(TestProjectBase): IGNORE, ) - destination = mkdtemp() - project_dir = Path(destination, project_name) + destination = tmp_path / "proj" + project_dir = destination / project_name + project_dir.mkdir(parents=True) existing_nodes = { - oct(permissions)[2:] + extension: permissions + f"{permissions:o}{extension}": permissions for extension in ("", ".d") for permissions in ( 0o444, @@ -244,7 +243,6 @@ class TestStartprojectTemplates(TestProjectBase): 0o777, ) } - project_dir.mkdir() for node, permissions in existing_nodes.items(): path = project_dir / node if node.endswith(".d"): @@ -253,25 +251,13 @@ class TestStartprojectTemplates(TestProjectBase): path.touch(mode=permissions) expected_permissions[node] = oct(path.stat().st_mode) - process = subprocess.Popen( - ( - sys.executable, - "-m", - "scrapy.cmdline", - "startproject", - project_name, - ".", - ), - cwd=project_dir, - env=self.env, - ) - process.wait() + assert call("startproject", project_name, ".", cwd=project_dir) == 0 actual_permissions = get_permissions_dict(project_dir) assert actual_permissions == expected_permissions - def test_startproject_permissions_umask_022(self): + def test_startproject_permissions_umask_002(self, tmp_path: Path) -> None: """Check that generated files have the right permissions when the system uses a umask value that causes new files to have different permissions than those from the template folder.""" @@ -296,21 +282,11 @@ class TestStartprojectTemplates(TestProjectBase): ) with umask(0o002): - destination = mkdtemp() - process = subprocess.Popen( - ( - sys.executable, - "-m", - "scrapy.cmdline", - "startproject", - project_name, - ), - cwd=destination, - env=self.env, - ) - process.wait() + destination = tmp_path / "proj" + destination.mkdir() + assert call("startproject", project_name, cwd=destination) == 0 - project_dir = Path(destination, project_name) + project_dir = destination / project_name actual_permissions = get_permissions_dict(project_dir) assert actual_permissions == expected_permissions diff --git a/tests/test_command_version.py b/tests/test_command_version.py index de58203fc..c4ca9d07b 100644 --- a/tests/test_command_version.py +++ b/tests/test_command_version.py @@ -1,14 +1,14 @@ import scrapy -from tests.test_commands import TestProjectBase +from tests.utils.cmdline import proc -class TestVersionCommand(TestProjectBase): - def test_output(self): - _, out, _ = self.proc("version") +class TestVersionCommand: + def test_output(self) -> None: + _, out, _ = proc("version") assert out.strip() == f"Scrapy {scrapy.__version__}" - def test_verbose_output(self): - _, out, _ = self.proc("version", "-v") + def test_verbose_output(self) -> None: + _, out, _ = proc("version", "-v") headers = [line.partition(":")[0].strip() for line in out.strip().splitlines()] assert headers == [ "Scrapy", diff --git a/tests/test_commands.py b/tests/test_commands.py index 851c92db4..d7b7a9ff2 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -2,32 +2,80 @@ from __future__ import annotations import argparse import json -import re -import subprocess -import sys from io import StringIO -from pathlib import Path -from shutil import rmtree -from tempfile import TemporaryFile, mkdtemp -from threading import Timer -from typing import TYPE_CHECKING, Any +from shutil import copytree +from typing import TYPE_CHECKING from unittest import mock +import pytest + import scrapy from scrapy.cmdline import _pop_command_name, _print_unknown_command_msg from scrapy.commands import ScrapyCommand, ScrapyHelpFormatter, view +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.settings import Settings -from scrapy.utils.python import to_unicode from scrapy.utils.reactor import _asyncio_reactor_path -from scrapy.utils.test import get_testenv +from tests.utils.cmdline import call, proc if TYPE_CHECKING: - import os + from pathlib import Path + + +class EmptyCommand(ScrapyCommand): + def short_desc(self) -> str: + return "" + + def run(self, args: list[str], opts: argparse.Namespace) -> None: + pass + + +class TestHelpDeprecation: + def test_calling_help_is_deprecated(self) -> None: + command = EmptyCommand() + with pytest.warns( + ScrapyDeprecationWarning, + match=r"ScrapyCommand\.help\(\) is deprecated, use long_desc\(\) instead\.", + ): + result = command.help() + # help() still delegates to long_desc() for backward compatibility. + assert result == command.long_desc() + + def test_overriding_help_is_deprecated(self) -> None: + class HelpCommand(ScrapyCommand): + def short_desc(self) -> str: + return "" + + def run(self, args: list[str], opts: argparse.Namespace) -> None: + pass + + def help(self) -> str: + return "custom help" + + with pytest.warns( + ScrapyDeprecationWarning, + match=r"The ScrapyCommand\.help\(\) method is deprecated and " + r"overriding it, as the .*HelpCommand class does, has no effect; " + r"override long_desc\(\) instead\.", + ): + HelpCommand() + + def test_not_overriding_help_does_not_warn(self, recwarn) -> None: + # Commands that do not override help() must not emit the + # override-deprecation warning when instantiated, including subclasses + # several levels below ScrapyCommand (as the built-in commands are). + class SubCommand(EmptyCommand): + pass + + EmptyCommand() + SubCommand() + assert not [ + w for w in recwarn.list if issubclass(w.category, ScrapyDeprecationWarning) + ] class TestCommandSettings: def setup_method(self): - self.command = ScrapyCommand() + self.command = EmptyCommand() self.command.settings = Settings() self.parser = argparse.ArgumentParser( formatter_class=ScrapyHelpFormatter, conflict_handler="resolve" @@ -60,100 +108,40 @@ class TestCommandSettings: class TestProjectBase: + """A base class for tests that may need a Scrapy project.""" + project_name = "testproject" - def setup_method(self): - self.temp_path = mkdtemp() - self.cwd = self.temp_path - self.proj_path = Path(self.temp_path, self.project_name) - self.proj_mod_path = self.proj_path / self.project_name - self.env = get_testenv() + @pytest.fixture(scope="session") + def _proj_path_cached(self, tmp_path_factory: pytest.TempPathFactory) -> Path: + """Create a Scrapy project in a temporary directory and return its path. - def teardown_method(self): - rmtree(self.temp_path) + Used as a cache for ``proj_path``. + """ + tmp_path = tmp_path_factory.mktemp("proj") + call("startproject", self.project_name, cwd=tmp_path) + return tmp_path / self.project_name - def call(self, *args: str, **popen_kwargs: Any) -> int: - with TemporaryFile() as out: - args = (sys.executable, "-m", "scrapy.cmdline", *args) - return subprocess.call( - args, stdout=out, stderr=out, cwd=self.cwd, env=self.env, **popen_kwargs - ) - - def proc( - self, *args: str, **popen_kwargs: Any - ) -> tuple[subprocess.Popen[bytes], str, str]: - args = (sys.executable, "-m", "scrapy.cmdline", *args) - p = subprocess.Popen( - args, - cwd=popen_kwargs.pop("cwd", self.cwd), - env=self.env, - stdout=subprocess.PIPE, - stderr=subprocess.PIPE, - **popen_kwargs, - ) - - def kill_proc(): - p.kill() - p.communicate() - raise AssertionError("Command took too much time to complete") - - timer = Timer(15, kill_proc) - try: - timer.start() - stdout, stderr = p.communicate() - finally: - timer.cancel() - - return p, to_unicode(stdout), to_unicode(stderr) - - def find_in_file(self, filename: str | os.PathLike, regex) -> re.Match | None: - """Find first pattern occurrence in file""" - pattern = re.compile(regex) - with Path(filename).open("r", encoding="utf-8") as f: - for line in f: - match = pattern.search(line) - if match is not None: - return match - return None + @pytest.fixture + def proj_path(self, tmp_path: Path, _proj_path_cached: Path) -> Path: + """Copy a pre-generated Scrapy project into a temporary directory and return its path.""" + proj_path = tmp_path / self.project_name + copytree(_proj_path_cached, proj_path) + return proj_path -class TestCommandBase(TestProjectBase): - def setup_method(self): - super().setup_method() - self.call("startproject", self.project_name) - self.cwd = self.proj_path - self.env["SCRAPY_SETTINGS_MODULE"] = f"{self.project_name}.settings" - - -class TestCommandCrawlerProcess(TestCommandBase): +class TestCommandCrawlerProcess(TestProjectBase): """Test that the command uses the expected kind of *CrawlerProcess and produces expected errors when needed.""" - name = "crawltest" + name = "crawl" + NORMAL_MSG = "Using CrawlerProcess" + ASYNC_MSG = "Using AsyncCrawlerProcess" - NORMAL_MSG = "Type of self.crawler_process: " - ASYNC_MSG = ( - "Type of self.crawler_process: " - ) - - def setup_method(self): - super().setup_method() - (self.cwd / self.project_name / "commands").mkdir(exist_ok=True) - (self.cwd / self.project_name / "commands" / "__init__.py").touch() - (self.cwd / self.project_name / "commands" / f"{self.name}.py").write_text(""" -from scrapy.commands.crawl import Command - -class CrawlerProcessCrawlCommand(Command): - requires_project = True - - def run(self, args, opts): - print(f"Type of self.crawler_process: {type(self.crawler_process)}") - super().run(args, opts) -""") - - self._append_settings(f"COMMANDS_MODULE = '{self.project_name}.commands'\n") - - (self.cwd / self.project_name / "spiders" / "sp.py").write_text(""" + @pytest.fixture(autouse=True) + def create_files(self, proj_path: Path) -> None: + proj_mod_path = proj_path / self.project_name + (proj_mod_path / "spiders" / "sp.py").write_text(""" import scrapy class MySpider(scrapy.Spider): @@ -167,7 +155,7 @@ class MySpider(scrapy.Spider): yield """) - (self.cwd / self.project_name / "spiders" / "aiosp.py").write_text(""" + (proj_mod_path / "spiders" / "aiosp.py").write_text(""" import asyncio import scrapy @@ -184,16 +172,20 @@ class MySpider(scrapy.Spider): yield """) - def _append_settings(self, text: str) -> None: + self._append_settings(proj_mod_path, "LOG_LEVEL = 'DEBUG'\n") + + @staticmethod + def _append_settings(proj_mod_path: Path, text: str) -> None: """Add text to the end of the project settings.py.""" - with (self.cwd / self.project_name / "settings.py").open( - "a", encoding="utf-8" - ) as f: + with (proj_mod_path / "settings.py").open("a", encoding="utf-8") as f: f.write(text) - def _replace_custom_settings(self, spider_name: str, text: str) -> None: + @staticmethod + def _replace_custom_settings( + proj_mod_path: Path, spider_name: str, text: str + ) -> None: """Replace custom_settings in the given spider file with the given text.""" - spider_path = self.cwd / self.project_name / "spiders" / f"{spider_name}.py" + spider_path = proj_mod_path / "spiders" / f"{spider_name}.py" with spider_path.open("r+", encoding="utf-8") as f: content = f.read() content = content.replace( @@ -203,74 +195,85 @@ class MySpider(scrapy.Spider): f.write(content) f.truncate() - def _assert_spider_works(self, msg: str, *args: str) -> None: + def _assert_spider_works(self, msg: str, proj_path: Path, *args: str) -> None: """The command uses the expected *CrawlerProcess, the spider works.""" - _, out, err = self.proc(self.name, *args) - assert msg in out, out - assert "It works!" in err, err - assert "Spider closed (finished)" in err, err + _, _, err = proc(self.name, *args, cwd=proj_path) + assert msg in err + assert "It works!" in err + assert "Spider closed (finished)" in err - def _assert_spider_asyncio_fail(self, msg: str, *args: str) -> None: + def _assert_spider_asyncio_fail( + self, msg: str, proj_path: Path, *args: str + ) -> None: """The command uses the expected *CrawlerProcess, the spider fails to use asyncio.""" - _, out, err = self.proc(self.name, *args) - assert msg in out, out - assert "no running event loop" in err, err + _, _, err = proc(self.name, *args, cwd=proj_path) + assert msg in err + assert "no running event loop" in err - def test_project_settings(self): + def test_project_settings(self, proj_path: Path) -> None: """The reactor is set via the project default settings (to the asyncio value). AsyncCrawlerProcess, the asyncio reactor, both spiders work.""" for spider in ["sp", "aiosp"]: - self._assert_spider_works(self.ASYNC_MSG, spider) + self._assert_spider_works(self.ASYNC_MSG, proj_path, spider) - def test_cmdline_asyncio(self): + def test_cmdline_asyncio(self, proj_path: Path) -> None: """The reactor is set via the command line to the asyncio value. AsyncCrawlerProcess, the asyncio reactor, both spiders work.""" for spider in ["sp", "aiosp"]: self._assert_spider_works( - self.ASYNC_MSG, spider, "-s", f"TWISTED_REACTOR={_asyncio_reactor_path}" + self.ASYNC_MSG, + proj_path, + spider, + "-s", + f"TWISTED_REACTOR={_asyncio_reactor_path}", ) - def test_project_settings_explicit_asyncio(self): + def test_project_settings_explicit_asyncio(self, proj_path: Path) -> None: """The reactor explicitly is set via the project settings to the asyncio value. AsyncCrawlerProcess, the asyncio reactor, both spiders work.""" - self._append_settings(f"TWISTED_REACTOR = '{_asyncio_reactor_path}'\n") + self._append_settings( + proj_path / self.project_name, + f"TWISTED_REACTOR = '{_asyncio_reactor_path}'\n", + ) for spider in ["sp", "aiosp"]: - self._assert_spider_works(self.ASYNC_MSG, spider) + self._assert_spider_works(self.ASYNC_MSG, proj_path, spider) - def test_cmdline_empty(self): + def test_cmdline_empty(self, proj_path: Path) -> None: """The reactor is set via the command line to the empty value. CrawlerProcess, the default reactor, only the normal spider works.""" - self._assert_spider_works(self.NORMAL_MSG, "sp", "-s", "TWISTED_REACTOR=") + self._assert_spider_works( + self.NORMAL_MSG, proj_path, "sp", "-s", "TWISTED_REACTOR=" + ) self._assert_spider_asyncio_fail( - self.NORMAL_MSG, "aiosp", "-s", "TWISTED_REACTOR=" + self.NORMAL_MSG, proj_path, "aiosp", "-s", "TWISTED_REACTOR=" ) - def test_project_settings_empty(self): + def test_project_settings_empty(self, proj_path: Path) -> None: """The reactor is set via the project settings to the empty value. CrawlerProcess, the default reactor, only the normal spider works.""" - self._append_settings("TWISTED_REACTOR = None\n") + self._append_settings(proj_path / self.project_name, "TWISTED_REACTOR = None\n") - self._assert_spider_works(self.NORMAL_MSG, "sp") - self._assert_spider_asyncio_fail( - self.NORMAL_MSG, "aiosp", "-s", "TWISTED_REACTOR=" - ) + self._assert_spider_works(self.NORMAL_MSG, proj_path, "sp") + self._assert_spider_asyncio_fail(self.NORMAL_MSG, proj_path, "aiosp") - def test_spider_settings_asyncio(self): + def test_spider_settings_asyncio(self, proj_path: Path) -> None: """The reactor is set via the spider settings to the asyncio value. AsyncCrawlerProcess, the asyncio reactor, both spiders work.""" for spider in ["sp", "aiosp"]: self._replace_custom_settings( - spider, f"{{'TWISTED_REACTOR': '{_asyncio_reactor_path}'}}" + proj_path / self.project_name, + spider, + f"{{'TWISTED_REACTOR': '{_asyncio_reactor_path}'}}", ) - self._assert_spider_works(self.ASYNC_MSG, spider) + self._assert_spider_works(self.ASYNC_MSG, proj_path, spider) - def test_spider_settings_asyncio_cmdline_empty(self): + def test_spider_settings_asyncio_cmdline_empty(self, proj_path: Path) -> None: """The reactor is set via the spider settings to the asyncio value and via command line to the empty value. The command line value takes precedence so the spider settings don't matter. @@ -278,29 +281,35 @@ class MySpider(scrapy.Spider): CrawlerProcess, the default reactor, only the normal spider works.""" for spider in ["sp", "aiosp"]: self._replace_custom_settings( - spider, f"{{'TWISTED_REACTOR': '{_asyncio_reactor_path}'}}" + proj_path / self.project_name, + spider, + f"{{'TWISTED_REACTOR': '{_asyncio_reactor_path}'}}", ) - self._assert_spider_works(self.NORMAL_MSG, "sp", "-s", "TWISTED_REACTOR=") + self._assert_spider_works( + self.NORMAL_MSG, proj_path, "sp", "-s", "TWISTED_REACTOR=" + ) self._assert_spider_asyncio_fail( - self.NORMAL_MSG, "aiosp", "-s", "TWISTED_REACTOR=" + self.NORMAL_MSG, proj_path, "aiosp", "-s", "TWISTED_REACTOR=" ) - def test_project_empty_spider_settings_asyncio(self): + def test_project_empty_spider_settings_asyncio(self, proj_path: Path) -> None: """The reactor is set via the project settings to the empty value and via the spider settings to the asyncio value. CrawlerProcess is chosen based on the project settings, but the asyncio reactor is chosen based on the spider settings. CrawlerProcess, the asyncio reactor, both spiders work.""" - self._append_settings("TWISTED_REACTOR = None\n") + self._append_settings(proj_path / self.project_name, "TWISTED_REACTOR = None\n") for spider in ["sp", "aiosp"]: self._replace_custom_settings( - spider, f"{{'TWISTED_REACTOR': '{_asyncio_reactor_path}'}}" + proj_path / self.project_name, + spider, + f"{{'TWISTED_REACTOR': '{_asyncio_reactor_path}'}}", ) - self._assert_spider_works(self.NORMAL_MSG, spider) + self._assert_spider_works(self.NORMAL_MSG, proj_path, spider) - def test_project_asyncio_spider_settings_select(self): + def test_project_asyncio_spider_settings_select(self, proj_path: Path) -> None: """The reactor is set via the project settings to the asyncio value and via the spider settings to the select value. AsyncCrawlerProcess is chosen based on the project settings, and the conflicting reactor @@ -308,43 +317,58 @@ class MySpider(scrapy.Spider): AsyncCrawlerProcess, the asyncio reactor, both spiders produce a mismatched reactor exception.""" - self._append_settings(f"TWISTED_REACTOR = '{_asyncio_reactor_path}'\n") + self._append_settings( + proj_path / self.project_name, + f"TWISTED_REACTOR = '{_asyncio_reactor_path}'\n", + ) for spider in ["sp", "aiosp"]: self._replace_custom_settings( + proj_path / self.project_name, spider, "{'TWISTED_REACTOR': 'twisted.internet.selectreactor.SelectReactor'}", ) - _, out, err = self.proc(self.name, spider) - assert self.ASYNC_MSG in out, out + _, _, err = proc(self.name, spider, cwd=proj_path) + assert self.ASYNC_MSG in err assert ( "The installed reactor (twisted.internet.asyncioreactor.AsyncioSelectorReactor)" " does not match the requested one" " (twisted.internet.selectreactor.SelectReactor)" - ) in err, err + ) in err - def test_project_asyncio_spider_settings_select_forced(self): + def test_project_asyncio_spider_settings_select_forced( + self, proj_path: Path + ) -> None: """The reactor is set via the project settings to the asyncio value and via the spider settings to the select value, CrawlerProcess is forced via the project settings. The reactor is chosen based on the spider settings. CrawlerProcess, the select reactor, only the normal spider works.""" - self._append_settings("FORCE_CRAWLER_PROCESS = True\n") + self._append_settings( + proj_path / self.project_name, "FORCE_CRAWLER_PROCESS = True\n" + ) for spider in ["sp", "aiosp"]: self._replace_custom_settings( + proj_path / self.project_name, spider, "{'TWISTED_REACTOR': 'twisted.internet.selectreactor.SelectReactor'}", ) - self._assert_spider_works(self.NORMAL_MSG, "sp") - self._assert_spider_asyncio_fail(self.NORMAL_MSG, "aiosp") + self._assert_spider_works(self.NORMAL_MSG, proj_path, "sp") + self._assert_spider_asyncio_fail(self.NORMAL_MSG, proj_path, "aiosp") -class TestMiscCommands(TestCommandBase): - def test_list(self): - assert self.call("list") == 0 +class TestMiscCommands(TestProjectBase): + def test_list(self, proj_path: Path) -> None: + assert call("list", cwd=proj_path) == 0 - def test_command_not_found(self): + def test_list_subdir(self, proj_path: Path) -> None: + """Test that commands work in a subdirectory of the project.""" + subdir = proj_path / "subdir" + subdir.mkdir(exist_ok=True) + assert call("list", cwd=subdir) == 0 + + def test_command_not_found(self) -> None: na_msg = """ The list command is not available from this location. These commands are only available from within a project: check, crawl, edit, list, parse. @@ -353,9 +377,9 @@ These commands are only available from within a project: check, crawl, edit, lis Unknown command: abc """ params = [ - ("list", 0, na_msg), - ("abc", 0, not_found_msg), - ("abc", 1, not_found_msg), + ("list", False, na_msg), + ("abc", False, not_found_msg), + ("abc", True, not_found_msg), ] for cmdname, inproject, message in params: with mock.patch("sys.stdout", new=StringIO()) as out: @@ -363,31 +387,26 @@ Unknown command: abc assert out.getvalue().strip() == message.strip() -class TestProjectSubdir(TestProjectBase): - """Test that commands work in a subdirectory of the project.""" - - def setup_method(self): - super().setup_method() - self.call("startproject", self.project_name) - self.cwd = self.proj_path / "subdir" - self.cwd.mkdir(exist_ok=True) - - def test_list(self): - assert self.call("list") == 0 +class TestBenchCommand: + @pytest.mark.parametrize("use_reactor", [True, False]) + def test_run(self, use_reactor: bool) -> None: + args: list[str] = [ + "bench", + "-s", + "LOGSTATS_INTERVAL=0.001", + "-s", + "CLOSESPIDER_TIMEOUT=0.01", + ] + if not use_reactor: + args += ["-s", "TWISTED_REACTOR_ENABLED=False"] + _, _, err = proc(*args) + assert "INFO: Crawled" in err + assert "Unhandled Error" not in err + assert "log_count/ERROR" not in err -class TestBenchCommand(TestCommandBase): - def test_run(self): - _, _, log = self.proc( - "bench", "-s", "LOGSTATS_INTERVAL=0.001", "-s", "CLOSESPIDER_TIMEOUT=0.01" - ) - assert "INFO: Crawled" in log - assert "Unhandled Error" not in log - assert "log_count/ERROR" not in log - - -class TestViewCommand(TestCommandBase): - def test_methods(self): +class TestViewCommand: + def test_methods(self) -> None: command = view.Command() command.settings = Settings() parser = argparse.ArgumentParser( @@ -401,10 +420,10 @@ class TestViewCommand(TestCommandBase): assert "URL using the Scrapy downloader and show its" in command.long_desc() -class TestHelpMessage(TestCommandBase): - def setup_method(self): - super().setup_method() - self.commands = [ +class TestHelpMessage(TestProjectBase): + @pytest.mark.parametrize( + "command", + [ "parse", "startproject", "view", @@ -419,34 +438,33 @@ class TestHelpMessage(TestCommandBase): "genspider", "check", "bench", - ] - - def test_help_messages(self): - for command in self.commands: - _, out, _ = self.proc(command, "-h") - assert "Usage" in out + ], + ) + def test_help_messages(self, proj_path: Path, command: str) -> None: + _, out, _ = proc(command, "-h", cwd=proj_path) + assert "Usage" in out class TestPopCommandName: - def test_valid_command(self): + def test_valid_command(self) -> None: argv = ["scrapy", "crawl", "my_spider"] command = _pop_command_name(argv) assert command == "crawl" assert argv == ["scrapy", "my_spider"] - def test_no_command(self): + def test_no_command(self) -> None: argv = ["scrapy"] command = _pop_command_name(argv) assert command is None assert argv == ["scrapy"] - def test_option_before_command(self): + def test_option_before_command(self) -> None: argv = ["scrapy", "-h", "crawl"] command = _pop_command_name(argv) assert command == "crawl" assert argv == ["scrapy", "-h"] - def test_option_after_command(self): + def test_option_after_command(self) -> None: argv = ["scrapy", "crawl", "-h"] command = _pop_command_name(argv) assert command == "crawl" diff --git a/tests/test_contracts.py b/tests/test_contracts.py index ad3efa042..e80945b93 100644 --- a/tests/test_contracts.py +++ b/tests/test_contracts.py @@ -1,11 +1,8 @@ from unittest import TextTestResult import pytest -from twisted.internet.defer import inlineCallbacks from twisted.python import failure -from twisted.trial import unittest -from scrapy import FormRequest from scrapy.contracts import Contract, ContractsManager from scrapy.contracts.default import ( CallbackKeywordArgumentsContract, @@ -19,7 +16,8 @@ from scrapy.item import Field, Item from scrapy.spidermiddlewares.httperror import HttpError from scrapy.spiders import Spider from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer +from tests.utils.decorators import inline_callbacks_test class DemoItem(Item): @@ -35,6 +33,12 @@ class ResponseMetaMock(ResponseMock): meta = None +class TaggedRequest(Request): + def __init__(self, url, contract_tag=None, **kwargs): + super().__init__(url, **kwargs) + self.contract_tag = contract_tag + + class CustomSuccessContract(Contract): name = "custom_success_contract" @@ -50,12 +54,13 @@ class CustomFailContract(Contract): raise TypeError("Error in adjust_request_args") -class CustomFormContract(Contract): - name = "custom_form" - request_cls = FormRequest +class CustomTaggedRequestContract(Contract): + name = "custom_tagged_request" + request_cls = TaggedRequest def adjust_request_args(self, args): - args["formdata"] = {"name": "scrapy"} + args["contract_tag"] = "custom" + args["method"] = "POST" return args @@ -180,10 +185,10 @@ class DemoSpider(Spider): @returns items 1 1 """ - def custom_form(self, response): + def custom_tagged_request(self, response): """ @url http://scrapy.org - @custom_form + @custom_tagged_request """ def invalid_regex(self, response): @@ -247,19 +252,19 @@ class InheritsDemoSpider(DemoSpider): name = "inherits_demo_spider" -class TestContractsManager(unittest.TestCase): +class TestContractsManager: contracts = [ UrlContract, CallbackKeywordArgumentsContract, MetadataContract, ReturnsContract, ScrapesContract, - CustomFormContract, + CustomTaggedRequestContract, CustomSuccessContract, CustomFailContract, ] - def setUp(self): + def setup_method(self): self.conman = ContractsManager(self.contracts) self.results = TextTestResult(stream=None, descriptions=False, verbosity=0) @@ -383,7 +388,7 @@ class TestContractsManager(unittest.TestCase): request = self.conman.from_method(spider.returns_item_meta, self.results) assert request.meta["key"] == "example" response.meta = request.meta - request.callback(ResponseMetaMock) + request.callback(response) assert response.meta["key"] == "example" self.should_succeed() @@ -471,14 +476,14 @@ class TestContractsManager(unittest.TestCase): # invalid regex request = self.conman.from_method(spider.invalid_regex, self.results) - self.should_succeed() + assert request is None # invalid regex with valid contract request = self.conman.from_method( spider.invalid_regex_with_valid_contract, self.results ) - self.should_succeed() request.callback(response) + self.should_succeed() def test_custom_contracts(self): self.conman.from_spider(CustomContractSuccessSpider(), self.results) @@ -502,7 +507,7 @@ class TestContractsManager(unittest.TestCase): assert not self.results.failures assert self.results.errors - @inlineCallbacks + @inline_callbacks_test def test_same_url(self): class TestSameUrlSpider(Spider): name = "test_same_url" @@ -534,17 +539,21 @@ class TestContractsManager(unittest.TestCase): assert crawler.spider.visited == 2 - def test_form_contract(self): + def test_custom_tagged_request_contract(self): spider = DemoSpider() - request = self.conman.from_method(spider.custom_form, self.results) + request = self.conman.from_method(spider.custom_tagged_request, self.results) assert request.method == "POST" - assert isinstance(request, FormRequest) + assert isinstance(request, TaggedRequest) + assert request.contract_tag == "custom" def test_inherited_contracts(self): spider = InheritsDemoSpider() requests = self.conman.from_spider(spider, self.results) assert requests + assert any( + isinstance(request, TaggedRequest) for request in requests if request + ) class CustomFailContractPreProcess(Contract): @@ -569,7 +578,7 @@ class TestCustomContractPrePostProcess: spider = DemoSpider() response = ResponseMock() contract = CustomFailContractPreProcess(spider.returns_request) - conman = ContractsManager([contract]) + conman = ContractsManager([UrlContract, ReturnsContract, contract]) request = conman.from_method(spider.returns_request, self.results) contract.add_pre_hook(request, self.results) @@ -583,7 +592,7 @@ class TestCustomContractPrePostProcess: spider = DemoSpider() response = ResponseMock() contract = CustomFailContractPostProcess(spider.returns_request) - conman = ContractsManager([contract]) + conman = ContractsManager([UrlContract, ReturnsContract, contract]) request = conman.from_method(spider.returns_request, self.results) contract.add_post_hook(request, self.results) diff --git a/tests/test_core_downloader.py b/tests/test_core_downloader.py index 464320602..e348bfb7f 100644 --- a/tests/test_core_downloader.py +++ b/tests/test_core_downloader.py @@ -1,43 +1,64 @@ from __future__ import annotations -import shutil import warnings -from pathlib import Path -from tempfile import mkdtemp -from typing import Any, cast +from typing import TYPE_CHECKING, cast import OpenSSL.SSL import pytest -from twisted.internet.defer import Deferred, inlineCallbacks -from twisted.protocols.policies import WrappingFactory -from twisted.trial import unittest +from pytest_twisted import async_yield_fixture +from twisted.internet.protocol import Factory +from twisted.internet.protocol import Protocol as TxProtocol +from twisted.internet.ssl import optionsForClientTLS +from twisted.protocols.tls import TLSMemoryBIOFactory, TLSMemoryBIOProtocol from twisted.web import server, static from twisted.web.client import Agent, BrowserLikePolicyForHTTPS, readBody from twisted.web.client import Response as TxResponse -from twisted.web.iweb import IBodyProducer -from scrapy.core.downloader import Slot +from scrapy.core.downloader import Downloader, Slot, tls from scrapy.core.downloader.contextfactory import ( - ScrapyClientContextFactory, - load_context_factory_from_settings, + _load_context_factory_from_settings, + _ScrapyClientContextFactory, ) from scrapy.core.downloader.handlers.http11 import _RequestBodyProducer -from scrapy.settings import Settings -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future +from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.utils._deps_compat import ( + PYOPENSSL_SET_CIPHER_LIST_TMP_CONN, + TWISTED_TLS_NEW_IMPL, +) +from scrapy.utils.defer import maybe_deferred_to_future from scrapy.utils.misc import build_from_crawler from scrapy.utils.python import to_bytes +from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler -from tests.mockserver import PayloadResource, ssl_context_factory +from tests.mockserver.http_resources import PayloadResource +from tests.mockserver.utils import ssl_context_factory +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + from twisted.internet.defer import Deferred + from twisted.web.iweb import IBodyProducer class TestSlot: def test_repr(self): slot = Slot(concurrency=8, delay=0.1, randomize_delay=True) - assert repr(slot) == "Slot(concurrency=8, delay=0.10, randomize_delay=True)" + assert repr(slot) == "Slot(concurrency=8, delay=0.1, randomize_delay=True)" -class TestContextFactoryBase(unittest.TestCase): - context_factory = None +@pytest.mark.requires_reactor # this test is related to the Twisted HTTP code +class TestContextFactoryBase: + @async_yield_fixture + async def server_url(self, tmp_path): + (tmp_path / "file").write_bytes(b"0123456789") + r = static.File(str(tmp_path)) + r.putChild(b"payload", PayloadResource()) + site = server.Site(r, timeout=None) + port = self._listen(site) + portno = port.getHost().port + + yield f"https://127.0.0.1:{portno}/" + + await port.stopListening() def _listen(self, site): from twisted.internet import reactor @@ -45,28 +66,10 @@ class TestContextFactoryBase(unittest.TestCase): return reactor.listenSSL( 0, site, - contextFactory=self.context_factory or ssl_context_factory(), + contextFactory=ssl_context_factory(), interface="127.0.0.1", ) - def getURL(self, path): - return f"https://127.0.0.1:{self.portno}/{path}" - - def setUp(self): - self.tmpname = Path(mkdtemp()) - (self.tmpname / "file").write_bytes(b"0123456789") - r = static.File(str(self.tmpname)) - r.putChild(b"payload", PayloadResource()) - self.site = server.Site(r, timeout=None) - self.wrapper = WrappingFactory(self.site) - self.port = self._listen(self.wrapper) - self.portno = self.port.getHost().port - - @inlineCallbacks - def tearDown(self): - yield self.port.stopListening() - shutil.rmtree(self.tmpname) - @staticmethod async def get_page( url: str, @@ -78,12 +81,12 @@ class TestContextFactoryBase(unittest.TestCase): agent = Agent(reactor, contextFactory=client_context_factory) body_producer = _RequestBodyProducer(body.encode()) if body else None response: TxResponse = cast( - TxResponse, + "TxResponse", await maybe_deferred_to_future( agent.request( b"GET", url.encode(), - bodyProducer=cast(IBodyProducer, body_producer), + bodyProducer=cast("IBodyProducer", body_producer), ) ), ) @@ -99,82 +102,179 @@ class TestContextFactoryBase(unittest.TestCase): class TestContextFactory(TestContextFactoryBase): - @deferred_f_from_coro_f - async def testPayload(self): - s = "0123456789" * 10 + @pytest.fixture + def factory(self) -> _ScrapyClientContextFactory: crawler = get_crawler() - settings = Settings() - client_context_factory = load_context_factory_from_settings(settings, crawler) - body = await self.get_page( - self.getURL("payload"), client_context_factory, body=s + return _load_context_factory_from_settings(crawler) + + @staticmethod + def _get_dummy_protocol() -> TLSMemoryBIOProtocol: + # from Twisted src/twisted/web/test/test_agent.py::dummyTLSProtocol() + factory = TLSMemoryBIOFactory( + optionsForClientTLS("example.com"), True, Factory.forProtocol(TxProtocol) ) + return factory.buildProtocol(None) + + @coroutine_test + async def test_payload( + self, factory: _ScrapyClientContextFactory, server_url: str + ) -> None: + s = "0123456789" * 10 + body = await self.get_page(server_url + "payload", factory, body=s) assert body == to_bytes(s) - def test_override_getContext(self): - class MyFactory(ScrapyClientContextFactory): - def getContext( - self, hostname: Any = None, port: Any = None - ) -> OpenSSL.SSL.Context: - ctx: OpenSSL.SSL.Context = super().getContext(hostname, port) - return ctx + @pytest.mark.skipif( + TWISTED_TLS_NEW_IMPL, + reason="The context is not stored on this Twisted version", + ) + def test_no_context_sharing(self, factory: _ScrapyClientContextFactory) -> None: + """Every call to creatorForNetloc() should give a fresh context.""" + creator1 = factory.creatorForNetloc(b"website1.tld", 443) + assert creator1._hostnameBytes == b"website1.tld" + creator2 = factory.creatorForNetloc(b"website2.tld", 443) + assert creator2._hostnameBytes == b"website2.tld" + assert creator1._ctx is not creator2._ctx # type: ignore[attr-defined] - with warnings.catch_warnings(record=True) as w: - MyFactory() - assert len(w) == 1 - assert ( - "Overriding ScrapyClientContextFactory.getContext() is deprecated" - in str(w[0].message) + def test_no_context_sharing_with_conn( + self, factory: _ScrapyClientContextFactory + ) -> None: + """Like test_no_context_sharing() but get the context from a connection.""" + creator1 = factory.creatorForNetloc(b"website1.tld", 443) + assert creator1._hostnameBytes == b"website1.tld" + conn1 = creator1.clientConnectionForTLS(self._get_dummy_protocol()) + + creator2 = factory.creatorForNetloc(b"website2.tld", 443) + assert creator2._hostnameBytes == b"website2.tld" + conn2 = creator2.clientConnectionForTLS(self._get_dummy_protocol()) + + assert conn1.get_context() is not conn2.get_context() + + @pytest.mark.skipif( + PYOPENSSL_SET_CIPHER_LIST_TMP_CONN, + reason="Fails or doesn't make sense on this pyOpenSSL version", + ) + def test_no_immutable_ctx_warning( + self, factory: _ScrapyClientContextFactory + ) -> None: + """There should be no pyOpenSSL context modification warning. + + pyOpenSSL < 25.1.0 doesn't produce this warning, and on 25.1.0 it's + always produced due to + https://github.com/scrapy/scrapy/issues/6859#issuecomment-4294917851. + """ + with warnings.catch_warnings(): + warnings.filterwarnings( + "error", + category=DeprecationWarning, + message="Attempting to mutate a Context after a Connection was created", ) + factory.creatorForNetloc(b"website.tld", 443) + + def test_ctx_flags(self, factory: _ScrapyClientContextFactory) -> None: + """The context should have the expected flags set.""" + creator = factory.creatorForNetloc(b"website.tld", 443) + conn = creator.clientConnectionForTLS(self._get_dummy_protocol()) + ctx = conn.get_context() + # fragile but pyOpenSSL doesn't have Context.get_options() + options = OpenSSL.SSL._lib.SSL_CTX_get_options(ctx._context) # type: ignore[attr-defined] + assert options & 0x4 # OP_LEGACY_SERVER_CONNECT class TestContextFactoryTLSMethod(TestContextFactoryBase): async def _assert_factory_works( - self, client_context_factory: ScrapyClientContextFactory + self, server_url: str, client_context_factory: _ScrapyClientContextFactory ) -> None: s = "0123456789" * 10 body = await self.get_page( - self.getURL("payload"), client_context_factory, body=s + server_url + "payload", client_context_factory, body=s ) assert body == to_bytes(s) - @deferred_f_from_coro_f - async def test_setting_default(self): + @coroutine_test + async def test_setting_default(self, server_url: str) -> None: crawler = get_crawler() - settings = Settings() - client_context_factory = load_context_factory_from_settings(settings, crawler) + client_context_factory = _load_context_factory_from_settings(crawler) assert client_context_factory._ssl_method == OpenSSL.SSL.SSLv23_METHOD - await self._assert_factory_works(client_context_factory) + await self._assert_factory_works(server_url, client_context_factory) def test_setting_none(self): - crawler = get_crawler() - settings = Settings({"DOWNLOADER_CLIENT_TLS_METHOD": None}) - with pytest.raises(KeyError): - load_context_factory_from_settings(settings, crawler) + crawler = get_crawler(settings_dict={"DOWNLOADER_CLIENT_TLS_METHOD": None}) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match="Setting DOWNLOADER_CLIENT_TLS_METHOD to a non-default value is deprecated", + ), + pytest.raises(KeyError), + ): + _load_context_factory_from_settings(crawler) def test_setting_bad(self): - crawler = get_crawler() - settings = Settings({"DOWNLOADER_CLIENT_TLS_METHOD": "bad"}) - with pytest.raises(KeyError): - load_context_factory_from_settings(settings, crawler) + crawler = get_crawler(settings_dict={"DOWNLOADER_CLIENT_TLS_METHOD": "bad"}) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match="Setting DOWNLOADER_CLIENT_TLS_METHOD to a non-default value is deprecated", + ), + pytest.raises(KeyError), + ): + _load_context_factory_from_settings(crawler) - @deferred_f_from_coro_f - async def test_setting_explicit(self): - crawler = get_crawler() - settings = Settings({"DOWNLOADER_CLIENT_TLS_METHOD": "TLSv1.2"}) - client_context_factory = load_context_factory_from_settings(settings, crawler) + @pytest.mark.filterwarnings( + r"ignore:Passing method to twisted\.internet\.ssl\.CertificateOptions:DeprecationWarning" + ) + @coroutine_test + async def test_setting_explicit(self, server_url: str) -> None: + crawler = get_crawler(settings_dict={"DOWNLOADER_CLIENT_TLS_METHOD": "TLSv1.2"}) + with pytest.warns( + ScrapyDeprecationWarning, + match="Setting DOWNLOADER_CLIENT_TLS_METHOD to a non-default value is deprecated", + ): + client_context_factory = _load_context_factory_from_settings(crawler) assert client_context_factory._ssl_method == OpenSSL.SSL.TLSv1_2_METHOD - await self._assert_factory_works(client_context_factory) + await self._assert_factory_works(server_url, client_context_factory) - @deferred_f_from_coro_f - async def test_direct_from_crawler(self): + @coroutine_test + async def test_direct_from_crawler(self, server_url: str) -> None: # the setting is ignored crawler = get_crawler(settings_dict={"DOWNLOADER_CLIENT_TLS_METHOD": "bad"}) - client_context_factory = build_from_crawler(ScrapyClientContextFactory, crawler) + client_context_factory = build_from_crawler( + _ScrapyClientContextFactory, crawler + ) assert client_context_factory._ssl_method == OpenSSL.SSL.SSLv23_METHOD - await self._assert_factory_works(client_context_factory) + await self._assert_factory_works(server_url, client_context_factory) - @deferred_f_from_coro_f - async def test_direct_init(self): - client_context_factory = ScrapyClientContextFactory(OpenSSL.SSL.TLSv1_2_METHOD) + @pytest.mark.filterwarnings( + r"ignore:Passing method to twisted\.internet\.ssl\.CertificateOptions:DeprecationWarning" + ) + @coroutine_test + async def test_direct_init(self, server_url: str) -> None: + client_context_factory = _ScrapyClientContextFactory(OpenSSL.SSL.TLSv1_2_METHOD) assert client_context_factory._ssl_method == OpenSSL.SSL.TLSv1_2_METHOD - await self._assert_factory_works(client_context_factory) + await self._assert_factory_works(server_url, client_context_factory) + + +@coroutine_test +async def test_fetch_deprecated_spider_arg(): + class CustomDownloader(Downloader): + def fetch(self, request, spider): # pylint: disable=signature-differs + return super().fetch(request, spider) + + crawler = get_crawler(DefaultSpider, {"DOWNLOADER": CustomDownloader}) + with pytest.warns( + ScrapyDeprecationWarning, + match=r"The fetch\(\) method of .+\.CustomDownloader requires a spider argument", + ): + await crawler.crawl_async() + + +def test_deprecated_tls_module_names() -> None: + with pytest.warns( + ScrapyDeprecationWarning, + match="scrapy.core.downloader.tls.METHOD_TLS is deprecated", + ): + assert tls.METHOD_TLS == "TLS" + with pytest.warns( + ScrapyDeprecationWarning, + match="scrapy.core.downloader.tls.openssl_methods is deprecated", + ): + assert isinstance(tls.openssl_methods, dict) diff --git a/tests/test_core_scraper.py b/tests/test_core_scraper.py new file mode 100644 index 000000000..1b8ba08ab --- /dev/null +++ b/tests/test_core_scraper.py @@ -0,0 +1,27 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +from scrapy.utils.test import get_crawler +from tests.spiders import SimpleSpider +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + import pytest + + from tests.mockserver.http import MockServer + + +@coroutine_test +async def test_scraper_exception( + mockserver: MockServer, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, +) -> None: + crawler = get_crawler(SimpleSpider) + monkeypatch.setattr( + "scrapy.core.engine.Scraper.handle_spider_output_async", + lambda *args, **kwargs: 1 / 0, + ) + await crawler.crawl_async(url=mockserver.url("/")) + assert "Scraper bug processing" in caplog.text diff --git a/tests/test_crawl.py b/tests/test_crawl.py index 42f9899f9..be6c80429 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -5,25 +5,24 @@ import logging from ipaddress import IPv4Address from socket import gethostbyname from typing import TYPE_CHECKING, Any -from urllib.parse import urlparse +from urllib.parse import urlencode, urlparse import pytest -from testfixtures import LogCapture -from twisted.internet.defer import inlineCallbacks +from cryptography.x509 import load_der_x509_certificate +from twisted.internet.defer import succeed from twisted.internet.ssl import Certificate from twisted.python.failure import Failure -from twisted.trial.unittest import TestCase from scrapy import Spider, signals -from scrapy.crawler import CrawlerRunner -from scrapy.exceptions import CloseSpider, StopDownload +from scrapy.crawler import AsyncCrawlerRunner, Crawler, CrawlerRunner +from scrapy.exceptions import CloseSpider, ScrapyDeprecationWarning, StopDownload from scrapy.http import Request from scrapy.http.response import Response -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future +from scrapy.utils.defer import ensure_awaitable, maybe_deferred_to_future +from scrapy.utils.engine import format_engine_status, get_engine_status from scrapy.utils.python import to_unicode from scrapy.utils.test import get_crawler, get_reactor_settings from tests import NON_EXISTING_RESOLVABLE -from tests.mockserver import MockServer from tests.spiders import ( AsyncDefAsyncioGenComplexSpider, AsyncDefAsyncioGenExcSpider, @@ -55,50 +54,43 @@ from tests.spiders import ( StartGoodAndBadOutput, StartItemSpider, ) +from tests.utils.decorators import coroutine_test if TYPE_CHECKING: from scrapy.statscollectors import StatsCollector + from tests.mockserver.http import MockServer -class TestCrawl(TestCase): - mockserver: MockServer - - @classmethod - def setUpClass(cls): - cls.mockserver = MockServer() - cls.mockserver.__enter__() - - @classmethod - def tearDownClass(cls): - cls.mockserver.__exit__(None, None, None) - - @inlineCallbacks - def test_follow_all(self): +class TestCrawl: + @coroutine_test + async def test_follow_all(self, mockserver: MockServer) -> None: crawler = get_crawler(FollowAllSpider) - yield crawler.crawl(mockserver=self.mockserver) + await crawler.crawl_async(mockserver=mockserver) + assert isinstance(crawler.spider, FollowAllSpider) assert len(crawler.spider.urls_visited) == 11 # 10 + start_url - @deferred_f_from_coro_f - async def test_fixed_delay(self): - await self._test_delay(total=3, delay=0.2) + @coroutine_test + async def test_fixed_delay(self, mockserver: MockServer) -> None: + await self._test_delay(mockserver, total=3, delay=0.2) - @deferred_f_from_coro_f - async def test_randomized_delay(self): - await self._test_delay(total=3, delay=0.1, randomize=True) + @coroutine_test + async def test_randomized_delay(self, mockserver: MockServer) -> None: + await self._test_delay(mockserver, total=3, delay=0.1, randomize=True) + @staticmethod async def _test_delay( - self, total: int, delay: float, randomize: bool = False + mockserver: MockServer, total: int, delay: float, randomize: bool = False ) -> None: crawl_kwargs = { "maxlatency": delay * 2, - "mockserver": self.mockserver, + "mockserver": mockserver, "total": total, } tolerance = 1 - (0.6 if randomize else 0.2) settings = {"DOWNLOAD_DELAY": delay, "RANDOMIZE_DOWNLOAD_DELAY": randomize} crawler = get_crawler(FollowAllSpider, settings) - await maybe_deferred_to_future(crawler.crawl(**crawl_kwargs)) + await crawler.crawl_async(**crawl_kwargs) assert crawler.spider assert isinstance(crawler.spider, FollowAllSpider) times = crawler.spider.times @@ -112,7 +104,7 @@ class TestCrawl(TestCase): # code above to have any meaning. settings["DOWNLOAD_DELAY"] = 0 crawler = get_crawler(FollowAllSpider, settings) - await maybe_deferred_to_future(crawler.crawl(**crawl_kwargs)) + await crawler.crawl_async(**crawl_kwargs) assert crawler.spider assert isinstance(crawler.spider, FollowAllSpider) times = crawler.spider.times @@ -120,18 +112,20 @@ class TestCrawl(TestCase): average = total_time / (len(times) - 1) assert average <= delay / tolerance, "test total or delay values are too small" - @inlineCallbacks - def test_timeout_success(self): + @coroutine_test + async def test_timeout_success(self, mockserver: MockServer) -> None: crawler = get_crawler(DelaySpider) - yield crawler.crawl(n=0.5, mockserver=self.mockserver) + await crawler.crawl_async(n=0.5, mockserver=mockserver) + assert isinstance(crawler.spider, DelaySpider) assert crawler.spider.t1 > 0 assert crawler.spider.t2 > 0 assert crawler.spider.t2 > crawler.spider.t1 - @inlineCallbacks - def test_timeout_failure(self): + @coroutine_test + async def test_timeout_failure(self, mockserver: MockServer) -> None: crawler = get_crawler(DelaySpider, {"DOWNLOAD_TIMEOUT": 0.35}) - yield crawler.crawl(n=0.5, mockserver=self.mockserver) + await crawler.crawl_async(n=0.5, mockserver=mockserver) + assert isinstance(crawler.spider, DelaySpider) assert crawler.spider.t1 > 0 assert crawler.spider.t2 == 0 assert crawler.spider.t2_err > 0 @@ -139,81 +133,96 @@ class TestCrawl(TestCase): # server hangs after receiving response headers crawler = get_crawler(DelaySpider, {"DOWNLOAD_TIMEOUT": 0.35}) - yield crawler.crawl(n=0.5, b=1, mockserver=self.mockserver) + await crawler.crawl_async(n=0.5, b=1, mockserver=mockserver) + assert isinstance(crawler.spider, DelaySpider) assert crawler.spider.t1 > 0 assert crawler.spider.t2 == 0 assert crawler.spider.t2_err > 0 assert crawler.spider.t2_err > crawler.spider.t1 - @inlineCallbacks - def test_retry_503(self): + @coroutine_test + async def test_retry_503( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: crawler = get_crawler(SimpleSpider) - with LogCapture() as log: - yield crawler.crawl( - self.mockserver.url("/status?n=503"), mockserver=self.mockserver + with caplog.at_level(logging.DEBUG): + await crawler.crawl_async( + mockserver.url("/status?n=503"), mockserver=mockserver ) - self._assert_retried(log) + self._assert_retried(caplog.text) - @inlineCallbacks - def test_retry_conn_failed(self): + @coroutine_test + async def test_retry_conn_failed( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: crawler = get_crawler(SimpleSpider) - with LogCapture() as log: - yield crawler.crawl( - "http://localhost:65432/status?n=503", mockserver=self.mockserver + with caplog.at_level(logging.DEBUG): + await crawler.crawl_async( + "http://localhost:65432/status?n=503", mockserver=mockserver ) - self._assert_retried(log) + self._assert_retried(caplog.text) - @inlineCallbacks - def test_retry_dns_error(self): + @coroutine_test + async def test_retry_dns_error( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: if NON_EXISTING_RESOLVABLE: pytest.skip("Non-existing hosts are resolvable") crawler = get_crawler(SimpleSpider) - with LogCapture() as log: + with caplog.at_level(logging.DEBUG): # try to fetch the homepage of a nonexistent domain - yield crawler.crawl( - "http://dns.resolution.invalid./", mockserver=self.mockserver + await crawler.crawl_async( + "http://dns.resolution.invalid./", mockserver=mockserver ) - self._assert_retried(log) + self._assert_retried(caplog.text) - @inlineCallbacks - def test_start_bug_before_yield(self): - with LogCapture("scrapy", level=logging.ERROR) as log: + @coroutine_test + async def test_start_bug_before_yield( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + with caplog.at_level(logging.ERROR): crawler = get_crawler(BrokenStartSpider) - yield crawler.crawl(fail_before_yield=1, mockserver=self.mockserver) + await crawler.crawl_async(fail_before_yield=1, mockserver=mockserver) - assert len(log.records) == 1 - record = log.records[0] + assert len(caplog.records) == 1 + record = caplog.records[0] assert record.exc_info is not None assert record.exc_info[0] is ZeroDivisionError - @inlineCallbacks - def test_start_bug_yielding(self): - with LogCapture("scrapy", level=logging.ERROR) as log: + @coroutine_test + async def test_start_bug_yielding( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + with caplog.at_level(logging.ERROR): crawler = get_crawler(BrokenStartSpider) - yield crawler.crawl(fail_yielding=1, mockserver=self.mockserver) + await crawler.crawl_async(fail_yielding=1, mockserver=mockserver) - assert len(log.records) == 1 - record = log.records[0] + assert len(caplog.records) == 1 + record = caplog.records[0] assert record.exc_info is not None assert record.exc_info[0] is ZeroDivisionError - @inlineCallbacks - def test_start_items(self): + @coroutine_test + async def test_start_items( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: items = [] def _on_item_scraped(item): items.append(item) - with LogCapture("scrapy", level=logging.ERROR) as log: + with caplog.at_level(logging.ERROR): crawler = get_crawler(StartItemSpider) crawler.signals.connect(_on_item_scraped, signals.item_scraped) - yield crawler.crawl(mockserver=self.mockserver) + await crawler.crawl_async(mockserver=mockserver) - assert len(log.records) == 0 + assert len(caplog.records) == 0 assert items == [{"name": "test item"}] - @inlineCallbacks - def test_start_unsupported_output(self): + @coroutine_test + async def test_start_unsupported_output( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: """Anything that is not a request is assumed to be an item, avoiding a potentially expensive call to itemadapter.is_item(), and letting instead things fail when ItemAdapter is actually used on the @@ -224,39 +233,41 @@ class TestCrawl(TestCase): def _on_item_scraped(item): items.append(item) - with LogCapture("scrapy", level=logging.ERROR) as log: + with caplog.at_level(logging.ERROR): crawler = get_crawler(StartGoodAndBadOutput) crawler.signals.connect(_on_item_scraped, signals.item_scraped) - yield crawler.crawl(mockserver=self.mockserver) + await crawler.crawl_async(mockserver=mockserver) - assert len(log.records) == 0 + assert len(caplog.records) == 0 assert len(items) == 3 assert not any(isinstance(item, Request) for item in items) - @inlineCallbacks - def test_start_dupes(self): + @coroutine_test + async def test_start_dupes(self, mockserver: MockServer) -> None: settings = {"CONCURRENT_REQUESTS": 1} crawler = get_crawler(DuplicateStartSpider, settings) - yield crawler.crawl( - dont_filter=True, distinct_urls=2, dupe_factor=3, mockserver=self.mockserver + await crawler.crawl_async( + dont_filter=True, distinct_urls=2, dupe_factor=3, mockserver=mockserver ) + assert isinstance(crawler.spider, DuplicateStartSpider) assert crawler.spider.visited == 6 crawler = get_crawler(DuplicateStartSpider, settings) - yield crawler.crawl( + await crawler.crawl_async( dont_filter=False, distinct_urls=3, dupe_factor=4, - mockserver=self.mockserver, + mockserver=mockserver, ) + assert isinstance(crawler.spider, DuplicateStartSpider) assert crawler.spider.visited == 3 - @inlineCallbacks - def test_unbounded_response(self): + @coroutine_test + async def test_unbounded_response( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: # Completeness of responses without Content-Length or Transfer-Encoding # can not be determined, we treat them as valid but flagged as "partial" - from urllib.parse import urlencode - query = urlencode( { "raw": """\ @@ -279,40 +290,45 @@ with multiples lines } ) crawler = get_crawler(SimpleSpider) - with LogCapture() as log: - yield crawler.crawl( - self.mockserver.url(f"/raw?{query}"), mockserver=self.mockserver + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + mockserver.url(f"/raw?{query}"), mockserver=mockserver ) - assert str(log).count("Got response 200") == 1 + assert caplog.text.count("Got response 200") == 1 - @inlineCallbacks - def test_retry_conn_lost(self): + @coroutine_test + async def test_retry_conn_lost( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: # connection lost after receiving data crawler = get_crawler(SimpleSpider) - with LogCapture() as log: - yield crawler.crawl( - self.mockserver.url("/drop?abort=0"), mockserver=self.mockserver + with caplog.at_level(logging.DEBUG): + await crawler.crawl_async( + mockserver.url("/drop?abort=0"), mockserver=mockserver ) - self._assert_retried(log) + self._assert_retried(caplog.text) - @inlineCallbacks - def test_retry_conn_aborted(self): + @coroutine_test + async def test_retry_conn_aborted( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: # connection lost before receiving data crawler = get_crawler(SimpleSpider) - with LogCapture() as log: - yield crawler.crawl( - self.mockserver.url("/drop?abort=1"), mockserver=self.mockserver + with caplog.at_level(logging.DEBUG): + await crawler.crawl_async( + mockserver.url("/drop?abort=1"), mockserver=mockserver ) - self._assert_retried(log) + self._assert_retried(caplog.text) - def _assert_retried(self, log): + @staticmethod + def _assert_retried(log: str) -> None: assert str(log).count("Retrying") == 2 assert str(log).count("Gave up retrying") == 1 - @inlineCallbacks - def test_referer_header(self): + @coroutine_test + async def test_referer_header(self, mockserver: MockServer) -> None: """Referer header is set by RefererMiddleware unless it is already set""" - req0 = Request(self.mockserver.url("/echo?headers=1&body=0"), dont_filter=1) + req0 = Request(mockserver.url("/echo?headers=1&body=0"), dont_filter=True) req1 = req0.replace() req2 = req0.replace(headers={"Referer": None}) req3 = req0.replace(headers={"Referer": "http://example.com"}) @@ -320,12 +336,13 @@ with multiples lines req1.meta["next"] = req2 req2.meta["next"] = req3 crawler = get_crawler(SingleRequestSpider) - yield crawler.crawl(seed=req0, mockserver=self.mockserver) + await crawler.crawl_async(seed=req0, mockserver=mockserver) + assert isinstance(crawler.spider, SingleRequestSpider) # basic asserts in case of weird communication errors assert "responses" in crawler.spider.meta assert "failures" not in crawler.spider.meta # start() doesn't set Referer header - echo0 = json.loads(to_unicode(crawler.spider.meta["responses"][2].body)) + echo0 = json.loads(to_unicode(crawler.spider.meta["responses"][0].body)) assert "Referer" not in echo0["headers"] # following request sets Referer to the source request url echo1 = json.loads(to_unicode(crawler.spider.meta["responses"][1].body)) @@ -337,37 +354,35 @@ with multiples lines echo3 = json.loads(to_unicode(crawler.spider.meta["responses"][3].body)) assert echo3["headers"].get("Referer") == ["http://example.com"] - @inlineCallbacks - def test_engine_status(self): - from scrapy.utils.engine import get_engine_status - + @coroutine_test + async def test_engine_status(self, mockserver: MockServer) -> None: est = [] def cb(response): est.append(get_engine_status(crawler.engine)) crawler = get_crawler(SingleRequestSpider) - yield crawler.crawl( - seed=self.mockserver.url("/"), callback_func=cb, mockserver=self.mockserver + await crawler.crawl_async( + seed=mockserver.url("/"), callback_func=cb, mockserver=mockserver ) + assert isinstance(crawler.spider, SingleRequestSpider) assert len(est) == 1, est s = dict(est[0]) assert s["engine.spider.name"] == crawler.spider.name assert s["len(engine.scraper.slot.active)"] == 1 - @inlineCallbacks - def test_format_engine_status(self): - from scrapy.utils.engine import format_engine_status - + @coroutine_test + async def test_format_engine_status(self, mockserver: MockServer) -> None: est = [] def cb(response): est.append(format_engine_status(crawler.engine)) crawler = get_crawler(SingleRequestSpider) - yield crawler.crawl( - seed=self.mockserver.url("/"), callback_func=cb, mockserver=self.mockserver + await crawler.crawl_async( + seed=mockserver.url("/"), callback_func=cb, mockserver=mockserver ) + assert isinstance(crawler.spider, SingleRequestSpider) assert len(est) == 1, est est = est[0].split("\n")[2:-2] # remove header & footer # convert to dict @@ -375,13 +390,15 @@ with multiples lines est = [x for sublist in est for x in sublist] # flatten est = [x.lstrip().rstrip() for x in est] it = iter(est) - s = dict(zip(it, it)) + s = dict(zip(it, it, strict=True)) assert s["engine.spider.name"] == crawler.spider.name assert s["len(engine.scraper.slot.active)"] == "1" - @inlineCallbacks - def test_open_spider_error_on_faulty_pipeline(self): + @coroutine_test + async def test_open_spider_error_on_faulty_pipeline( + self, mockserver: MockServer + ) -> None: settings = { "ITEM_PIPELINES": { "tests.pipelines.ZeroDivisionErrorPipeline": 300, @@ -389,59 +406,84 @@ with multiples lines } crawler = get_crawler(SimpleSpider, settings) with pytest.raises(ZeroDivisionError): - yield crawler.crawl( - self.mockserver.url("/status?n=200"), mockserver=self.mockserver + await crawler.crawl_async( + mockserver.url("/status?n=200"), mockserver=mockserver ) assert not crawler.crawling - @inlineCallbacks - def test_crawlerrunner_accepts_crawler(self): - crawler = get_crawler(SimpleSpider) - runner = CrawlerRunner() - with LogCapture() as log: - yield runner.crawl( - crawler, - self.mockserver.url("/status?n=200"), - mockserver=self.mockserver, + @coroutine_test + async def test_open_spider_error_on_faulty_pipeline_crawl( + self, mockserver: MockServer + ) -> None: + # cover the except block in Crawler.crawl() + settings = { + "ITEM_PIPELINES": { + "tests.pipelines.ZeroDivisionErrorPipeline": 300, + } + } + crawler = get_crawler(SimpleSpider, settings) + with pytest.raises(ZeroDivisionError): + await maybe_deferred_to_future( + crawler.crawl(mockserver.url("/status?n=200"), mockserver=mockserver) ) - assert "Got response 200" in str(log) + assert not crawler.crawling - @inlineCallbacks - def test_crawl_multiple(self): - runner = CrawlerRunner(get_reactor_settings()) + @coroutine_test + async def test_crawlerrunner_accepts_crawler( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + crawler = Crawler(SimpleSpider, get_reactor_settings()) + runner = CrawlerRunner() + with caplog.at_level(logging.DEBUG): + await maybe_deferred_to_future( + runner.crawl( + crawler, + mockserver.url("/status?n=200"), + mockserver=mockserver, + ) + ) + assert "Got response 200" in caplog.text + + @coroutine_test + async def test_crawl_multiple( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + settings_dict = get_reactor_settings() + runner_cls = ( + CrawlerRunner + if settings_dict.get("TWISTED_REACTOR_ENABLED", True) + else AsyncCrawlerRunner + ) + runner = runner_cls(settings_dict) runner.crawl( SimpleSpider, - self.mockserver.url("/status?n=200"), - mockserver=self.mockserver, + mockserver.url("/status?n=200"), + mockserver=mockserver, ) runner.crawl( SimpleSpider, - self.mockserver.url("/status?n=503"), - mockserver=self.mockserver, + mockserver.url("/status?n=503"), + mockserver=mockserver, ) - with LogCapture() as log: - yield runner.join() + with caplog.at_level(logging.DEBUG): + await ensure_awaitable(runner.join()) - self._assert_retried(log) - assert "Got response 200" in str(log) + self._assert_retried(caplog.text) + assert "Got response 200" in caplog.text + + @coroutine_test + async def test_unknown_url_scheme(self, caplog: pytest.LogCaptureFixture) -> None: + crawler = get_crawler(SimpleSpider) + await crawler.crawl_async("foo://bar") + assert "NotSupported: Unsupported URL scheme 'foo'" in caplog.text -class TestCrawlSpider(TestCase): - mockserver: MockServer - - @classmethod - def setUpClass(cls): - cls.mockserver = MockServer() - cls.mockserver.__enter__() - - @classmethod - def tearDownClass(cls): - cls.mockserver.__exit__(None, None, None) - +class TestCrawlSpider: + @staticmethod async def _run_spider( - self, spider_cls: type[Spider] - ) -> tuple[LogCapture, list[Any], StatsCollector]: + spider_cls: type[Spider], mockserver: MockServer + ) -> tuple[list[Any], StatsCollector]: items = [] def _on_item_scraped(item): @@ -449,103 +491,119 @@ class TestCrawlSpider(TestCase): crawler = get_crawler(spider_cls) crawler.signals.connect(_on_item_scraped, signals.item_scraped) - with LogCapture() as log: - await maybe_deferred_to_future( - crawler.crawl( - self.mockserver.url("/status?n=200"), mockserver=self.mockserver - ) - ) + await crawler.crawl_async( + mockserver.url("/status?n=200"), mockserver=mockserver + ) assert crawler.stats - return log, items, crawler.stats + return items, crawler.stats - @inlineCallbacks - def test_crawlspider_with_parse(self): + @coroutine_test + async def test_crawlspider_with_parse( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: crawler = get_crawler(CrawlSpiderWithParseMethod) - with LogCapture() as log: - yield crawler.crawl(mockserver=self.mockserver) + with caplog.at_level(logging.INFO): + await crawler.crawl_async(mockserver=mockserver) - assert "[parse] status 200 (foo: None)" in str(log) - assert "[parse] status 201 (foo: None)" in str(log) - assert "[parse] status 202 (foo: bar)" in str(log) + assert "[parse] status 200 (foo: None)" in caplog.text + assert "[parse] status 201 (foo: None)" in caplog.text + assert "[parse] status 202 (foo: bar)" in caplog.text - @inlineCallbacks - def test_crawlspider_with_async_callback(self): + @coroutine_test + async def test_crawlspider_with_async_callback( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: crawler = get_crawler(CrawlSpiderWithAsyncCallback) - with LogCapture() as log: - yield crawler.crawl(mockserver=self.mockserver) + with caplog.at_level(logging.INFO): + await crawler.crawl_async(mockserver=mockserver) - assert "[parse_async] status 200 (foo: None)" in str(log) - assert "[parse_async] status 201 (foo: None)" in str(log) - assert "[parse_async] status 202 (foo: bar)" in str(log) + assert "[parse_async] status 200 (foo: None)" in caplog.text + assert "[parse_async] status 201 (foo: None)" in caplog.text + assert "[parse_async] status 202 (foo: bar)" in caplog.text - @inlineCallbacks - def test_crawlspider_with_async_generator_callback(self): + @coroutine_test + async def test_crawlspider_with_async_generator_callback( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: crawler = get_crawler(CrawlSpiderWithAsyncGeneratorCallback) - with LogCapture() as log: - yield crawler.crawl(mockserver=self.mockserver) + with caplog.at_level(logging.INFO): + await crawler.crawl_async(mockserver=mockserver) - assert "[parse_async_gen] status 200 (foo: None)" in str(log) - assert "[parse_async_gen] status 201 (foo: None)" in str(log) - assert "[parse_async_gen] status 202 (foo: bar)" in str(log) + assert "[parse_async_gen] status 200 (foo: None)" in caplog.text + assert "[parse_async_gen] status 201 (foo: None)" in caplog.text + assert "[parse_async_gen] status 202 (foo: bar)" in caplog.text - @inlineCallbacks - def test_crawlspider_with_errback(self): + @coroutine_test + async def test_crawlspider_with_errback( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: crawler = get_crawler(CrawlSpiderWithErrback) - with LogCapture() as log: - yield crawler.crawl(mockserver=self.mockserver) + with caplog.at_level(logging.INFO): + await crawler.crawl_async(mockserver=mockserver) - assert "[parse] status 200 (foo: None)" in str(log) - assert "[parse] status 201 (foo: None)" in str(log) - assert "[parse] status 202 (foo: bar)" in str(log) - assert "[errback] status 404" in str(log) - assert "[errback] status 500" in str(log) - assert "[errback] status 501" in str(log) + assert "[parse] status 200 (foo: None)" in caplog.text + assert "[parse] status 201 (foo: None)" in caplog.text + assert "[parse] status 202 (foo: bar)" in caplog.text + assert "[errback] status 404" in caplog.text + assert "[errback] status 500" in caplog.text + assert "[errback] status 501" in caplog.text - @inlineCallbacks - def test_crawlspider_process_request_cb_kwargs(self): + @coroutine_test + async def test_crawlspider_process_request_cb_kwargs( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: crawler = get_crawler(CrawlSpiderWithProcessRequestCallbackKeywordArguments) - with LogCapture() as log: - yield crawler.crawl(mockserver=self.mockserver) + with caplog.at_level(logging.INFO): + await crawler.crawl_async(mockserver=mockserver) - assert "[parse] status 200 (foo: process_request)" in str(log) - assert "[parse] status 201 (foo: process_request)" in str(log) - assert "[parse] status 202 (foo: bar)" in str(log) + assert "[parse] status 200 (foo: process_request)" in caplog.text + assert "[parse] status 201 (foo: process_request)" in caplog.text + assert "[parse] status 202 (foo: bar)" in caplog.text - @inlineCallbacks - def test_async_def_parse(self): + @coroutine_test + async def test_async_def_parse( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: crawler = get_crawler(AsyncDefSpider) - with LogCapture() as log: - yield crawler.crawl( - self.mockserver.url("/status?n=200"), mockserver=self.mockserver + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + mockserver.url("/status?n=200"), mockserver=mockserver ) - assert "Got response 200" in str(log) + assert "Got response 200" in caplog.text @pytest.mark.only_asyncio - @inlineCallbacks - def test_async_def_asyncio_parse(self): + @coroutine_test + async def test_async_def_asyncio_parse( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: crawler = get_crawler( AsyncDefAsyncioSpider, { "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor" }, ) - with LogCapture() as log: - yield crawler.crawl( - self.mockserver.url("/status?n=200"), mockserver=self.mockserver + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + mockserver.url("/status?n=200"), mockserver=mockserver ) - assert "Got response 200" in str(log) + assert "Got response 200" in caplog.text @pytest.mark.only_asyncio - @deferred_f_from_coro_f - async def test_async_def_asyncio_parse_items_list(self): - log, items, _ = await self._run_spider(AsyncDefAsyncioReturnSpider) - assert "Got response 200" in str(log) + @coroutine_test + async def test_async_def_asyncio_parse_items_list( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + with caplog.at_level(logging.INFO): + items, _ = await self._run_spider(AsyncDefAsyncioReturnSpider, mockserver) + assert "Got response 200" in caplog.text assert {"id": 1} in items assert {"id": 2} in items @pytest.mark.only_asyncio - @inlineCallbacks - def test_async_def_asyncio_parse_items_single_element(self): + @coroutine_test + async def test_async_def_asyncio_parse_items_single_element( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: items = [] def _on_item_scraped(item): @@ -553,47 +611,63 @@ class TestCrawlSpider(TestCase): crawler = get_crawler(AsyncDefAsyncioReturnSingleElementSpider) crawler.signals.connect(_on_item_scraped, signals.item_scraped) - with LogCapture() as log: - yield crawler.crawl( - self.mockserver.url("/status?n=200"), mockserver=self.mockserver + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + mockserver.url("/status?n=200"), mockserver=mockserver ) - assert "Got response 200" in str(log) + assert "Got response 200" in caplog.text assert {"foo": 42} in items @pytest.mark.only_asyncio - @deferred_f_from_coro_f - async def test_async_def_asyncgen_parse(self): - log, _, stats = await self._run_spider(AsyncDefAsyncioGenSpider) - assert "Got response 200" in str(log) + @coroutine_test + async def test_async_def_asyncgen_parse( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + with caplog.at_level(logging.INFO): + _, stats = await self._run_spider(AsyncDefAsyncioGenSpider, mockserver) + assert "Got response 200" in caplog.text itemcount = stats.get_value("item_scraped_count") assert itemcount == 1 @pytest.mark.only_asyncio - @deferred_f_from_coro_f - async def test_async_def_asyncgen_parse_loop(self): - log, items, stats = await self._run_spider(AsyncDefAsyncioGenLoopSpider) - assert "Got response 200" in str(log) + @coroutine_test + async def test_async_def_asyncgen_parse_loop( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + with caplog.at_level(logging.INFO): + items, stats = await self._run_spider( + AsyncDefAsyncioGenLoopSpider, mockserver + ) + assert "Got response 200" in caplog.text itemcount = stats.get_value("item_scraped_count") assert itemcount == 10 for i in range(10): assert {"foo": i} in items @pytest.mark.only_asyncio - @deferred_f_from_coro_f - async def test_async_def_asyncgen_parse_exc(self): - log, items, stats = await self._run_spider(AsyncDefAsyncioGenExcSpider) - log = str(log) - assert "Spider error processing" in log - assert "ValueError" in log + @coroutine_test + async def test_async_def_asyncgen_parse_exc( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + with caplog.at_level(logging.INFO): + items, stats = await self._run_spider( + AsyncDefAsyncioGenExcSpider, mockserver + ) + assert "Spider error processing" in caplog.text + assert "ValueError" in caplog.text itemcount = stats.get_value("item_scraped_count") assert itemcount == 7 for i in range(7): assert {"foo": i} in items @pytest.mark.only_asyncio - @deferred_f_from_coro_f - async def test_async_def_asyncgen_parse_complex(self): - _, items, stats = await self._run_spider(AsyncDefAsyncioGenComplexSpider) + @coroutine_test + async def test_async_def_asyncgen_parse_complex( + self, mockserver: MockServer + ) -> None: + items, stats = await self._run_spider( + AsyncDefAsyncioGenComplexSpider, mockserver + ) itemcount = stats.get_value("item_scraped_count") assert itemcount == 156 # some random items @@ -603,81 +677,111 @@ class TestCrawlSpider(TestCase): assert {"index2": i} in items @pytest.mark.only_asyncio - @deferred_f_from_coro_f - async def test_async_def_asyncio_parse_reqs_list(self): - log, *_ = await self._run_spider(AsyncDefAsyncioReqsReturnSpider) + @coroutine_test + async def test_async_def_asyncio_parse_reqs_list( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + with caplog.at_level(logging.INFO): + await self._run_spider(AsyncDefAsyncioReqsReturnSpider, mockserver) for req_id in range(3): - assert f"Got response 200, req_id {req_id}" in str(log) + assert f"Got response 200, req_id {req_id}" in caplog.text @pytest.mark.only_not_asyncio - @deferred_f_from_coro_f - async def test_async_def_deferred_direct(self): - _, items, _ = await self._run_spider(AsyncDefDeferredDirectSpider) + @coroutine_test + async def test_async_def_deferred_direct(self, mockserver: MockServer) -> None: + items, _ = await self._run_spider(AsyncDefDeferredDirectSpider, mockserver) assert items == [{"code": 200}] @pytest.mark.only_asyncio - @deferred_f_from_coro_f - async def test_async_def_deferred_wrapped(self): - log, items, _ = await self._run_spider(AsyncDefDeferredWrappedSpider) + @coroutine_test + async def test_async_def_deferred_wrapped(self, mockserver: MockServer) -> None: + items, _ = await self._run_spider(AsyncDefDeferredWrappedSpider, mockserver) assert items == [{"code": 200}] - @deferred_f_from_coro_f - async def test_async_def_deferred_maybe_wrapped(self): - _, items, _ = await self._run_spider(AsyncDefDeferredMaybeWrappedSpider) + @coroutine_test + async def test_async_def_deferred_maybe_wrapped( + self, mockserver: MockServer + ) -> None: + items, _ = await self._run_spider( + AsyncDefDeferredMaybeWrappedSpider, mockserver + ) assert items == [{"code": 200}] - @inlineCallbacks - def test_response_ssl_certificate_none(self): + @coroutine_test + async def test_response_ssl_certificate_none(self, mockserver: MockServer) -> None: crawler = get_crawler(SingleRequestSpider) - url = self.mockserver.url("/echo?body=test", is_secure=False) - yield crawler.crawl(seed=url, mockserver=self.mockserver) + url = mockserver.url("/echo?body=test", is_secure=False) + await crawler.crawl_async(seed=url, mockserver=mockserver) + assert isinstance(crawler.spider, SingleRequestSpider) assert crawler.spider.meta["responses"][0].certificate is None - @inlineCallbacks - def test_response_ssl_certificate(self): - crawler = get_crawler(SingleRequestSpider) - url = self.mockserver.url("/echo?body=test", is_secure=True) - yield crawler.crawl(seed=url, mockserver=self.mockserver) - cert = crawler.spider.meta["responses"][0].certificate - assert isinstance(cert, Certificate) - assert cert.getSubject().commonName == b"localhost" - assert cert.getIssuer().commonName == b"localhost" - - @pytest.mark.xfail( - reason="Responses with no body return early and contain no certificate" + @pytest.mark.filterwarnings( + r"ignore:.*You should use cryptography's X\.509 APIs:DeprecationWarning" ) - @inlineCallbacks - def test_response_ssl_certificate_empty_response(self): + @pytest.mark.parametrize( + "url", + [ + "/echo?body=test", + pytest.param( + "/status?n=200", + marks=pytest.mark.xfail( + 'config.getoption("--reactor") != "none"', + reason="With HTTP11DownloadHandler, responses with no body are returned early and contain no certificate", + strict=True, + ), + ), + ], + ) + @coroutine_test + async def test_response_ssl_certificate( + self, mockserver: MockServer, url: str + ) -> None: crawler = get_crawler(SingleRequestSpider) - url = self.mockserver.url("/status?n=200", is_secure=True) - yield crawler.crawl(seed=url, mockserver=self.mockserver) + url = mockserver.url(url, is_secure=True) + await crawler.crawl_async(seed=url, mockserver=mockserver) + assert isinstance(crawler.spider, SingleRequestSpider) cert = crawler.spider.meta["responses"][0].certificate - assert isinstance(cert, Certificate) - assert cert.getSubject().commonName == b"localhost" - assert cert.getIssuer().commonName == b"localhost" + assert cert is not None + if isinstance(cert, Certificate): # Twisted + assert cert.getSubject().commonName == b"localhost" + assert cert.getIssuer().commonName == b"localhost" + elif isinstance(cert, bytes): # DER bytes + cert_x509 = load_der_x509_certificate(cert) + assert cert_x509.subject.rfc4514_string() == "CN=localhost,O=Scrapy,C=IE" + assert cert_x509.issuer.rfc4514_string() == "CN=localhost,O=Scrapy,C=IE" - @inlineCallbacks - def test_dns_server_ip_address_none(self): + @pytest.mark.parametrize( + "url", + [ + "/echo?body=test", + pytest.param( + "/status?n=200", + marks=pytest.mark.xfail( + 'config.getoption("--reactor") != "none"', + reason="With HTTP11DownloadHandler, responses with no body are returned early and contain no ip_address", + strict=True, + ), + ), + ], + ) + @coroutine_test + async def test_response_ip_address(self, mockserver: MockServer, url: str) -> None: crawler = get_crawler(SingleRequestSpider) - url = self.mockserver.url("/status?n=200") - yield crawler.crawl(seed=url, mockserver=self.mockserver) - ip_address = crawler.spider.meta["responses"][0].ip_address - assert ip_address is None - - @inlineCallbacks - def test_dns_server_ip_address(self): - crawler = get_crawler(SingleRequestSpider) - url = self.mockserver.url("/echo?body=test") + url = mockserver.url(url) expected_netloc, _ = urlparse(url).netloc.split(":") - yield crawler.crawl(seed=url, mockserver=self.mockserver) + await crawler.crawl_async(seed=url, mockserver=mockserver) + assert isinstance(crawler.spider, SingleRequestSpider) ip_address = crawler.spider.meta["responses"][0].ip_address assert isinstance(ip_address, IPv4Address) assert str(ip_address) == gethostbyname(expected_netloc) - @inlineCallbacks - def test_bytes_received_stop_download_callback(self): + @coroutine_test + async def test_bytes_received_stop_download_callback( + self, mockserver: MockServer + ) -> None: crawler = get_crawler(BytesReceivedCallbackSpider) - yield crawler.crawl(mockserver=self.mockserver) + await crawler.crawl_async(mockserver=mockserver) + assert isinstance(crawler.spider, BytesReceivedCallbackSpider) assert crawler.spider.meta.get("failure") is None assert isinstance(crawler.spider.meta["response"], Response) assert crawler.spider.meta["response"].body == crawler.spider.meta.get( @@ -688,10 +792,13 @@ class TestCrawlSpider(TestCase): < crawler.spider.full_response_length ) - @inlineCallbacks - def test_bytes_received_stop_download_errback(self): + @coroutine_test + async def test_bytes_received_stop_download_errback( + self, mockserver: MockServer + ) -> None: crawler = get_crawler(BytesReceivedErrbackSpider) - yield crawler.crawl(mockserver=self.mockserver) + await crawler.crawl_async(mockserver=mockserver) + assert isinstance(crawler.spider, BytesReceivedErrbackSpider) assert crawler.spider.meta.get("response") is None assert isinstance(crawler.spider.meta["failure"], Failure) assert isinstance(crawler.spider.meta["failure"].value, StopDownload) @@ -704,20 +811,26 @@ class TestCrawlSpider(TestCase): < crawler.spider.full_response_length ) - @inlineCallbacks - def test_headers_received_stop_download_callback(self): + @coroutine_test + async def test_headers_received_stop_download_callback( + self, mockserver: MockServer + ) -> None: crawler = get_crawler(HeadersReceivedCallbackSpider) - yield crawler.crawl(mockserver=self.mockserver) + await crawler.crawl_async(mockserver=mockserver) + assert isinstance(crawler.spider, HeadersReceivedCallbackSpider) assert crawler.spider.meta.get("failure") is None assert isinstance(crawler.spider.meta["response"], Response) assert crawler.spider.meta["response"].headers == crawler.spider.meta.get( "headers_received" ) - @inlineCallbacks - def test_headers_received_stop_download_errback(self): + @coroutine_test + async def test_headers_received_stop_download_errback( + self, mockserver: MockServer + ) -> None: crawler = get_crawler(HeadersReceivedErrbackSpider) - yield crawler.crawl(mockserver=self.mockserver) + await crawler.crawl_async(mockserver=mockserver) + assert isinstance(crawler.spider, HeadersReceivedErrbackSpider) assert crawler.spider.meta.get("response") is None assert isinstance(crawler.spider.meta["failure"], Failure) assert isinstance(crawler.spider.meta["failure"].value, StopDownload) @@ -726,8 +839,24 @@ class TestCrawlSpider(TestCase): "failure" ].value.response.headers == crawler.spider.meta.get("headers_received") - @inlineCallbacks - def test_spider_errback(self): + @coroutine_test + async def test_spider_callback_deferred_deprecated( + self, mockserver: MockServer + ) -> None: + def cb(response: Response) -> Any: + return succeed(None) + + crawler = get_crawler(SingleRequestSpider) + with pytest.warns( + ScrapyDeprecationWarning, + match="Returning Deferreds from spider callbacks is deprecated", + ): + await crawler.crawl_async(seed=mockserver.url("/"), callback_func=cb) + + @coroutine_test + async def test_spider_errback( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: failures = [] def eb(failure: Failure) -> Failure: @@ -735,72 +864,82 @@ class TestCrawlSpider(TestCase): return failure crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl( - seed=self.mockserver.url("/status?n=400"), errback_func=eb + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + seed=mockserver.url("/status?n=400"), errback_func=eb ) assert len(failures) == 1 - assert "HTTP status code is not handled or not allowed" in str(log) - assert "Spider error processing" not in str(log) + assert "HTTP status code is not handled or not allowed" in caplog.text + assert "Spider error processing" not in caplog.text - @inlineCallbacks - def test_spider_errback_silence(self): + @coroutine_test + async def test_spider_errback_silence( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: failures = [] def eb(failure: Failure) -> None: failures.append(failure) crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl( - seed=self.mockserver.url("/status?n=400"), errback_func=eb + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + seed=mockserver.url("/status?n=400"), errback_func=eb ) assert len(failures) == 1 - assert "HTTP status code is not handled or not allowed" not in str(log) - assert "Spider error processing" not in str(log) + assert "HTTP status code is not handled or not allowed" not in caplog.text + assert "Spider error processing" not in caplog.text - @inlineCallbacks - def test_spider_errback_exception(self): + @coroutine_test + async def test_spider_errback_exception( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: def eb(failure: Failure) -> None: raise ValueError("foo") crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl( - seed=self.mockserver.url("/status?n=400"), errback_func=eb + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + seed=mockserver.url("/status?n=400"), errback_func=eb ) - assert "Spider error processing" in str(log) + assert "Spider error processing" in caplog.text - @inlineCallbacks - def test_spider_errback_item(self): + @coroutine_test + async def test_spider_errback_item( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: def eb(failure: Failure) -> Any: return {"foo": "bar"} crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl( - seed=self.mockserver.url("/status?n=400"), errback_func=eb + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + seed=mockserver.url("/status?n=400"), errback_func=eb ) - assert "HTTP status code is not handled or not allowed" not in str(log) - assert "Spider error processing" not in str(log) - assert "'item_scraped_count': 1" in str(log) + assert "HTTP status code is not handled or not allowed" not in caplog.text + assert "Spider error processing" not in caplog.text + assert "'item_scraped_count': 1" in caplog.text - @inlineCallbacks - def test_spider_errback_request(self): + @coroutine_test + async def test_spider_errback_request( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: def eb(failure: Failure) -> Request: - return Request(self.mockserver.url("/")) + return Request(mockserver.url("/")) crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl( - seed=self.mockserver.url("/status?n=400"), errback_func=eb + with caplog.at_level(logging.DEBUG): + await crawler.crawl_async( + seed=mockserver.url("/status?n=400"), errback_func=eb ) - assert "HTTP status code is not handled or not allowed" not in str(log) - assert "Spider error processing" not in str(log) - assert "Crawled (200)" in str(log) + assert "HTTP status code is not handled or not allowed" not in caplog.text + assert "Spider error processing" not in caplog.text + assert "Crawled (200)" in caplog.text - @inlineCallbacks - def test_spider_errback_downloader_error(self): + @coroutine_test + async def test_spider_errback_downloader_error( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: failures = [] def eb(failure: Failure) -> Failure: @@ -808,73 +947,99 @@ class TestCrawlSpider(TestCase): return failure crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl( - seed=self.mockserver.url("/drop?abort=1"), errback_func=eb + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + seed=mockserver.url("/drop?abort=1"), errback_func=eb ) assert len(failures) == 1 - assert "Error downloading" in str(log) - assert "Spider error processing" not in str(log) + assert "Error downloading" in caplog.text + assert "Spider error processing" not in caplog.text - @inlineCallbacks - def test_spider_errback_downloader_error_exception(self): + @coroutine_test + async def test_spider_errback_downloader_error_exception( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: def eb(failure: Failure) -> None: raise ValueError("foo") crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl( - seed=self.mockserver.url("/drop?abort=1"), errback_func=eb + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + seed=mockserver.url("/drop?abort=1"), errback_func=eb ) - assert "Error downloading" in str(log) - assert "Spider error processing" in str(log) + assert "Error downloading" in caplog.text + assert "Spider error processing" in caplog.text - @inlineCallbacks - def test_spider_errback_downloader_error_item(self): + @coroutine_test + async def test_spider_errback_downloader_error_item( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: def eb(failure: Failure) -> Any: return {"foo": "bar"} crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl( - seed=self.mockserver.url("/drop?abort=1"), errback_func=eb + with caplog.at_level(logging.INFO): + await crawler.crawl_async( + seed=mockserver.url("/drop?abort=1"), errback_func=eb ) - assert "HTTP status code is not handled or not allowed" not in str(log) - assert "Spider error processing" not in str(log) - assert "'item_scraped_count': 1" in str(log) + assert "HTTP status code is not handled or not allowed" not in caplog.text + assert "Spider error processing" not in caplog.text + assert "'item_scraped_count': 1" in caplog.text - @inlineCallbacks - def test_spider_errback_downloader_error_request(self): + @coroutine_test + async def test_spider_errback_downloader_error_request( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: def eb(failure: Failure) -> Request: - return Request(self.mockserver.url("/")) + return Request(mockserver.url("/")) crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl( - seed=self.mockserver.url("/drop?abort=1"), errback_func=eb + with caplog.at_level(logging.DEBUG): + await crawler.crawl_async( + seed=mockserver.url("/drop?abort=1"), errback_func=eb ) - assert "HTTP status code is not handled or not allowed" not in str(log) - assert "Spider error processing" not in str(log) - assert "Crawled (200)" in str(log) + assert "HTTP status code is not handled or not allowed" not in caplog.text + assert "Spider error processing" not in caplog.text + assert "Crawled (200)" in caplog.text - @inlineCallbacks - def test_raise_closespider(self): + @coroutine_test + async def test_spider_errback_deferred_deprecated( + self, mockserver: MockServer + ) -> None: + def eb(failure: Failure) -> Any: + return succeed(None) + + crawler = get_crawler(SingleRequestSpider) + with pytest.warns( + ScrapyDeprecationWarning, + match="Returning Deferreds from spider errbacks is deprecated", + ): + await crawler.crawl_async( + seed=mockserver.url("/status?n=400"), errback_func=eb + ) + + @coroutine_test + async def test_raise_closespider( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: def cb(response): raise CloseSpider crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl(seed=self.mockserver.url("/"), callback_func=cb) - assert "Closing spider (cancelled)" in str(log) - assert "Spider error processing" not in str(log) + with caplog.at_level(logging.INFO): + await crawler.crawl_async(seed=mockserver.url("/"), callback_func=cb) + assert "Closing spider (cancelled)" in caplog.text + assert "Spider error processing" not in caplog.text - @inlineCallbacks - def test_raise_closespider_reason(self): + @coroutine_test + async def test_raise_closespider_reason( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: def cb(response): raise CloseSpider("my_reason") crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl(seed=self.mockserver.url("/"), callback_func=cb) - assert "Closing spider (my_reason)" in str(log) - assert "Spider error processing" not in str(log) + with caplog.at_level(logging.INFO): + await crawler.crawl_async(seed=mockserver.url("/"), callback_func=cb) + assert "Closing spider (my_reason)" in caplog.text + assert "Spider error processing" not in caplog.text diff --git a/tests/test_crawler.py b/tests/test_crawler.py index 56cb21650..0cddfd0ed 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -1,21 +1,12 @@ +from __future__ import annotations + import asyncio import logging -import platform import re -import signal -import subprocess -import sys -import warnings -from abc import ABC, abstractmethod from pathlib import Path -from typing import Any +from typing import Any, ClassVar import pytest -from packaging.version import parse as parse_version -from pexpect.popen_spawn import PopenSpawn -from twisted.internet.defer import Deferred, inlineCallbacks -from twisted.trial import unittest -from w3lib import __version__ as w3lib_version from zope.interface.exceptions import MultipleInvalid import scrapy @@ -26,20 +17,27 @@ from scrapy.crawler import ( Crawler, CrawlerProcess, CrawlerRunner, + CrawlerRunnerBase, ) from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.extensions.throttle import AutoThrottle from scrapy.settings import Settings, default_settings -from scrapy.utils.defer import deferred_f_from_coro_f, deferred_from_coro -from scrapy.utils.log import configure_logging, get_scrapy_root_handler +from scrapy.utils.defer import ensure_awaitable, maybe_deferred_to_future +from scrapy.utils.log import ( + _uninstall_scrapy_root_handler, + configure_logging, + get_scrapy_root_handler, +) from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler, get_reactor_settings -from tests.mockserver import MockServer, get_mockserver_env +from tests.utils.decorators import coroutine_test BASE_SETTINGS: dict[str, Any] = {} -def get_raw_crawler(spidercls=None, settings_dict=None): +def get_raw_crawler( + spidercls: type[Spider] | None = None, settings_dict: dict[str, Any] | None = None +) -> Crawler: """get_crawler alternative that only calls the __init__ method of the crawler.""" settings = Settings() @@ -48,15 +46,19 @@ def get_raw_crawler(spidercls=None, settings_dict=None): return Crawler(spidercls or DefaultSpider, settings) -class TestBaseCrawler(unittest.TestCase): - def assertOptionIsDefault(self, settings, key): +class TestBaseCrawler: + @staticmethod + def assertOptionIsDefault(settings: Settings, key: str) -> None: assert isinstance(settings, Settings) assert settings[key] == getattr(default_settings, key) class TestCrawler(TestBaseCrawler): - def test_populate_spidercls_settings(self): - spider_settings = {"TEST1": "spider", "TEST2": "spider"} + def test_populate_spidercls_settings(self) -> None: + spider_settings: dict[str, Any] = { + "TEST1": "spider", + "TEST2": "spider", + } project_settings = { **BASE_SETTINGS, "TEST1": "project", @@ -79,48 +81,45 @@ class TestCrawler(TestBaseCrawler): assert not settings.frozen assert crawler.settings.frozen - def test_crawler_accepts_dict(self): + def test_crawler_accepts_dict(self) -> None: crawler = get_crawler(DefaultSpider, {"foo": "bar"}) assert crawler.settings["foo"] == "bar" self.assertOptionIsDefault(crawler.settings, "RETRY_ENABLED") - def test_crawler_accepts_None(self): - with warnings.catch_warnings(): - warnings.simplefilter("ignore", ScrapyDeprecationWarning) - crawler = Crawler(DefaultSpider) + def test_crawler_accepts_None(self) -> None: + crawler = Crawler(DefaultSpider) self.assertOptionIsDefault(crawler.settings, "RETRY_ENABLED") - def test_crawler_rejects_spider_objects(self): + def test_crawler_rejects_spider_objects(self) -> None: with pytest.raises(ValueError, match="spidercls argument must be a class"): - Crawler(DefaultSpider()) + Crawler(DefaultSpider()) # type: ignore[arg-type] - @inlineCallbacks - def test_crawler_crawl_twice_seq_unsupported(self): + @coroutine_test + async def test_crawler_crawl_twice_seq_unsupported(self) -> None: crawler = get_raw_crawler(NoRequestsSpider, BASE_SETTINGS) - yield crawler.crawl() + await maybe_deferred_to_future(crawler.crawl()) with pytest.raises(RuntimeError, match="more than once on the same instance"): - yield crawler.crawl() + await maybe_deferred_to_future(crawler.crawl()) - @pytest.mark.only_asyncio - @deferred_f_from_coro_f - async def test_crawler_crawl_async_twice_seq_unsupported(self): + @coroutine_test + async def test_crawler_crawl_async_twice_seq_unsupported(self) -> None: crawler = get_raw_crawler(NoRequestsSpider, BASE_SETTINGS) await crawler.crawl_async() with pytest.raises(RuntimeError, match="more than once on the same instance"): await crawler.crawl_async() - @inlineCallbacks - def test_crawler_crawl_twice_parallel_unsupported(self): + @coroutine_test + async def test_crawler_crawl_twice_parallel_unsupported(self) -> None: crawler = get_raw_crawler(NoRequestsSpider, BASE_SETTINGS) d1 = crawler.crawl() d2 = crawler.crawl() - yield d1 + await maybe_deferred_to_future(d1) with pytest.raises(RuntimeError, match="Crawling already taking place"): - yield d2 + await maybe_deferred_to_future(d2) @pytest.mark.only_asyncio - @deferred_f_from_coro_f - async def test_crawler_crawl_async_twice_parallel_unsupported(self): + @coroutine_test + async def test_crawler_crawl_async_twice_parallel_unsupported(self) -> None: crawler = get_raw_crawler(NoRequestsSpider, BASE_SETTINGS) t1 = asyncio.create_task(crawler.crawl_async()) t2 = asyncio.create_task(crawler.crawl_async()) @@ -128,12 +127,12 @@ class TestCrawler(TestBaseCrawler): with pytest.raises(RuntimeError, match="Crawling already taking place"): await t2 - def test_get_addon(self): + def test_get_addon(self) -> None: class ParentAddon: pass class TrackingAddon(ParentAddon): - instances = [] + instances: ClassVar[list[TrackingAddon]] = [] def __init__(self): TrackingAddon.instances.append(self) @@ -154,7 +153,7 @@ class TestCrawler(TestBaseCrawler): addon = crawler.get_addon(TrackingAddon) assert addon == expected - addon = crawler.get_addon(DefaultSpider) + addon = crawler.get_addon(DefaultSpider) # type: ignore[assignment] assert addon is None addon = crawler.get_addon(ParentAddon) @@ -166,19 +165,21 @@ class TestCrawler(TestBaseCrawler): addon = crawler.get_addon(ChildAddon) assert addon is None - @inlineCallbacks - def test_get_downloader_middleware(self): + @coroutine_test + async def test_get_downloader_middleware(self) -> None: class ParentDownloaderMiddleware: pass class TrackingDownloaderMiddleware(ParentDownloaderMiddleware): - instances = [] + instances: ClassVar[list[TrackingDownloaderMiddleware]] = [] def __init__(self): TrackingDownloaderMiddleware.instances.append(self) class MySpider(Spider): name = "myspider" + cls: ClassVar[type[Any]] + result: ClassVar[Any] @classmethod def from_crawler(cls, crawler): @@ -202,18 +203,18 @@ class TestCrawler(TestBaseCrawler): crawler = get_raw_crawler(MySpider, settings) MySpider.cls = TrackingDownloaderMiddleware - yield crawler.crawl() + await crawler.crawl_async() assert len(TrackingDownloaderMiddleware.instances) == 1 assert MySpider.result == TrackingDownloaderMiddleware.instances[-1] crawler = get_raw_crawler(MySpider, settings) MySpider.cls = DefaultSpider - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result is None crawler = get_raw_crawler(MySpider, settings) MySpider.cls = ParentDownloaderMiddleware - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result == TrackingDownloaderMiddleware.instances[-1] class ChildDownloaderMiddleware(TrackingDownloaderMiddleware): @@ -221,44 +222,42 @@ class TestCrawler(TestBaseCrawler): crawler = get_raw_crawler(MySpider, settings) MySpider.cls = ChildDownloaderMiddleware - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result is None - def test_get_downloader_middleware_not_crawling(self): + def test_get_downloader_middleware_not_crawling(self) -> None: crawler = get_raw_crawler(settings_dict=BASE_SETTINGS) with pytest.raises(RuntimeError): crawler.get_downloader_middleware(DefaultSpider) - @inlineCallbacks - def test_get_downloader_middleware_no_engine(self): + @coroutine_test + async def test_get_downloader_middleware_no_engine(self) -> None: class MySpider(Spider): name = "myspider" @classmethod def from_crawler(cls, crawler): - try: - crawler.get_downloader_middleware(DefaultSpider) - except Exception as e: - MySpider.result = e - raise + crawler.get_downloader_middleware(DefaultSpider) crawler = get_raw_crawler(MySpider, BASE_SETTINGS) with pytest.raises(RuntimeError): - yield crawler.crawl() + await crawler.crawl_async() - @inlineCallbacks - def test_get_extension(self): + @coroutine_test + async def test_get_extension(self) -> None: class ParentExtension: pass class TrackingExtension(ParentExtension): - instances = [] + instances: ClassVar[list[TrackingExtension]] = [] def __init__(self): TrackingExtension.instances.append(self) class MySpider(Spider): name = "myspider" + cls: ClassVar[type[Any]] + result: ClassVar[Any] @classmethod def from_crawler(cls, crawler): @@ -282,18 +281,18 @@ class TestCrawler(TestBaseCrawler): crawler = get_raw_crawler(MySpider, settings) MySpider.cls = TrackingExtension - yield crawler.crawl() + await crawler.crawl_async() assert len(TrackingExtension.instances) == 1 assert MySpider.result == TrackingExtension.instances[-1] crawler = get_raw_crawler(MySpider, settings) MySpider.cls = DefaultSpider - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result is None crawler = get_raw_crawler(MySpider, settings) MySpider.cls = ParentExtension - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result == TrackingExtension.instances[-1] class ChildExtension(TrackingExtension): @@ -301,44 +300,42 @@ class TestCrawler(TestBaseCrawler): crawler = get_raw_crawler(MySpider, settings) MySpider.cls = ChildExtension - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result is None - def test_get_extension_not_crawling(self): + def test_get_extension_not_crawling(self) -> None: crawler = get_raw_crawler(settings_dict=BASE_SETTINGS) with pytest.raises(RuntimeError): crawler.get_extension(DefaultSpider) - @inlineCallbacks - def test_get_extension_no_engine(self): + @coroutine_test + async def test_get_extension_no_engine(self) -> None: class MySpider(Spider): name = "myspider" @classmethod def from_crawler(cls, crawler): - try: - crawler.get_extension(DefaultSpider) - except Exception as e: - MySpider.result = e - raise + crawler.get_extension(DefaultSpider) crawler = get_raw_crawler(MySpider, BASE_SETTINGS) with pytest.raises(RuntimeError): - yield crawler.crawl() + await crawler.crawl_async() - @inlineCallbacks - def test_get_item_pipeline(self): + @coroutine_test + async def test_get_item_pipeline(self) -> None: class ParentItemPipeline: pass class TrackingItemPipeline(ParentItemPipeline): - instances = [] + instances: ClassVar[list[TrackingItemPipeline]] = [] def __init__(self): TrackingItemPipeline.instances.append(self) class MySpider(Spider): name = "myspider" + cls: ClassVar[type[Any]] + result: ClassVar[Any] @classmethod def from_crawler(cls, crawler): @@ -362,18 +359,18 @@ class TestCrawler(TestBaseCrawler): crawler = get_raw_crawler(MySpider, settings) MySpider.cls = TrackingItemPipeline - yield crawler.crawl() + await crawler.crawl_async() assert len(TrackingItemPipeline.instances) == 1 assert MySpider.result == TrackingItemPipeline.instances[-1] crawler = get_raw_crawler(MySpider, settings) MySpider.cls = DefaultSpider - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result is None crawler = get_raw_crawler(MySpider, settings) MySpider.cls = ParentItemPipeline - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result == TrackingItemPipeline.instances[-1] class ChildItemPipeline(TrackingItemPipeline): @@ -381,44 +378,42 @@ class TestCrawler(TestBaseCrawler): crawler = get_raw_crawler(MySpider, settings) MySpider.cls = ChildItemPipeline - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result is None - def test_get_item_pipeline_not_crawling(self): + def test_get_item_pipeline_not_crawling(self) -> None: crawler = get_raw_crawler(settings_dict=BASE_SETTINGS) with pytest.raises(RuntimeError): crawler.get_item_pipeline(DefaultSpider) - @inlineCallbacks - def test_get_item_pipeline_no_engine(self): + @coroutine_test + async def test_get_item_pipeline_no_engine(self) -> None: class MySpider(Spider): name = "myspider" @classmethod def from_crawler(cls, crawler): - try: - crawler.get_item_pipeline(DefaultSpider) - except Exception as e: - MySpider.result = e - raise + crawler.get_item_pipeline(DefaultSpider) crawler = get_raw_crawler(MySpider, BASE_SETTINGS) with pytest.raises(RuntimeError): - yield crawler.crawl() + await crawler.crawl_async() - @inlineCallbacks - def test_get_spider_middleware(self): + @coroutine_test + async def test_get_spider_middleware(self) -> None: class ParentSpiderMiddleware: pass class TrackingSpiderMiddleware(ParentSpiderMiddleware): - instances = [] + instances: ClassVar[list[TrackingSpiderMiddleware]] = [] def __init__(self): TrackingSpiderMiddleware.instances.append(self) class MySpider(Spider): name = "myspider" + cls: ClassVar[type[Any]] + result: ClassVar[Any] @classmethod def from_crawler(cls, crawler): @@ -442,18 +437,18 @@ class TestCrawler(TestBaseCrawler): crawler = get_raw_crawler(MySpider, settings) MySpider.cls = TrackingSpiderMiddleware - yield crawler.crawl() + await crawler.crawl_async() assert len(TrackingSpiderMiddleware.instances) == 1 assert MySpider.result == TrackingSpiderMiddleware.instances[-1] crawler = get_raw_crawler(MySpider, settings) MySpider.cls = DefaultSpider - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result is None crawler = get_raw_crawler(MySpider, settings) MySpider.cls = ParentSpiderMiddleware - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result == TrackingSpiderMiddleware.instances[-1] class ChildSpiderMiddleware(TrackingSpiderMiddleware): @@ -461,45 +456,42 @@ class TestCrawler(TestBaseCrawler): crawler = get_raw_crawler(MySpider, settings) MySpider.cls = ChildSpiderMiddleware - yield crawler.crawl() + await crawler.crawl_async() assert MySpider.result is None - def test_get_spider_middleware_not_crawling(self): + def test_get_spider_middleware_not_crawling(self) -> None: crawler = get_raw_crawler(settings_dict=BASE_SETTINGS) with pytest.raises(RuntimeError): crawler.get_spider_middleware(DefaultSpider) - @inlineCallbacks - def test_get_spider_middleware_no_engine(self): + @coroutine_test + async def test_get_spider_middleware_no_engine(self) -> None: class MySpider(Spider): name = "myspider" @classmethod def from_crawler(cls, crawler): - try: - crawler.get_spider_middleware(DefaultSpider) - except Exception as e: - MySpider.result = e - raise + crawler.get_spider_middleware(DefaultSpider) crawler = get_raw_crawler(MySpider, BASE_SETTINGS) with pytest.raises(RuntimeError): - yield crawler.crawl() + await crawler.crawl_async() class TestSpiderSettings: - def test_spider_custom_settings(self): + def test_spider_custom_settings(self) -> None: class MySpider(scrapy.Spider): name = "spider" custom_settings = {"AUTOTHROTTLE_ENABLED": True} crawler = get_crawler(MySpider) + assert crawler.extensions enabled_exts = [e.__class__ for e in crawler.extensions.middlewares] assert AutoThrottle in enabled_exts class TestCrawlerLogging: - def test_no_root_handler_installed(self): + def test_no_root_handler_installed(self) -> None: handler = get_scrapy_root_handler() if handler is not None: logging.root.removeHandler(handler) @@ -510,10 +502,13 @@ class TestCrawlerLogging: get_crawler(MySpider) assert get_scrapy_root_handler() is None - def test_spider_custom_settings_log_level(self, tmp_path): + @coroutine_test + async def test_spider_custom_settings_log_level(self, tmp_path: Path) -> None: log_file = Path(tmp_path, "log.txt") log_file.write_text("previous message\n", encoding="utf-8") + info_count = None + class MySpider(scrapy.Spider): name = "spider" custom_settings = { @@ -521,15 +516,31 @@ class TestCrawlerLogging: "LOG_FILE": str(log_file), } - configure_logging() - assert get_scrapy_root_handler().level == logging.DEBUG - crawler = get_crawler(MySpider) - assert get_scrapy_root_handler().level == logging.INFO - info_count = crawler.stats.get_value("log_count/INFO") - logging.debug("debug message") - logging.info("info message") - logging.warning("warning message") - logging.error("error message") + async def start(self): + info_count_start = crawler.stats.get_value("log_count/INFO") + logging.debug("debug message") # noqa: LOG015 + logging.info("info message") # noqa: LOG015 + logging.warning("warning message") # noqa: LOG015 + logging.error("error message") # noqa: LOG015 + nonlocal info_count + info_count = ( + crawler.stats.get_value("log_count/INFO") - info_count_start + ) + return + yield + + try: + configure_logging() + handler = get_scrapy_root_handler() + assert handler is not None + assert handler.level == logging.DEBUG + crawler = get_crawler(MySpider) + handler = get_scrapy_root_handler() + assert handler is not None + assert handler.level == logging.INFO + await crawler.crawl_async() + finally: + _uninstall_scrapy_root_handler() logged = log_file.read_text(encoding="utf-8") @@ -538,12 +549,13 @@ class TestCrawlerLogging: assert "info message" in logged assert "warning message" in logged assert "error message" in logged + assert crawler.stats assert crawler.stats.get_value("log_count/ERROR") == 1 assert crawler.stats.get_value("log_count/WARNING") == 1 - assert crawler.stats.get_value("log_count/INFO") - info_count == 1 + assert info_count == 1 assert crawler.stats.get_value("log_count/DEBUG", 0) == 0 - def test_spider_custom_settings_log_append(self, tmp_path): + def test_spider_custom_settings_log_append(self, tmp_path: Path) -> None: log_file = Path(tmp_path, "log.txt") log_file.write_text("previous message\n", encoding="utf-8") @@ -554,9 +566,12 @@ class TestCrawlerLogging: "LOG_FILE_APPEND": False, } - configure_logging() - get_crawler(MySpider) - logging.debug("debug message") + try: + configure_logging() + get_crawler(MySpider) + logging.debug("debug message") # noqa: LOG015 + finally: + _uninstall_scrapy_root_handler() logged = log_file.read_text(encoding="utf-8") @@ -565,12 +580,12 @@ class TestCrawlerLogging: class SpiderLoaderWithWrongInterface: - def unneeded_method(self): + def unneeded_method(self) -> None: pass class TestCrawlerRunner(TestBaseCrawler): - def test_spider_manager_verify_interface(self): + def test_spider_manager_verify_interface(self) -> None: settings = Settings( { "SPIDER_LOADER_CLASS": SpiderLoaderWithWrongInterface, @@ -579,18 +594,18 @@ class TestCrawlerRunner(TestBaseCrawler): with pytest.raises(MultipleInvalid): CrawlerRunner(settings) - def test_crawler_runner_accepts_dict(self): + def test_crawler_runner_accepts_dict(self) -> None: runner = CrawlerRunner({"foo": "bar"}) assert runner.settings["foo"] == "bar" self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") - def test_crawler_runner_accepts_None(self): + def test_crawler_runner_accepts_None(self) -> None: runner = CrawlerRunner() self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") class TestAsyncCrawlerRunner(TestBaseCrawler): - def test_spider_manager_verify_interface(self): + def test_spider_manager_verify_interface(self) -> None: settings = Settings( { "SPIDER_LOADER_CLASS": SpiderLoaderWithWrongInterface, @@ -599,39 +614,79 @@ class TestAsyncCrawlerRunner(TestBaseCrawler): with pytest.raises(MultipleInvalid): AsyncCrawlerRunner(settings) - def test_crawler_runner_accepts_dict(self): + def test_crawler_runner_accepts_dict(self) -> None: runner = AsyncCrawlerRunner({"foo": "bar"}) assert runner.settings["foo"] == "bar" self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") - def test_crawler_runner_accepts_None(self): + def test_crawler_runner_accepts_None(self) -> None: runner = AsyncCrawlerRunner() self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") class TestCrawlerProcess(TestBaseCrawler): - def test_crawler_process_accepts_dict(self): - runner = CrawlerProcess({"foo": "bar"}) + def test_crawler_process_accepts_dict(self) -> None: + runner = CrawlerProcess({"foo": "bar"}, install_root_handler=False) assert runner.settings["foo"] == "bar" self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") - def test_crawler_process_accepts_None(self): - runner = CrawlerProcess() + def test_crawler_process_accepts_None(self) -> None: + runner = CrawlerProcess(install_root_handler=False) self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") @pytest.mark.only_asyncio class TestAsyncCrawlerProcess(TestBaseCrawler): - def test_crawler_process_accepts_dict(self): - runner = AsyncCrawlerProcess({"foo": "bar"}) + def test_crawler_process_accepts_dict(self, reactor_pytest: str) -> None: + runner = AsyncCrawlerProcess( + {"foo": "bar", "TWISTED_REACTOR_ENABLED": reactor_pytest != "none"}, + install_root_handler=False, + ) assert runner.settings["foo"] == "bar" self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") - def test_crawler_process_accepts_None(self): - runner = AsyncCrawlerProcess() + @pytest.mark.requires_reactor # can't pass TWISTED_REACTOR_ENABLED=False + def test_crawler_process_accepts_None(self) -> None: + runner = AsyncCrawlerProcess(install_root_handler=False) self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") +@pytest.mark.parametrize("runner_cls", [AsyncCrawlerRunner, CrawlerRunner]) +def test_runner_settings_applied_to_crawler_instance( + runner_cls: type[CrawlerRunnerBase], +) -> None: + runner = runner_cls({"FOO": "runner"}) + crawler = Crawler(DefaultSpider) + result = runner.create_crawler(crawler) + assert result is crawler + assert result.settings["FOO"] == "runner" + + +@pytest.mark.parametrize("runner_cls", [AsyncCrawlerRunner, CrawlerRunner]) +def test_spider_custom_settings_override_runner( + runner_cls: type[CrawlerRunnerBase], +) -> None: + class MySpider(DefaultSpider): + custom_settings = {"FOO": "spider"} + + runner = runner_cls({"FOO": "runner"}) + crawler = Crawler(MySpider) + runner.create_crawler(crawler) + assert crawler.settings["FOO"] == "spider" + + +def test_create_crawler_instance_consistent_with_spider_class() -> None: + runner = AsyncCrawlerRunner({"FOO": "runner"}) + + crawler_from_class = runner.create_crawler(DefaultSpider) + + pre_built = Crawler(DefaultSpider) + runner.create_crawler(pre_built) + + assert crawler_from_class.settings["FOO"] == "runner" + assert pre_built.settings["FOO"] == "runner" + + class ExceptionSpider(scrapy.Spider): name = "exception" @@ -648,35 +703,37 @@ class NoRequestsSpider(scrapy.Spider): yield -@pytest.mark.usefixtures("reactor_pytest") -class TestCrawlerRunnerHasSpider(unittest.TestCase): - @staticmethod - def _runner(): +@pytest.mark.requires_reactor # CrawlerRunner requires a reactor +class TestCrawlerRunnerHasSpider: + @pytest.fixture + def runner(self) -> CrawlerRunnerBase: return CrawlerRunner(get_reactor_settings()) @staticmethod - def _crawl(runner, spider): - return runner.crawl(spider) + async def _crawl(runner: CrawlerRunnerBase, spider: type[Spider]) -> None: + await ensure_awaitable(runner.crawl(spider)) - @inlineCallbacks - def test_crawler_runner_bootstrap_successful(self): - runner = self._runner() - yield self._crawl(runner, NoRequestsSpider) + @coroutine_test + async def test_crawler_runner_bootstrap_successful( + self, runner: CrawlerRunnerBase + ) -> None: + await self._crawl(runner, NoRequestsSpider) assert not runner.bootstrap_failed - @inlineCallbacks - def test_crawler_runner_bootstrap_successful_for_several(self): - runner = self._runner() - yield self._crawl(runner, NoRequestsSpider) - yield self._crawl(runner, NoRequestsSpider) + @coroutine_test + async def test_crawler_runner_bootstrap_successful_for_several( + self, runner: CrawlerRunnerBase + ) -> None: + await self._crawl(runner, NoRequestsSpider) + await self._crawl(runner, NoRequestsSpider) assert not runner.bootstrap_failed - @inlineCallbacks - def test_crawler_runner_bootstrap_failed(self): - runner = self._runner() - + @coroutine_test + async def test_crawler_runner_bootstrap_failed( + self, runner: CrawlerRunnerBase + ) -> None: try: - yield self._crawl(runner, ExceptionSpider) + await self._crawl(runner, ExceptionSpider) except ValueError: pass else: @@ -684,24 +741,26 @@ class TestCrawlerRunnerHasSpider(unittest.TestCase): assert runner.bootstrap_failed - @inlineCallbacks - def test_crawler_runner_bootstrap_failed_for_several(self): - runner = self._runner() - + @coroutine_test + async def test_crawler_runner_bootstrap_failed_for_several( + self, runner: CrawlerRunnerBase + ) -> None: try: - yield self._crawl(runner, ExceptionSpider) + await self._crawl(runner, ExceptionSpider) except ValueError: pass else: pytest.fail("Exception should be raised from spider") - yield self._crawl(runner, NoRequestsSpider) + await self._crawl(runner, NoRequestsSpider) assert runner.bootstrap_failed - @inlineCallbacks - def test_crawler_runner_asyncio_enabled_true(self): - if self.reactor_pytest == "default": + @coroutine_test + async def test_crawler_runner_asyncio_enabled_true( + self, reactor_pytest: str + ) -> None: + if reactor_pytest != "asyncio": runner = CrawlerRunner( settings={ "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", @@ -711,445 +770,26 @@ class TestCrawlerRunnerHasSpider(unittest.TestCase): Exception, match=r"The installed reactor \(.*?\) does not match the requested one \(.*?\)", ): - yield self._crawl(runner, NoRequestsSpider) + await self._crawl(runner, NoRequestsSpider) else: - CrawlerRunner( + runner = CrawlerRunner( settings={ "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", } ) + await self._crawl(runner, NoRequestsSpider) @pytest.mark.only_asyncio class TestAsyncCrawlerRunnerHasSpider(TestCrawlerRunnerHasSpider): - @staticmethod - def _runner(): + @pytest.fixture + def runner(self) -> CrawlerRunnerBase: return AsyncCrawlerRunner(get_reactor_settings()) - @staticmethod - def _crawl(runner, spider): - return deferred_from_coro(runner.crawl(spider)) - - def test_crawler_runner_asyncio_enabled_true(self): + def test_crawler_runner_asyncio_enabled_true(self) -> None: # type: ignore[override] pytest.skip("This test is only for CrawlerRunner") -class ScriptRunnerMixin(ABC): - @property - @abstractmethod - def script_dir(self) -> Path: - raise NotImplementedError - - @staticmethod - def get_script_dir(name: str) -> Path: - return Path(__file__).parent.resolve() / name - - def get_script_args(self, script_name: str, *script_args: str) -> list[str]: - script_path = self.script_dir / script_name - return [sys.executable, str(script_path), *script_args] - - def run_script(self, script_name: str, *script_args: str) -> str: - args = self.get_script_args(script_name, *script_args) - p = subprocess.Popen( - args, - env=get_mockserver_env(), - stdout=subprocess.PIPE, - stderr=subprocess.PIPE, - ) - stdout, stderr = p.communicate() - return stderr.decode("utf-8") - - -class TestCrawlerProcessSubprocessBase(ScriptRunnerMixin, unittest.TestCase): - """Common tests between CrawlerProcess and AsyncCrawlerProcess, - with the same file names and expectations. - """ - - def test_simple(self): - log = self.run_script("simple.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - - def test_multi(self): - log = self.run_script("multi.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert "ReactorAlreadyInstalledError" not in log - - def test_reactor_default(self): - log = self.run_script("reactor_default.py") - assert "Spider closed (finished)" not in log - assert ( - "does not match the requested one " - "(twisted.internet.asyncioreactor.AsyncioSelectorReactor)" - ) in log - - def test_asyncio_enabled_no_reactor(self): - log = self.run_script("asyncio_enabled_no_reactor.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert "RuntimeError" not in log - - def test_asyncio_enabled_reactor(self): - log = self.run_script("asyncio_enabled_reactor.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert "RuntimeError" not in log - - @pytest.mark.skipif( - parse_version(w3lib_version) >= parse_version("2.0.0"), - reason="w3lib 2.0.0 and later do not allow invalid domains.", - ) - def test_ipv6_default_name_resolver(self): - log = self.run_script("default_name_resolver.py") - assert "Spider closed (finished)" in log - assert ( - "'downloader/exception_type_count/twisted.internet.error.DNSLookupError': 1," - in log - ) - assert ( - "twisted.internet.error.DNSLookupError: DNS lookup failed: no results for hostname lookup: ::1." - in log - ) - - def test_caching_hostname_resolver_ipv6(self): - log = self.run_script("caching_hostname_resolver_ipv6.py") - assert "Spider closed (finished)" in log - assert "twisted.internet.error.DNSLookupError" not in log - - def test_caching_hostname_resolver_finite_execution(self): - with MockServer() as mock_server: - http_address = mock_server.http_address.replace("0.0.0.0", "127.0.0.1") - log = self.run_script("caching_hostname_resolver.py", http_address) - assert "Spider closed (finished)" in log - assert "ERROR: Error downloading" not in log - assert "TimeoutError" not in log - assert "twisted.internet.error.DNSLookupError" not in log - - def test_twisted_reactor_asyncio(self): - log = self.run_script("twisted_reactor_asyncio.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - - def test_twisted_reactor_asyncio_custom_settings(self): - log = self.run_script("twisted_reactor_custom_settings.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - - def test_twisted_reactor_asyncio_custom_settings_same(self): - log = self.run_script("twisted_reactor_custom_settings_same.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - - @pytest.mark.requires_uvloop - def test_custom_loop_asyncio(self): - log = self.run_script("asyncio_custom_loop.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert "Using asyncio event loop: uvloop.Loop" in log - - @pytest.mark.requires_uvloop - def test_custom_loop_asyncio_deferred_signal(self): - log = self.run_script("asyncio_deferred_signal.py", "uvloop.Loop") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert "Using asyncio event loop: uvloop.Loop" in log - assert "async pipeline opened!" in log - - @pytest.mark.requires_uvloop - def test_asyncio_enabled_reactor_same_loop(self): - log = self.run_script("asyncio_enabled_reactor_same_loop.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert "Using asyncio event loop: uvloop.Loop" in log - - @pytest.mark.requires_uvloop - def test_asyncio_enabled_reactor_different_loop(self): - log = self.run_script("asyncio_enabled_reactor_different_loop.py") - assert "Spider closed (finished)" not in log - assert ( - "does not match the one specified in the ASYNCIO_EVENT_LOOP " - "setting (uvloop.Loop)" - ) in log - - def test_default_loop_asyncio_deferred_signal(self): - log = self.run_script("asyncio_deferred_signal.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert "Using asyncio event loop: uvloop.Loop" not in log - assert "async pipeline opened!" in log - - def test_args_change_settings(self): - log = self.run_script("args_settings.py") - assert "Spider closed (finished)" in log - assert "The value of FOO is 42" in log - - def test_shutdown_graceful(self): - sig = signal.SIGINT if sys.platform != "win32" else signal.SIGBREAK - args = self.get_script_args("sleeping.py", "3") - p = PopenSpawn(args, timeout=5) - p.expect_exact("Spider opened") - p.expect_exact("Crawled (200)") - p.kill(sig) - p.expect_exact("shutting down gracefully") - p.expect_exact("Spider closed (shutdown)") - p.wait() - - @inlineCallbacks - def test_shutdown_forced(self): - from twisted.internet import reactor - - sig = signal.SIGINT if sys.platform != "win32" else signal.SIGBREAK - args = self.get_script_args("sleeping.py", "10") - p = PopenSpawn(args, timeout=5) - p.expect_exact("Spider opened") - p.expect_exact("Crawled (200)") - p.kill(sig) - p.expect_exact("shutting down gracefully") - # sending the second signal too fast often causes problems - d = Deferred() - reactor.callLater(0.01, d.callback, None) - yield d - p.kill(sig) - p.expect_exact("forcing unclean shutdown") - p.wait() - - -class TestCrawlerProcessSubprocess(TestCrawlerProcessSubprocessBase): - @property - def script_dir(self) -> Path: - return self.get_script_dir("CrawlerProcess") - - def test_reactor_default_twisted_reactor_select(self): - log = self.run_script("reactor_default_twisted_reactor_select.py") - if platform.system() in ["Windows", "Darwin"]: - # The goal of this test function is to test that, when a reactor is - # installed (the default one here) and a different reactor is - # configured (select here), an error raises. - # - # In Windows the default reactor is the select reactor, so that - # error does not raise. - # - # If that ever becomes the case on more platforms (i.e. if Linux - # also starts using the select reactor by default in a future - # version of Twisted), then we will need to rethink this test. - assert "Spider closed (finished)" in log - else: - assert "Spider closed (finished)" not in log - assert ( - "does not match the requested one " - "(twisted.internet.selectreactor.SelectReactor)" - ) in log - - def test_reactor_select(self): - log = self.run_script("reactor_select.py") - assert "Spider closed (finished)" not in log - assert ( - "does not match the requested one " - "(twisted.internet.asyncioreactor.AsyncioSelectorReactor)" - ) in log - - def test_reactor_select_twisted_reactor_select(self): - log = self.run_script("reactor_select_twisted_reactor_select.py") - assert "Spider closed (finished)" in log - assert "ReactorAlreadyInstalledError" not in log - - def test_reactor_select_subclass_twisted_reactor_select(self): - log = self.run_script("reactor_select_subclass_twisted_reactor_select.py") - assert "Spider closed (finished)" not in log - assert ( - "does not match the requested one " - "(twisted.internet.selectreactor.SelectReactor)" - ) in log - - def test_twisted_reactor_select(self): - log = self.run_script("twisted_reactor_select.py") - assert "Spider closed (finished)" in log - assert "Using reactor: twisted.internet.selectreactor.SelectReactor" in log - - @pytest.mark.skipif( - platform.system() == "Windows", reason="PollReactor is not supported on Windows" - ) - def test_twisted_reactor_poll(self): - log = self.run_script("twisted_reactor_poll.py") - assert "Spider closed (finished)" in log - assert "Using reactor: twisted.internet.pollreactor.PollReactor" in log - - def test_twisted_reactor_asyncio_custom_settings_conflict(self): - log = self.run_script("twisted_reactor_custom_settings_conflict.py") - assert "Using reactor: twisted.internet.selectreactor.SelectReactor" in log - assert ( - "(twisted.internet.selectreactor.SelectReactor) does not match the requested one" - in log - ) - - -class TestAsyncCrawlerProcessSubprocess(TestCrawlerProcessSubprocessBase): - @property - def script_dir(self) -> Path: - return self.get_script_dir("AsyncCrawlerProcess") - - def test_twisted_reactor_custom_settings_select(self): - log = self.run_script("twisted_reactor_custom_settings_select.py") - assert "Spider closed (finished)" not in log - assert ( - "(twisted.internet.asyncioreactor.AsyncioSelectorReactor) " - "does not match the requested one " - "(twisted.internet.selectreactor.SelectReactor)" - ) in log - - @pytest.mark.requires_uvloop - def test_asyncio_enabled_reactor_same_loop(self): - log = self.run_script("asyncio_custom_loop_custom_settings_same.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert "Using asyncio event loop: uvloop.Loop" in log - - @pytest.mark.requires_uvloop - def test_asyncio_enabled_reactor_different_loop(self): - log = self.run_script("asyncio_custom_loop_custom_settings_different.py") - assert "Spider closed (finished)" not in log - assert ( - "does not match the one specified in the ASYNCIO_EVENT_LOOP " - "setting (uvloop.Loop)" - ) in log - - -class TestCrawlerRunnerSubprocessBase(ScriptRunnerMixin): - """Common tests between CrawlerRunner and AsyncCrawlerRunner, - with the same file names and expectations. - """ - - def test_simple(self): - log = self.run_script("simple.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - - def test_multi_parallel(self): - log = self.run_script("multi_parallel.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert re.search( - r"Spider opened.+Spider opened.+Closing spider.+Closing spider", - log, - re.DOTALL, - ) - - def test_multi_seq(self): - log = self.run_script("multi_seq.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert re.search( - r"Spider opened.+Closing spider.+Spider opened.+Closing spider", - log, - re.DOTALL, - ) - - @pytest.mark.requires_uvloop - def test_custom_loop_same(self): - log = self.run_script("custom_loop_same.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert "Using asyncio event loop: uvloop.Loop" in log - - @pytest.mark.requires_uvloop - def test_custom_loop_different(self): - log = self.run_script("custom_loop_different.py") - assert "Spider closed (finished)" not in log - assert ( - "does not match the one specified in the ASYNCIO_EVENT_LOOP " - "setting (uvloop.Loop)" - ) in log - - -class TestCrawlerRunnerSubprocess(TestCrawlerRunnerSubprocessBase): - @property - def script_dir(self) -> Path: - return self.get_script_dir("CrawlerRunner") - - def test_explicit_default_reactor(self): - log = self.run_script("explicit_default_reactor.py") - assert "Spider closed (finished)" in log - assert ( - "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - not in log - ) - - def test_response_ip_address(self): - log = self.run_script("ip_address.py") - assert "INFO: Spider closed (finished)" in log - assert "INFO: Host: not.a.real.domain" in log - assert "INFO: Type: " in log - assert "INFO: IP address: 127.0.0.1" in log - - def test_change_default_reactor(self): - log = self.run_script("change_reactor.py") - assert ( - "DEBUG: Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" - in log - ) - assert "DEBUG: Using asyncio event loop" in log - - -class TestAsyncCrawlerRunnerSubprocess(TestCrawlerRunnerSubprocessBase): - @property - def script_dir(self) -> Path: - return self.get_script_dir("AsyncCrawlerRunner") - - def test_simple_default_reactor(self): - log = self.run_script("simple_default_reactor.py") - assert "Spider closed (finished)" not in log - assert "RuntimeError: AsyncCrawlerRunner requires AsyncioSelectorReactor" in log - - @pytest.mark.parametrize( ("settings", "items"), [ @@ -1158,9 +798,11 @@ class TestAsyncCrawlerRunnerSubprocess(TestCrawlerRunnerSubprocessBase): ({"LOG_VERSIONS": []}, None), ], ) -def test_log_scrapy_info(settings, items, caplog): +def test_log_scrapy_info( + settings: dict[str, Any], items: list[str] | None, caplog: pytest.LogCaptureFixture +) -> None: with caplog.at_level("INFO"): - CrawlerProcess(settings) + CrawlerProcess(settings, install_root_handler=False) assert ( caplog.records[0].getMessage() == f"Scrapy {scrapy.__version__} started (bot: scrapybot)" @@ -1173,3 +815,14 @@ def test_log_scrapy_info(settings, items, caplog): f"{item}': '[^']+('\n +'[^']+)*" for item in items ) assert re.search(r"^Versions:\n{'" + expected_items_pattern + "'}$", version_string) + + +@coroutine_test +async def test_deprecated_crawler_stop() -> None: + crawler = get_crawler(DefaultSpider) + d = crawler.crawl() + await maybe_deferred_to_future(d) + with pytest.warns( + ScrapyDeprecationWarning, match=r"Crawler.stop\(\) is deprecated" + ): + await maybe_deferred_to_future(crawler.stop()) diff --git a/tests/test_crawler_subprocess.py b/tests/test_crawler_subprocess.py new file mode 100644 index 000000000..146d94ecd --- /dev/null +++ b/tests/test_crawler_subprocess.py @@ -0,0 +1,575 @@ +from __future__ import annotations + +import platform +import re +import signal +import subprocess +import sys +from abc import ABC, abstractmethod +from pathlib import Path +from typing import TYPE_CHECKING + +import pytest +from packaging.version import parse as parse_version +from pexpect.popen_spawn import PopenSpawn +from w3lib import __version__ as w3lib_version + +from tests.utils import async_sleep, get_script_run_env +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + from tests.mockserver.http import MockServer + + +class ScriptRunnerMixin(ABC): + @property + @abstractmethod + def script_dir(self) -> Path: + raise NotImplementedError + + @staticmethod + def get_script_dir(name: str) -> Path: + return Path(__file__).parent.resolve() / name + + def get_script_args(self, script_name: str, *script_args: str) -> list[str]: + script_path = self.script_dir / script_name + return [sys.executable, str(script_path), *script_args] + + def run_script(self, script_name: str, *script_args: str) -> str: + args = self.get_script_args(script_name, *script_args) + p = subprocess.Popen( + args, + env=get_script_run_env(), + stdout=subprocess.PIPE, + stderr=subprocess.PIPE, + ) + _, stderr = p.communicate() + return stderr.decode("utf-8") + + +class TestCrawlerProcessSubprocessBase(ScriptRunnerMixin): + """Common tests between CrawlerProcess and AsyncCrawlerProcess, + with the same file names and expectations. + """ + + def test_simple(self) -> None: + log = self.run_script("simple.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "is_reactorless(): False" in log + + def test_multi(self) -> None: + log = self.run_script("multi.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "ReactorAlreadyInstalledError" not in log + + def test_reactor_default(self) -> None: + log = self.run_script("reactor_default.py") + assert "Spider closed (finished)" not in log + assert ( + "does not match the requested one " + "(twisted.internet.asyncioreactor.AsyncioSelectorReactor)" + ) in log + + def test_asyncio_enabled_no_reactor(self) -> None: + log = self.run_script("asyncio_enabled_no_reactor.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "RuntimeError" not in log + + def test_asyncio_enabled_reactor(self) -> None: + log = self.run_script("asyncio_enabled_reactor.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "RuntimeError" not in log + + @pytest.mark.skipif( + parse_version(w3lib_version) >= parse_version("2.0.0"), + reason="w3lib 2.0.0 and later do not allow invalid domains.", + ) + def test_ipv6_default_name_resolver(self) -> None: + log = self.run_script("default_name_resolver.py") + assert "Spider closed (finished)" in log + assert ( + "'downloader/exception_type_count/scrapy.exceptions.CannotResolveHostError': 1," + in log + ) + assert ( + "scrapy.exceptions.CannotResolveHostError: DNS lookup failed: no results for hostname lookup: ::1." + in log + ) + + def test_caching_hostname_resolver_ipv6(self) -> None: + log = self.run_script("caching_hostname_resolver_ipv6.py") + assert "Spider closed (finished)" in log + assert "scrapy.exceptions.CannotResolveHostError" not in log + + def test_caching_hostname_resolver_finite_execution( + self, mockserver: MockServer + ) -> None: + log = self.run_script("caching_hostname_resolver.py", mockserver.url("/")) + assert "Spider closed (finished)" in log + assert "ERROR: Error downloading" not in log + assert "TimeoutError" not in log + assert "scrapy.exceptions.CannotResolveHostError" not in log + + def test_twisted_reactor_asyncio(self) -> None: + log = self.run_script("twisted_reactor_asyncio.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + + def test_twisted_reactor_asyncio_custom_settings(self) -> None: + log = self.run_script("twisted_reactor_custom_settings.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + + def test_twisted_reactor_asyncio_custom_settings_same(self) -> None: + log = self.run_script("twisted_reactor_custom_settings_same.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + + @pytest.mark.requires_uvloop + def test_custom_loop_asyncio(self) -> None: + log = self.run_script("asyncio_custom_loop.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "Using asyncio event loop: uvloop.Loop" in log + + @pytest.mark.requires_uvloop + def test_custom_loop_asyncio_deferred_signal(self) -> None: + log = self.run_script("asyncio_deferred_signal.py", "uvloop.Loop") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "Using asyncio event loop: uvloop.Loop" in log + assert "async pipeline opened!" in log + + @pytest.mark.requires_uvloop + def test_asyncio_enabled_reactor_same_loop(self) -> None: + log = self.run_script("asyncio_enabled_reactor_same_loop.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "Using asyncio event loop: uvloop.Loop" in log + + @pytest.mark.requires_uvloop + def test_asyncio_enabled_reactor_different_loop(self) -> None: + log = self.run_script("asyncio_enabled_reactor_different_loop.py") + assert "Spider closed (finished)" not in log + assert ( + "does not match the one specified in the ASYNCIO_EVENT_LOOP " + "setting (uvloop.Loop)" + ) in log + + def test_default_loop_asyncio_deferred_signal(self) -> None: + log = self.run_script("asyncio_deferred_signal.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "Using asyncio event loop: uvloop.Loop" not in log + assert "async pipeline opened!" in log + + def test_args_change_settings(self) -> None: + log = self.run_script("args_settings.py") + assert "Spider closed (finished)" in log + assert "The value of FOO is 42" in log + + def _test_shutdown_graceful(self, script: str = "sleeping.py") -> None: + sig = signal.SIGINT if sys.platform != "win32" else signal.SIGBREAK # type: ignore[attr-defined] + args = self.get_script_args(script, "3") + p = PopenSpawn(args, timeout=5, env=get_script_run_env()) + p.expect_exact("Spider opened") + p.expect_exact("Crawled (200)") + p.kill(sig) + p.expect_exact("shutting down gracefully") + p.expect_exact("Spider closed (shutdown)") + p.wait() # type: ignore[no-untyped-call] + + def test_shutdown_graceful(self) -> None: + self._test_shutdown_graceful() + + async def _test_shutdown_forced(self, script: str = "sleeping.py") -> None: + sig = signal.SIGINT if sys.platform != "win32" else signal.SIGBREAK # type: ignore[attr-defined] + args = self.get_script_args(script, "10") + p = PopenSpawn(args, timeout=5, env=get_script_run_env()) + p.expect_exact("Spider opened") + p.expect_exact("Crawled (200)") + p.kill(sig) + p.expect_exact("shutting down gracefully") + # sending the second signal too fast often causes problems + await async_sleep(0.01) + p.kill(sig) + p.expect_exact("forcing unclean shutdown") + p.wait() # type: ignore[no-untyped-call] + + @coroutine_test + async def test_shutdown_forced(self) -> None: + await self._test_shutdown_forced() + + +class TestCrawlerProcessSubprocess(TestCrawlerProcessSubprocessBase): + @property + def script_dir(self) -> Path: + return self.get_script_dir("CrawlerProcess") + + def test_reactor_default_twisted_reactor_select(self) -> None: + log = self.run_script("reactor_default_twisted_reactor_select.py") + if platform.system() in ["Windows", "Darwin"]: + # The goal of this test function is to test that, when a reactor is + # installed (the default one here) and a different reactor is + # configured (select here), an error raises. + # + # In Windows the default reactor is the select reactor, so that + # error does not raise. + # + # If that ever becomes the case on more platforms (i.e. if Linux + # also starts using the select reactor by default in a future + # version of Twisted), then we will need to rethink this test. + assert "Spider closed (finished)" in log + else: + assert "Spider closed (finished)" not in log + assert ( + "does not match the requested one " + "(twisted.internet.selectreactor.SelectReactor)" + ) in log + + def test_reactor_select(self) -> None: + log = self.run_script("reactor_select.py") + assert "Spider closed (finished)" not in log + assert ( + "does not match the requested one " + "(twisted.internet.asyncioreactor.AsyncioSelectorReactor)" + ) in log + + def test_reactor_select_twisted_reactor_select(self) -> None: + log = self.run_script("reactor_select_twisted_reactor_select.py") + assert "Spider closed (finished)" in log + assert "ReactorAlreadyInstalledError" not in log + + def test_reactor_select_subclass_twisted_reactor_select(self) -> None: + log = self.run_script("reactor_select_subclass_twisted_reactor_select.py") + assert "Spider closed (finished)" not in log + assert ( + "does not match the requested one " + "(twisted.internet.selectreactor.SelectReactor)" + ) in log + + def test_twisted_reactor_select(self) -> None: + log = self.run_script("twisted_reactor_select.py") + assert "Spider closed (finished)" in log + assert "Using reactor: twisted.internet.selectreactor.SelectReactor" in log + + @pytest.mark.skipif( + platform.system() == "Windows", reason="PollReactor is not supported on Windows" + ) + def test_twisted_reactor_poll(self) -> None: + log = self.run_script("twisted_reactor_poll.py") + assert "Spider closed (finished)" in log + assert "Using reactor: twisted.internet.pollreactor.PollReactor" in log + + def test_twisted_reactor_asyncio_custom_settings_conflict(self) -> None: + log = self.run_script("twisted_reactor_custom_settings_conflict.py") + assert "Using reactor: twisted.internet.selectreactor.SelectReactor" in log + assert ( + "(twisted.internet.selectreactor.SelectReactor) does not match the requested one" + in log + ) + + def test_reactorless(self) -> None: + log = self.run_script("reactorless.py") + assert ( + "RuntimeError: CrawlerProcess doesn't support TWISTED_REACTOR_ENABLED=False" + in log + ) + + +class TestAsyncCrawlerProcessSubprocess(TestCrawlerProcessSubprocessBase): + @property + def script_dir(self) -> Path: + return self.get_script_dir("AsyncCrawlerProcess") + + def test_twisted_reactor_custom_settings_select(self) -> None: + log = self.run_script("twisted_reactor_custom_settings_select.py") + assert "Spider closed (finished)" not in log + assert ( + "(twisted.internet.asyncioreactor.AsyncioSelectorReactor) " + "does not match the requested one " + "(twisted.internet.selectreactor.SelectReactor)" + ) in log + + @pytest.mark.requires_uvloop + def test_asyncio_enabled_reactor_same_loop(self) -> None: + log = self.run_script("asyncio_custom_loop_custom_settings_same.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "Using asyncio event loop: uvloop.Loop" in log + + @pytest.mark.requires_uvloop + def test_asyncio_enabled_reactor_different_loop(self) -> None: + log = self.run_script("asyncio_custom_loop_custom_settings_different.py") + assert "Spider closed (finished)" not in log + assert ( + "does not match the one specified in the ASYNCIO_EVENT_LOOP " + "setting (uvloop.Loop)" + ) in log + + def test_reactorless_simple(self) -> None: + log = self.run_script("reactorless_simple.py") + assert "Not using a Twisted reactor" in log + assert "Spider closed (finished)" in log + assert "is_reactorless(): True" in log + assert "ERROR: " not in log + assert log.count("WARNING: HttpxDownloadHandler is experimental") == 2 + assert log.count("WARNING: ") == 2 + + def test_reactorless_custom_settings(self) -> None: + """Setting TWISTED_REACTOR_ENABLED=False in spider settings is not + currently supported, AsyncCrawlerProcess will install a reactor in this + case. + """ + log = self.run_script("reactorless_custom_settings.py") + assert "Spider closed (finished)" not in log + assert ( + "TWISTED_REACTOR_ENABLED is False but a Twisted reactor is installed." + in log + ) + + def test_reactorless_datauri(self) -> None: + log = self.run_script("reactorless_datauri.py") + assert "Not using a Twisted reactor" in log + assert "Spider closed (finished)" in log + assert "{'data': 'foo'}" in log + assert "'item_scraped_count': 1" in log + assert "ERROR: " not in log + assert log.count("WARNING: HttpxDownloadHandler is experimental") == 2 + assert log.count("WARNING: ") == 2 + + def test_reactorless_import_hook(self) -> None: + log = self.run_script("reactorless_import_hook.py") + assert "Not using a Twisted reactor" in log + assert "Spider closed (finished)" in log + assert "ImportError: Import of twisted.internet.reactor is forbidden" in log + + def test_reactorless_telnetconsole_default(self) -> None: + """By default TWISTED_REACTOR_ENABLED=False silently sets TELNETCONSOLE_ENABLED=False.""" + log = self.run_script("reactorless_simple.py") # no need for a separate script + assert "Not using a Twisted reactor" in log + assert "Spider closed (finished)" in log + assert "The TelnetConsole extension requires a Twisted reactor" not in log + assert "scrapy.extensions.telnet.TelnetConsole" not in log + + def test_reactorless_telnetconsole_disabled(self) -> None: + """Explicit TELNETCONSOLE_ENABLED=False, there are no warnings.""" + log = self.run_script("reactorless_telnetconsole_disabled.py") + assert "Not using a Twisted reactor" in log + assert "Spider closed (finished)" in log + assert "The TelnetConsole extension requires a Twisted reactor" not in log + assert "scrapy.extensions.telnet.TelnetConsole" not in log + + def test_reactorless_telnetconsole_enabled(self) -> None: + """Explicit TELNETCONSOLE_ENABLED=True, the user gets a warning.""" + log = self.run_script("reactorless_telnetconsole_enabled.py") + assert "Not using a Twisted reactor" in log + assert "Spider closed (finished)" in log + assert "The TelnetConsole extension requires a Twisted reactor" in log + + def test_reactorless_reactor(self) -> None: + log = self.run_script("reactorless_reactor.py") + assert ( + "RuntimeError: TWISTED_REACTOR_ENABLED is False but a Twisted reactor is installed" + in log + ) + + def test_shutdown_graceful(self) -> None: + self._test_shutdown_graceful("reactorless_sleeping.py") + + @coroutine_test + async def test_shutdown_forced(self) -> None: + await self._test_shutdown_forced("reactorless_sleeping.py") + + +class TestCrawlerRunnerSubprocessBase(ScriptRunnerMixin): + """Common tests between CrawlerRunner and AsyncCrawlerRunner, + with the same file names and expectations. + """ + + def test_simple(self) -> None: + log = self.run_script("simple.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "is_reactorless(): False" in log + + def test_multi_parallel(self) -> None: + log = self.run_script("multi_parallel.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert re.search( + r"Spider opened.+Spider opened.+Closing spider.+Closing spider", + log, + re.DOTALL, + ) + + def test_multi_seq(self) -> None: + log = self.run_script("multi_seq.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert re.search( + r"Spider opened.+Closing spider.+Spider opened.+Closing spider", + log, + re.DOTALL, + ) + + @pytest.mark.requires_uvloop + def test_custom_loop_same(self) -> None: + log = self.run_script("custom_loop_same.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "Using asyncio event loop: uvloop.Loop" in log + + @pytest.mark.requires_uvloop + def test_custom_loop_different(self) -> None: + log = self.run_script("custom_loop_different.py") + assert "Spider closed (finished)" not in log + assert ( + "does not match the one specified in the ASYNCIO_EVENT_LOOP " + "setting (uvloop.Loop)" + ) in log + + def test_no_reactor(self) -> None: + log = self.run_script("no_reactor.py") + assert "Spider closed (finished)" not in log + assert ( + "RuntimeError: We expected a Twisted reactor to be installed but it isn't." + in log + ) + + +class TestCrawlerRunnerSubprocess(TestCrawlerRunnerSubprocessBase): + @property + def script_dir(self) -> Path: + return self.get_script_dir("CrawlerRunner") + + def test_explicit_default_reactor(self) -> None: + log = self.run_script("explicit_default_reactor.py") + assert "Spider closed (finished)" in log + assert ( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + not in log + ) + + def test_response_ip_address(self) -> None: + log = self.run_script("ip_address.py") + assert "INFO: Spider closed (finished)" in log + assert "INFO: Host: not.a.real.domain" in log + assert "INFO: Type: " in log + assert "INFO: IP address: 127.0.0.1" in log + + def test_change_default_reactor(self) -> None: + log = self.run_script("change_reactor.py") + assert ( + "DEBUG: Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor" + in log + ) + assert "DEBUG: Using asyncio event loop" in log + + def test_reactorless(self) -> None: + log = self.run_script("reactorless.py") + assert ( + "RuntimeError: CrawlerRunner doesn't support TWISTED_REACTOR_ENABLED=False" + in log + ) + + +class TestAsyncCrawlerRunnerSubprocess(TestCrawlerRunnerSubprocessBase): + @property + def script_dir(self) -> Path: + return self.get_script_dir("AsyncCrawlerRunner") + + def test_simple_default_reactor(self) -> None: + log = self.run_script("simple_default_reactor.py") + assert "Spider closed (finished)" not in log + assert ( + "RuntimeError: When TWISTED_REACTOR_ENABLED is True, " + "AsyncCrawlerRunner requires that the installed Twisted reactor" + ) in log + + def test_reactorless_simple(self) -> None: + log = self.run_script("reactorless_simple.py") + assert "Not using a Twisted reactor" in log + assert "Spider closed (finished)" in log + assert "is_reactorless(): True" in log + assert "ERROR: " not in log + assert log.count("WARNING: HttpxDownloadHandler is experimental") == 2 + assert log.count("WARNING: ") == 2 + + def test_reactorless_custom_settings(self) -> None: + """Setting TWISTED_REACTOR_ENABLED=False in spider settings is not + currently supported, AsyncCrawlerRunner will expect a reactor installed + by the user. + """ + log = self.run_script("reactorless_custom_settings.py") + assert "Spider closed (finished)" not in log + assert "We expected a Twisted reactor to be installed but it isn't." in log + + def test_reactorless_datauri(self) -> None: + log = self.run_script("reactorless_datauri.py") + assert "Not using a Twisted reactor" in log + assert "Spider closed (finished)" in log + assert "{'data': 'foo'}" in log + assert "'item_scraped_count': 1" in log + assert "ERROR: " not in log + assert log.count("WARNING: HttpxDownloadHandler is experimental") == 2 + assert log.count("WARNING: ") == 2 + + def test_reactorless_reactor(self) -> None: + log = self.run_script("reactorless_reactor.py") + assert ( + "RuntimeError: TWISTED_REACTOR_ENABLED is False but a Twisted reactor is installed" + in log + ) diff --git a/tests/test_dependencies.py b/tests/test_dependencies.py index 4436efd9b..578e84359 100644 --- a/tests/test_dependencies.py +++ b/tests/test_dependencies.py @@ -15,14 +15,14 @@ class TestScrapyUtils: See https://github.com/scrapy/scrapy/pull/4814#issuecomment-706230011 """ - if not os.environ.get("_SCRAPY_PINNED", None): - pytest.skip("Not in a pinned environment") + if not os.environ.get("_SCRAPY_MIN", None): + pytest.skip("Not in a min environment") tox_config_file_path = Path(__file__).parent / ".." / "tox.ini" config_parser = ConfigParser() config_parser.read(tox_config_file_path) pattern = r"Twisted==([\d.]+)" - match = re.search(pattern, config_parser["pinned"]["deps"]) + match = re.search(pattern, config_parser["min"]["deps"]) pinned_twisted_version_string = match[1] assert twisted_version.short() == pinned_twisted_version_string diff --git a/tests/test_downloader_handler_httpx.py b/tests/test_downloader_handler_httpx.py new file mode 100644 index 000000000..fdacad963 --- /dev/null +++ b/tests/test_downloader_handler_httpx.py @@ -0,0 +1,161 @@ +"""Tests for scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler.""" + +from __future__ import annotations + +import sys +from typing import TYPE_CHECKING, Any, ClassVar + +import pytest + +from scrapy import Request +from scrapy.core.downloader.handlers._httpx import ( + HAS_HTTP2, + HAS_SOCKS, + HttpxDownloadHandler, +) +from scrapy.exceptions import DownloadFailedError +from tests.test_downloader_handlers_http_base import ( + TestHttpBase, + TestHttpProxyBase, + TestHttpsBase, + TestHttpsCustomCiphersBase, + TestHttpsInvalidDNSIdBase, + TestHttpsInvalidDNSPatternBase, + TestHttpsTLSVersionBase, + TestHttpsWrongHostnameBase, + TestHttpWithCrawlerBase, + TestMitmProxyBase, + TestRealWebsiteBase, + TestSimpleHttpsBase, +) +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + from scrapy.core.downloader.handlers import DownloadHandlerProtocol + from tests.mockserver.http import MockServer + + +pytestmark = pytest.mark.only_asyncio + +pytest.importorskip("httpx") + + +class HttpxDownloadHandlerMixin: + @property + def download_handler_cls(self) -> type[DownloadHandlerProtocol]: + return HttpxDownloadHandler + + @property + def settings_dict(self) -> dict[str, Any] | None: + return { + "DOWNLOAD_HANDLERS": { + "http": "scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler", + "https": "scrapy.core.downloader.handlers._httpx.HttpxDownloadHandler", + } + } + + +class TestHttp(HttpxDownloadHandlerMixin, TestHttpBase): + handler_supports_bindaddress_meta = False + + @pytest.mark.skipif( + sys.platform == "darwin", + reason="127.0.0.2 is not available on macOS by default", + ) + @coroutine_test + async def test_bind_address_port_warning( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + request = Request(mockserver.url("/client-ip")) + async with self.get_dh( + {"DOWNLOAD_BIND_ADDRESS": ("127.0.0.2", 12345)} + ) as download_handler: + response = await download_handler.download_request(request) + assert response.body == b"127.0.0.2" + assert "DOWNLOAD_BIND_ADDRESS specifies a port (12345)" in caplog.text + assert "Ignoring the port" in caplog.text + + +class TestHttps(HttpxDownloadHandlerMixin, TestHttpsBase): + handler_supports_bindaddress_meta = False + tls_log_message = "SSL connection to 127.0.0.1 using protocol TLSv1.3, cipher" + + @pytest.mark.skip(reason="The check is Twisted-specific") + def test_verify_certs_deprecated(self) -> None: # type: ignore[override] + pass + + +@pytest.mark.skipif(not HAS_HTTP2, reason="No HTTP/2 support in HttpxDownloadHandler") +class TestHttp2(TestHttps): + http2 = True + handler_supports_http2_dataloss = False + + default_handler_settings: ClassVar[dict[str, Any]] = { + "HTTPX_HTTP2_ENABLED": True, + } + + @coroutine_test + async def test_protocol(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/host", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.protocol == "HTTP/2" + + @coroutine_test + async def test_data_loss_handling(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/broken", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + with pytest.raises(DownloadFailedError): + await download_handler.download_request(request) + + +class TestSimpleHttps(HttpxDownloadHandlerMixin, TestSimpleHttpsBase): + pass + + +class TestHttpsWrongHostname(HttpxDownloadHandlerMixin, TestHttpsWrongHostnameBase): + pass + + +class TestHttpsInvalidDNSId(HttpxDownloadHandlerMixin, TestHttpsInvalidDNSIdBase): + pass + + +class TestHttpsInvalidDNSPattern( + HttpxDownloadHandlerMixin, TestHttpsInvalidDNSPatternBase +): + pass + + +class TestHttpsCustomCiphers(HttpxDownloadHandlerMixin, TestHttpsCustomCiphersBase): + pass + + +class TestHttpsTLSVersion(HttpxDownloadHandlerMixin, TestHttpsTLSVersionBase): + pass + + +class TestHttpWithCrawler(HttpxDownloadHandlerMixin, TestHttpWithCrawlerBase): + pass + + +class TestHttpsWithCrawler(TestHttpWithCrawler): + is_secure = True + + +class TestHttpProxy(HttpxDownloadHandlerMixin, TestHttpProxyBase): + expected_http_proxy_request_body = b"http://example.com/" + + +class TestHttpsProxy(TestHttpProxy): + is_secure = True + + +@pytest.mark.requires_mitmproxy +class TestMitmProxy(HttpxDownloadHandlerMixin, TestMitmProxyBase): + handler_supports_socks = HAS_SOCKS + + +@pytest.mark.requires_internet +class TestRealWebsite(HttpxDownloadHandlerMixin, TestRealWebsiteBase): + pass diff --git a/tests/test_downloader_handler_twisted_ftp.py b/tests/test_downloader_handler_twisted_ftp.py new file mode 100644 index 000000000..489b70e74 --- /dev/null +++ b/tests/test_downloader_handler_twisted_ftp.py @@ -0,0 +1,207 @@ +from __future__ import annotations + +import os +import sys +from abc import ABC, abstractmethod +from pathlib import Path +from tempfile import mkstemp +from typing import TYPE_CHECKING, Any + +import pytest +from pytest_twisted import async_yield_fixture +from twisted.cred import checkers, credentials, portal + +from scrapy import Spider +from scrapy.core.downloader.handlers.ftp import FTPDownloadHandler +from scrapy.crawler import Crawler +from scrapy.exceptions import NotConfigured +from scrapy.http import HtmlResponse, Request, Response +from scrapy.http.response.text import TextResponse +from scrapy.utils.defer import deferred_f_from_coro_f +from scrapy.utils.misc import build_from_crawler +from scrapy.utils.python import to_bytes +from scrapy.utils.test import get_crawler + +if TYPE_CHECKING: + from collections.abc import AsyncGenerator, Generator + + from twisted.protocols.ftp import FTPFactory + + +pytestmark = pytest.mark.requires_reactor # FTPDownloadHandler requires a reactor + + +class TestFTPBase(ABC): + username = "scrapy" + password = "passwd" + req_meta: dict[str, Any] = {"ftp_user": username, "ftp_password": password} + + test_files = ( + ("file.txt", b"I have the power!"), + ("file with spaces.txt", b"Moooooooooo power!"), + ("html-file-without-extension", b"\n."), + ) + + @abstractmethod + def _create_files(self, root: Path) -> None: + raise NotImplementedError + + @abstractmethod + def _get_factory(self, tmp_path: Path) -> FTPFactory: + raise NotImplementedError + + @async_yield_fixture # type: ignore[untyped-decorator] + async def server_url(self, tmp_path: Path) -> AsyncGenerator[str]: + from twisted.internet import reactor + + self._create_files(tmp_path) + factory = self._get_factory(tmp_path) + port = reactor.listenTCP(0, factory, interface="127.0.0.1") + portno = port.getHost().port + + yield f"ftp://127.0.0.1:{portno}/" + + await port.stopListening() + + @staticmethod + @pytest.fixture + def dh() -> Generator[FTPDownloadHandler]: + crawler = get_crawler() + dh = build_from_crawler(FTPDownloadHandler, crawler) + + yield dh + + # if the test was skipped, there will be no client attribute + if hasattr(dh, "client"): + assert dh.client.transport + dh.client.transport.loseConnection() + + @deferred_f_from_coro_f + async def test_ftp_download_success( + self, server_url: str, dh: FTPDownloadHandler + ) -> None: + request = Request(url=server_url + "file.txt", meta=self.req_meta) + r = await dh.download_request(request) + assert r.status == 200 + assert r.body == b"I have the power!" + assert r.headers == {b"Local Filename": [b""], b"Size": [b"17"]} + assert r.protocol is None + + @deferred_f_from_coro_f + async def test_ftp_download_path_with_spaces( + self, server_url: str, dh: FTPDownloadHandler + ) -> None: + request = Request( + url=server_url + "file with spaces.txt", + meta=self.req_meta, + ) + r = await dh.download_request(request) + assert r.status == 200 + assert r.body == b"Moooooooooo power!" + assert r.headers == {b"Local Filename": [b""], b"Size": [b"18"]} + + @deferred_f_from_coro_f + async def test_ftp_download_nonexistent( + self, server_url: str, dh: FTPDownloadHandler + ) -> None: + request = Request(url=server_url + "nonexistent.txt", meta=self.req_meta) + r = await dh.download_request(request) + assert r.status == 404 + assert r.body == b"['550 nonexistent.txt: No such file or directory.']" + + @deferred_f_from_coro_f + async def test_ftp_local_filename( + self, server_url: str, dh: FTPDownloadHandler + ) -> None: + f, local_fname = mkstemp() + fname_bytes = to_bytes(local_fname) + local_path = Path(local_fname) + os.close(f) + meta = {"ftp_local_filename": fname_bytes} + meta.update(self.req_meta) + request = Request(url=server_url + "file.txt", meta=meta) + r = await dh.download_request(request) + assert r.body == fname_bytes + assert r.headers == {b"Local Filename": [fname_bytes], b"Size": [b"17"]} + assert local_path.exists() + assert local_path.read_bytes() == b"I have the power!" + local_path.unlink() + + @pytest.mark.parametrize( + ("filename", "response_class"), + [ + ("file.txt", TextResponse), + ("html-file-without-extension", HtmlResponse), + ], + ) + @deferred_f_from_coro_f + async def test_response_class( + self, + filename: str, + response_class: type[Response], + server_url: str, + dh: FTPDownloadHandler, + ) -> None: + meta = {} + meta.update(self.req_meta) + request = Request(url=server_url + filename, meta=meta) + r = await dh.download_request(request) + assert type(r) is response_class # pylint: disable=unidiomatic-typecheck + + +class TestFTP(TestFTPBase): + def _create_files(self, root: Path) -> None: + userdir = root / self.username + userdir.mkdir() + for filename, content in self.test_files: + (userdir / filename).write_bytes(content) + + def _get_factory(self, root): + from twisted.protocols.ftp import FTPFactory, FTPRealm + + realm = FTPRealm(anonymousRoot=str(root), userHome=str(root)) + p = portal.Portal(realm) + users_checker = checkers.InMemoryUsernamePasswordDatabaseDontUse() + users_checker.addUser(self.username, self.password) + p.registerChecker(users_checker, credentials.IUsernamePassword) + return FTPFactory(portal=p) + + @deferred_f_from_coro_f + async def test_invalid_credentials( + self, server_url: str, dh: FTPDownloadHandler, reactor_pytest: str + ) -> None: + if reactor_pytest == "asyncio" and sys.platform == "win32": + pytest.skip( + "This test produces DirtyReactorAggregateError on Windows with asyncio" + ) + + from twisted.protocols.ftp import ConnectionLost + + meta = dict(self.req_meta) + meta.update({"ftp_password": "invalid"}) + request = Request(url=server_url + "file.txt", meta=meta) + with pytest.raises(ConnectionLost): + await dh.download_request(request) + + +class TestAnonymousFTP(TestFTPBase): + username = "anonymous" + req_meta = {} + + def _create_files(self, root: Path) -> None: + for filename, content in self.test_files: + (root / filename).write_bytes(content) + + def _get_factory(self, tmp_path): + from twisted.protocols.ftp import FTPFactory, FTPRealm + + realm = FTPRealm(anonymousRoot=str(tmp_path)) + p = portal.Portal(realm) + p.registerChecker(checkers.AllowAnonymousAccess(), credentials.IAnonymous) + return FTPFactory(portal=p, userAnonymous=self.username) + + +def test_not_configured_without_reactor() -> None: + crawler = Crawler(Spider, {"TWISTED_REACTOR_ENABLED": False}) + with pytest.raises(NotConfigured): + FTPDownloadHandler.from_crawler(crawler) diff --git a/tests/test_downloader_handler_twisted_http10.py b/tests/test_downloader_handler_twisted_http10.py deleted file mode 100644 index bc306aa07..000000000 --- a/tests/test_downloader_handler_twisted_http10.py +++ /dev/null @@ -1,46 +0,0 @@ -"""Tests for scrapy.core.downloader.handlers.http10.HTTP10DownloadHandler.""" - -from __future__ import annotations - -from typing import TYPE_CHECKING - -import pytest - -from scrapy.core.downloader.handlers.http10 import HTTP10DownloadHandler -from scrapy.http import Request -from scrapy.spiders import Spider -from scrapy.utils.defer import deferred_f_from_coro_f -from tests.test_downloader_handlers_http_base import TestHttpBase, TestHttpProxyBase - -if TYPE_CHECKING: - from scrapy.core.downloader.handlers import DownloadHandlerProtocol - - -class HTTP10DownloadHandlerMixin: - @property - def download_handler_cls(self) -> type[DownloadHandlerProtocol]: - return HTTP10DownloadHandler - - -@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") -class TestHttp10(HTTP10DownloadHandlerMixin, TestHttpBase): - """HTTP 1.0 test case""" - - @deferred_f_from_coro_f - async def test_protocol(self): - request = Request(self.getURL("host"), method="GET") - response = await self.download_request(request, Spider("foo")) - assert response.protocol == "HTTP/1.0" - - -class TestHttps10(TestHttp10): - scheme = "https" - - -@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") -class TestHttp10Proxy(HTTP10DownloadHandlerMixin, TestHttpProxyBase): - def test_download_with_proxy_https_timeout(self): - pytest.skip("Not implemented") - - def test_download_with_proxy_without_http_scheme(self): - pytest.skip("Not implemented") diff --git a/tests/test_downloader_handler_twisted_http11.py b/tests/test_downloader_handler_twisted_http11.py index 7b26ce03f..79750a136 100644 --- a/tests/test_downloader_handler_twisted_http11.py +++ b/tests/test_downloader_handler_twisted_http11.py @@ -2,18 +2,27 @@ from __future__ import annotations +import sys from typing import TYPE_CHECKING, Any +import pytest + +from scrapy import Spider from scrapy.core.downloader.handlers.http11 import HTTP11DownloadHandler +from scrapy.crawler import Crawler +from scrapy.exceptions import NotConfigured from tests.test_downloader_handlers_http_base import ( - TestHttp11Base, - TestHttpMockServerBase, + TestHttpBase, TestHttpProxyBase, - TestHttps11Base, + TestHttpsBase, TestHttpsCustomCiphersBase, TestHttpsInvalidDNSIdBase, TestHttpsInvalidDNSPatternBase, + TestHttpsTLSVersionBase, TestHttpsWrongHostnameBase, + TestHttpWithCrawlerBase, + TestMitmProxyBase, + TestRealWebsiteBase, TestSimpleHttpsBase, ) @@ -21,17 +30,35 @@ if TYPE_CHECKING: from scrapy.core.downloader.handlers import DownloadHandlerProtocol +pytestmark = pytest.mark.requires_reactor # HTTP11DownloadHandler requires a reactor + + class HTTP11DownloadHandlerMixin: @property def download_handler_cls(self) -> type[DownloadHandlerProtocol]: return HTTP11DownloadHandler + @property + def settings_dict(self) -> dict[str, Any] | None: + return { + "DOWNLOAD_HANDLERS": { + "http": "scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler", + "https": "scrapy.core.downloader.handlers.http11.HTTP11DownloadHandler", + } + } -class TestHttp11(HTTP11DownloadHandlerMixin, TestHttp11Base): + +def test_not_configured_without_reactor() -> None: + crawler = Crawler(Spider, {"TWISTED_REACTOR_ENABLED": False}) + with pytest.raises(NotConfigured): + HTTP11DownloadHandler.from_crawler(crawler) + + +class TestHttp(HTTP11DownloadHandlerMixin, TestHttpBase): pass -class TestHttps11(HTTP11DownloadHandlerMixin, TestHttps11Base): +class TestHttps(HTTP11DownloadHandlerMixin, TestHttpsBase): pass @@ -39,29 +66,54 @@ class TestSimpleHttps(HTTP11DownloadHandlerMixin, TestSimpleHttpsBase): pass -class TestHttps11WrongHostname(HTTP11DownloadHandlerMixin, TestHttpsWrongHostnameBase): +class TestHttpsWrongHostname(HTTP11DownloadHandlerMixin, TestHttpsWrongHostnameBase): pass -class TestHttps11InvalidDNSId(HTTP11DownloadHandlerMixin, TestHttpsInvalidDNSIdBase): +class TestHttpsInvalidDNSId(HTTP11DownloadHandlerMixin, TestHttpsInvalidDNSIdBase): pass -class TestHttps11InvalidDNSPattern( +class TestHttpsInvalidDNSPattern( HTTP11DownloadHandlerMixin, TestHttpsInvalidDNSPatternBase ): pass -class TestHttps11CustomCiphers(HTTP11DownloadHandlerMixin, TestHttpsCustomCiphersBase): +class TestHttpsCustomCiphers(HTTP11DownloadHandlerMixin, TestHttpsCustomCiphersBase): pass -class TestHttp11MockServer(TestHttpMockServerBase): +class TestHttpsTLSVersion(HTTP11DownloadHandlerMixin, TestHttpsTLSVersionBase): + pass + + +class TestHttpWithCrawler(HTTP11DownloadHandlerMixin, TestHttpWithCrawlerBase): + pass + + +class TestHttpsWithCrawler(TestHttpWithCrawler): + is_secure = True + + +class TestHttpProxy(HTTP11DownloadHandlerMixin, TestHttpProxyBase): + pass + + +class TestHttpsProxy(HTTP11DownloadHandlerMixin, TestHttpProxyBase): + is_secure = True + # not implemented + handler_supports_tls_in_tls = False + + +@pytest.mark.requires_mitmproxy +class TestMitmProxy(HTTP11DownloadHandlerMixin, TestMitmProxyBase): + # not implemented + handler_supports_tls_in_tls = False + + +@pytest.mark.requires_internet +class TestRealWebsite(HTTP11DownloadHandlerMixin, TestRealWebsiteBase): @property - def settings_dict(self) -> dict[str, Any] | None: - return None # default handler settings - - -class TestHttp11Proxy(HTTP11DownloadHandlerMixin, TestHttpProxyBase): - pass + def platform_cert_store_works(self) -> bool: + return sys.platform != "win32" diff --git a/tests/test_downloader_handler_twisted_http2.py b/tests/test_downloader_handler_twisted_http2.py index 3e685bb28..bea97642e 100644 --- a/tests/test_downloader_handler_twisted_http2.py +++ b/tests/test_downloader_handler_twisted_http2.py @@ -2,146 +2,142 @@ from __future__ import annotations -import json +import sys from typing import TYPE_CHECKING, Any -from unittest import mock import pytest from testfixtures import LogCapture -from twisted.internet import defer, error -from twisted.web import server -from twisted.web.error import SchemeNotSupported from twisted.web.http import H2_ENABLED +from scrapy import Spider +from scrapy.crawler import Crawler +from scrapy.exceptions import DownloadFailedError, NotConfigured from scrapy.http import Request -from scrapy.spiders import Spider -from scrapy.utils.defer import ( - deferred_f_from_coro_f, - maybe_deferred_to_future, -) -from scrapy.utils.misc import build_from_crawler -from scrapy.utils.test import get_crawler -from tests.mockserver import ssl_context_factory from tests.test_downloader_handlers_http_base import ( - TestHttpMockServerBase, TestHttpProxyBase, - TestHttps11Base, + TestHttpsBase, TestHttpsCustomCiphersBase, TestHttpsInvalidDNSIdBase, TestHttpsInvalidDNSPatternBase, + TestHttpsTLSVersionBase, TestHttpsWrongHostnameBase, - UriResource, + TestHttpWithCrawlerBase, + TestMitmProxyBase, + TestRealWebsiteBase, + TestSimpleHttpsBase, ) +from tests.utils.decorators import coroutine_test if TYPE_CHECKING: from scrapy.core.downloader.handlers import DownloadHandlerProtocol + from tests.mockserver.http import MockServer -pytestmark = pytest.mark.skipif( - not H2_ENABLED, reason="HTTP/2 support in Twisted is not enabled" -) +pytestmark = [ + pytest.mark.requires_reactor, # H2DownloadHandler requires a reactor + pytest.mark.skipif( + not H2_ENABLED, reason="HTTP/2 support in Twisted is not enabled" + ), +] class H2DownloadHandlerMixin: @property def download_handler_cls(self) -> type[DownloadHandlerProtocol]: # the import can fail when H2_ENABLED is False - from scrapy.core.downloader.handlers.http2 import H2DownloadHandler + from scrapy.core.downloader.handlers.http2 import ( # noqa: PLC0415 + H2DownloadHandler, + ) return H2DownloadHandler + @property + def settings_dict(self) -> dict[str, Any] | None: + return { + "DOWNLOAD_HANDLERS": { + "http": None, + "https": "scrapy.core.downloader.handlers.http2.H2DownloadHandler", + } + } -class TestHttps2(H2DownloadHandlerMixin, TestHttps11Base): - HTTP2_DATALOSS_SKIP_REASON = "Content-Length mismatch raises InvalidBodyLengthError" - @deferred_f_from_coro_f - async def test_protocol(self): - request = Request(self.getURL("host"), method="GET") - response = await self.download_request(request, Spider("foo")) +def test_not_configured_without_reactor() -> None: + from scrapy.core.downloader.handlers.http2 import H2DownloadHandler # noqa: PLC0415 + + crawler = Crawler(Spider, {"TWISTED_REACTOR_ENABLED": False}) + with pytest.raises(NotConfigured): + H2DownloadHandler.from_crawler(crawler) + + +class TestHttp2(H2DownloadHandlerMixin, TestHttpsBase): + http2 = True + handler_supports_http2_dataloss = False + + @coroutine_test + async def test_protocol(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/host", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.protocol == "h2" - @deferred_f_from_coro_f - async def test_download_with_maxsize_very_large_file(self): - from twisted.internet import reactor + def test_download_conn_failed(self) -> None: # type: ignore[override] + # Unlike HTTP11DownloadHandler which raises it from download_request() + # (without any special handling), here ConnectionRefusedError (raised in + # twisted.internet.endpoints.startConnectionAttempts()) bubbles up as + # an unhandled exception in a Deferred and the handler waits until + # DOWNLOAD_TIMEOUT. + pytest.skip("The handler doesn't properly reraise ConnectionRefusedError") - with mock.patch("scrapy.core.http2.stream.logger") as logger: - request = Request(self.getURL("largechunkedfile")) + def test_download_dns_error(self) -> None: # type: ignore[override] + # Unlike HTTP11DownloadHandler which raises it from download_request() + # (without any special handling), here DNSLookupError (raised in + # twisted.internet.endpoints.startConnectionAttempts()) bubbles up as + # an unhandled exception in a Deferred and the handler waits until + # DOWNLOAD_TIMEOUT. + pytest.skip("The handler doesn't properly reraise DNSLookupError") - def check(logger): - logger.error.assert_called_once_with(mock.ANY) - - with pytest.raises((defer.CancelledError, error.ConnectionAborted)): - await self.download_request( - request, Spider("foo", download_maxsize=1500) - ) - - # As the error message is logged in the dataReceived callback, we - # have to give a bit of time to the reactor to process the queue - # after closing the connection. - d = defer.Deferred() - d.addCallback(check) - reactor.callLater(0.1, d.callback, logger) - await maybe_deferred_to_future(d) - - @deferred_f_from_coro_f - async def test_unsupported_scheme(self): - request = Request("ftp://unsupported.scheme") - with pytest.raises(SchemeNotSupported): - await self.download_request(request, Spider("foo")) - - def test_download_broken_content_cause_data_loss(self, url="broken"): - pytest.skip(self.HTTP2_DATALOSS_SKIP_REASON) - - def test_download_broken_chunked_content_cause_data_loss(self): - pytest.skip(self.HTTP2_DATALOSS_SKIP_REASON) - - def test_download_broken_content_allow_data_loss(self, url="broken"): - pytest.skip(self.HTTP2_DATALOSS_SKIP_REASON) - - def test_download_broken_chunked_content_allow_data_loss(self): - pytest.skip(self.HTTP2_DATALOSS_SKIP_REASON) - - def test_download_broken_content_allow_data_loss_via_setting(self, url="broken"): - pytest.skip(self.HTTP2_DATALOSS_SKIP_REASON) - - def test_download_broken_chunked_content_allow_data_loss_via_setting(self): - pytest.skip(self.HTTP2_DATALOSS_SKIP_REASON) - - @deferred_f_from_coro_f - async def test_concurrent_requests_same_domain(self): - spider = Spider("foo") - - request1 = Request(self.getURL("file")) - response1 = await self.download_request(request1, spider) - assert response1.body == b"0123456789" - - request2 = Request(self.getURL("echo"), method="POST") - response2 = await self.download_request(request2, spider) - assert response2.headers["Content-Length"] == b"79" + @coroutine_test + async def test_concurrent_requests_same_domain( + self, mockserver: MockServer + ) -> None: + request1 = Request(mockserver.url("/text", is_secure=self.is_secure)) + request2 = Request( + mockserver.url("/echo", is_secure=self.is_secure), method="POST" + ) + async with self.get_dh() as download_handler: + response1 = await download_handler.download_request(request1) + assert response1.body == b"Works" + response2 = await download_handler.download_request(request2) + assert response2.headers["Content-Length"] == b"79" @pytest.mark.xfail(reason="https://github.com/python-hyper/h2/issues/1247") - @deferred_f_from_coro_f - async def test_connect_request(self): - request = Request(self.getURL("file"), method="CONNECT") - response = await self.download_request(request, Spider("foo")) + @coroutine_test + async def test_connect_request(self, mockserver: MockServer) -> None: + request = Request( + mockserver.url("/file", is_secure=self.is_secure), method="CONNECT" + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.body == b"" - @deferred_f_from_coro_f - async def test_custom_content_length_good(self): - request = Request(self.getURL("contentlength")) + @coroutine_test + async def test_custom_content_length_good(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/contentlength", is_secure=self.is_secure)) custom_content_length = str(len(request.body)) request.headers["Content-Length"] = custom_content_length - response = await self.download_request(request, Spider("foo")) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.text == custom_content_length - @deferred_f_from_coro_f - async def test_custom_content_length_bad(self): - request = Request(self.getURL("contentlength")) + @coroutine_test + async def test_custom_content_length_bad(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/contentlength", is_secure=self.is_secure)) actual_content_length = str(len(request.body)) bad_content_length = str(len(request.body) + 1) request.headers["Content-Length"] = bad_content_length - with LogCapture() as log: - response = await self.download_request(request, Spider("foo")) + async with self.get_dh() as download_handler: + with LogCapture() as log: + response = await download_handler.download_request(request) assert response.text == actual_content_length log.check_present( ( @@ -153,79 +149,69 @@ class TestHttps2(H2DownloadHandlerMixin, TestHttps11Base): ) ) - @deferred_f_from_coro_f - async def test_duplicate_header(self): - request = Request(self.getURL("echo")) - header, value1, value2 = "Custom-Header", "foo", "bar" - request.headers.appendlist(header, value1) - request.headers.appendlist(header, value2) - response = await self.download_request(request, Spider("foo")) - assert json.loads(response.text)["headers"][header] == [value1, value2] + @coroutine_test + async def test_data_loss_handling(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/broken", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + with pytest.raises(DownloadFailedError): + await download_handler.download_request(request) -class TestHttps2WrongHostname(H2DownloadHandlerMixin, TestHttpsWrongHostnameBase): +class TestSimpleHttp2(H2DownloadHandlerMixin, TestSimpleHttpsBase): pass -class TestHttps2InvalidDNSId(H2DownloadHandlerMixin, TestHttpsInvalidDNSIdBase): +class TestHttp2WrongHostname(H2DownloadHandlerMixin, TestHttpsWrongHostnameBase): pass -class TestHttps2InvalidDNSPattern( +class TestHttp2InvalidDNSId(H2DownloadHandlerMixin, TestHttpsInvalidDNSIdBase): + pass + + +class TestHttp2InvalidDNSPattern( H2DownloadHandlerMixin, TestHttpsInvalidDNSPatternBase ): pass -class TestHttps2CustomCiphers(H2DownloadHandlerMixin, TestHttpsCustomCiphersBase): +class TestHttp2CustomCiphers(H2DownloadHandlerMixin, TestHttpsCustomCiphersBase): pass -class TestHttp2MockServer(TestHttpMockServerBase): - """HTTP 2.0 test case with MockServer""" +class TestHttp2TLSVersion(H2DownloadHandlerMixin, TestHttpsTLSVersionBase): + pass - @property - def settings_dict(self) -> dict[str, Any] | None: - return { - "DOWNLOAD_HANDLERS": { - "https": "scrapy.core.downloader.handlers.http2.H2DownloadHandler" - } - } +class TestHttp2WithCrawler(H2DownloadHandlerMixin, TestHttpWithCrawlerBase): + is_secure = True + + def test_bytes_received_stop_download_callback(self) -> None: # type: ignore[override] + pytest.skip("bytes_received support is not implemented") + + def test_bytes_received_stop_download_errback(self) -> None: # type: ignore[override] + pytest.skip("bytes_received support is not implemented") + + def test_headers_received_stop_download_callback(self) -> None: # type: ignore[override] + pytest.skip("headers_received support is not implemented") + + def test_headers_received_stop_download_errback(self) -> None: # type: ignore[override] + pytest.skip("headers_received support is not implemented") + + +@pytest.mark.skip(reason="Proxy support is not implemented yet") +class TestHttp2Proxy(H2DownloadHandlerMixin, TestHttpProxyBase): is_secure = True -class TestHttps2Proxy(H2DownloadHandlerMixin, TestHttpProxyBase): - # only used for HTTPS tests - keyfile = "keys/localhost.key" - certfile = "keys/localhost.crt" +@pytest.mark.skip(reason="Proxy support is not implemented yet") +@pytest.mark.requires_mitmproxy +class TestMitmProxy(H2DownloadHandlerMixin, TestMitmProxyBase): + pass - scheme = "https" - host = "127.0.0.1" - expected_http_proxy_request_body = b"/" - - def setUp(self): - from twisted.internet import reactor - - site = server.Site(UriResource(), timeout=None) - self.port = reactor.listenSSL( - 0, - site, - ssl_context_factory(self.keyfile, self.certfile), - interface=self.host, - ) - self.portno = self.port.getHost().port - self.download_handler = build_from_crawler( - self.download_handler_cls, get_crawler() - ) - - def getURL(self, path): - return f"{self.scheme}://{self.host}:{self.portno}/{path}" - - @deferred_f_from_coro_f - async def test_download_with_proxy_https_timeout(self): - with pytest.raises(NotImplementedError): - await maybe_deferred_to_future( - super().test_download_with_proxy_https_timeout() - ) +@pytest.mark.requires_internet +class TestRealWebsite(H2DownloadHandlerMixin, TestRealWebsiteBase): + @property + def platform_cert_store_works(self) -> bool: + return sys.platform != "win32" diff --git a/tests/test_downloader_handlers.py b/tests/test_downloader_handlers.py index 518dc6b24..e685f607a 100644 --- a/tests/test_downloader_handlers.py +++ b/tests/test_downloader_handlers.py @@ -4,45 +4,37 @@ from __future__ import annotations import contextlib import os -import shutil -import sys from pathlib import Path from tempfile import mkdtemp, mkstemp from unittest import mock import pytest -from twisted.cred import checkers, credentials, portal -from twisted.internet.defer import inlineCallbacks -from twisted.protocols.ftp import FTPFactory, FTPRealm -from twisted.trial import unittest from w3lib.url import path_to_file_uri from scrapy.core.downloader.handlers import DownloadHandlers from scrapy.core.downloader.handlers.datauri import DataURIDownloadHandler from scrapy.core.downloader.handlers.file import FileDownloadHandler -from scrapy.core.downloader.handlers.ftp import FTPDownloadHandler from scrapy.core.downloader.handlers.s3 import S3DownloadHandler -from scrapy.exceptions import NotConfigured -from scrapy.http import HtmlResponse, Request, Response -from scrapy.http.response.text import TextResponse +from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning +from scrapy.http import Request from scrapy.responsetypes import responsetypes -from scrapy.spiders import Spider -from scrapy.utils.defer import ( - deferred_f_from_coro_f, - maybe_deferred_to_future, -) +from scrapy.utils.boto import is_botocore_available from scrapy.utils.misc import build_from_crawler -from scrapy.utils.python import to_bytes from scrapy.utils.test import get_crawler +from tests.utils.decorators import coroutine_test class DummyDH: lazy = False + async def download_request(self, request): + pass + class DummyLazyDH: - # Default is lazy for backward compatibility - pass + # Default (but deprecated) is lazy for backward compatibility + async def download_request(self, request): + pass class OffDH: @@ -56,6 +48,17 @@ class OffDH: return cls(crawler) +class BuggyDH: + lazy = False + + def __init__(self, crawler): + raise ValueError + + @classmethod + def from_crawler(cls, crawler): + return cls(crawler) + + class TestLoad: def test_enabled_handler(self): handlers = {"scheme": DummyDH} @@ -73,86 +76,98 @@ class TestLoad: assert "scheme" not in dh._handlers assert "scheme" in dh._notconfigured + def test_buggy_handler(self, caplog: pytest.LogCaptureFixture) -> None: + handlers = {"scheme": BuggyDH} + crawler = get_crawler(settings_dict={"DOWNLOAD_HANDLERS": handlers}) + dh = DownloadHandlers(crawler) + assert "scheme" in dh._schemes + assert "scheme" not in dh._handlers + assert "scheme" in dh._notconfigured + assert ( + 'Loading "" for scheme "scheme"' + in caplog.text + ) + def test_disabled_handler(self): handlers = {"scheme": None} crawler = get_crawler(settings_dict={"DOWNLOAD_HANDLERS": handlers}) dh = DownloadHandlers(crawler) assert "scheme" not in dh._schemes - for scheme in handlers: # force load handlers - dh._get_handler(scheme) + assert dh._get_handler("scheme") is None assert "scheme" not in dh._handlers assert "scheme" in dh._notconfigured + # get the handler again to cover the code that gets it from dh._notconfigured + assert dh._get_handler("scheme") is None def test_lazy_handlers(self): handlers = {"scheme": DummyLazyDH} crawler = get_crawler(settings_dict={"DOWNLOAD_HANDLERS": handlers}) - dh = DownloadHandlers(crawler) + with pytest.warns( + ScrapyDeprecationWarning, + match="DummyLazyDH doesn't define a 'lazy' attribute", + ): + dh = DownloadHandlers(crawler) assert "scheme" in dh._schemes assert "scheme" not in dh._handlers - for scheme in handlers: # force load lazy handler - dh._get_handler(scheme) + handler = dh._get_handler("scheme") # force load lazy handler + assert handler assert "scheme" in dh._handlers assert "scheme" not in dh._notconfigured -class TestFile(unittest.TestCase): - def setUp(self): +class TestFile: + def setup_method(self): # add a special char to check that they are handled correctly self.fd, self.tmpname = mkstemp(suffix="^") Path(self.tmpname).write_text("0123456789", encoding="utf-8") - self.download_handler = build_from_crawler(FileDownloadHandler, get_crawler()) + download_handler = build_from_crawler(FileDownloadHandler, get_crawler()) + self.download_request = download_handler.download_request - def tearDown(self): + def teardown_method(self): os.close(self.fd) Path(self.tmpname).unlink() - async def download_request(self, request: Request, spider: Spider) -> Response: - return await maybe_deferred_to_future( - self.download_handler.download_request(request, spider) - ) - - @deferred_f_from_coro_f + @coroutine_test async def test_download(self): request = Request(path_to_file_uri(self.tmpname)) assert request.url.upper().endswith("%5E") - response = await self.download_request(request, Spider("foo")) + response = await self.download_request(request) assert response.url == request.url assert response.status == 200 assert response.body == b"0123456789" assert response.protocol is None - @deferred_f_from_coro_f + @coroutine_test async def test_non_existent(self): request = Request(path_to_file_uri(mkdtemp())) # the specific exception differs between platforms with pytest.raises(OSError): # noqa: PT011 - await self.download_request(request, Spider("foo")) + await self.download_request(request) class HttpDownloadHandlerMock: def __init__(self, *args, **kwargs): pass - def download_request(self, request, spider): + async def download_request(self, request): return request @pytest.mark.requires_botocore class TestS3Anon: def setup_method(self): - crawler = get_crawler() - self.s3reqh = build_from_crawler( - S3DownloadHandler, - crawler, - httpdownloadhandler=HttpDownloadHandlerMock, - # anon=True, # implicit + crawler = get_crawler( + settings_dict={ + "DOWNLOAD_HANDLERS": {"https": HttpDownloadHandlerMock}, + } ) + self.s3reqh = build_from_crawler(S3DownloadHandler, crawler) self.download_request = self.s3reqh.download_request - self.spider = Spider("foo") - def test_anon_request(self): + @coroutine_test + async def test_anon_request(self): req = Request("s3://aws-publicdatasets/") - httpreq = self.download_request(req, self.spider) + httpreq = await self.download_request(req) assert hasattr(self.s3reqh, "anon") assert self.s3reqh.anon assert httpreq.url == "http://aws-publicdatasets.s3.amazonaws.com/" @@ -160,62 +175,45 @@ class TestS3Anon: @pytest.mark.requires_botocore class TestS3: - download_handler_cls: type = S3DownloadHandler - - # test use same example keys than amazon developer guide - # http://s3.amazonaws.com/awsdocs/S3/20060301/s3-dg-20060301.pdf - # and the tests described here are the examples from that manual - - AWS_ACCESS_KEY_ID = "0PN5J17HBGZHT7JJ3X82" - AWS_SECRET_ACCESS_KEY = "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o" - def setup_method(self): - crawler = get_crawler() - s3reqh = build_from_crawler( - S3DownloadHandler, - crawler, - aws_access_key_id=self.AWS_ACCESS_KEY_ID, - aws_secret_access_key=self.AWS_SECRET_ACCESS_KEY, - httpdownloadhandler=HttpDownloadHandlerMock, + # test use same example keys than amazon developer guide + # http://s3.amazonaws.com/awsdocs/S3/20060301/s3-dg-20060301.pdf + # and the tests described here are the examples from that manual + crawler = get_crawler( + settings_dict={ + "AWS_ACCESS_KEY_ID": "0PN5J17HBGZHT7JJ3X82", + "AWS_SECRET_ACCESS_KEY": "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o", + "DOWNLOAD_HANDLERS": {"https": HttpDownloadHandlerMock}, + } ) + s3reqh = build_from_crawler(S3DownloadHandler, crawler) self.download_request = s3reqh.download_request - self.spider = Spider("foo") @contextlib.contextmanager def _mocked_date(self, date): - try: - import botocore.auth # noqa: F401 - except ImportError: + import botocore.auth # noqa: F401,PLC0415 + + # We need to mock botocore.auth.formatdate, because otherwise + # botocore overrides Date header with current date and time + # and Authorization header is different each time + with mock.patch("botocore.auth.formatdate") as mock_formatdate: + mock_formatdate.return_value = date yield - else: - # We need to mock botocore.auth.formatdate, because otherwise - # botocore overrides Date header with current date and time - # and Authorization header is different each time - with mock.patch("botocore.auth.formatdate") as mock_formatdate: - mock_formatdate.return_value = date - yield - def test_extra_kw(self): - crawler = get_crawler() - with pytest.raises((TypeError, NotConfigured)): - build_from_crawler( - S3DownloadHandler, - crawler, - extra_kw=True, - ) - - def test_request_signing1(self): + @coroutine_test + async def test_request_signing1(self): # gets an object from the johnsmith bucket. date = "Tue, 27 Mar 2007 19:36:42 +0000" req = Request("s3://johnsmith/photos/puppy.jpg", headers={"Date": date}) with self._mocked_date(date): - httpreq = self.download_request(req, self.spider) + httpreq = await self.download_request(req) assert ( httpreq.headers["Authorization"] == b"AWS 0PN5J17HBGZHT7JJ3X82:xXjDGYUmKxnwqr5KXNPGldn5LbA=" ) - def test_request_signing2(self): + @coroutine_test + async def test_request_signing2(self): # puts an object into the johnsmith bucket. date = "Tue, 27 Mar 2007 21:15:45 +0000" req = Request( @@ -228,13 +226,14 @@ class TestS3: }, ) with self._mocked_date(date): - httpreq = self.download_request(req, self.spider) + httpreq = await self.download_request(req) assert ( httpreq.headers["Authorization"] == b"AWS 0PN5J17HBGZHT7JJ3X82:hcicpDDvL9SsO6AkvxqmIWkmOuQ=" ) - def test_request_signing3(self): + @coroutine_test + async def test_request_signing3(self): # lists the content of the johnsmith bucket. date = "Tue, 27 Mar 2007 19:42:41 +0000" req = Request( @@ -246,24 +245,26 @@ class TestS3: }, ) with self._mocked_date(date): - httpreq = self.download_request(req, self.spider) + httpreq = await self.download_request(req) assert ( httpreq.headers["Authorization"] == b"AWS 0PN5J17HBGZHT7JJ3X82:jsRt/rhG+Vtp88HrYL706QhE4w4=" ) - def test_request_signing4(self): + @coroutine_test + async def test_request_signing4(self): # fetches the access control policy sub-resource for the 'johnsmith' bucket. date = "Tue, 27 Mar 2007 19:44:46 +0000" req = Request("s3://johnsmith/?acl", method="GET", headers={"Date": date}) with self._mocked_date(date): - httpreq = self.download_request(req, self.spider) + httpreq = await self.download_request(req) assert ( httpreq.headers["Authorization"] == b"AWS 0PN5J17HBGZHT7JJ3X82:thdUi9VAkzhkniLj96JIrOPGi0g=" ) - def test_request_signing6(self): + @coroutine_test + async def test_request_signing6(self): # uploads an object to a CNAME style virtual hosted bucket with metadata. date = "Tue, 27 Mar 2007 21:06:08 +0000" req = Request( @@ -285,13 +286,14 @@ class TestS3: }, ) with self._mocked_date(date): - httpreq = self.download_request(req, self.spider) + httpreq = await self.download_request(req) assert ( httpreq.headers["Authorization"] == b"AWS 0PN5J17HBGZHT7JJ3X82:C0FlOtU8Ylb9KDTpZqYkZPX91iI=" ) - def test_request_signing7(self): + @coroutine_test + async def test_request_signing7(self): # ensure that spaces are quoted properly before signing date = "Tue, 27 Mar 2007 19:42:41 +0000" req = Request( @@ -300,256 +302,78 @@ class TestS3: headers={"Date": date}, ) with self._mocked_date(date): - httpreq = self.download_request(req, self.spider) + httpreq = await self.download_request(req) assert ( httpreq.headers["Authorization"] == b"AWS 0PN5J17HBGZHT7JJ3X82:+CfvG8EZ3YccOrRVMXNaK2eKZmM=" ) -class TestFTPBase(unittest.TestCase): - username = "scrapy" - password = "passwd" - req_meta = {"ftp_user": username, "ftp_password": password} +@pytest.mark.skipif(is_botocore_available(), reason="Requires not having botocore") +def test_s3_no_botocore() -> None: + crawler = get_crawler() + with pytest.raises(NotConfigured, match="missing botocore library"): + build_from_crawler(S3DownloadHandler, crawler) - test_files = ( - ("file.txt", b"I have the power!"), - ("file with spaces.txt", b"Moooooooooo power!"), - ("html-file-without-extension", b"\n."), - ) - def setUp(self): - from twisted.internet import reactor - - # setup dirs and test file - self.directory = Path(mkdtemp()) - userdir = self.directory / self.username - userdir.mkdir() - for filename, content in self.test_files: - (userdir / filename).write_bytes(content) - - # setup server - realm = FTPRealm( - anonymousRoot=str(self.directory), userHome=str(self.directory) - ) - p = portal.Portal(realm) - users_checker = checkers.InMemoryUsernamePasswordDatabaseDontUse() - users_checker.addUser(self.username, self.password) - p.registerChecker(users_checker, credentials.IUsernamePassword) - self.factory = FTPFactory(portal=p) - self.port = reactor.listenTCP(0, self.factory, interface="127.0.0.1") - self.portNum = self.port.getHost().port +class TestDataURI: + def setup_method(self): crawler = get_crawler() - self.download_handler = build_from_crawler(FTPDownloadHandler, crawler) + download_handler = build_from_crawler(DataURIDownloadHandler, crawler) + self.download_request = download_handler.download_request - @inlineCallbacks - def tearDown(self): - yield self.port.stopListening() - shutil.rmtree(self.directory) - - def _add_test_callbacks(self, deferred, callback=None, errback=None): - def _clean(data): - self.download_handler.client.transport.loseConnection() - return data - - deferred.addCallback(_clean) - if callback: - deferred.addCallback(callback) - if errback: - deferred.addErrback(errback) - return deferred - - def test_ftp_download_success(self): - request = Request( - url=f"ftp://127.0.0.1:{self.portNum}/file.txt", meta=self.req_meta - ) - d = self.download_handler.download_request(request, None) - - def _test(r): - assert r.status == 200 - assert r.body == b"I have the power!" - assert r.headers == {b"Local Filename": [b""], b"Size": [b"17"]} - assert r.protocol is None - - return self._add_test_callbacks(d, _test) - - def test_ftp_download_path_with_spaces(self): - request = Request( - url=f"ftp://127.0.0.1:{self.portNum}/file with spaces.txt", - meta=self.req_meta, - ) - d = self.download_handler.download_request(request, None) - - def _test(r): - assert r.status == 200 - assert r.body == b"Moooooooooo power!" - assert r.headers == {b"Local Filename": [b""], b"Size": [b"18"]} - - return self._add_test_callbacks(d, _test) - - def test_ftp_download_nonexistent(self): - request = Request( - url=f"ftp://127.0.0.1:{self.portNum}/nonexistent.txt", meta=self.req_meta - ) - d = self.download_handler.download_request(request, None) - - def _test(r): - assert r.status == 404 - - return self._add_test_callbacks(d, _test) - - def test_ftp_local_filename(self): - f, local_fname = mkstemp() - fname_bytes = to_bytes(local_fname) - local_fname = Path(local_fname) - os.close(f) - meta = {"ftp_local_filename": fname_bytes} - meta.update(self.req_meta) - request = Request(url=f"ftp://127.0.0.1:{self.portNum}/file.txt", meta=meta) - d = self.download_handler.download_request(request, None) - - def _test(r): - assert r.body == fname_bytes - assert r.headers == {b"Local Filename": [fname_bytes], b"Size": [b"17"]} - assert local_fname.exists() - assert local_fname.read_bytes() == b"I have the power!" - local_fname.unlink() - - return self._add_test_callbacks(d, _test) - - def _test_response_class(self, filename, response_class): - f, local_fname = mkstemp() - local_fname = Path(local_fname) - os.close(f) - meta = {} - meta.update(self.req_meta) - request = Request(url=f"ftp://127.0.0.1:{self.portNum}/{filename}", meta=meta) - d = self.download_handler.download_request(request, None) - - def _test(r): - assert type(r) is response_class # pylint: disable=unidiomatic-typecheck - local_fname.unlink() - - return self._add_test_callbacks(d, _test) - - def test_response_class_from_url(self): - return self._test_response_class("file.txt", TextResponse) - - def test_response_class_from_body(self): - return self._test_response_class("html-file-without-extension", HtmlResponse) - - -class TestFTP(TestFTPBase): - def test_invalid_credentials(self): - if self.reactor_pytest != "default" and sys.platform == "win32": - pytest.skip( - "This test produces DirtyReactorAggregateError on Windows with asyncio" - ) - from twisted.protocols.ftp import ConnectionLost - - meta = dict(self.req_meta) - meta.update({"ftp_password": "invalid"}) - request = Request(url=f"ftp://127.0.0.1:{self.portNum}/file.txt", meta=meta) - d = self.download_handler.download_request(request, None) - - def _test(r): - assert r.type == ConnectionLost - - return self._add_test_callbacks(d, errback=_test) - - -class TestAnonymousFTP(TestFTPBase): - username = "anonymous" - req_meta = {} - - def setUp(self): - from twisted.internet import reactor - - # setup dir and test file - self.directory = Path(mkdtemp()) - for filename, content in self.test_files: - (self.directory / filename).write_bytes(content) - - # setup server for anonymous access - realm = FTPRealm(anonymousRoot=str(self.directory)) - p = portal.Portal(realm) - p.registerChecker(checkers.AllowAnonymousAccess(), credentials.IAnonymous) - - self.factory = FTPFactory(portal=p, userAnonymous=self.username) - self.port = reactor.listenTCP(0, self.factory, interface="127.0.0.1") - self.portNum = self.port.getHost().port - crawler = get_crawler() - self.download_handler = build_from_crawler(FTPDownloadHandler, crawler) - - @inlineCallbacks - def tearDown(self): - yield self.port.stopListening() - shutil.rmtree(self.directory) - - -class TestDataURI(unittest.TestCase): - def setUp(self): - crawler = get_crawler() - self.download_handler = build_from_crawler(DataURIDownloadHandler, crawler) - self.spider = Spider("foo") - - async def download_request(self, request: Request, spider: Spider) -> Response: - return await maybe_deferred_to_future( - self.download_handler.download_request(request, spider) - ) - - @deferred_f_from_coro_f + @coroutine_test async def test_response_attrs(self): uri = "data:,A%20brief%20note" request = Request(uri) - response = await self.download_request(request, self.spider) + response = await self.download_request(request) assert response.url == uri assert not response.headers - @deferred_f_from_coro_f + @coroutine_test async def test_default_mediatype_encoding(self): request = Request("data:,A%20brief%20note") - response = await self.download_request(request, self.spider) + response = await self.download_request(request) assert response.text == "A brief note" assert type(response) is responsetypes.from_mimetype("text/plain") # pylint: disable=unidiomatic-typecheck assert response.encoding == "US-ASCII" - @deferred_f_from_coro_f + @coroutine_test async def test_default_mediatype(self): request = Request("data:;charset=iso-8859-7,%be%d3%be") - response = await self.download_request(request, self.spider) + response = await self.download_request(request) assert response.text == "\u038e\u03a3\u038e" assert type(response) is responsetypes.from_mimetype("text/plain") # pylint: disable=unidiomatic-typecheck assert response.encoding == "iso-8859-7" - @deferred_f_from_coro_f + @coroutine_test async def test_text_charset(self): request = Request("data:text/plain;charset=iso-8859-7,%be%d3%be") - response = await self.download_request(request, self.spider) + response = await self.download_request(request) assert response.text == "\u038e\u03a3\u038e" assert response.body == b"\xbe\xd3\xbe" assert response.encoding == "iso-8859-7" - @deferred_f_from_coro_f + @coroutine_test async def test_mediatype_parameters(self): request = Request( "data:text/plain;foo=%22foo;bar%5C%22%22;" "charset=utf-8;bar=%22foo;%5C%22 foo ;/,%22" ",%CE%8E%CE%A3%CE%8E" ) - response = await self.download_request(request, self.spider) + response = await self.download_request(request) assert response.text == "\u038e\u03a3\u038e" assert type(response) is responsetypes.from_mimetype("text/plain") # pylint: disable=unidiomatic-typecheck assert response.encoding == "utf-8" - @deferred_f_from_coro_f + @coroutine_test async def test_base64(self): request = Request("data:text/plain;base64,SGVsbG8sIHdvcmxkLg%3D%3D") - response = await self.download_request(request, self.spider) + response = await self.download_request(request) assert response.text == "Hello, world." - @deferred_f_from_coro_f + @coroutine_test async def test_protocol(self): request = Request("data:,") - response = await self.download_request(request, self.spider) + response = await self.download_request(request) assert response.protocol is None diff --git a/tests/test_downloader_handlers_http_base.py b/tests/test_downloader_handlers_http_base.py index 9b2c49fd4..c4a8193c8 100644 --- a/tests/test_downloader_handlers_http_base.py +++ b/tests/test_downloader_handlers_http_base.py @@ -2,277 +2,388 @@ from __future__ import annotations +import gzip import json -import shutil +import logging +import os +import re import sys from abc import ABC, abstractmethod -from pathlib import Path -from tempfile import mkdtemp -from typing import TYPE_CHECKING, Any -from unittest import mock +from contextlib import asynccontextmanager +from http import HTTPStatus +from ipaddress import IPv4Address +from socket import gethostbyname +from typing import TYPE_CHECKING, Any, ClassVar +from urllib.parse import urlparse import pytest -from testfixtures import LogCapture -from twisted.internet import defer, error -from twisted.internet.defer import inlineCallbacks, maybeDeferred -from twisted.protocols.policies import WrappingFactory -from twisted.trial import unittest -from twisted.web import resource, server, static, util -from twisted.web._newclient import ResponseFailed -from twisted.web.http import _DataLoss +from cryptography.x509 import load_der_x509_certificate +from twisted.internet.ssl import Certificate +from twisted.python.failure import Failure -from scrapy.http import Headers, HtmlResponse, Request, Response, TextResponse -from scrapy.spiders import Spider -from scrapy.utils.defer import ( - deferred_f_from_coro_f, - deferred_from_coro, - maybe_deferred_to_future, +from scrapy.exceptions import ( + CannotResolveHostError, + DownloadCancelledError, + DownloadConnectionRefusedError, + DownloadFailedError, + DownloadTimeoutError, + ResponseDataLossError, + ScrapyDeprecationWarning, + StopDownload, + UnsupportedURLSchemeError, ) +from scrapy.http import Headers, HtmlResponse, Request, Response, TextResponse +from scrapy.utils._deps_compat import ( + PYOPENSSL_X509_DEPRECATED, + TWISTED_TLS_LIMITS_OFFBY1, +) +from scrapy.utils.defer import deferred_from_coro, maybe_deferred_to_future from scrapy.utils.misc import build_from_crawler -from scrapy.utils.python import to_bytes +from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler from tests import NON_EXISTING_RESOLVABLE -from tests.mockserver import ( - Echo, - ForeverTakingResource, - HostHeaderResource, - MockServer, - NoLengthResource, - PayloadResource, - ssl_context_factory, +from tests.mockserver.mitm_proxy import wrong_credentials +from tests.mockserver.proxy_echo import ProxyEchoMockServer +from tests.mockserver.simple_https import SimpleMockServer +from tests.spiders import ( + BytesReceivedCallbackSpider, + BytesReceivedErrbackSpider, + HeadersReceivedCallbackSpider, + HeadersReceivedErrbackSpider, + SimpleSpider, + SingleRequestSpider, ) -from tests.spiders import SingleRequestSpider +from tests.utils.decorators import coroutine_test if TYPE_CHECKING: + from collections.abc import AsyncGenerator, Generator + from scrapy.core.downloader.handlers import DownloadHandlerProtocol + from tests.mockserver.http import MockServer -class ContentLengthHeaderResource(resource.Resource): - """ - A testing resource which renders itself as the value of the Content-Length - header from the request. - """ - - def render(self, request): - return request.requestHeaders.getRawHeaders(b"content-length")[0] - - -class ChunkedResource(resource.Resource): - def render(self, request): - from twisted.internet import reactor - - def response(): - request.write(b"chunked ") - request.write(b"content\n") - request.finish() - - reactor.callLater(0, response) - return server.NOT_DONE_YET - - -class BrokenChunkedResource(resource.Resource): - def render(self, request): - from twisted.internet import reactor - - def response(): - request.write(b"chunked ") - request.write(b"content\n") - # Disable terminating chunk on finish. - request.chunked = False - closeConnection(request) - - reactor.callLater(0, response) - return server.NOT_DONE_YET - - -class BrokenDownloadResource(resource.Resource): - def render(self, request): - from twisted.internet import reactor - - def response(): - request.setHeader(b"Content-Length", b"20") - request.write(b"partial") - closeConnection(request) - - reactor.callLater(0, response) - return server.NOT_DONE_YET - - -def closeConnection(request): - # We have to force a disconnection for HTTP/1.1 clients. Otherwise - # client keeps the connection open waiting for more data. - request.channel.loseConnection() - request.finish() - - -class EmptyContentTypeHeaderResource(resource.Resource): - """ - A testing resource which renders itself as the value of request body - without content-type header in response. - """ - - def render(self, request): - request.setHeader("content-type", "") - return request.content.read() - - -class LargeChunkedFileResource(resource.Resource): - def render(self, request): - from twisted.internet import reactor - - def response(): - for i in range(1024): - request.write(b"x" * 1024) - request.finish() - - reactor.callLater(0, response) - return server.NOT_DONE_YET - - -class DuplicateHeaderResource(resource.Resource): - def render(self, request): - request.responseHeaders.setRawHeaders(b"Set-Cookie", [b"a=b", b"c=d"]) - return b"" - - -class TestHttpBase(unittest.TestCase, ABC): - scheme = "http" - - # only used for HTTPS tests - keyfile = "keys/localhost.key" - certfile = "keys/localhost.crt" +class TestHttpBase(ABC): + is_secure: bool = False + http2: bool = False + # whether the handler supports per-request bindaddress + handler_supports_bindaddress_meta: bool = True + # RFC 9113 §8.1.1 explicitly says that a Content-Length mismatch is a + # stream error (of type PROTOCOL_ERROR) so the client will send + # RST_STREAM. Some libraries do only this while e.g. h2 also closes the + # connection (see handling of ProtocolError in + # h2.connection.H2Connection.receive_data()), thus closing all streams that + # were using it, and we handle this as a normal exception. + handler_supports_http2_dataloss: bool = True + # default headers added by the underlying library that cannot be suppressed + always_present_req_headers: ClassVar[frozenset[str]] = frozenset() + default_handler_settings: ClassVar[dict[str, Any]] = {} @property @abstractmethod def download_handler_cls(self) -> type[DownloadHandlerProtocol]: raise NotImplementedError - def setUp(self): - from twisted.internet import reactor + @asynccontextmanager + async def get_dh( + self, settings_dict: dict[str, Any] | None = None + ) -> AsyncGenerator[DownloadHandlerProtocol]: + settings_dict = { + **self.default_handler_settings, + **(settings_dict or {}), + } + crawler = get_crawler(DefaultSpider, settings_dict) + crawler.spider = crawler._create_spider() + dh = build_from_crawler(self.download_handler_cls, crawler) + try: + yield dh + finally: + await dh.close() - self.tmpname = Path(mkdtemp()) - (self.tmpname / "file").write_bytes(b"0123456789") - r = static.File(str(self.tmpname)) - r.putChild(b"redirect", util.Redirect(b"/file")) - r.putChild(b"wait", ForeverTakingResource()) - r.putChild(b"hang-after-headers", ForeverTakingResource(write=True)) - r.putChild(b"nolength", NoLengthResource()) - r.putChild(b"host", HostHeaderResource()) - r.putChild(b"payload", PayloadResource()) - r.putChild(b"broken", BrokenDownloadResource()) - r.putChild(b"chunked", ChunkedResource()) - r.putChild(b"broken-chunked", BrokenChunkedResource()) - r.putChild(b"contentlength", ContentLengthHeaderResource()) - r.putChild(b"nocontenttype", EmptyContentTypeHeaderResource()) - r.putChild(b"largechunkedfile", LargeChunkedFileResource()) - r.putChild(b"duplicate-header", DuplicateHeaderResource()) - r.putChild(b"echo", Echo()) - self.site = server.Site(r, timeout=None) - self.wrapper = WrappingFactory(self.site) - self.host = "localhost" - if self.scheme == "https": - # Using WrappingFactory do not enable HTTP/2 failing all the - # tests with H2DownloadHandler - self.port = reactor.listenSSL( - 0, - self.site, - ssl_context_factory(self.keyfile, self.certfile), - interface=self.host, - ) - else: - self.port = reactor.listenTCP(0, self.wrapper, interface=self.host) - self.portno = self.port.getHost().port - self.download_handler = build_from_crawler( - self.download_handler_cls, get_crawler() + @coroutine_test + async def test_unsupported_scheme(self) -> None: + request = Request("unsupp://unsupported.scheme") + async with self.get_dh() as download_handler: + with pytest.raises(UnsupportedURLSchemeError): + await download_handler.download_request(request) + + @coroutine_test + async def test_download(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.body == b"Works" + + @coroutine_test + async def test_download_head(self, mockserver: MockServer) -> None: + request = Request( + mockserver.url("/text", is_secure=self.is_secure), method="HEAD" ) - - @inlineCallbacks - def tearDown(self): - yield self.port.stopListening() - if hasattr(self.download_handler, "close"): - yield self.download_handler.close() - shutil.rmtree(self.tmpname) - - def getURL(self, path): - return f"{self.scheme}://{self.host}:{self.portno}/{path}" - - async def download_request(self, request: Request, spider: Spider) -> Response: - return await maybe_deferred_to_future( - self.download_handler.download_request(request, spider) - ) - - @deferred_f_from_coro_f - async def test_download(self): - request = Request(self.getURL("file")) - response = await self.download_request(request, Spider("foo")) - assert response.body == b"0123456789" - - @deferred_f_from_coro_f - async def test_download_head(self): - request = Request(self.getURL("file"), method="HEAD") - response = await self.download_request(request, Spider("foo")) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.body == b"" - @deferred_f_from_coro_f - async def test_redirect_status(self): - request = Request(self.getURL("redirect")) - response = await self.download_request(request, Spider("foo")) - assert response.status == 302 + @pytest.mark.parametrize( + "http_status", + [ + pytest.param(http_status, id=f"status={http_status.value}") + for http_status in HTTPStatus + if http_status.value == 200 or http_status.value // 100 in (4, 5) + ], + ) + @coroutine_test + async def test_download_has_correct_http_status_code( + self, mockserver: MockServer, http_status: HTTPStatus + ) -> None: + request = Request( + mockserver.url(f"/status?n={http_status.value}", is_secure=self.is_secure) + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == http_status.value - @deferred_f_from_coro_f - async def test_redirect_status_head(self): - request = Request(self.getURL("redirect"), method="HEAD") - response = await self.download_request(request, Spider("foo")) - assert response.status == 302 + @coroutine_test + async def test_server_receives_correct_request_headers( + self, mockserver: MockServer + ) -> None: + request_headers = { + # common request headers + "Accept": "text/html", + "Accept-Charset": "utf-8", + "Accept-Datetime": "Thu, 31 May 2007 20:35:00 GMT", + "Accept-Encoding": "gzip, deflate", + # custom headers + "X-Custom-Header": "Custom Value", + } - @deferred_f_from_coro_f - async def test_timeout_download_from_spider_nodata_rcvd(self): - if self.reactor_pytest != "default" and sys.platform == "win32": + request = Request( + mockserver.url("/echo", is_secure=self.is_secure), + headers=request_headers, + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == HTTPStatus.OK + body = json.loads(response.body.decode("utf-8")) + assert "headers" in body + for header_name, header_value in request_headers.items(): + assert header_name in body["headers"] + assert body["headers"][header_name] == [header_value] + + @coroutine_test + async def test_request_header_none(self, mockserver: MockServer) -> None: + """Adding a header with None as the value should not send that header.""" + request_headers = { + "Cookie": None, + "X-Custom-Header": None, + } + request = Request( + mockserver.url("/echo", is_secure=self.is_secure), + headers=request_headers, + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == HTTPStatus.OK + body = json.loads(response.body.decode("utf-8")) + assert "headers" in body + for header_name in request_headers: + assert header_name not in body["headers"] + + @pytest.mark.parametrize( + "request_headers", + [ + {"X-Custom-Header": ["foo", "bar"]}, + [("X-Custom-Header", "foo"), ("X-Custom-Header", "bar")], + ], + ) + @coroutine_test + async def test_request_header_duplicate( + self, mockserver: MockServer, request_headers: Any + ) -> None: + """All values for a header should be sent.""" + request = Request( + mockserver.url("/echo", is_secure=self.is_secure), + headers=request_headers, + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == HTTPStatus.OK + body = json.loads(response.body.decode("utf-8")) + assert "headers" in body + assert body["headers"]["X-Custom-Header"] == ["foo", "bar"] + + @coroutine_test + async def test_server_receives_no_extra_headers( + self, mockserver: MockServer + ) -> None: + """Test that the handler doesn't add headers to the request.""" + request = Request(mockserver.url("/echo", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == HTTPStatus.OK + body = json.loads(response.body.decode("utf-8")) + assert "headers" in body + received_headers = set(body["headers"].keys()) + allowed_headers = { + "Connection", + "Content-Length", + "Host", + } | self.always_present_req_headers + extra_headers = received_headers - allowed_headers + assert not extra_headers, body["headers"] + + @coroutine_test + async def test_server_receives_correct_request_body( + self, mockserver: MockServer + ) -> None: + request_body = { + "message": "It works!", + } + request = Request( + mockserver.url("/echo", is_secure=self.is_secure), + body=json.dumps(request_body), + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == HTTPStatus.OK + body = json.loads(response.body.decode("utf-8")) + assert json.loads(body["body"]) == request_body + + @coroutine_test + async def test_download_has_correct_response_headers( + self, mockserver: MockServer + ) -> None: + # these headers will be set on the response in the resource and returned + response_headers = { + # common response headers + "Access-Control-Allow-Origin": "*", + "Allow": "Get, Head", + "Age": "12", + "Cache-Control": "max-age=3600", + "Content-Encoding": "gzip", + "Content-MD5": "Q2hlY2sgSW50ZWdyaXR5IQ==", + "Content-Type": "text/html; charset=utf-8", + "Date": "Tue, 15 Nov 1994 08:12:31 GMT", + "Pragma": "no-cache", + "Retry-After": "120", + "Set-Cookie": "CookieName=CookieValue; Max-Age=3600; Version=1", + "WWW-Authenticate": "Basic", + # custom headers + "X-Custom-Header": "Custom Header Value", + } + + request = Request( + mockserver.url("/response-headers", is_secure=self.is_secure), + headers={"content-type": "application/json"}, + body=json.dumps(response_headers), + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == 200 + for header_name, header_value in response_headers.items(): + assert header_name in response.headers, ( + f"Response was missing expected header {header_name}" + ) + assert response.headers.getlist(header_name) == [ + header_value.encode(encoding="utf-8") + ] + + @coroutine_test + async def test_download_no_extra_response_headers( + self, mockserver: MockServer + ) -> None: + """Test that the handler doesn't add headers to the response.""" + request = Request( + mockserver.url("/response-headers", is_secure=self.is_secure), + headers={"content-type": "application/json"}, + body=json.dumps({}), + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == 200 + received_headers = set(response.headers.keys()) + allowed_headers = { + b"Content-Length", + b"Content-Type", + b"Date", + b"Server", + } + extra_headers = received_headers - allowed_headers + assert not extra_headers, response.headers + + @coroutine_test + async def test_redirect_status(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/redirect", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == 302 + assert response.headers["Location"] == b"/redirected" + + @coroutine_test + async def test_redirect_status_head(self, mockserver: MockServer) -> None: + request = Request( + mockserver.url("/redirect", is_secure=self.is_secure), method="HEAD" + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == 302 + assert response.headers["Location"] == b"/redirected" + + @coroutine_test + async def test_timeout_download_from_spider_nodata_rcvd( + self, mockserver: MockServer, reactor_pytest: str + ) -> None: + if reactor_pytest == "asyncio" and sys.platform == "win32": # https://twistedmatrix.com/trac/ticket/10279 pytest.skip( "This test produces DirtyReactorAggregateError on Windows with asyncio" ) # client connects but no data is received - spider = Spider("foo") meta = {"download_timeout": 0.5} - request = Request(self.getURL("wait"), meta=meta) - d = deferred_from_coro(self.download_request(request, spider)) - with pytest.raises((defer.TimeoutError, error.TimeoutError)): - await maybe_deferred_to_future(d) + request = Request(mockserver.url("/wait", is_secure=self.is_secure), meta=meta) + async with self.get_dh() as download_handler: + d = deferred_from_coro(download_handler.download_request(request)) + with pytest.raises(DownloadTimeoutError): + await maybe_deferred_to_future(d) - @deferred_f_from_coro_f - async def test_timeout_download_from_spider_server_hangs(self): - if self.reactor_pytest != "default" and sys.platform == "win32": + @coroutine_test + async def test_timeout_download_from_spider_server_hangs( + self, mockserver: MockServer, reactor_pytest: str + ) -> None: + if reactor_pytest == "asyncio" and sys.platform == "win32": # https://twistedmatrix.com/trac/ticket/10279 pytest.skip( "This test produces DirtyReactorAggregateError on Windows with asyncio" ) # client connects, server send headers and some body bytes but hangs - spider = Spider("foo") meta = {"download_timeout": 0.5} - request = Request(self.getURL("hang-after-headers"), meta=meta) - d = deferred_from_coro(self.download_request(request, spider)) - with pytest.raises((defer.TimeoutError, error.TimeoutError)): - await maybe_deferred_to_future(d) + request = Request( + mockserver.url("/hang-after-headers", is_secure=self.is_secure), meta=meta + ) + async with self.get_dh() as download_handler: + d = deferred_from_coro(download_handler.download_request(request)) + with pytest.raises(DownloadTimeoutError): + await maybe_deferred_to_future(d) - @deferred_f_from_coro_f - async def test_host_header_not_in_request_headers(self): - request = Request(self.getURL("host")) - response = await self.download_request(request, Spider("foo")) - assert response.body == to_bytes(f"{self.host}:{self.portno}") - assert not request.headers + @pytest.mark.parametrize("send_header", [True, False]) + @coroutine_test + async def test_host_header(self, send_header: bool, mockserver: MockServer) -> None: + host_port = f"{mockserver.host}:{mockserver.port(is_secure=self.is_secure)}" + request = Request( + mockserver.url("/host", is_secure=self.is_secure), + headers={"Host": host_port} if send_header else {}, + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.body == host_port.encode() + if send_header: + assert request.headers.get("Host") == host_port.encode() + else: + assert not request.headers - @deferred_f_from_coro_f - async def test_host_header_set_in_request_headers(self): - host = self.host + ":" + str(self.portno) - request = Request(self.getURL("host"), headers={"Host": host}) - response = await self.download_request(request, Spider("foo")) - assert response.body == host.encode() - assert request.headers.get("Host") == host.encode() - - @deferred_f_from_coro_f - async def test_content_length_zero_bodyless_post_request_headers(self): + @coroutine_test + async def test_content_length_zero_bodyless_post_request_headers( + self, mockserver: MockServer + ) -> None: """Tests if "Content-Length: 0" is sent for bodyless POST requests. This is not strictly required by HTTP RFCs but can cause trouble @@ -283,273 +394,554 @@ class TestHttpBase(unittest.TestCase, ABC): https://github.com/kennethreitz/requests/issues/405 https://bugs.python.org/issue14721 """ - request = Request(self.getURL("contentlength"), method="POST") - response = await self.download_request(request, Spider("foo")) + request = Request( + mockserver.url("/contentlength", is_secure=self.is_secure), method="POST" + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.body == b"0" - @deferred_f_from_coro_f - async def test_content_length_zero_bodyless_post_only_one(self): - request = Request(self.getURL("echo"), method="POST") - response = await self.download_request(request, Spider("foo")) + @coroutine_test + async def test_content_length_zero_bodyless_post_only_one( + self, mockserver: MockServer + ) -> None: + request = Request( + mockserver.url("/echo", is_secure=self.is_secure), method="POST" + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) headers = Headers(json.loads(response.text)["headers"]) contentlengths = headers.getlist("Content-Length") assert len(contentlengths) == 1 assert contentlengths == [b"0"] - @deferred_f_from_coro_f - async def test_payload(self): + @coroutine_test + async def test_payload(self, mockserver: MockServer) -> None: body = b"1" * 100 # PayloadResource requires body length to be 100 - request = Request(self.getURL("payload"), method="POST", body=body) - response = await self.download_request(request, Spider("foo")) + request = Request( + mockserver.url("/payload", is_secure=self.is_secure), + method="POST", + body=body, + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.body == body - @deferred_f_from_coro_f - async def test_response_header_content_length(self): - request = Request(self.getURL("file"), method=b"GET") - response = await self.download_request(request, Spider("foo")) - assert response.headers[b"content-length"] == b"159" + @coroutine_test + async def test_response_header_content_length(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.headers[b"content-length"] == b"5" - async def _test_response_class( - self, filename: str, body: bytes, response_class: type[Response] + @pytest.mark.parametrize( + ("filename", "body", "response_class"), + [ + ("foo.html", b"", HtmlResponse), + ("foo", b"\n.", HtmlResponse), + ], + ) + @coroutine_test + async def test_response_class( + self, + filename: str, + body: bytes, + response_class: type[Response], + mockserver: MockServer, ) -> None: - request = Request(self.getURL(filename), body=body) - response = await self.download_request(request, Spider("foo")) + request = Request( + mockserver.url(f"/{filename}", is_secure=self.is_secure), body=body + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert type(response) is response_class # pylint: disable=unidiomatic-typecheck - @deferred_f_from_coro_f - async def test_response_class_from_url(self): - await self._test_response_class("foo.html", b"", HtmlResponse) - - @deferred_f_from_coro_f - async def test_response_class_from_body(self): - await self._test_response_class( - "foo", - b"\n.", - HtmlResponse, - ) - - @deferred_f_from_coro_f - async def test_get_duplicate_header(self): - request = Request(self.getURL("duplicate-header")) - response = await self.download_request(request, Spider("foo")) + @coroutine_test + async def test_get_duplicate_header(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/duplicate-header", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.headers.getlist(b"Set-Cookie") == [b"a=b", b"c=d"] + @coroutine_test + async def test_download_is_not_automatically_gzip_decoded( + self, mockserver: MockServer + ) -> None: + """Test download handler does not automatically decode content using the scheme provided in Content-Encoding header""" -class TestHttp11Base(TestHttpBase): - """HTTP 1.1 test case""" + data = "compress-me" - @deferred_f_from_coro_f - async def test_download_without_maxsize_limit(self): - request = Request(self.getURL("file")) - response = await self.download_request(request, Spider("foo")) - assert response.body == b"0123456789" + # send a request to mock resource that gzip encodes the "data" url parameter + request = Request( + mockserver.url(f"/compress?data={data}", is_secure=self.is_secure), + headers={ + "accept-encoding": "gzip", + }, + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) - @deferred_f_from_coro_f - async def test_response_class_choosing_request(self): + assert response.status == 200 + + # check that the Content-Encoding header is gzip + content_encoding = response.headers[b"Content-Encoding"] + assert content_encoding == b"gzip" + + # check that the response is still encoded + # by checking for the magic number that is always included at the start of a gzip encoding + # see https://datatracker.ietf.org/doc/html/rfc1952#page-5 section 2.3.1 + GZIP_MAGIC = b"\x1f\x8b" + assert response.body[:2] == GZIP_MAGIC, "Response body was not in gzip format" + + # check that a gzip decoding matches the data sent in the request + expected_decoding = bytes(data, encoding="utf-8") + assert gzip.decompress(response.body) == expected_decoding + + @coroutine_test + async def test_no_cookie_processing_or_persistence( + self, mockserver: MockServer + ) -> None: + cookie_name = "foo" + cookie_value = "bar" + + # check that cookies are not modified + request = Request( + mockserver.url( + f"/set-cookie?{cookie_name}={cookie_value}", is_secure=self.is_secure + ) + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == 200 + set_cookie = response.headers.get(b"Set-Cookie") + assert set_cookie == f"{cookie_name}={cookie_value}".encode() + + # check that cookies are not sent in the next request + request = Request(mockserver.url("/echo", is_secure=self.is_secure)) + response = await download_handler.download_request(request) + assert response.status == 200 + headers = Headers(json.loads(response.text)["headers"]) + assert "Cookie" not in headers + assert "cookie" not in headers + + @coroutine_test + async def test_download_latency(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + await download_handler.download_request(request) + assert "download_latency" in request.meta + latency = request.meta["download_latency"] + if sys.version_info < (3, 13) and sys.platform == "win32": + # time.monotonic() resolution is too low here: + # https://docs.python.org/3/whatsnew/3.13.html#time + assert latency >= 0 + else: + assert latency > 0 + + @coroutine_test + async def test_download_without_maxsize_limit(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.body == b"Works" + + @coroutine_test + async def test_response_class_choosing_request( + self, mockserver: MockServer + ) -> None: """Tests choosing of correct response type in case of Content-Type is empty but body contains text. """ body = b"Some plain text\ndata with tabs\t and null bytes\0" - request = Request(self.getURL("nocontenttype"), body=body) - response = await self.download_request(request, Spider("foo")) + request = Request( + mockserver.url("/nocontenttype", is_secure=self.is_secure), body=body + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert type(response) is TextResponse # pylint: disable=unidiomatic-typecheck - @deferred_f_from_coro_f - async def test_download_with_maxsize(self): - request = Request(self.getURL("file")) + @coroutine_test + async def test_download_with_maxsize( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) - # 10 is minimal size for this request and the limit is only counted on + # 5 is minimal size for this request and the limit is only counted on # response body. (regardless of headers) - response = await self.download_request( - request, Spider("foo", download_maxsize=10) + async with self.get_dh({"DOWNLOAD_MAXSIZE": 5}) as download_handler: + response = await download_handler.download_request(request) + assert response.body == b"Works" + + caplog.clear() + msg = "Expected to receive 5 bytes which is larger than download max size (4)" + async with self.get_dh({"DOWNLOAD_MAXSIZE": 4}) as download_handler: + with pytest.raises(DownloadCancelledError, match=re.escape(msg)): + await download_handler.download_request(request) + assert msg in caplog.text + + @coroutine_test + async def test_download_with_maxsize_very_large_file( + self, mockserver: MockServer, caplog: pytest.LogCaptureFixture + ) -> None: + request = Request(mockserver.url("/largechunkedfile", is_secure=self.is_secure)) + async with self.get_dh({"DOWNLOAD_MAXSIZE": 1_500}) as download_handler: + with pytest.raises(DownloadCancelledError): + await download_handler.download_request(request) + assert re.search( + r"Received \d+ bytes which is larger than download max size \(1500\)", + caplog.text, ) - assert response.body == b"0123456789" - with pytest.raises((defer.CancelledError, error.ConnectionAborted)): - await self.download_request(request, Spider("foo", download_maxsize=9)) - - @deferred_f_from_coro_f - async def test_download_with_maxsize_very_large_file(self): - from twisted.internet import reactor - - # TODO: the logger check is specific to scrapy.core.downloader.handlers.http11 - with mock.patch("scrapy.core.downloader.handlers.http11.logger") as logger: - request = Request(self.getURL("largechunkedfile")) - - def check(logger): - logger.warning.assert_called_once_with(mock.ANY, mock.ANY) - - with pytest.raises((defer.CancelledError, error.ConnectionAborted)): - await self.download_request( - request, Spider("foo", download_maxsize=1500) - ) - - # As the error message is logged in the dataReceived callback, we - # have to give a bit of time to the reactor to process the queue - # after closing the connection. - d = defer.Deferred() - d.addCallback(check) - reactor.callLater(0.1, d.callback, logger) - await maybe_deferred_to_future(d) - - @deferred_f_from_coro_f - async def test_download_with_maxsize_per_req(self): + @coroutine_test + async def test_download_with_maxsize_per_req(self, mockserver: MockServer) -> None: meta = {"download_maxsize": 2} - request = Request(self.getURL("file"), meta=meta) - with pytest.raises((defer.CancelledError, error.ConnectionAborted)): - await self.download_request(request, Spider("foo")) + request = Request(mockserver.url("/text", is_secure=self.is_secure), meta=meta) + async with self.get_dh() as download_handler: + with pytest.raises(DownloadCancelledError): + await download_handler.download_request(request) - @deferred_f_from_coro_f - async def test_download_with_small_maxsize_per_spider(self): - request = Request(self.getURL("file")) - with pytest.raises((defer.CancelledError, error.ConnectionAborted)): - await self.download_request(request, Spider("foo", download_maxsize=2)) + @coroutine_test + async def test_download_with_small_maxsize_via_setting( + self, mockserver: MockServer + ) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) + async with self.get_dh({"DOWNLOAD_MAXSIZE": 2}) as download_handler: + with pytest.raises(DownloadCancelledError): + await download_handler.download_request(request) - @deferred_f_from_coro_f - async def test_download_with_large_maxsize_per_spider(self): - request = Request(self.getURL("file")) - response = await self.download_request( - request, Spider("foo", download_maxsize=100) + @coroutine_test + async def test_download_with_large_maxsize_via_setting( + self, mockserver: MockServer + ) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) + async with self.get_dh({"DOWNLOAD_MAXSIZE": 100}) as download_handler: + response = await download_handler.download_request(request) + assert response.body == b"Works" + + @coroutine_test + async def test_download_with_warnsize( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) + async with self.get_dh({"DOWNLOAD_WARNSIZE": 4}) as download_handler: + response = await download_handler.download_request(request) + assert response.body == b"Works" + assert ( + "Expected to receive 5 bytes which is larger than download warn size (4)" + in caplog.text ) - assert response.body == b"0123456789" - @deferred_f_from_coro_f - async def test_download_chunked_content(self): - request = Request(self.getURL("chunked")) - response = await self.download_request(request, Spider("foo")) + @coroutine_test + async def test_download_with_warnsize_no_content_length( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: + request = Request( + mockserver.url("/delay?n=0.1", is_secure=self.is_secure), + ) + async with self.get_dh({"DOWNLOAD_WARNSIZE": 10}) as download_handler: + response = await download_handler.download_request(request) + assert response.body == b"Response delayed for 0.100 seconds\n" + assert ( + "Received 35 bytes which is larger than download warn size (10)" + in caplog.text + ) + + @coroutine_test + async def test_download_chunked_content(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/chunked", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.body == b"chunked content\n" - @deferred_f_from_coro_f - async def test_download_broken_content_cause_data_loss( - self, url: str = "broken" - ) -> None: - # TODO: this one checks for Twisted-specific exceptions - request = Request(self.getURL(url)) - with pytest.raises(ResponseFailed) as exc_info: - await self.download_request(request, Spider("foo")) - assert any(r.check(_DataLoss) for r in exc_info.value.reasons) + @coroutine_test + async def test_download_cause_data_loss(self, mockserver: MockServer) -> None: + if self.http2 and not self.handler_supports_http2_dataloss: + pytest.skip("This handler doesn't support dataloss on HTTP/2") + request = Request(mockserver.url("/broken", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + with pytest.raises(ResponseDataLossError): + await download_handler.download_request(request) - def test_download_broken_chunked_content_cause_data_loss(self): - return self.test_download_broken_content_cause_data_loss("broken-chunked") - - @deferred_f_from_coro_f - async def test_download_broken_content_allow_data_loss( - self, url: str = "broken" + @coroutine_test + async def test_download_cause_data_loss_double_warning( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer ) -> None: - request = Request(self.getURL(url), meta={"download_fail_on_dataloss": False}) - response = await self.download_request(request, Spider("foo")) + if self.http2 and not self.handler_supports_http2_dataloss: + pytest.skip("This handler doesn't support dataloss on HTTP/2") + request = Request(mockserver.url("/broken", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + with pytest.raises(ResponseDataLossError): + await download_handler.download_request(request) + assert "Got data loss" in caplog.text + caplog.clear() + with pytest.raises(ResponseDataLossError): + await download_handler.download_request(request) + # no repeated warning + assert "Got data loss" not in caplog.text + + @coroutine_test + async def test_download_allow_data_loss_broken( + self, mockserver: MockServer + ) -> None: + if self.http2 and not self.handler_supports_http2_dataloss: + pytest.skip("This handler doesn't support dataloss on HTTP/2") + request = Request( + mockserver.url("/broken", is_secure=self.is_secure), + meta={"download_fail_on_dataloss": False}, + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.flags == ["dataloss"] + assert response.text == "partial" + + @coroutine_test + async def test_download_allow_data_loss_broken_chunked( + self, mockserver: MockServer + ) -> None: + if self.http2: + pytest.skip("Chunked encoding is specific to HTTP/1.1") + request = Request( + mockserver.url("/broken-chunked", is_secure=self.is_secure), + meta={"download_fail_on_dataloss": False}, + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.flags == ["dataloss"] + assert response.text == "chunked content\n" + + @coroutine_test + async def test_download_allow_data_loss_via_setting( + self, mockserver: MockServer + ) -> None: + if self.http2 and not self.handler_supports_http2_dataloss: + pytest.skip("This handler doesn't support dataloss on HTTP/2") + request = Request(mockserver.url("/broken", is_secure=self.is_secure)) + async with self.get_dh( + {"DOWNLOAD_FAIL_ON_DATALOSS": False} + ) as download_handler: + response = await download_handler.download_request(request) assert response.flags == ["dataloss"] - def test_download_broken_chunked_content_allow_data_loss(self): - return self.test_download_broken_content_allow_data_loss("broken-chunked") + @coroutine_test + async def test_download_conn_failed(self) -> None: + # copy of TestCrawl.test_retry_conn_failed() + scheme = "https" if self.is_secure else "http" + request = Request(f"{scheme}://localhost:65432/") + async with self.get_dh() as download_handler: + with pytest.raises(DownloadConnectionRefusedError): + await download_handler.download_request(request) - @deferred_f_from_coro_f - async def test_download_broken_content_allow_data_loss_via_setting( - self, url: str = "broken" - ) -> None: - crawler = get_crawler(settings_dict={"DOWNLOAD_FAIL_ON_DATALOSS": False}) - download_handler = build_from_crawler(self.download_handler_cls, crawler) - request = Request(self.getURL(url)) - response = await maybe_deferred_to_future( - download_handler.download_request(request, Spider("foo")) - ) - assert response.flags == ["dataloss"] + @coroutine_test + async def test_download_conn_lost(self, mockserver: MockServer) -> None: + # copy of TestCrawl.test_retry_conn_lost() + request = Request(mockserver.url("/drop?abort=0", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + with pytest.raises(ResponseDataLossError): + await download_handler.download_request(request) - def test_download_broken_chunked_content_allow_data_loss_via_setting(self): - return self.test_download_broken_content_allow_data_loss_via_setting( - "broken-chunked" - ) + @coroutine_test + async def test_download_conn_aborted(self, mockserver: MockServer) -> None: + # copy of TestCrawl.test_retry_conn_aborted() + if self.http2: + # it may be possible to write a separate resource that does something + # suitable on HTTP/2 without sending Content-Length + pytest.skip( + "On HTTP/2 this triggers a Content-Length mismatch error instead." + ) + request = Request(mockserver.url("/drop?abort=1", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + with pytest.raises(DownloadFailedError): + await download_handler.download_request(request) - @deferred_f_from_coro_f - async def test_protocol(self): - request = Request(self.getURL("host"), method="GET") - response = await self.download_request(request, Spider("foo")) + @pytest.mark.skipif( + NON_EXISTING_RESOLVABLE, reason="Non-existing hosts are resolvable" + ) + @coroutine_test + async def test_download_dns_error(self) -> None: + # copy of TestCrawl.test_retry_dns_error() + scheme = "https" if self.is_secure else "http" + request = Request(f"{scheme}://dns.resolution.invalid./") + async with self.get_dh() as download_handler: + with pytest.raises(CannotResolveHostError): + await download_handler.download_request(request) + + @coroutine_test + async def test_protocol(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/host", is_secure=self.is_secure)) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.protocol == "HTTP/1.1" + @pytest.mark.skipif( + sys.platform == "darwin", + reason="127.0.0.2 is not available on macOS by default", + ) + @pytest.mark.parametrize("setting_value", [("127.0.0.2", 0), "127.0.0.2"]) + @coroutine_test + async def test_download_bind_address_setting( + self, mockserver: MockServer, setting_value: Any + ) -> None: + request = Request(mockserver.url("/client-ip", is_secure=self.is_secure)) + async with self.get_dh( + {"DOWNLOAD_BIND_ADDRESS": setting_value} + ) as download_handler: + response = await download_handler.download_request(request) + assert response.body == b"127.0.0.2" -class TestHttps11Base(TestHttp11Base): - scheme = "https" + @pytest.mark.skipif( + sys.platform == "darwin", + reason="127.0.0.2 is not available on macOS by default", + ) + @pytest.mark.parametrize("meta_value", [("127.0.0.2", 0), "127.0.0.2"]) + @coroutine_test + async def test_download_bind_address_meta( + self, mockserver: MockServer, caplog: pytest.LogCaptureFixture, meta_value: Any + ) -> None: + request = Request( + mockserver.url("/client-ip", is_secure=self.is_secure), + meta={"bindaddress": meta_value}, + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + if self.handler_supports_bindaddress_meta: + assert response.body == b"127.0.0.2" + else: + assert ( + "The 'bindaddress' request meta key is not supported by" in caplog.text + ) + + @coroutine_test + async def test_verbatim_url(self, mockserver: MockServer) -> None: + # Square brackets are encoded by safe_url_string (w3lib). + path = "/uri/items?data[0]=a" + url = mockserver.url(path, is_secure=self.is_secure) + + # Without verbatim_url, the brackets are percent-encoded before the + # request reaches the server. + request = Request(url) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.body == b"/uri/items?data%5B0%5D=a" + + # With verbatim_url=True the URL is sent to the server as-is. + request = Request(url, meta={"verbatim_url": True}) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.body == path.encode() + + +class TestHttpsBase(TestHttpBase): + is_secure = True tls_log_message = ( - 'SSL connection certificate: issuer "/C=IE/O=Scrapy/CN=localhost", ' - 'subject "/C=IE/O=Scrapy/CN=localhost"' + ( + 'SSL connection certificate: issuer "CN=localhost,O=Scrapy,C=IE", ' + 'subject "CN=localhost,O=Scrapy,C=IE"' + ) + if PYOPENSSL_X509_DEPRECATED + else ( + 'SSL connection certificate: issuer "/C=IE/O=Scrapy/CN=localhost", ' + 'subject "/C=IE/O=Scrapy/CN=localhost"' + ) ) - @deferred_f_from_coro_f - async def test_tls_logging(self): - crawler = get_crawler( - settings_dict={"DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING": True} - ) - download_handler = build_from_crawler(self.download_handler_cls, crawler) - try: - with LogCapture() as log_capture: - request = Request(self.getURL("file")) - response = await maybe_deferred_to_future( - download_handler.download_request(request, Spider("foo")) - ) - assert response.body == b"0123456789" - log_capture.check_present( - ("scrapy.core.downloader.tls", "DEBUG", self.tls_log_message) - ) - finally: - await maybe_deferred_to_future(maybeDeferred(download_handler.close)) + def test_download_conn_lost(self) -> None: # type: ignore[override] + # For some reason (maybe related to TLS shutdown flow, and maybe the + # mockserver resource can be fixed so that this works) HTTPS clients + # (not just Scrapy) hang on /drop?abort=0. + pytest.skip("Unable to test on HTTPS") + + @coroutine_test + async def test_tls_logging( + self, mockserver: MockServer, caplog: pytest.LogCaptureFixture + ) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) + async with self.get_dh( + {"DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING": True} + ) as download_handler: + with caplog.at_level("DEBUG"): + response = await download_handler.download_request(request) + assert response.body == b"Works" + assert self.tls_log_message in caplog.text + + @coroutine_test + async def test_verify_certs_deprecated(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) + with ( # noqa: PT031 + pytest.warns( + ScrapyDeprecationWarning, + match="'DOWNLOADER_CLIENTCONTEXTFACTORY' setting is deprecated", + ), + pytest.warns( + ScrapyDeprecationWarning, + match="BrowserLikeContextFactory is deprecated", + ), + ): + async with self.get_dh( + { + "DOWNLOADER_CLIENTCONTEXTFACTORY": "scrapy.core.downloader.contextfactory.BrowserLikeContextFactory" + } + ) as download_handler: + with pytest.raises( + (DownloadConnectionRefusedError, DownloadFailedError) + ): + await download_handler.download_request(request) + + @coroutine_test + async def test_verify_certs(self, mockserver: MockServer) -> None: + request = Request(mockserver.url("/text", is_secure=self.is_secure)) + async with self.get_dh( + {"DOWNLOAD_VERIFY_CERTIFICATES": True} + ) as download_handler: + with pytest.raises((DownloadConnectionRefusedError, DownloadFailedError)): + await download_handler.download_request(request) -class TestSimpleHttpsBase(unittest.TestCase, ABC): +class TestSimpleHttpsBase(ABC): """Base class for special cases tested with just one simple request""" keyfile = "keys/localhost.key" certfile = "keys/localhost.crt" + host = "localhost" cipher_string: str | None = None + @pytest.fixture(scope="class") + @classmethod + def simple_mockserver(cls) -> Generator[SimpleMockServer]: + with SimpleMockServer( + cls.keyfile, cls.certfile, cipher_string=cls.cipher_string + ) as simple_mockserver: + yield simple_mockserver + + @pytest.fixture(scope="class") + @classmethod + def url(cls, simple_mockserver: SimpleMockServer) -> str: + return f"https://{cls.host}:{simple_mockserver.port(is_secure=True)}/file" + @property @abstractmethod def download_handler_cls(self) -> type[DownloadHandlerProtocol]: raise NotImplementedError - def setUp(self): - from twisted.internet import reactor - - self.tmpname = Path(mkdtemp()) - (self.tmpname / "file").write_bytes(b"0123456789") - r = static.File(str(self.tmpname)) - self.site = server.Site(r, timeout=None) - self.host = "localhost" - self.port = reactor.listenSSL( - 0, - self.site, - ssl_context_factory( - self.keyfile, self.certfile, cipher_string=self.cipher_string - ), - interface=self.host, - ) - self.portno = self.port.getHost().port + @asynccontextmanager + async def get_dh(self) -> AsyncGenerator[DownloadHandlerProtocol]: if self.cipher_string is not None: settings_dict = {"DOWNLOADER_CLIENT_TLS_CIPHERS": self.cipher_string} else: settings_dict = None - crawler = get_crawler(settings_dict=settings_dict) - self.download_handler = build_from_crawler(self.download_handler_cls, crawler) + crawler = get_crawler(DefaultSpider, settings_dict=settings_dict) + crawler.spider = crawler._create_spider() + dh = build_from_crawler(self.download_handler_cls, crawler) + try: + yield dh + finally: + await dh.close() - @inlineCallbacks - def tearDown(self): - yield self.port.stopListening() - if hasattr(self.download_handler, "close"): - yield self.download_handler.close() - shutil.rmtree(self.tmpname) - - def getURL(self, path): - return f"https://{self.host}:{self.portno}/{path}" - - async def download_request(self, request: Request, spider: Spider) -> Response: - return await maybe_deferred_to_future( - self.download_handler.download_request(request, spider) - ) - - @deferred_f_from_coro_f - async def test_download(self): - request = Request(self.getURL("file")) - response = await self.download_request(request, Spider("foo")) + @coroutine_test + async def test_download(self, url: str) -> None: + request = Request(url) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.body == b"0123456789" @@ -566,9 +958,7 @@ class TestHttpsWrongHostnameBase(TestSimpleHttpsBase): class TestHttpsInvalidDNSIdBase(TestSimpleHttpsBase): """Connect to HTTPS hosts with IP while certificate uses domain names IDs.""" - def setUp(self): - super().setUp() - self.host = "127.0.0.1" + host = "127.0.0.1" class TestHttpsInvalidDNSPatternBase(TestSimpleHttpsBase): @@ -582,9 +972,144 @@ class TestHttpsCustomCiphersBase(TestSimpleHttpsBase): cipher_string = "CAMELLIA256-SHA" -class TestHttpMockServerBase(unittest.TestCase, ABC): - """HTTP 1.1 test case with MockServer""" +class TestHttpsTLSVersionBase(ABC): + keyfile = "keys/localhost.key" + certfile = "keys/localhost.crt" + @property + @abstractmethod + def download_handler_cls(self) -> type[DownloadHandlerProtocol]: + raise NotImplementedError + + @asynccontextmanager + async def get_dh( + self, client_tls_min: str | None, client_tls_max: str | None + ) -> AsyncGenerator[DownloadHandlerProtocol]: + settings = {} + if client_tls_min is not None: + settings["DOWNLOAD_TLS_MIN_VERSION"] = client_tls_min + if client_tls_max is not None: + settings["DOWNLOAD_TLS_MAX_VERSION"] = client_tls_max + crawler = get_crawler(DefaultSpider, settings_dict=settings) + crawler.spider = crawler._create_spider() + dh = build_from_crawler(self.download_handler_cls, crawler) + try: + yield dh + finally: + await dh.close() + + @pytest.mark.parametrize( + ( + "server_tls_min", + "server_tls_max", + "client_tls_min", + "client_tls_max", + "expect_success", + ), + [ + pytest.param(None, None, None, None, True, id="no-limits"), + pytest.param(None, None, None, "TLSv1.2", True, id="client-max-tls1.2"), + pytest.param(None, None, "TLSv1.3", None, True, id="client-min-tls1.3"), + pytest.param( + "TLSv1.3", + None, + None, + "TLSv1.2", + False, + id="client-max-below-server-min", + ), + pytest.param( + None, + "TLSv1.2", + "TLSv1.3", + None, + False, + id="client-min-above-server-max", + ), + pytest.param(None, "TLSv1.2", None, "TLSv1.2", True, id="both-tls1.2"), + pytest.param("TLSv1.3", None, "TLSv1.3", None, True, id="both-tls1.3"), + pytest.param( + None, + None, + "TLSv1.0", + None, + True, + id="client-min-tls1.0", + marks=pytest.mark.filterwarnings( + r"ignore:ssl\.TLSVersion\.TLSv1 is deprecated:DeprecationWarning" + ), + ), + pytest.param( + "TLSv1.0", + None, + "TLSv1.0", + None, + True, + id="both-min-tls1.0", + marks=pytest.mark.filterwarnings( + r"ignore:ssl\.TLSVersion\.TLSv1 is deprecated:DeprecationWarning" + ), + ), + pytest.param( + "TLSv1.2", + "TLSv1.3", + "TLSv1.2", + "TLSv1.3", + True, + id="both-tls1.2-1.3", + marks=pytest.mark.xfail( + TWISTED_TLS_LIMITS_OFFBY1, + reason="Can't set max to 1.3 on this Twisted version", + strict=True, + ), + ), + ], + ) + @coroutine_test + async def test_download( + self, + server_tls_min: str | None, + server_tls_max: str | None, + client_tls_min: str | None, + client_tls_max: str | None, + expect_success: bool, + ) -> None: + with SimpleMockServer( + self.keyfile, + self.certfile, + tls_min_version=server_tls_min, + tls_max_version=server_tls_max, + ) as simple_mockserver: + url = f"https://localhost:{simple_mockserver.port(is_secure=True)}/file" + request = Request(url) + async with self.get_dh(client_tls_min, client_tls_max) as dh: + if expect_success: + response = await dh.download_request(request) + assert response.body == b"0123456789" + else: + with pytest.raises( + (DownloadConnectionRefusedError, DownloadFailedError) + ): + await dh.download_request(request) + + @coroutine_test + async def test_invalid_min_version_setting(self) -> None: + with pytest.raises( + ValueError, match="Unknown DOWNLOAD_TLS_MIN_VERSION value: invalid" + ): + async with self.get_dh(client_tls_min="invalid", client_tls_max=None): + pass + + @coroutine_test + async def test_invalid_max_version_setting(self) -> None: + with pytest.raises( + ValueError, match="Unknown DOWNLOAD_TLS_MAX_VERSION value: invalid" + ): + async with self.get_dh(client_tls_min=None, client_tls_max="invalid"): + pass + + +class TestHttpWithCrawlerBase(ABC): @property @abstractmethod def settings_dict(self) -> dict[str, Any] | None: @@ -592,126 +1117,445 @@ class TestHttpMockServerBase(unittest.TestCase, ABC): is_secure = False - @classmethod - def setUpClass(cls): - cls.mockserver = MockServer() - cls.mockserver.__enter__() - - @classmethod - def tearDownClass(cls): - cls.mockserver.__exit__(None, None, None) - - @deferred_f_from_coro_f - async def test_download_with_content_length(self): + @coroutine_test + async def test_download_with_content_length(self, mockserver: MockServer) -> None: crawler = get_crawler(SingleRequestSpider, self.settings_dict) # http://localhost:8998/partial set Content-Length to 1024, use download_maxsize= 1000 to avoid # download it await maybe_deferred_to_future( crawler.crawl( seed=Request( - url=self.mockserver.url("/partial", is_secure=self.is_secure), + url=mockserver.url("/partial", is_secure=self.is_secure), meta={"download_maxsize": 1000}, ) ) ) - failure = crawler.spider.meta["failure"] - assert isinstance(failure.value, defer.CancelledError) + assert crawler.spider + failure = crawler.spider.meta["failure"] # type: ignore[attr-defined] + assert isinstance(failure.value, DownloadCancelledError) - @deferred_f_from_coro_f - async def test_download(self): + @coroutine_test + async def test_download(self, mockserver: MockServer) -> None: crawler = get_crawler(SingleRequestSpider, self.settings_dict) await maybe_deferred_to_future( crawler.crawl( - seed=Request(url=self.mockserver.url("", is_secure=self.is_secure)) + seed=Request(url=mockserver.url("", is_secure=self.is_secure)) ) ) - failure = crawler.spider.meta.get("failure") + assert crawler.spider + failure = crawler.spider.meta.get("failure") # type: ignore[attr-defined] assert failure is None - reason = crawler.spider.meta["close_reason"] + reason = crawler.spider.meta["close_reason"] # type: ignore[attr-defined] assert reason == "finished" + @pytest.mark.filterwarnings( + r"ignore:.*You should use cryptography's X\.509 APIs:DeprecationWarning" + ) + @coroutine_test + async def test_response_ssl_certificate(self, mockserver: MockServer) -> None: + if not self.is_secure: + pytest.skip("Only applies to HTTPS") + # copy of TestCrawl.test_response_ssl_certificate() + crawler = get_crawler(SingleRequestSpider, self.settings_dict) + url = mockserver.url("/echo?body=test", is_secure=self.is_secure) + await crawler.crawl_async(seed=url, mockserver=mockserver) + assert isinstance(crawler.spider, SingleRequestSpider) + cert = crawler.spider.meta["responses"][0].certificate + assert cert is not None + if isinstance(cert, Certificate): # Twisted + assert cert.getSubject().commonName == b"localhost" + assert cert.getIssuer().commonName == b"localhost" + elif isinstance(cert, bytes): # DER bytes + cert_x509 = load_der_x509_certificate(cert) + assert cert_x509.subject.rfc4514_string() == "CN=localhost,O=Scrapy,C=IE" + assert cert_x509.issuer.rfc4514_string() == "CN=localhost,O=Scrapy,C=IE" -class UriResource(resource.Resource): - """Return the full uri that was requested""" + @coroutine_test + async def test_response_ip_address(self, mockserver: MockServer) -> None: + # copy of TestCrawl.test_response_ip_address() + crawler = get_crawler(SingleRequestSpider, self.settings_dict) + url = mockserver.url("/echo?body=test", is_secure=self.is_secure) + expected_netloc, _ = urlparse(url).netloc.split(":") + await crawler.crawl_async(seed=url, mockserver=mockserver) + assert isinstance(crawler.spider, SingleRequestSpider) + ip_address = crawler.spider.meta["responses"][0].ip_address + assert isinstance(ip_address, IPv4Address) + assert str(ip_address) == gethostbyname(expected_netloc) - def getChild(self, path, request): - return self + @coroutine_test + async def test_bytes_received_stop_download_callback( + self, mockserver: MockServer + ) -> None: + # copy of TestCrawl.test_bytes_received_stop_download_callback() + crawler = get_crawler(BytesReceivedCallbackSpider, self.settings_dict) + await crawler.crawl_async(mockserver=mockserver, is_secure=self.is_secure) + assert isinstance(crawler.spider, BytesReceivedCallbackSpider) + assert crawler.spider.meta.get("failure") is None + assert isinstance(crawler.spider.meta["response"], Response) + assert crawler.spider.meta["response"].body == crawler.spider.meta.get( + "bytes_received" + ) + assert ( + len(crawler.spider.meta["response"].body) + < crawler.spider.full_response_length + ) - def render(self, request): - # Note: this is an ugly hack for CONNECT request timeout test. - # Returning some data here fail SSL/TLS handshake - # ToDo: implement proper HTTPS proxy tests, not faking them. - if request.method != b"CONNECT": - return request.uri - return b"" + @coroutine_test + async def test_bytes_received_stop_download_errback( + self, mockserver: MockServer + ) -> None: + # copy of TestCrawl.test_bytes_received_stop_download_errback() + crawler = get_crawler(BytesReceivedErrbackSpider, self.settings_dict) + await crawler.crawl_async(mockserver=mockserver, is_secure=self.is_secure) + assert isinstance(crawler.spider, BytesReceivedErrbackSpider) + assert crawler.spider.meta.get("response") is None + assert isinstance(crawler.spider.meta["failure"], Failure) + assert isinstance(crawler.spider.meta["failure"].value, StopDownload) + assert isinstance(crawler.spider.meta["failure"].value.response, Response) + assert crawler.spider.meta[ + "failure" + ].value.response.body == crawler.spider.meta.get("bytes_received") + assert ( + len(crawler.spider.meta["failure"].value.response.body) + < crawler.spider.full_response_length + ) + + @coroutine_test + async def test_headers_received_stop_download_callback( + self, mockserver: MockServer + ) -> None: + # copy of TestCrawl.test_headers_received_stop_download_callback() + crawler = get_crawler(HeadersReceivedCallbackSpider, self.settings_dict) + await crawler.crawl_async(mockserver=mockserver, is_secure=self.is_secure) + assert isinstance(crawler.spider, HeadersReceivedCallbackSpider) + assert crawler.spider.meta.get("failure") is None + assert isinstance(crawler.spider.meta["response"], Response) + assert crawler.spider.meta["response"].headers == crawler.spider.meta.get( + "headers_received" + ) + + @coroutine_test + async def test_headers_received_stop_download_errback( + self, mockserver: MockServer + ) -> None: + # copy of TestCrawl.test_headers_received_stop_download_errback() + crawler = get_crawler(HeadersReceivedErrbackSpider, self.settings_dict) + await crawler.crawl_async(mockserver=mockserver, is_secure=self.is_secure) + assert isinstance(crawler.spider, HeadersReceivedErrbackSpider) + assert crawler.spider.meta.get("response") is None + assert isinstance(crawler.spider.meta["failure"], Failure) + assert isinstance(crawler.spider.meta["failure"].value, StopDownload) + assert isinstance(crawler.spider.meta["failure"].value.response, Response) + assert crawler.spider.meta[ + "failure" + ].value.response.headers == crawler.spider.meta.get("headers_received") -class TestHttpProxyBase(unittest.TestCase, ABC): +class TestHttpProxyBase(ABC): + is_secure = False expected_http_proxy_request_body = b"http://example.com" + # whether the handler supports HTTPS proxies with HTTPS destinations + handler_supports_tls_in_tls: bool = True @property @abstractmethod def download_handler_cls(self) -> type[DownloadHandlerProtocol]: raise NotImplementedError - def setUp(self): - from twisted.internet import reactor + @pytest.fixture(scope="session") + def proxy_mockserver(self) -> Generator[ProxyEchoMockServer]: + with ProxyEchoMockServer() as proxy: + yield proxy - site = server.Site(UriResource(), timeout=None) - wrapper = WrappingFactory(site) - self.port = reactor.listenTCP(0, wrapper, interface="127.0.0.1") - self.portno = self.port.getHost().port - self.download_handler = build_from_crawler( - self.download_handler_cls, get_crawler() - ) + @asynccontextmanager + async def get_dh(self) -> AsyncGenerator[DownloadHandlerProtocol]: + crawler = get_crawler(DefaultSpider) + crawler.spider = crawler._create_spider() + dh = build_from_crawler(self.download_handler_cls, crawler) + try: + yield dh + finally: + await dh.close() - @inlineCallbacks - def tearDown(self): - yield self.port.stopListening() - if hasattr(self.download_handler, "close"): - yield self.download_handler.close() - - def getURL(self, path): - return f"http://127.0.0.1:{self.portno}/{path}" - - async def download_request(self, request: Request, spider: Spider) -> Response: - return await maybe_deferred_to_future( - self.download_handler.download_request(request, spider) - ) - - @deferred_f_from_coro_f - async def test_download_with_proxy(self): - http_proxy = self.getURL("") + @coroutine_test + async def test_download_with_proxy( + self, proxy_mockserver: ProxyEchoMockServer + ) -> None: + http_proxy = proxy_mockserver.url("", is_secure=self.is_secure) request = Request("http://example.com", meta={"proxy": http_proxy}) - response = await self.download_request(request, Spider("foo")) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.status == 200 assert response.url == request.url assert response.body == self.expected_http_proxy_request_body - @deferred_f_from_coro_f - async def test_download_without_proxy(self): - request = Request(self.getURL("path/to/resource")) - response = await self.download_request(request, Spider("foo")) + @coroutine_test + async def test_download_without_proxy( + self, proxy_mockserver: ProxyEchoMockServer + ) -> None: + request = Request( + proxy_mockserver.url("/path/to/resource", is_secure=self.is_secure) + ) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.status == 200 assert response.url == request.url assert response.body == b"/path/to/resource" - @deferred_f_from_coro_f - async def test_download_with_proxy_https_timeout(self): + @coroutine_test + async def test_download_with_proxy_https_timeout( + self, proxy_mockserver: ProxyEchoMockServer + ) -> None: if NON_EXISTING_RESOLVABLE: pytest.skip("Non-existing hosts are resolvable") - http_proxy = self.getURL("") + if self.is_secure and not self.handler_supports_tls_in_tls: + pytest.skip("HTTPS proxies for HTTPS destinations are not supported") + http_proxy = proxy_mockserver.url("", is_secure=self.is_secure) domain = "https://no-such-domain.nosuch" request = Request(domain, meta={"proxy": http_proxy, "download_timeout": 0.2}) - with pytest.raises(error.TimeoutError) as exc_info: - await self.download_request(request, Spider("foo")) - assert domain in exc_info.value.osError + async with self.get_dh() as download_handler: + with pytest.raises(DownloadTimeoutError) as exc_info: + await download_handler.download_request(request) + assert domain in str(exc_info.value) - @deferred_f_from_coro_f - async def test_download_with_proxy_without_http_scheme(self): - http_proxy = self.getURL("").replace("http://", "") + @coroutine_test + async def test_download_with_proxy_without_http_scheme( + self, proxy_mockserver: ProxyEchoMockServer + ) -> None: + http_proxy = f"{proxy_mockserver.host}:{proxy_mockserver.port()}" request = Request("http://example.com", meta={"proxy": http_proxy}) - response = await self.download_request(request, Spider("foo")) + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) assert response.status == 200 assert response.url == request.url assert response.body == self.expected_http_proxy_request_body + + +PROXY_KINDS = ["http", "https", "socks5"] + + +class TestMitmProxyBase(ABC): + # whether the handler supports HTTPS proxies with HTTPS destinations + handler_supports_tls_in_tls: bool = True + handler_supports_socks: bool = False + + @property + @abstractmethod + def settings_dict(self) -> dict[str, Any] | None: + raise NotImplementedError + + def _maybe_skip(self, proxy_kind: str, https_dest: bool) -> None: + if proxy_kind == "socks5" and not self.handler_supports_socks: + pytest.skip("SOCKS proxies are not supported") + if ( + proxy_kind == "https" + and https_dest + and not self.handler_supports_tls_in_tls + ): + pytest.skip("HTTPS proxies for HTTPS destinations are not supported") + + @pytest.mark.parametrize("proxy_server", PROXY_KINDS, indirect=True) + @pytest.mark.parametrize( + "https_dest", [False, True], ids=["HTTP dest", "HTTPS dest"] + ) + @coroutine_test + async def test_proxy( + self, + caplog: pytest.LogCaptureFixture, + proxy_server: str, + mockserver: MockServer, + https_dest: bool, + ) -> None: + """HTTP/HTTPS/SOCKS5 proxy, HTTP or HTTPS destination.""" + self._maybe_skip(proxy_server, https_dest) + crawler = get_crawler(SingleRequestSpider, self.settings_dict) + with caplog.at_level(logging.DEBUG): + await crawler.crawl_async( + seed=mockserver.url("/status?n=200", is_secure=https_dest) + ) + assert isinstance(crawler.spider, SingleRequestSpider) + self._assert_got_response_code(200, caplog.text) + self._assert_headers(crawler.spider.meta["responses"][0].headers, https_dest) + + @pytest.mark.parametrize("proxy_server", PROXY_KINDS, indirect=True) + @pytest.mark.parametrize( + "https_dest", [False, True], ids=["HTTP dest", "HTTPS dest"] + ) + @coroutine_test + async def test_proxy_auth_error( + self, + caplog: pytest.LogCaptureFixture, + monkeypatch: pytest.MonkeyPatch, + proxy_server: str, + mockserver: MockServer, + https_dest: bool, + ) -> None: + """HTTP/HTTPS/SOCKS5 proxy, HTTP or HTTPS destination, wrong proxy creds.""" + self._maybe_skip(proxy_server, https_dest) + envvar = "https_proxy" if https_dest else "http_proxy" + monkeypatch.setenv(envvar, wrong_credentials(os.environ[envvar])) + crawler = get_crawler(SimpleSpider, self.settings_dict) + with caplog.at_level(logging.DEBUG): + await crawler.crawl_async( + mockserver.url("/status?n=200", is_secure=https_dest) + ) + if proxy_server == "socks5": + assert "DownloadConnectionRefusedError" in caplog.text + else: + # The proxy returns a 407 error code but it does not reach the + # client; it just sees an exception. + self._assert_got_auth_exception(caplog.text) + + @pytest.mark.parametrize("proxy_server", PROXY_KINDS, indirect=True) + @pytest.mark.parametrize( + "https_dest", [False, True], ids=["HTTP dest", "HTTPS dest"] + ) + @coroutine_test + async def test_proxy_dont_leak_auth_header( + self, + caplog: pytest.LogCaptureFixture, + proxy_server: str, + mockserver: MockServer, + https_dest: bool, + ) -> None: + """HTTP/HTTPS/SOCKS5 proxy, HTTP or HTTPS destination. Check that the + auth header is not sent to the destination.""" + self._maybe_skip(proxy_server, https_dest) + request = Request(mockserver.url("/echo", is_secure=https_dest)) + crawler = get_crawler(SingleRequestSpider, self.settings_dict) + with caplog.at_level(logging.DEBUG): + await crawler.crawl_async(seed=request) + assert isinstance(crawler.spider, SingleRequestSpider) + self._assert_got_response_code(200, caplog.text) + self._assert_headers(crawler.spider.meta["responses"][0].headers, https_dest) + echo = json.loads(crawler.spider.meta["responses"][0].text) + assert "Proxy-Authorization" not in echo["headers"] + + @pytest.mark.parametrize("proxy_server", PROXY_KINDS, indirect=True) + @pytest.mark.parametrize( + "https_dest", [False, True], ids=["HTTP dest", "HTTPS dest"] + ) + @coroutine_test + async def test_proxy_redirect( + self, + caplog: pytest.LogCaptureFixture, + proxy_server: str, + mockserver: MockServer, + https_dest: bool, + ) -> None: + """HTTP/HTTPS/SOCKS5 proxy, HTTP or HTTPS destination, following a + redirect. Check that the redirected request still goes through the + proxy and doesn't lose the proxy auth. + """ + self._maybe_skip(proxy_server, https_dest) + crawler = get_crawler(SingleRequestSpider, self.settings_dict) + with caplog.at_level(logging.DEBUG): + await crawler.crawl_async( + seed=mockserver.url("/redirect", is_secure=https_dest) + ) + assert isinstance(crawler.spider, SingleRequestSpider) + assert crawler.spider.meta.get("failure") is None + responses = crawler.spider.meta.get("responses", []) + assert len(responses) == 1 + assert responses[0].status == 200 + assert responses[0].url == mockserver.url("/redirected", is_secure=https_dest) + self._assert_got_response_code(200, caplog.text) + self._assert_headers(responses[0].headers, https_dest) + + @staticmethod + def _assert_headers(headers: Headers, https_dest: bool) -> None: + assert b"X-Via-Mitmproxy" in headers + if https_dest: + assert b"X-Via-Mitmproxy-TLS" in headers + + @staticmethod + def _assert_got_response_code(code: int, log: str) -> None: + assert str(log).count(f"Crawled ({code})") == 1 + + @staticmethod + def _assert_got_auth_exception(log: str) -> None: + assert "Proxy Authentication Required" in log or "407" in log + + +class TestRealWebsiteBase(ABC): + @property + @abstractmethod + def download_handler_cls(self) -> type[DownloadHandlerProtocol]: + raise NotImplementedError + + @property + @abstractmethod + def settings_dict(self) -> dict[str, Any] | None: + raise NotImplementedError + + @property + def platform_cert_store_works(self) -> bool: + """Whether valid certificates can be verified. + + Twisted on Windows cannot do that out of the box, see e.g. + https://github.com/twisted/twisted/issues/6371. + """ + return True + + @asynccontextmanager + async def get_dh( + self, settings_dict: dict[str, Any] | None = None + ) -> AsyncGenerator[DownloadHandlerProtocol]: + crawler = get_crawler(DefaultSpider, settings_dict) + crawler.spider = crawler._create_spider() + dh = build_from_crawler(self.download_handler_cls, crawler) + try: + yield dh + finally: + await dh.close() + + @coroutine_test + async def test_download(self) -> None: + request = Request("https://books.toscrape.com/") + async with self.get_dh() as download_handler: + response = await download_handler.download_request(request) + assert response.status == 200 + assert "All products | Books to Scrape - Sandbox" in response.text + + @coroutine_test + async def test_download_with_spider(self) -> None: + crawler = get_crawler(SingleRequestSpider, self.settings_dict) + await maybe_deferred_to_future( + crawler.crawl(seed=Request("https://books.toscrape.com/")) + ) + assert isinstance(crawler.spider, SingleRequestSpider) + failure = crawler.spider.meta.get("failure") + assert failure is None + reason = crawler.spider.meta["close_reason"] + assert reason == "finished" + + @coroutine_test + async def test_verify_certs(self) -> None: + if not self.platform_cert_store_works: + pytest.skip("Cannot verify certificates") + request = Request("https://books.toscrape.com/") + async with self.get_dh( + {"DOWNLOAD_VERIFY_CERTIFICATES": True} + ) as download_handler: + response = await download_handler.download_request(request) + assert response.status == 200 + assert "All products | Books to Scrape - Sandbox" in response.text + + @pytest.mark.parametrize("verify_certs", [True, False]) + @coroutine_test + async def test_tls_logging( + self, caplog: pytest.LogCaptureFixture, verify_certs: bool + ) -> None: + if verify_certs and not self.platform_cert_store_works: + pytest.skip("Cannot verify certificates") + request = Request("https://books.toscrape.com/") + async with self.get_dh( + { + "DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING": True, + "DOWNLOAD_VERIFY_CERTIFICATES": verify_certs, + } + ) as download_handler: + with caplog.at_level("DEBUG"): + response = await download_handler.download_request(request) + assert response.status == 200 + assert "SSL connection to books.toscrape.com using protocol" in caplog.text diff --git a/tests/test_downloadermiddleware.py b/tests/test_downloadermiddleware.py index 61a5a7df5..d321c9047 100644 --- a/tests/test_downloadermiddleware.py +++ b/tests/test_downloadermiddleware.py @@ -1,37 +1,48 @@ from __future__ import annotations import asyncio +from contextlib import asynccontextmanager from gzip import BadGzipFile +from typing import TYPE_CHECKING from unittest import mock import pytest from twisted.internet.defer import Deferred, succeed -from twisted.trial.unittest import TestCase from scrapy.core.downloader.middleware import DownloaderMiddlewareManager -from scrapy.exceptions import _InvalidOutput +from scrapy.exceptions import ScrapyDeprecationWarning, _InvalidOutput from scrapy.http import Request, Response from scrapy.spiders import Spider -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future +from scrapy.utils.defer import maybe_deferred_to_future from scrapy.utils.python import to_bytes from scrapy.utils.test import get_crawler, get_from_asyncio_queue +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + from collections.abc import AsyncGenerator -class TestManagerBase(TestCase): +class TestManagerBase: settings_dict = None - def setUp(self): - self.crawler = get_crawler(Spider, self.settings_dict) - self.spider = self.crawler._create_spider("foo") - self.mwman = DownloaderMiddlewareManager.from_crawler(self.crawler) - self.crawler.engine = self.crawler._create_engine() - return self.crawler.engine.open_spider(self.spider) - - def tearDown(self): - return self.crawler.engine.close_spider(self.spider) + # should be a fixture but async fixtures that use Futures are problematic with pytest-twisted + @asynccontextmanager + async def get_mwman(self) -> AsyncGenerator[DownloaderMiddlewareManager]: + crawler = get_crawler(Spider, self.settings_dict) + crawler.spider = crawler._create_spider("foo") + mwman = DownloaderMiddlewareManager.from_crawler(crawler) + crawler.engine = crawler._create_engine() + await crawler.engine.open_spider_async() + try: + yield mwman + finally: + await crawler.engine.close_spider_async() + @staticmethod async def _download( - self, request: Request, response: Response | None = None + mwman: DownloaderMiddlewareManager, + request: Request, + response: Response | None = None, ) -> Response | Request: """Executes downloader mw manager's download method and returns the result (Request or Response) or raises exception in case of @@ -40,25 +51,24 @@ class TestManagerBase(TestCase): if not response: response = Response(request.url) - def download_func(request: Request, spider: Spider) -> Deferred[Response]: - return succeed(response) + async def download_func(request: Request) -> Response: + return response - return await maybe_deferred_to_future( - self.mwman.download(download_func, request, self.spider) - ) + return await mwman.download_async(download_func, request) class TestDefaults(TestManagerBase): """Tests default behavior with default settings""" - @deferred_f_from_coro_f + @coroutine_test async def test_request_response(self): req = Request("http://example.com/index.html") resp = Response(req.url, status=200) - ret = await self._download(req, resp) + async with self.get_mwman() as mwman: + ret = await self._download(mwman, req, resp) assert isinstance(ret, Response), "Non-response returned" - @deferred_f_from_coro_f + @coroutine_test async def test_3xx_and_invalid_gzipped_body_must_redirect(self): """Regression test for a failure when redirecting a compressed request. @@ -84,13 +94,14 @@ class TestDefaults(TestManagerBase): "Location": "http://example.com/login", }, ) - ret = await self._download(req, resp) + async with self.get_mwman() as mwman: + ret = await self._download(mwman, req, resp) assert isinstance(ret, Request), f"Not redirected: {ret!r}" assert to_bytes(ret.url) == resp.headers["Location"], ( "Not redirected to location header" ) - @deferred_f_from_coro_f + @coroutine_test async def test_200_and_invalid_gzipped_body_must_fail(self): req = Request("http://example.com") body = b"

You are being redirected

" @@ -106,27 +117,26 @@ class TestDefaults(TestManagerBase): }, ) with pytest.raises(BadGzipFile): - await self._download(req, resp) + async with self.get_mwman() as mwman: + await self._download(mwman, req, resp) class TestResponseFromProcessRequest(TestManagerBase): """Tests middleware returning a response from process_request.""" - @deferred_f_from_coro_f + @coroutine_test async def test_download_func_not_called(self): + req = Request("http://example.com/index.html") resp = Response("http://example.com/index.html") + download_func = mock.MagicMock() class ResponseMiddleware: - def process_request(self, request, spider): + def process_request(self, request): return resp - self.mwman._add_middleware(ResponseMiddleware()) - - req = Request("http://example.com/index.html") - download_func = mock.MagicMock() - result = await maybe_deferred_to_future( - self.mwman.download(download_func, req, self.spider) - ) + async with self.get_mwman() as mwman: + mwman._add_middleware(ResponseMiddleware()) + result = await mwman.download_async(download_func, req) assert result is resp assert not download_func.called @@ -134,29 +144,27 @@ class TestResponseFromProcessRequest(TestManagerBase): class TestResponseFromProcessException(TestManagerBase): """Tests middleware returning a response from process_exception.""" - @deferred_f_from_coro_f + @coroutine_test async def test_process_response_called(self): + req = Request("http://example.com/index.html") resp = Response("http://example.com/index.html") calls = [] - def download_func(request, spider): + def download_func(request): raise ValueError("test") class ResponseMiddleware: - def process_response(self, request, response, spider): + def process_response(self, request, response): calls.append("process_response") return resp - def process_exception(self, request, exception, spider): + def process_exception(self, request, exception): calls.append("process_exception") return resp - self.mwman._add_middleware(ResponseMiddleware()) - - req = Request("http://example.com/index.html") - result = await maybe_deferred_to_future( - self.mwman.download(download_func, req, self.spider) - ) + async with self.get_mwman() as mwman: + mwman._add_middleware(ResponseMiddleware()) + result = await mwman.download_async(download_func, req) assert result is resp assert calls == [ "process_exception", @@ -165,113 +173,174 @@ class TestResponseFromProcessException(TestManagerBase): class TestInvalidOutput(TestManagerBase): - @deferred_f_from_coro_f + @coroutine_test async def test_invalid_process_request(self): """Invalid return value for process_request method should raise an exception""" req = Request("http://example.com/index.html") class InvalidProcessRequestMiddleware: - def process_request(self, request, spider): + def process_request(self, request): return 1 - self.mwman._add_middleware(InvalidProcessRequestMiddleware()) - with pytest.raises(_InvalidOutput): - await self._download(req) + async with self.get_mwman() as mwman: + mwman._add_middleware(InvalidProcessRequestMiddleware()) + with pytest.raises(_InvalidOutput): + await self._download(mwman, req) - @deferred_f_from_coro_f + @coroutine_test async def test_invalid_process_response(self): """Invalid return value for process_response method should raise an exception""" req = Request("http://example.com/index.html") class InvalidProcessResponseMiddleware: - def process_response(self, request, response, spider): + def process_response(self, request, response): return 1 - self.mwman._add_middleware(InvalidProcessResponseMiddleware()) - with pytest.raises(_InvalidOutput): - await self._download(req) + async with self.get_mwman() as mwman: + mwman._add_middleware(InvalidProcessResponseMiddleware()) + with pytest.raises(_InvalidOutput): + await self._download(mwman, req) - @deferred_f_from_coro_f + @coroutine_test async def test_invalid_process_exception(self): """Invalid return value for process_exception method should raise an exception""" req = Request("http://example.com/index.html") class InvalidProcessExceptionMiddleware: - def process_request(self, request, spider): + def process_request(self, request): raise RuntimeError - def process_exception(self, request, exception, spider): + def process_exception(self, request, exception): return 1 - self.mwman._add_middleware(InvalidProcessExceptionMiddleware()) - with pytest.raises(_InvalidOutput): - await self._download(req) + async with self.get_mwman() as mwman: + mwman._add_middleware(InvalidProcessExceptionMiddleware()) + with pytest.raises(_InvalidOutput): + await self._download(mwman, req) class TestMiddlewareUsingDeferreds(TestManagerBase): - """Middlewares using Deferreds should work""" + """Middlewares using Deferreds (deprecated) should work""" - @deferred_f_from_coro_f + @coroutine_test async def test_deferred(self): + req = Request("http://example.com/index.html") resp = Response("http://example.com/index.html") + download_func = mock.MagicMock() class DeferredMiddleware: def cb(self, result): return result - def process_request(self, request, spider): + def process_request(self, request): d = Deferred() d.addCallback(self.cb) d.callback(resp) return d - self.mwman._add_middleware(DeferredMiddleware()) - req = Request("http://example.com/index.html") - download_func = mock.MagicMock() - result = await maybe_deferred_to_future( - self.mwman.download(download_func, req, self.spider) - ) + async with self.get_mwman() as mwman: + mwman._add_middleware(DeferredMiddleware()) + with pytest.warns( + ScrapyDeprecationWarning, + match="returned a Deferred, this is deprecated", + ): + result = await mwman.download_async(download_func, req) assert result is resp assert not download_func.called -@pytest.mark.usefixtures("reactor_pytest") class TestMiddlewareUsingCoro(TestManagerBase): """Middlewares using asyncio coroutines should work""" - @deferred_f_from_coro_f + @coroutine_test async def test_asyncdef(self): + req = Request("http://example.com/index.html") resp = Response("http://example.com/index.html") + download_func = mock.MagicMock() class CoroMiddleware: - async def process_request(self, request, spider): + async def process_request(self, request): await succeed(42) return resp - self.mwman._add_middleware(CoroMiddleware()) - req = Request("http://example.com/index.html") - download_func = mock.MagicMock() - result = await maybe_deferred_to_future( - self.mwman.download(download_func, req, self.spider) - ) + async with self.get_mwman() as mwman: + mwman._add_middleware(CoroMiddleware()) + result = await mwman.download_async(download_func, req) assert result is resp assert not download_func.called @pytest.mark.only_asyncio - @deferred_f_from_coro_f + @coroutine_test async def test_asyncdef_asyncio(self): + req = Request("http://example.com/index.html") resp = Response("http://example.com/index.html") + download_func = mock.MagicMock() class CoroMiddleware: - async def process_request(self, request, spider): + async def process_request(self, request): await asyncio.sleep(0.1) return await get_from_asyncio_queue(resp) - self.mwman._add_middleware(CoroMiddleware()) - req = Request("http://example.com/index.html") - download_func = mock.MagicMock() - result = await maybe_deferred_to_future( - self.mwman.download(download_func, req, self.spider) - ) + async with self.get_mwman() as mwman: + mwman._add_middleware(CoroMiddleware()) + result = await mwman.download_async(download_func, req) + assert result is resp + assert not download_func.called + + +class TestDownloadDeprecated(TestManagerBase): + @coroutine_test + async def test_mwman_download(self): + req = Request("http://example.com/index.html") + resp = Response(req.url, status=200) + + def download_func(request: Request, spider: Spider) -> Deferred[Response]: + return succeed(resp) + + async with self.get_mwman() as mwman: + with pytest.warns( + ScrapyDeprecationWarning, + match=r"DownloaderMiddlewareManager.download\(\) is deprecated, use download_async\(\) instead", + ): + ret = await maybe_deferred_to_future( + mwman.download(download_func, req, mwman.crawler.spider) + ) + assert isinstance(ret, Response) + + +class TestDeprecatedSpiderArg(TestManagerBase): + @coroutine_test + async def test_deprecated_spider_arg(self): + req = Request("http://example.com/index.html") + resp = Response("http://example.com/index.html") + download_func = mock.MagicMock() + + class DeprecatedSpiderArgMiddleware: + def process_request(self, request, spider): + 1 / 0 + + def process_response(self, request, response, spider): + return response + + def process_exception(self, request, exception, spider): + return resp + + async with self.get_mwman() as mwman: + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"process_request\(\) requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"process_response\(\) requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"process_exception\(\) requires a spider argument", + ), + ): + mwman._add_middleware(DeprecatedSpiderArgMiddleware()) + result = await mwman.download_async(download_func, req) assert result is resp assert not download_func.called diff --git a/tests/test_downloadermiddleware_ajaxcrawlable.py b/tests/test_downloadermiddleware_ajaxcrawlable.py deleted file mode 100644 index 44084f1e8..000000000 --- a/tests/test_downloadermiddleware_ajaxcrawlable.py +++ /dev/null @@ -1,62 +0,0 @@ -import pytest - -from scrapy.downloadermiddlewares.ajaxcrawl import AjaxCrawlMiddleware -from scrapy.http import HtmlResponse, Request, Response -from scrapy.spiders import Spider -from scrapy.utils.test import get_crawler - - -@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") -class TestAjaxCrawlMiddleware: - def setup_method(self): - crawler = get_crawler(Spider, {"AJAXCRAWL_ENABLED": True}) - self.spider = crawler._create_spider("foo") - self.mw = AjaxCrawlMiddleware.from_crawler(crawler) - - def _ajaxcrawlable_body(self): - return b'' - - def _req_resp(self, url, req_kwargs=None, resp_kwargs=None): - req = Request(url, **(req_kwargs or {})) - resp = HtmlResponse(url, request=req, **(resp_kwargs or {})) - return req, resp - - def test_non_get(self): - req, resp = self._req_resp("http://example.com/", {"method": "HEAD"}) - resp2 = self.mw.process_response(req, resp, self.spider) - assert resp == resp2 - - def test_binary_response(self): - req = Request("http://example.com/") - resp = Response("http://example.com/", body=b"foobar\x00\x01\x02", request=req) - resp2 = self.mw.process_response(req, resp, self.spider) - assert resp is resp2 - - def test_ajaxcrawl(self): - req, resp = self._req_resp( - "http://example.com/", - {"meta": {"foo": "bar"}}, - {"body": self._ajaxcrawlable_body()}, - ) - req2 = self.mw.process_response(req, resp, self.spider) - assert req2.url == "http://example.com/?_escaped_fragment_=" - assert req2.meta["foo"] == "bar" - - def test_ajaxcrawl_loop(self): - req, resp = self._req_resp( - "http://example.com/", {}, {"body": self._ajaxcrawlable_body()} - ) - req2 = self.mw.process_response(req, resp, self.spider) - resp2 = HtmlResponse(req2.url, body=resp.body, request=req2) - resp3 = self.mw.process_response(req2, resp2, self.spider) - - assert isinstance(resp3, HtmlResponse), (resp3.__class__, resp3) - assert resp3.request.url == "http://example.com/?_escaped_fragment_=" - assert resp3 is resp2 - - def test_noncrawlable_body(self): - req, resp = self._req_resp( - "http://example.com/", {}, {"body": b""} - ) - resp2 = self.mw.process_response(req, resp, self.spider) - assert resp is resp2 diff --git a/tests/test_downloadermiddleware_cookies.py b/tests/test_downloadermiddleware_cookies.py index 8bf3a1f09..225562644 100644 --- a/tests/test_downloadermiddleware_cookies.py +++ b/tests/test_downloadermiddleware_cookies.py @@ -8,9 +8,8 @@ from scrapy.downloadermiddlewares.defaultheaders import DefaultHeadersMiddleware from scrapy.downloadermiddlewares.redirect import RedirectMiddleware from scrapy.exceptions import NotConfigured from scrapy.http import Request, Response -from scrapy.settings import Settings -from scrapy.spiders import Spider from scrapy.utils.python import to_bytes +from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler UNSET = object() @@ -43,7 +42,7 @@ def _cookie_to_set_cookie_value(cookie): def _cookies_to_set_cookie_list(cookies): """Given a group of cookie defined either as a dictionary or as a list of dictionaries (i.e. in a format supported by the cookies parameter of - Request), return the equivalen list of strings that can be associated to a + Request), return the equivalent list of strings that can be associated to a ``Set-Cookie`` header.""" if not cookies: return [] @@ -60,9 +59,10 @@ class TestCookiesMiddleware: assert split_cookies(first) == split_cookies(second), msg def setup_method(self): - self.spider = Spider("foo") - self.mw = CookiesMiddleware() - self.redirect_middleware = RedirectMiddleware(settings=Settings()) + crawler = get_crawler(DefaultSpider) + crawler.spider = crawler._create_spider() + self.mw = CookiesMiddleware.from_crawler(crawler) + self.redirect_middleware = RedirectMiddleware.from_crawler(crawler) def teardown_method(self): del self.mw @@ -70,15 +70,15 @@ class TestCookiesMiddleware: def test_basic(self): req = Request("http://scrapytest.org/") - assert self.mw.process_request(req, self.spider) is None + assert self.mw.process_request(req) is None assert "Cookie" not in req.headers headers = {"Set-Cookie": "C1=value1; path=/"} res = Response("http://scrapytest.org/", headers=headers) - assert self.mw.process_response(req, res, self.spider) is res + assert self.mw.process_response(req, res) is res req2 = Request("http://scrapytest.org/sub1/") - assert self.mw.process_request(req2, self.spider) is None + assert self.mw.process_request(req2) is None assert req2.headers.get("Cookie") == b"C1=value1" def test_setting_false_cookies_enabled(self): @@ -112,9 +112,9 @@ class TestCookiesMiddleware: res = Response( "http://scrapytest.org/", headers={"Set-Cookie": "C1=value1; path=/"} ) - mw.process_response(req, res, crawler.spider) + mw.process_response(req, res) req2 = Request("http://scrapytest.org/sub1/") - mw.process_request(req2, crawler.spider) + mw.process_request(req2) log.check( ( @@ -143,23 +143,23 @@ class TestCookiesMiddleware: res = Response( "http://scrapytest.org/", headers={"Set-Cookie": "C1=value1; path=/"} ) - mw.process_response(req, res, crawler.spider) + mw.process_response(req, res) req2 = Request("http://scrapytest.org/sub1/") - mw.process_request(req2, crawler.spider) + mw.process_request(req2) log.check() def test_do_not_break_on_non_utf8_header(self): req = Request("http://scrapytest.org/") - assert self.mw.process_request(req, self.spider) is None + assert self.mw.process_request(req) is None assert "Cookie" not in req.headers headers = {"Set-Cookie": b"C1=in\xa3valid; path=/", "Other": b"ignore\xa3me"} res = Response("http://scrapytest.org/", headers=headers) - assert self.mw.process_response(req, res, self.spider) is res + assert self.mw.process_response(req, res) is res req2 = Request("http://scrapytest.org/sub1/") - assert self.mw.process_request(req2, self.spider) is None + assert self.mw.process_request(req2) is None assert "Cookie" in req2.headers def test_dont_merge_cookies(self): @@ -167,11 +167,11 @@ class TestCookiesMiddleware: headers = {"Set-Cookie": "C1=value1; path=/"} req = Request("http://scrapytest.org/") res = Response("http://scrapytest.org/", headers=headers) - assert self.mw.process_response(req, res, self.spider) is res + assert self.mw.process_response(req, res) is res # test Cookie header is not seted to request req = Request("http://scrapytest.org/dontmerge", meta={"dont_merge_cookies": 1}) - assert self.mw.process_request(req, self.spider) is None + assert self.mw.process_request(req) is None assert "Cookie" not in req.headers # check that returned cookies are not merged back to jar @@ -179,16 +179,16 @@ class TestCookiesMiddleware: "http://scrapytest.org/dontmerge", headers={"Set-Cookie": "dont=mergeme; path=/"}, ) - assert self.mw.process_response(req, res, self.spider) is res + assert self.mw.process_response(req, res) is res # check that cookies are merged back req = Request("http://scrapytest.org/mergeme") - assert self.mw.process_request(req, self.spider) is None + assert self.mw.process_request(req) is None assert req.headers.get("Cookie") == b"C1=value1" # check that cookies are merged when dont_merge_cookies is passed as 0 req = Request("http://scrapytest.org/mergeme", meta={"dont_merge_cookies": 0}) - assert self.mw.process_request(req, self.spider) is None + assert self.mw.process_request(req) is None assert req.headers.get("Cookie") == b"C1=value1" def test_complex_cookies(self): @@ -216,11 +216,11 @@ class TestCookiesMiddleware: ] req = Request("http://scrapytest.org/", cookies=cookies) - self.mw.process_request(req, self.spider) + self.mw.process_request(req) # embed C1 and C3 for scrapytest.org/foo req = Request("http://scrapytest.org/foo") - self.mw.process_request(req, self.spider) + self.mw.process_request(req) assert req.headers.get("Cookie") in ( b"C1=value1; C3=value3", b"C3=value3; C1=value1", @@ -228,25 +228,25 @@ class TestCookiesMiddleware: # embed C2 for scrapytest.org/bar req = Request("http://scrapytest.org/bar") - self.mw.process_request(req, self.spider) + self.mw.process_request(req) assert req.headers.get("Cookie") == b"C2=value2" # embed nothing for scrapytest.org/baz req = Request("http://scrapytest.org/baz") - self.mw.process_request(req, self.spider) + self.mw.process_request(req) assert "Cookie" not in req.headers def test_merge_request_cookies(self): req = Request("http://scrapytest.org/", cookies={"galleta": "salada"}) - assert self.mw.process_request(req, self.spider) is None + assert self.mw.process_request(req) is None assert req.headers.get("Cookie") == b"galleta=salada" headers = {"Set-Cookie": "C1=value1; path=/"} res = Response("http://scrapytest.org/", headers=headers) - assert self.mw.process_response(req, res, self.spider) is res + assert self.mw.process_response(req, res) is res req2 = Request("http://scrapytest.org/sub1/") - assert self.mw.process_request(req2, self.spider) is None + assert self.mw.process_request(req2) is None self.assertCookieValEqual( req2.headers.get("Cookie"), b"C1=value1; galleta=salada" @@ -258,15 +258,15 @@ class TestCookiesMiddleware: cookies={"galleta": "salada"}, meta={"cookiejar": "store1"}, ) - assert self.mw.process_request(req, self.spider) is None + assert self.mw.process_request(req) is None assert req.headers.get("Cookie") == b"galleta=salada" headers = {"Set-Cookie": "C1=value1; path=/"} res = Response("http://scrapytest.org/", headers=headers, request=req) - assert self.mw.process_response(req, res, self.spider) is res + assert self.mw.process_response(req, res) is res req2 = Request("http://scrapytest.org/", meta=res.meta) - assert self.mw.process_request(req2, self.spider) is None + assert self.mw.process_request(req2) is None self.assertCookieValEqual( req2.headers.get("Cookie"), b"C1=value1; galleta=salada" ) @@ -276,45 +276,45 @@ class TestCookiesMiddleware: cookies={"galleta": "dulce"}, meta={"cookiejar": "store2"}, ) - assert self.mw.process_request(req3, self.spider) is None + assert self.mw.process_request(req3) is None assert req3.headers.get("Cookie") == b"galleta=dulce" headers = {"Set-Cookie": "C2=value2; path=/"} res2 = Response("http://scrapytest.org/", headers=headers, request=req3) - assert self.mw.process_response(req3, res2, self.spider) is res2 + assert self.mw.process_response(req3, res2) is res2 req4 = Request("http://scrapytest.org/", meta=res2.meta) - assert self.mw.process_request(req4, self.spider) is None + assert self.mw.process_request(req4) is None self.assertCookieValEqual( req4.headers.get("Cookie"), b"C2=value2; galleta=dulce" ) # cookies from hosts with port req5_1 = Request("http://scrapytest.org:1104/") - assert self.mw.process_request(req5_1, self.spider) is None + assert self.mw.process_request(req5_1) is None headers = {"Set-Cookie": "C1=value1; path=/"} res5_1 = Response( "http://scrapytest.org:1104/", headers=headers, request=req5_1 ) - assert self.mw.process_response(req5_1, res5_1, self.spider) is res5_1 + assert self.mw.process_response(req5_1, res5_1) is res5_1 req5_2 = Request("http://scrapytest.org:1104/some-redirected-path") - assert self.mw.process_request(req5_2, self.spider) is None + assert self.mw.process_request(req5_2) is None assert req5_2.headers.get("Cookie") == b"C1=value1" req5_3 = Request("http://scrapytest.org/some-redirected-path") - assert self.mw.process_request(req5_3, self.spider) is None + assert self.mw.process_request(req5_3) is None assert req5_3.headers.get("Cookie") == b"C1=value1" # skip cookie retrieval for not http request req6 = Request("file:///scrapy/sometempfile") - assert self.mw.process_request(req6, self.spider) is None + assert self.mw.process_request(req6) is None assert req6.headers.get("Cookie") is None def test_local_domain(self): request = Request("http://example-host/", cookies={"currencyCookie": "USD"}) - assert self.mw.process_request(request, self.spider) is None + assert self.mw.process_request(request) is None assert "Cookie" in request.headers assert request.headers["Cookie"] == b"currencyCookie=USD" @@ -324,15 +324,15 @@ class TestCookiesMiddleware: mw_default_headers = DefaultHeadersMiddleware(DEFAULT_REQUEST_HEADERS.items()) # overwrite with values from 'cookies' request argument req1 = Request("http://example.org", cookies={"default": "something"}) - assert mw_default_headers.process_request(req1, self.spider) is None - assert self.mw.process_request(req1, self.spider) is None + assert mw_default_headers.process_request(req1) is None + assert self.mw.process_request(req1) is None self.assertCookieValEqual( req1.headers["Cookie"], b"default=something; asdf=qwerty" ) # keep both req2 = Request("http://example.com", cookies={"a": "b"}) - assert mw_default_headers.process_request(req2, self.spider) is None - assert self.mw.process_request(req2, self.spider) is None + assert mw_default_headers.process_request(req2) is None + assert self.mw.process_request(req2) is None self.assertCookieValEqual( req2.headers["Cookie"], b"default=value; a=b; asdf=qwerty" ) @@ -341,13 +341,13 @@ class TestCookiesMiddleware: def test_keep_cookie_header(self): # keep only cookies from 'Cookie' request header req1 = Request("http://scrapytest.org", headers={"Cookie": "a=b; c=d"}) - assert self.mw.process_request(req1, self.spider) is None + assert self.mw.process_request(req1) is None self.assertCookieValEqual(req1.headers["Cookie"], "a=b; c=d") # keep cookies from both 'Cookie' request header and 'cookies' keyword req2 = Request( "http://scrapytest.org", headers={"Cookie": "a=b; c=d"}, cookies={"e": "f"} ) - assert self.mw.process_request(req2, self.spider) is None + assert self.mw.process_request(req2) is None self.assertCookieValEqual(req2.headers["Cookie"], "a=b; c=d; e=f") # overwrite values from 'Cookie' request header with 'cookies' keyword req3 = Request( @@ -355,40 +355,40 @@ class TestCookiesMiddleware: headers={"Cookie": "a=b; c=d"}, cookies={"a": "new", "e": "f"}, ) - assert self.mw.process_request(req3, self.spider) is None + assert self.mw.process_request(req3) is None self.assertCookieValEqual(req3.headers["Cookie"], "a=new; c=d; e=f") def test_request_cookies_encoding(self): # 1) UTF8-encoded bytes req1 = Request("http://example.org", cookies={"a": "á".encode()}) - assert self.mw.process_request(req1, self.spider) is None + assert self.mw.process_request(req1) is None self.assertCookieValEqual(req1.headers["Cookie"], b"a=\xc3\xa1") # 2) Non UTF8-encoded bytes req2 = Request("http://example.org", cookies={"a": "á".encode("latin1")}) - assert self.mw.process_request(req2, self.spider) is None + assert self.mw.process_request(req2) is None self.assertCookieValEqual(req2.headers["Cookie"], b"a=\xc3\xa1") # 3) String req3 = Request("http://example.org", cookies={"a": "á"}) - assert self.mw.process_request(req3, self.spider) is None + assert self.mw.process_request(req3) is None self.assertCookieValEqual(req3.headers["Cookie"], b"a=\xc3\xa1") @pytest.mark.xfail(reason="Cookie header is not currently being processed") def test_request_headers_cookie_encoding(self): # 1) UTF8-encoded bytes req1 = Request("http://example.org", headers={"Cookie": "a=á".encode()}) - assert self.mw.process_request(req1, self.spider) is None + assert self.mw.process_request(req1) is None self.assertCookieValEqual(req1.headers["Cookie"], b"a=\xc3\xa1") # 2) Non UTF8-encoded bytes req2 = Request("http://example.org", headers={"Cookie": "a=á".encode("latin1")}) - assert self.mw.process_request(req2, self.spider) is None + assert self.mw.process_request(req2) is None self.assertCookieValEqual(req2.headers["Cookie"], b"a=\xc3\xa1") # 3) String req3 = Request("http://example.org", headers={"Cookie": "a=á"}) - assert self.mw.process_request(req3, self.spider) is None + assert self.mw.process_request(req3) is None self.assertCookieValEqual(req3.headers["Cookie"], b"a=\xc3\xa1") def test_invalid_cookies(self): @@ -402,13 +402,13 @@ class TestCookiesMiddleware: ) as lc: cookies1 = [{"value": "bar"}, {"name": "key", "value": "value1"}] req1 = Request("http://example.org/1", cookies=cookies1) - assert self.mw.process_request(req1, self.spider) is None + assert self.mw.process_request(req1) is None cookies2 = [{"name": "foo"}, {"name": "key", "value": "value2"}] req2 = Request("http://example.org/2", cookies=cookies2) - assert self.mw.process_request(req2, self.spider) is None + assert self.mw.process_request(req2) is None cookies3 = [{"name": "foo", "value": None}, {"name": "key", "value": ""}] req3 = Request("http://example.org/3", cookies=cookies3) - assert self.mw.process_request(req3, self.spider) is None + assert self.mw.process_request(req3) is None lc.check( ( "scrapy.downloadermiddlewares.cookies", @@ -436,22 +436,22 @@ class TestCookiesMiddleware: def test_primitive_type_cookies(self): # Boolean req1 = Request("http://example.org", cookies={"a": True}) - assert self.mw.process_request(req1, self.spider) is None + assert self.mw.process_request(req1) is None self.assertCookieValEqual(req1.headers["Cookie"], b"a=True") # Float req2 = Request("http://example.org", cookies={"a": 9.5}) - assert self.mw.process_request(req2, self.spider) is None + assert self.mw.process_request(req2) is None self.assertCookieValEqual(req2.headers["Cookie"], b"a=9.5") # Integer req3 = Request("http://example.org", cookies={"a": 10}) - assert self.mw.process_request(req3, self.spider) is None + assert self.mw.process_request(req3) is None self.assertCookieValEqual(req3.headers["Cookie"], b"a=10") # String req4 = Request("http://example.org", cookies={"a": "b"}) - assert self.mw.process_request(req4, self.spider) is None + assert self.mw.process_request(req4) is None self.assertCookieValEqual(req4.headers["Cookie"], b"a=b") def _test_cookie_redirect( @@ -471,7 +471,7 @@ class TestCookiesMiddleware: target.setdefault("status", 301) request1 = Request(cookies=input_cookies, **source) - self.mw.process_request(request1, self.spider) + self.mw.process_request(request1) cookies = request1.headers.get("Cookie") assert cookies == (b"a=b" if cookies1 else None) @@ -481,16 +481,12 @@ class TestCookiesMiddleware: }, **target, ) - assert self.mw.process_response(request1, response, self.spider) == response + assert self.mw.process_response(request1, response) == response - request2 = self.redirect_middleware.process_response( - request1, - response, - self.spider, - ) + request2 = self.redirect_middleware.process_response(request1, response) assert isinstance(request2, Request) - self.mw.process_request(request2, self.spider) + self.mw.process_request(request2) cookies = request2.headers.get("Cookie") assert cookies == (b"a=b" if cookies2 else None) @@ -564,11 +560,7 @@ class TestCookiesMiddleware: **target, ) - request2 = self.redirect_middleware.process_response( - request1, - response, - self.spider, - ) + request2 = self.redirect_middleware.process_response(request1, response) assert isinstance(request2, Request) cookies = request2.headers.get("Cookie") @@ -620,12 +612,12 @@ class TestCookiesMiddleware: ] request1 = Request(url1, cookies=input_cookies) - self.mw.process_request(request1, self.spider) + self.mw.process_request(request1) cookies = request1.headers.get("Cookie") assert cookies == (b"a=b" if cookies1 else None) request2 = Request(url2) - self.mw.process_request(request2, self.spider) + self.mw.process_request(request2) cookies = request2.headers.get("Cookie") assert cookies == (b"a=b" if cookies2 else None) @@ -674,7 +666,7 @@ class TestCookiesMiddleware: cookies, ): request1 = Request(url1) - self.mw.process_request(request1, self.spider) + self.mw.process_request(request1) input_cookies = [ { @@ -688,10 +680,10 @@ class TestCookiesMiddleware: "Set-Cookie": _cookies_to_set_cookie_list(input_cookies), } response = Response(url1, status=200, headers=headers) - assert self.mw.process_response(request1, response, self.spider) == response + assert self.mw.process_response(request1, response) == response request2 = Request(url2) - self.mw.process_request(request2, self.spider) + self.mw.process_request(request2) actual_cookies = request2.headers.get("Cookie") assert actual_cookies == (b"a=b" if cookies else None) @@ -743,7 +735,7 @@ class TestCookiesMiddleware: input_cookies = [{"name": "a", "value": "b", **cookie_kwargs}] request1 = Request(f"{from_scheme}://a.example", cookies=input_cookies) - self.mw.process_request(request1, self.spider) + self.mw.process_request(request1) cookies = request1.headers.get("Cookie") assert cookies == (b"a=b" if cookies1 else None) @@ -752,18 +744,14 @@ class TestCookiesMiddleware: headers={"Location": f"{to_scheme}://a.example"}, status=301, ) - assert self.mw.process_response(request1, response, self.spider) == response + assert self.mw.process_response(request1, response) == response - request2 = self.redirect_middleware.process_response( - request1, - response, - self.spider, - ) + request2 = self.redirect_middleware.process_response(request1, response) assert isinstance(request2, Request) cookies = request2.headers.get("Cookie") assert cookies == (b"a=b" if cookies2 else None) - self.mw.process_request(request2, self.spider) + self.mw.process_request(request2) cookies = request2.headers.get("Cookie") assert cookies == (b"a=b" if cookies3 else None) diff --git a/tests/test_downloadermiddleware_defaultheaders.py b/tests/test_downloadermiddleware_defaultheaders.py index 5716e3631..e697de9b7 100644 --- a/tests/test_downloadermiddleware_defaultheaders.py +++ b/tests/test_downloadermiddleware_defaultheaders.py @@ -6,28 +6,27 @@ from scrapy.utils.test import get_crawler class TestDefaultHeadersMiddleware: - def get_defaults_spider_mw(self): + def get_defaults_mw(self): crawler = get_crawler(Spider) - spider = crawler._create_spider("foo") defaults = { to_bytes(k): [to_bytes(v)] for k, v in crawler.settings.get("DEFAULT_REQUEST_HEADERS").items() } - return defaults, spider, DefaultHeadersMiddleware.from_crawler(crawler) + return defaults, DefaultHeadersMiddleware.from_crawler(crawler) def test_process_request(self): - defaults, spider, mw = self.get_defaults_spider_mw() + defaults, mw = self.get_defaults_mw() req = Request("http://www.scrapytest.org") - mw.process_request(req, spider) + mw.process_request(req) assert req.headers == defaults def test_update_headers(self): - defaults, spider, mw = self.get_defaults_spider_mw() + defaults, mw = self.get_defaults_mw() headers = {"Accept-Language": ["es"], "Test-Header": ["test"]} bytes_headers = {b"Accept-Language": [b"es"], b"Test-Header": [b"test"]} req = Request("http://www.scrapytest.org", headers=headers) assert req.headers == bytes_headers - mw.process_request(req, spider) + mw.process_request(req) defaults.update(bytes_headers) assert req.headers == defaults diff --git a/tests/test_downloadermiddleware_downloadtimeout.py b/tests/test_downloadermiddleware_downloadtimeout.py index 31323c8fa..c744d259c 100644 --- a/tests/test_downloadermiddleware_downloadtimeout.py +++ b/tests/test_downloadermiddleware_downloadtimeout.py @@ -14,26 +14,24 @@ class TestDownloadTimeoutMiddleware: def test_default_download_timeout(self): req, spider, mw = self.get_request_spider_mw() mw.spider_opened(spider) - assert mw.process_request(req, spider) is None + assert mw.process_request(req) is None assert req.meta.get("download_timeout") == 180 def test_string_download_timeout(self): req, spider, mw = self.get_request_spider_mw({"DOWNLOAD_TIMEOUT": "20.1"}) mw.spider_opened(spider) - assert mw.process_request(req, spider) is None + assert mw.process_request(req) is None assert req.meta.get("download_timeout") == 20.1 - def test_spider_has_download_timeout(self): - req, spider, mw = self.get_request_spider_mw() - spider.download_timeout = 2 + def test_setting_has_download_timeout(self): + req, spider, mw = self.get_request_spider_mw({"DOWNLOAD_TIMEOUT": 2}) mw.spider_opened(spider) - assert mw.process_request(req, spider) is None + assert mw.process_request(req) is None assert req.meta.get("download_timeout") == 2 def test_request_has_download_timeout(self): - req, spider, mw = self.get_request_spider_mw() - spider.download_timeout = 2 + req, spider, mw = self.get_request_spider_mw({"DOWNLOAD_TIMEOUT": 2}) mw.spider_opened(spider) req.meta["download_timeout"] = 1 - assert mw.process_request(req, spider) is None + assert mw.process_request(req) is None assert req.meta.get("download_timeout") == 1 diff --git a/tests/test_downloadermiddleware_httpauth.py b/tests/test_downloadermiddleware_httpauth.py index 9154e1850..827133d2e 100644 --- a/tests/test_downloadermiddleware_httpauth.py +++ b/tests/test_downloadermiddleware_httpauth.py @@ -2,8 +2,25 @@ import pytest from w3lib.http import basic_auth_header from scrapy.downloadermiddlewares.httpauth import HttpAuthMiddleware +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request from scrapy.spiders import Spider +from scrapy.utils.test import get_crawler + +_DOMAIN_NOT_SET = object() + + +def make_mw(user="", passwd="", domain=_DOMAIN_NOT_SET): + settings: dict = { + "HTTPAUTH_USER": user, + "HTTPAUTH_PASS": passwd, + } + if domain is not _DOMAIN_NOT_SET: + settings["HTTPAUTH_DOMAIN"] = domain + return HttpAuthMiddleware.from_crawler(get_crawler(settings_dict=settings)) + + +# --- Spider attribute tests (deprecated) --- class LegacySpider(Spider): @@ -23,61 +40,135 @@ class AnyDomainSpider(Spider): http_auth_domain = None -class TestHttpAuthMiddlewareLegacy: - def setup_method(self): - self.spider = LegacySpider("foo") - - def test_auth(self): +class TestHttpAuthMiddlewareLegacySpiderAttr: + def test_missing_domain_raises(self): mw = HttpAuthMiddleware() - with pytest.raises(AttributeError): - mw.spider_opened(self.spider) + with pytest.warns(ScrapyDeprecationWarning), pytest.raises(AttributeError): + mw.spider_opened(LegacySpider("foo")) + def test_domain_spider(self): + mw = HttpAuthMiddleware() + with pytest.warns(ScrapyDeprecationWarning): + mw.spider_opened(DomainSpider("foo")) + req = Request("http://example.com/") + mw.process_request(req) + assert req.headers["Authorization"] == basic_auth_header("foo", "bar") -class TestHttpAuthMiddleware: - def setup_method(self): - self.mw = HttpAuthMiddleware() - self.spider = DomainSpider("foo") - self.mw.spider_opened(self.spider) - - def teardown_method(self): - del self.mw - - def test_no_auth(self): - req = Request("http://example-noauth.com/") - assert self.mw.process_request(req, self.spider) is None + def test_no_auth_wrong_domain(self): + mw = HttpAuthMiddleware() + with pytest.warns(ScrapyDeprecationWarning): + mw.spider_opened(DomainSpider("foo")) + req = Request("http://other.com/") + mw.process_request(req) assert "Authorization" not in req.headers - def test_auth_domain(self): + def test_any_domain_spider(self): + mw = HttpAuthMiddleware() + with pytest.warns(ScrapyDeprecationWarning): + mw.spider_opened(AnyDomainSpider("foo")) + req = Request("http://anywhere.com/") + mw.process_request(req) + assert req.headers["Authorization"] == basic_auth_header("foo", "bar") + + +# --- Settings-based tests --- + + +class TestHttpAuthMiddlewareSettings: + def test_no_auth(self): + mw = make_mw() req = Request("http://example.com/") - assert self.mw.process_request(req, self.spider) is None + mw.process_request(req) + assert "Authorization" not in req.headers + + def test_auth_without_domain_raises(self): + with pytest.raises(ValueError, match="HTTPAUTH_DOMAIN"): + make_mw(user="foo", passwd="bar") + + def test_auth_all_domains(self): + mw = make_mw(user="foo", passwd="bar", domain=None) + req = Request("http://example.com/") + mw.process_request(req) + assert req.headers["Authorization"] == basic_auth_header("foo", "bar") + + def test_auth_domain_match(self): + mw = make_mw(user="foo", passwd="bar", domain="example.com") + req = Request("http://example.com/") + mw.process_request(req) assert req.headers["Authorization"] == basic_auth_header("foo", "bar") def test_auth_subdomain(self): - req = Request("http://foo.example.com/") - assert self.mw.process_request(req, self.spider) is None + mw = make_mw(user="foo", passwd="bar", domain="example.com") + req = Request("http://sub.example.com/") + mw.process_request(req) assert req.headers["Authorization"] == basic_auth_header("foo", "bar") + def test_no_auth_wrong_domain(self): + mw = make_mw(user="foo", passwd="bar", domain="example.com") + req = Request("http://other.com/") + mw.process_request(req) + assert "Authorization" not in req.headers + def test_auth_already_set(self): + mw = make_mw(user="foo", passwd="bar", domain="example.com") req = Request("http://example.com/", headers={"Authorization": "Digest 123"}) - assert self.mw.process_request(req, self.spider) is None + mw.process_request(req) assert req.headers["Authorization"] == b"Digest 123" -class TestHttpAuthAnyMiddleware: - def setup_method(self): - self.mw = HttpAuthMiddleware() - self.spider = AnyDomainSpider("foo") - self.mw.spider_opened(self.spider) +# --- Per-request meta tests --- - def teardown_method(self): - del self.mw - def test_auth(self): - req = Request("http://example.com/") - assert self.mw.process_request(req, self.spider) is None - assert req.headers["Authorization"] == basic_auth_header("foo", "bar") +class TestHttpAuthMiddlewareMeta: + def test_meta_auth_no_domain(self): + mw = make_mw() + req = Request("http://example.com/", meta={"http_user": "u", "http_pass": "p"}) + mw.process_request(req) + assert req.headers["Authorization"] == basic_auth_header("u", "p") - def test_auth_already_set(self): - req = Request("http://example.com/", headers={"Authorization": "Digest 123"}) - assert self.mw.process_request(req, self.spider) is None + def test_meta_auth_domain_match(self): + mw = make_mw() + req = Request( + "http://example.com/", + meta={ + "http_user": "u", + "http_pass": "p", + "http_auth_domain": "example.com", + }, + ) + mw.process_request(req) + assert req.headers["Authorization"] == basic_auth_header("u", "p") + + def test_meta_auth_domain_no_match(self): + mw = make_mw() + req = Request( + "http://other.com/", + meta={ + "http_user": "u", + "http_pass": "p", + "http_auth_domain": "example.com", + }, + ) + mw.process_request(req) + assert "Authorization" not in req.headers + + def test_meta_overrides_middleware(self): + mw = make_mw(user="mw_user", passwd="mw_pass", domain="example.com") + req = Request( + "http://example.com/", + meta={"http_user": "meta_user", "http_pass": "meta_pass"}, + ) + mw.process_request(req) + assert req.headers["Authorization"] == basic_auth_header( + "meta_user", "meta_pass" + ) + + def test_meta_already_set(self): + mw = make_mw() + req = Request( + "http://example.com/", + headers={"Authorization": "Digest 123"}, + meta={"http_user": "u", "http_pass": "p"}, + ) + mw.process_request(req) assert req.headers["Authorization"] == b"Digest 123" diff --git a/tests/test_downloadermiddleware_httpcache.py b/tests/test_downloadermiddleware_httpcache.py index 02f4f488e..e5d726764 100644 --- a/tests/test_downloadermiddleware_httpcache.py +++ b/tests/test_downloadermiddleware_httpcache.py @@ -1,28 +1,36 @@ +from __future__ import annotations + import email.utils import shutil import tempfile import time from contextlib import contextmanager +from typing import TYPE_CHECKING, Any import pytest from scrapy.downloadermiddlewares.httpcache import HttpCacheMiddleware from scrapy.exceptions import IgnoreRequest from scrapy.http import HtmlResponse, Request, Response -from scrapy.settings import Settings from scrapy.spiders import Spider from scrapy.utils.test import get_crawler +if TYPE_CHECKING: + from collections.abc import Generator + + from scrapy.crawler import Crawler + class TestBase: """Base class with common setup and helper methods.""" + policy_class: str + storage_class: str + def setup_method(self): self.yesterday = email.utils.formatdate(time.time() - 86400) self.today = email.utils.formatdate() self.tomorrow = email.utils.formatdate(time.time() + 86400) - self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider("example.com") self.tmpdir = tempfile.mkdtemp() self.request = Request("http://www.example.com", headers={"User-Agent": "test"}) self.response = Response( @@ -31,13 +39,11 @@ class TestBase: body=b"test body", status=202, ) - self.crawler.stats.open_spider(self.spider) def teardown_method(self): - self.crawler.stats.close_spider(self.spider, "") shutil.rmtree(self.tmpdir) - def _get_settings(self, **new_settings): + def _get_settings(self, **new_settings: Any) -> dict[str, Any]: settings = { "HTTPCACHE_ENABLED": True, "HTTPCACHE_DIR": self.tmpdir, @@ -47,27 +53,35 @@ class TestBase: "HTTPCACHE_STORAGE": self.storage_class, } settings.update(new_settings) - return Settings(settings) + return settings @contextmanager - def _storage(self, **new_settings): - with self._middleware(**new_settings) as mw: - yield mw.storage - - @contextmanager - def _policy(self, **new_settings): - with self._middleware(**new_settings) as mw: - yield mw.policy - - @contextmanager - def _middleware(self, **new_settings): + def _get_crawler(self, **new_settings: Any) -> Generator[Crawler]: settings = self._get_settings(**new_settings) - mw = HttpCacheMiddleware(settings, self.crawler.stats) - mw.spider_opened(self.spider) + crawler = get_crawler(Spider, settings) + crawler.spider = crawler._create_spider("example.com") + assert crawler.stats + crawler.stats.open_spider() try: - yield mw + yield crawler finally: - mw.spider_closed(self.spider) + crawler.stats.close_spider() + + @contextmanager + def _storage(self, **new_settings: Any): + with self._middleware(**new_settings) as mw: + yield mw.storage, mw.crawler + + @contextmanager + def _middleware(self, **new_settings: Any) -> Generator[HttpCacheMiddleware]: + with self._get_crawler(**new_settings) as crawler: + assert crawler.spider + mw = HttpCacheMiddleware.from_crawler(crawler) + mw.spider_opened(crawler.spider) + try: + yield mw + finally: + mw.spider_closed(crawler.spider) def assertEqualResponse(self, response1, response2): assert response1.url == response2.url @@ -75,56 +89,42 @@ class TestBase: assert response1.headers == response2.headers assert response1.body == response2.body - def assertEqualRequest(self, request1, request2): - assert request1.url == request2.url - assert request1.headers == request2.headers - assert request1.body == request2.body - - def assertEqualRequestButWithCacheValidators(self, request1, request2): - assert request1.url == request2.url - assert b"If-None-Match" not in request1.headers - assert b"If-Modified-Since" not in request1.headers - assert any( - h in request2.headers for h in (b"If-None-Match", b"If-Modified-Since") - ) - assert request1.body == request2.body - class StorageTestMixin: """Mixin containing storage-specific test methods.""" def test_storage(self): - with self._storage() as storage: + with self._storage() as (storage, crawler): request2 = self.request.copy() - assert storage.retrieve_response(self.spider, request2) is None + assert storage.retrieve_response(crawler.spider, request2) is None - storage.store_response(self.spider, self.request, self.response) - response2 = storage.retrieve_response(self.spider, request2) + storage.store_response(crawler.spider, self.request, self.response) + response2 = storage.retrieve_response(crawler.spider, request2) assert isinstance(response2, HtmlResponse) # content-type header self.assertEqualResponse(self.response, response2) time.sleep(2) # wait for cache to expire - assert storage.retrieve_response(self.spider, request2) is None + assert storage.retrieve_response(crawler.spider, request2) is None def test_storage_never_expire(self): - with self._storage(HTTPCACHE_EXPIRATION_SECS=0) as storage: - assert storage.retrieve_response(self.spider, self.request) is None - storage.store_response(self.spider, self.request, self.response) + with self._storage(HTTPCACHE_EXPIRATION_SECS=0) as (storage, crawler): + assert storage.retrieve_response(crawler.spider, self.request) is None + storage.store_response(crawler.spider, self.request, self.response) time.sleep(0.5) # give the chance to expire - assert storage.retrieve_response(self.spider, self.request) + assert storage.retrieve_response(crawler.spider, self.request) def test_storage_no_content_type_header(self): """Test that the response body is used to get the right response class even if there is no Content-Type header""" - with self._storage() as storage: - assert storage.retrieve_response(self.spider, self.request) is None + with self._storage() as (storage, crawler): + assert storage.retrieve_response(crawler.spider, self.request) is None response = Response( "http://www.example.com", body=b"\n.", status=202, ) - storage.store_response(self.spider, self.request, response) - cached_response = storage.retrieve_response(self.spider, self.request) + storage.store_response(crawler.spider, self.request, response) + cached_response = storage.retrieve_response(crawler.spider, self.request) assert isinstance(cached_response, HtmlResponse) self.assertEqualResponse(response, cached_response) @@ -135,15 +135,15 @@ class PolicyTestMixin: def test_dont_cache(self): with self._middleware() as mw: self.request.meta["dont_cache"] = True - mw.process_response(self.request, self.response, self.spider) - assert mw.storage.retrieve_response(self.spider, self.request) is None + mw.process_response(self.request, self.response) + assert mw.storage.retrieve_response(mw.crawler.spider, self.request) is None with self._middleware() as mw: self.request.meta["dont_cache"] = False - mw.process_response(self.request, self.response, self.spider) + mw.process_response(self.request, self.response) if mw.policy.should_cache_response(self.response, self.request): assert isinstance( - mw.storage.retrieve_response(self.spider, self.request), + mw.storage.retrieve_response(mw.crawler.spider, self.request), self.response.__class__, ) @@ -153,9 +153,9 @@ class DummyPolicyTestMixin(PolicyTestMixin): def test_middleware(self): with self._middleware() as mw: - assert mw.process_request(self.request, self.spider) is None - mw.process_response(self.request, self.response, self.spider) - response = mw.process_request(self.request, self.spider) + assert mw.process_request(self.request) is None + mw.process_response(self.request, self.response) + response = mw.process_request(self.request) assert isinstance(response, HtmlResponse) self.assertEqualResponse(self.response, response) assert "cached" in response.flags @@ -164,9 +164,9 @@ class DummyPolicyTestMixin(PolicyTestMixin): with self._middleware() as mw: req = Request("http://host.com/path") res = Response("http://host2.net/test.html") - assert mw.process_request(req, self.spider) is None - mw.process_response(req, res, self.spider) - cached = mw.process_request(req, self.spider) + assert mw.process_request(req) is None + mw.process_response(req, res) + cached = mw.process_request(req) assert isinstance(cached, Response) self.assertEqualResponse(res, cached) assert "cached" in cached.flags @@ -174,9 +174,9 @@ class DummyPolicyTestMixin(PolicyTestMixin): def test_middleware_ignore_missing(self): with self._middleware(HTTPCACHE_IGNORE_MISSING=True) as mw: with pytest.raises(IgnoreRequest): - mw.process_request(self.request, self.spider) - mw.process_response(self.request, self.response, self.spider) - response = mw.process_request(self.request, self.spider) + mw.process_request(self.request) + mw.process_response(self.request, self.response) + response = mw.process_request(self.request) assert isinstance(response, HtmlResponse) self.assertEqualResponse(self.response, response) assert "cached" in response.flags @@ -185,10 +185,10 @@ class DummyPolicyTestMixin(PolicyTestMixin): # http responses are cached by default req, res = Request("http://test.com/"), Response("http://test.com/") with self._middleware() as mw: - assert mw.process_request(req, self.spider) is None - mw.process_response(req, res, self.spider) + assert mw.process_request(req) is None + mw.process_response(req, res) - cached = mw.process_request(req, self.spider) + cached = mw.process_request(req) assert isinstance(cached, Response), type(cached) self.assertEqualResponse(res, cached) assert "cached" in cached.flags @@ -196,45 +196,45 @@ class DummyPolicyTestMixin(PolicyTestMixin): # file response is not cached by default req, res = Request("file:///tmp/t.txt"), Response("file:///tmp/t.txt") with self._middleware() as mw: - assert mw.process_request(req, self.spider) is None - mw.process_response(req, res, self.spider) + assert mw.process_request(req) is None + mw.process_response(req, res) - assert mw.storage.retrieve_response(self.spider, req) is None - assert mw.process_request(req, self.spider) is None + assert mw.storage.retrieve_response(mw.crawler.spider, req) is None + assert mw.process_request(req) is None # s3 scheme response is cached by default - req, res = Request("s3://bucket/key"), Response("http://bucket/key") + req, res = Request("s3://bucket/key"), Response("s3://bucket/key") with self._middleware() as mw: - assert mw.process_request(req, self.spider) is None - mw.process_response(req, res, self.spider) + assert mw.process_request(req) is None + mw.process_response(req, res) - cached = mw.process_request(req, self.spider) + cached = mw.process_request(req) assert isinstance(cached, Response), type(cached) self.assertEqualResponse(res, cached) assert "cached" in cached.flags # ignore s3 scheme - req, res = Request("s3://bucket/key2"), Response("http://bucket/key2") + req, res = Request("s3://bucket/key2"), Response("s3://bucket/key2") with self._middleware(HTTPCACHE_IGNORE_SCHEMES=["s3"]) as mw: - assert mw.process_request(req, self.spider) is None - mw.process_response(req, res, self.spider) + assert mw.process_request(req) is None + mw.process_response(req, res) - assert mw.storage.retrieve_response(self.spider, req) is None - assert mw.process_request(req, self.spider) is None + assert mw.storage.retrieve_response(mw.crawler.spider, req) is None + assert mw.process_request(req) is None def test_middleware_ignore_http_codes(self): # test response is not cached with self._middleware(HTTPCACHE_IGNORE_HTTP_CODES=[202]) as mw: - assert mw.process_request(self.request, self.spider) is None - mw.process_response(self.request, self.response, self.spider) + assert mw.process_request(self.request) is None + mw.process_response(self.request, self.response) - assert mw.storage.retrieve_response(self.spider, self.request) is None - assert mw.process_request(self.request, self.spider) is None + assert mw.storage.retrieve_response(mw.crawler.spider, self.request) is None + assert mw.process_request(self.request) is None # test response is cached with self._middleware(HTTPCACHE_IGNORE_HTTP_CODES=[203]) as mw: - mw.process_response(self.request, self.response, self.spider) - response = mw.process_request(self.request, self.spider) + mw.process_response(self.request, self.response) + response = mw.process_request(self.request) assert isinstance(response, HtmlResponse) self.assertEqualResponse(self.response, response) assert "cached" in response.flags @@ -243,14 +243,18 @@ class DummyPolicyTestMixin(PolicyTestMixin): class RFC2616PolicyTestMixin(PolicyTestMixin): """Mixin containing RFC2616 policy specific test methods.""" - def _process_requestresponse(self, mw, request, response): + @staticmethod + def _process_requestresponse( + mw: HttpCacheMiddleware, request: Request, response: Response | None + ) -> Response | Request: result = None try: - result = mw.process_request(request, self.spider) + result = mw.process_request(request) if result: assert isinstance(result, (Request, Response)) return result - result = mw.process_response(request, response, self.spider) + assert response is not None + result = mw.process_response(request, response) assert isinstance(result, Response) return result except Exception: @@ -270,11 +274,11 @@ class RFC2616PolicyTestMixin(PolicyTestMixin): # response for a request with no-store must not be cached res1 = self._process_requestresponse(mw, req1, res0) self.assertEqualResponse(res1, res0) - assert mw.storage.retrieve_response(self.spider, req1) is None + assert mw.storage.retrieve_response(mw.crawler.spider, req1) is None # Re-do request without no-store and expect it to be cached res2 = self._process_requestresponse(mw, req0, res0) assert "cached" not in res2.flags - res3 = mw.process_request(req0, self.spider) + res3 = mw.process_request(req0) assert "cached" in res3.flags self.assertEqualResponse(res2, res3) # request with no-cache directive must not return cached response @@ -330,7 +334,7 @@ class RFC2616PolicyTestMixin(PolicyTestMixin): ) self.assertEqualResponse(res1, res0) self.assertEqualResponse(res2, res0) - resc = mw.storage.retrieve_response(self.spider, req0) + resc = mw.storage.retrieve_response(mw.crawler.spider, req0) if shouldcache: self.assertEqualResponse(resc, res1) assert "cached" in res2.flags @@ -354,7 +358,7 @@ class RFC2616PolicyTestMixin(PolicyTestMixin): ) self.assertEqualResponse(res1, res0) self.assertEqualResponse(res2, res0) - resc = mw.storage.retrieve_response(self.spider, req0) + resc = mw.storage.retrieve_response(mw.crawler.spider, req0) if shouldcache: self.assertEqualResponse(resc, res1) assert "cached" in res2.flags @@ -421,7 +425,7 @@ class RFC2616PolicyTestMixin(PolicyTestMixin): # validate cached response if request max-age set as 0 req1 = req0.replace(headers={"Cache-Control": "max-age=0"}) res304 = res0.replace(status=304) - assert mw.process_request(req1, self.spider) is None + assert mw.process_request(req1) is None res3 = self._process_requestresponse(mw, req1, res304) self.assertEqualResponse(res1, res3) assert "cached" in res3.flags @@ -513,14 +517,14 @@ class RFC2616PolicyTestMixin(PolicyTestMixin): self._process_requestresponse(mw, req0, res0) for e in mw.DOWNLOAD_EXCEPTIONS: # Simulate encountering an error on download attempts - assert mw.process_request(req0, self.spider) is None - res1 = mw.process_exception(req0, e("foo"), self.spider) + assert mw.process_request(req0) is None + res1 = mw.process_exception(req0, e("foo")) # Use cached response as recovery assert "cached" in res1.flags self.assertEqualResponse(res0, res1) # Do not use cached response for unhandled exceptions - mw.process_request(req0, self.spider) - assert mw.process_exception(req0, Exception("foo"), self.spider) is None + mw.process_request(req0) + assert mw.process_exception(req0, Exception("foo")) is None def test_ignore_response_cache_controls(self): sampledata = [ @@ -578,17 +582,17 @@ class TestDbmStorageWithRFC2616Policy( class TestDbmStorageWithCustomDbmModule(TestDbmStorageWithDummyPolicy): dbm_module = "tests.mocks.dummydbm" - def _get_settings(self, **new_settings): + def _get_settings(self, **new_settings) -> dict[str, Any]: new_settings.setdefault("HTTPCACHE_DBM_MODULE", self.dbm_module) return super()._get_settings(**new_settings) def test_custom_dbm_module_loaded(self): # make sure our dbm module has been loaded - with self._storage() as storage: + with self._storage() as (storage, _): assert storage.dbmodule.__name__ == self.dbm_module class TestFilesystemStorageGzipWithDummyPolicy(TestFilesystemStorageWithDummyPolicy): - def _get_settings(self, **new_settings): + def _get_settings(self, **new_settings) -> dict[str, Any]: new_settings.setdefault("HTTPCACHE_GZIP", True) return super()._get_settings(**new_settings) diff --git a/tests/test_downloadermiddleware_httpcompression.py b/tests/test_downloadermiddleware_httpcompression.py index 3c26b242f..30caa094f 100644 --- a/tests/test_downloadermiddleware_httpcompression.py +++ b/tests/test_downloadermiddleware_httpcompression.py @@ -50,12 +50,32 @@ FORMAT = { } +def _skip_if_no_br() -> None: + try: + try: + import brotli # noqa: PLC0415 + + brotli.Decompressor.can_accept_more_data + except (ImportError, AttributeError): + import brotlicffi # noqa: PLC0415 + + brotlicffi.Decompressor.can_accept_more_data + except (ImportError, AttributeError): + pytest.skip("no brotli support") + + +def _skip_if_no_zstd() -> None: + try: + import zstandard # noqa: F401,PLC0415 + except ImportError: + pytest.skip("no zstd support (zstandard)") + + class TestHttpCompression: def setup_method(self): self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider("scrapytest.org") self.mw = HttpCompressionMiddleware.from_crawler(self.crawler) - self.crawler.stats.open_spider(self.spider) + self.crawler.stats.open_spider() def _getresponse(self, coding): if coding not in FORMAT: @@ -80,8 +100,8 @@ class TestHttpCompression: return response def assertStatsEqual(self, key, value): - assert self.crawler.stats.get_value(key, spider=self.spider) == value, str( - self.crawler.stats.get_stats(self.spider) + assert self.crawler.stats.get_value(key) == value, str( + self.crawler.stats.get_stats() ) def test_setting_false_compression_enabled(self): @@ -107,7 +127,7 @@ class TestHttpCompression: def test_process_request(self): request = Request("http://scrapytest.org") assert "Accept-Encoding" not in request.headers - self.mw.process_request(request, self.spider) + self.mw.process_request(request) assert request.headers.get("Accept-Encoding") == b", ".join(ACCEPTED_ENCODINGS) def test_process_response_gzip(self): @@ -115,7 +135,7 @@ class TestHttpCompression: request = response.request assert response.headers["Content-Encoding"] == b"gzip" - newresponse = self.mw.process_response(request, response, self.spider) + newresponse = self.mw.process_response(request, response) assert newresponse is not response assert newresponse.body.startswith(b"= 1.2.0 to decode 'br'." ), ), ) @@ -176,10 +191,8 @@ class TestHttpCompression: assert newresponse.headers.getlist("Content-Encoding") == [b"br"] def test_process_response_zstd(self): - try: - import zstandard # noqa: F401 - except ImportError: - pytest.skip("no zstd support (zstandard)") + _skip_if_no_zstd() + raw_content = None for check_key in FORMAT: if not check_key.startswith("zstd-"): @@ -187,7 +200,7 @@ class TestHttpCompression: response = self._getresponse(check_key) request = response.request assert response.headers["Content-Encoding"] == b"zstd" - newresponse = self.mw.process_response(request, response, self.spider) + newresponse = self.mw.process_response(request, response) if raw_content is None: raw_content = newresponse.body else: @@ -198,7 +211,7 @@ class TestHttpCompression: def test_process_response_zstd_unsupported(self): try: - import zstandard # noqa: F401 + import zstandard # noqa: F401,PLC0415 pytest.skip("Requires not having zstandard support") except ImportError: @@ -211,7 +224,7 @@ class TestHttpCompression: propagate=False, level=WARNING, ) as log: - newresponse = self.mw.process_response(request, response, self.spider) + newresponse = self.mw.process_response(request, response) log.check( ( "scrapy.downloadermiddlewares.httpcompression", @@ -231,7 +244,7 @@ class TestHttpCompression: request = response.request assert response.headers["Content-Encoding"] == b"deflate" - newresponse = self.mw.process_response(request, response, self.spider) + newresponse = self.mw.process_response(request, response) assert newresponse is not response assert newresponse.body.startswith(b" req.priority - - def test_dont_redirect(self): - url = "http://www.example.com/301" - url2 = "http://www.example.com/redirected" - req = Request(url, meta={"dont_redirect": True}) - rsp = self.get_response(req, url2) - - r = self.mw.process_response(req, rsp, self.spider) - assert isinstance(r, Response) - assert r is rsp - - # Test that it redirects when dont_redirect is False - req = Request(url, meta={"dont_redirect": False}) - rsp = self.get_response(req, url2) - - r = self.mw.process_response(req, rsp, self.spider) - assert isinstance(r, Request) - - def test_post(self): - url = "http://www.example.com/302" - url2 = "http://www.example.com/redirected2" - req = Request( - url, - method="POST", - body="test", - headers={"Content-Type": "text/plain", "Content-length": "4"}, - ) - rsp = self.get_response(req, url2) - - req2 = self.mw.process_response(req, rsp, self.spider) - assert isinstance(req2, Request) - assert req2.url == url2 - assert req2.method == "GET" - assert "Content-Type" not in req2.headers, ( - "Content-Type header must not be present in redirected request" - ) - assert "Content-Length" not in req2.headers, ( - "Content-Length header must not be present in redirected request" - ) - assert not req2.body, f"Redirected body must be empty, not '{req2.body}'" - - def test_max_redirect_times(self): - self.mw.max_redirect_times = 1 - req = Request("http://scrapytest.org/302") - rsp = self.get_response(req, "/redirected") - - req = self.mw.process_response(req, rsp, self.spider) - assert isinstance(req, Request) - assert "redirect_times" in req.meta - assert req.meta["redirect_times"] == 1 - with pytest.raises(IgnoreRequest): - self.mw.process_response(req, rsp, self.spider) - - def test_ttl(self): - self.mw.max_redirect_times = 100 - req = Request("http://scrapytest.org/302", meta={"redirect_ttl": 1}) - rsp = self.get_response(req, "/a") - - req = self.mw.process_response(req, rsp, self.spider) - assert isinstance(req, Request) - with pytest.raises(IgnoreRequest): - self.mw.process_response(req, rsp, self.spider) - - def test_redirect_urls(self): - req1 = Request("http://scrapytest.org/first") - rsp1 = self.get_response(req1, "/redirected") - req2 = self.mw.process_response(req1, rsp1, self.spider) - rsp2 = self.get_response(req1, "/redirected2") - req3 = self.mw.process_response(req2, rsp2, self.spider) - - assert req2.url == "http://scrapytest.org/redirected" - assert req2.meta["redirect_urls"] == ["http://scrapytest.org/first"] - assert req3.url == "http://scrapytest.org/redirected2" - assert req3.meta["redirect_urls"] == [ - "http://scrapytest.org/first", - "http://scrapytest.org/redirected", - ] - - def test_redirect_reasons(self): - req1 = Request("http://scrapytest.org/first") - rsp1 = self.get_response(req1, "/redirected1") - req2 = self.mw.process_response(req1, rsp1, self.spider) - rsp2 = self.get_response(req2, "/redirected2") - req3 = self.mw.process_response(req2, rsp2, self.spider) - assert req2.meta["redirect_reasons"] == [self.reason] - assert req3.meta["redirect_reasons"] == [self.reason, self.reason] - - def test_cross_origin_header_dropping(self): - safe_headers = {"A": "B"} - cookie_header = {"Cookie": "a=b"} - authorization_header = {"Authorization": "Bearer 123456"} - - original_request = Request( - "https://example.com", - headers={**safe_headers, **cookie_header, **authorization_header}, - ) - - # Redirects to the same origin (same scheme, same domain, same port) - # keep all headers. - internal_response = self.get_response( - original_request, "https://example.com/a" - ) - internal_redirect_request = self.mw.process_response( - original_request, internal_response, self.spider - ) - assert isinstance(internal_redirect_request, Request) - assert original_request.headers == internal_redirect_request.headers - - # Redirects to the same origin (same scheme, same domain, same port) - # keep all headers also when the scheme is http. - http_request = Request( - "http://example.com", - headers={**safe_headers, **cookie_header, **authorization_header}, - ) - http_response = self.get_response(http_request, "http://example.com/a") - http_redirect_request = self.mw.process_response( - http_request, http_response, self.spider - ) - assert isinstance(http_redirect_request, Request) - assert http_request.headers == http_redirect_request.headers - - # For default ports, whether the port is explicit or implicit does not - # affect the outcome, it is still the same origin. - to_explicit_port_response = self.get_response( - original_request, "https://example.com:443/a" - ) - to_explicit_port_redirect_request = self.mw.process_response( - original_request, to_explicit_port_response, self.spider - ) - assert isinstance(to_explicit_port_redirect_request, Request) - assert original_request.headers == to_explicit_port_redirect_request.headers - - # For default ports, whether the port is explicit or implicit does not - # affect the outcome, it is still the same origin. - to_implicit_port_response = self.get_response( - original_request, "https://example.com/a" - ) - to_implicit_port_redirect_request = self.mw.process_response( - original_request, to_implicit_port_response, self.spider - ) - assert isinstance(to_implicit_port_redirect_request, Request) - assert original_request.headers == to_implicit_port_redirect_request.headers - - # A port change drops the Authorization header because the origin - # changes, but keeps the Cookie header because the domain remains the - # same. - different_port_response = self.get_response( - original_request, "https://example.com:8080/a" - ) - different_port_redirect_request = self.mw.process_response( - original_request, different_port_response, self.spider - ) - assert isinstance(different_port_redirect_request, Request) - assert { - **safe_headers, - **cookie_header, - } == different_port_redirect_request.headers.to_unicode_dict() - - # A domain change drops both the Authorization and the Cookie header. - external_response = self.get_response( - original_request, "https://example.org/a" - ) - external_redirect_request = self.mw.process_response( - original_request, external_response, self.spider - ) - assert isinstance(external_redirect_request, Request) - assert safe_headers == external_redirect_request.headers.to_unicode_dict() - - # A scheme upgrade (http → https) drops the Authorization header - # because the origin changes, but keeps the Cookie header because the - # domain remains the same. - upgrade_response = self.get_response(http_request, "https://example.com/a") - upgrade_redirect_request = self.mw.process_response( - http_request, upgrade_response, self.spider - ) - assert isinstance(upgrade_redirect_request, Request) - assert { - **safe_headers, - **cookie_header, - } == upgrade_redirect_request.headers.to_unicode_dict() - - # A scheme downgrade (https → http) drops the Authorization header - # because the origin changes, and the Cookie header because its value - # cannot indicate whether the cookies were secure (HTTPS-only) or not. - # - # Note: If the Cookie header is set by the cookie management - # middleware, as recommended in the docs, the dropping of Cookie on - # scheme downgrade is not an issue, because the cookie management - # middleware will add again the Cookie header to the new request if - # appropriate. - downgrade_response = self.get_response( - original_request, "http://example.com/a" - ) - downgrade_redirect_request = self.mw.process_response( - original_request, downgrade_response, self.spider - ) - assert isinstance(downgrade_redirect_request, Request) - assert safe_headers == downgrade_redirect_request.headers.to_unicode_dict() - - def test_meta_proxy_http_absolute(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - meta = {"proxy": "https://a:@a.example"} - request1 = Request("http://example.com", meta=meta) - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "http://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "http://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_meta_proxy_http_relative(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - meta = {"proxy": "https://a:@a.example"} - request1 = Request("http://example.com", meta=meta) - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "/a") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "/a") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_meta_proxy_https_absolute(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - meta = {"proxy": "https://a:@a.example"} - request1 = Request("https://example.com", meta=meta) - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "https://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "https://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_meta_proxy_https_relative(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - meta = {"proxy": "https://a:@a.example"} - request1 = Request("https://example.com", meta=meta) - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "/a") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "/a") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_meta_proxy_http_to_https(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - meta = {"proxy": "https://a:@a.example"} - request1 = Request("http://example.com", meta=meta) - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "https://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "http://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_meta_proxy_https_to_http(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - meta = {"proxy": "https://a:@a.example"} - request1 = Request("https://example.com", meta=meta) - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "http://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "https://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_system_proxy_http_absolute(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - env = { - "http_proxy": "https://a:@a.example", - } - with set_environ(**env): - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("http://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "http://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "http://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_system_proxy_http_relative(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - env = { - "http_proxy": "https://a:@a.example", - } - with set_environ(**env): - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("http://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "/a") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "/a") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_system_proxy_https_absolute(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - env = { - "https_proxy": "https://a:@a.example", - } - with set_environ(**env): - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("https://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "https://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "https://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_system_proxy_https_relative(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - env = { - "https_proxy": "https://a:@a.example", - } - with set_environ(**env): - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("https://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "/a") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "/a") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_system_proxy_proxied_http_to_proxied_https(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - env = { - "http_proxy": "https://a:@a.example", - "https_proxy": "https://b:@b.example", - } - with set_environ(**env): - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("http://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "https://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic Yjo=" - assert request2.meta["_auth_proxy"] == "https://b.example" - assert request2.meta["proxy"] == "https://b.example" - - response2 = self.get_response(request2, "http://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_system_proxy_proxied_http_to_unproxied_https(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - env = { - "http_proxy": "https://a:@a.example", - } - with set_environ(**env): - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("http://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request1.meta["_auth_proxy"] == "https://a.example" - assert request1.meta["proxy"] == "https://a.example" - - response1 = self.get_response(request1, "https://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - proxy_mw.process_request(request2, spider) - - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - response2 = self.get_response(request2, "http://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request3.meta["_auth_proxy"] == "https://a.example" - assert request3.meta["proxy"] == "https://a.example" - - def test_system_proxy_unproxied_http_to_proxied_https(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - env = { - "https_proxy": "https://b:@b.example", - } - with set_environ(**env): - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("http://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert "Proxy-Authorization" not in request1.headers - assert "_auth_proxy" not in request1.meta - assert "proxy" not in request1.meta - - response1 = self.get_response(request1, "https://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic Yjo=" - assert request2.meta["_auth_proxy"] == "https://b.example" - assert request2.meta["proxy"] == "https://b.example" - - response2 = self.get_response(request2, "http://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - proxy_mw.process_request(request3, spider) - - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - def test_system_proxy_unproxied_http_to_unproxied_https(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("http://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert "Proxy-Authorization" not in request1.headers - assert "_auth_proxy" not in request1.meta - assert "proxy" not in request1.meta - - response1 = self.get_response(request1, "https://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - proxy_mw.process_request(request2, spider) - - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - response2 = self.get_response(request2, "http://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - proxy_mw.process_request(request3, spider) - - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - def test_system_proxy_proxied_https_to_proxied_http(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - env = { - "http_proxy": "https://a:@a.example", - "https_proxy": "https://b:@b.example", - } - with set_environ(**env): - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("https://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic Yjo=" - assert request1.meta["_auth_proxy"] == "https://b.example" - assert request1.meta["proxy"] == "https://b.example" - - response1 = self.get_response(request1, "http://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "https://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic Yjo=" - assert request3.meta["_auth_proxy"] == "https://b.example" - assert request3.meta["proxy"] == "https://b.example" - - def test_system_proxy_proxied_https_to_unproxied_http(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - env = { - "https_proxy": "https://b:@b.example", - } - with set_environ(**env): - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("https://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert request1.headers["Proxy-Authorization"] == b"Basic Yjo=" - assert request1.meta["_auth_proxy"] == "https://b.example" - assert request1.meta["proxy"] == "https://b.example" - - response1 = self.get_response(request1, "http://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - proxy_mw.process_request(request2, spider) - - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - response2 = self.get_response(request2, "https://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - proxy_mw.process_request(request3, spider) - - assert request3.headers["Proxy-Authorization"] == b"Basic Yjo=" - assert request3.meta["_auth_proxy"] == "https://b.example" - assert request3.meta["proxy"] == "https://b.example" - - def test_system_proxy_unproxied_https_to_proxied_http(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - env = { - "http_proxy": "https://a:@a.example", - } - with set_environ(**env): - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("https://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert "Proxy-Authorization" not in request1.headers - assert "_auth_proxy" not in request1.meta - assert "proxy" not in request1.meta - - response1 = self.get_response(request1, "http://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - proxy_mw.process_request(request2, spider) - - assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" - assert request2.meta["_auth_proxy"] == "https://a.example" - assert request2.meta["proxy"] == "https://a.example" - - response2 = self.get_response(request2, "https://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - proxy_mw.process_request(request3, spider) - - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - def test_system_proxy_unproxied_https_to_unproxied_http(self): - crawler = get_crawler() - redirect_mw = self.mwcls.from_crawler(crawler) - proxy_mw = HttpProxyMiddleware.from_crawler(crawler) - - request1 = Request("https://example.com") - spider = None - proxy_mw.process_request(request1, spider) - - assert "Proxy-Authorization" not in request1.headers - assert "_auth_proxy" not in request1.meta - assert "proxy" not in request1.meta - - response1 = self.get_response(request1, "http://example.com") - request2 = redirect_mw.process_response(request1, response1, spider) - - assert isinstance(request2, Request) - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - proxy_mw.process_request(request2, spider) - - assert "Proxy-Authorization" not in request2.headers - assert "_auth_proxy" not in request2.meta - assert "proxy" not in request2.meta - - response2 = self.get_response(request2, "https://example.com") - request3 = redirect_mw.process_response(request2, response2, spider) - - assert isinstance(request3, Request) - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta - - proxy_mw.process_request(request3, spider) - - assert "Proxy-Authorization" not in request3.headers - assert "_auth_proxy" not in request3.meta - assert "proxy" not in request3.meta +from tests.test_downloadermiddleware_redirect_base import ( + REDIRECT_SCHEME_CASES, + SCHEME_PARAMS, + Base, +) class TestRedirectMiddleware(Base.Test): @@ -1012,33 +27,29 @@ class TestRedirectMiddleware(Base.Test): reason = 302 def setup_method(self): - self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider("foo") - self.mw = self.mwcls.from_crawler(self.crawler) + crawler = get_crawler(DefaultSpider) + crawler.spider = crawler._create_spider() + self.mw = self.mwcls.from_crawler(crawler) def get_response(self, request, location, status=302): headers = {"Location": location} return Response(request.url, status=status, headers=headers) def test_redirect_3xx_permanent(self): - def _test(method, status=301): + def _test(method, status: int): url = f"http://www.example.com/{status}" url2 = "http://www.example.com/redirected" req = Request(url, method=method) rsp = Response(url, headers={"Location": url2}, status=status) - req2 = self.mw.process_response(req, rsp, self.spider) + req2 = self.mw.process_response(req, rsp) assert isinstance(req2, Request) assert req2.url == url2 assert req2.method == method # response without Location header but with status code is 3XX should be ignored del rsp.headers["Location"] - assert self.mw.process_response(req, rsp, self.spider) is rsp - - _test("GET") - _test("POST") - _test("HEAD") + assert self.mw.process_response(req, rsp) is rsp _test("GET", status=307) _test("POST", status=307) @@ -1048,13 +59,219 @@ class TestRedirectMiddleware(Base.Test): _test("POST", status=308) _test("HEAD", status=308) + @pytest.mark.parametrize("status", [301, 302, 303]) + def test_method_becomes_get(self, status): + source_url = f"http://www.example.com/{status}" + target_url = "http://www.example.com/redirected2" + request = Request( + source_url, + method="POST", + body="test", + headers={"Content-Type": "text/plain", "Content-length": "4"}, + ) + response = Response(source_url, headers={"Location": target_url}, status=status) + redirect_request = self.mw.process_response(request, response) + assert isinstance(redirect_request, Request) + assert redirect_request.url == target_url + assert redirect_request.method == "GET" + assert "Content-Type" not in redirect_request.headers + assert "Content-Length" not in redirect_request.headers + assert not redirect_request.body + + @pytest.mark.parametrize("status", [301, 302]) + @pytest.mark.parametrize("method", ["PUT", "DELETE"]) + def test_method_not_converted_on_301_302(self, status, method): + url = f"http://www.example.com/{status}" + url2 = "http://www.example.com/redirected" + body = b"test-body" + req = Request( + url, + method=method, + body=body, + headers={"Content-Type": "text/plain", "Content-Length": str(len(body))}, + ) + rsp = Response(url, headers={"Location": url2}, status=status) + + req2 = self.mw.process_response(req, rsp) + assert isinstance(req2, Request) + assert req2.url == url2 + assert req2.method == method + assert req2.body == body + assert req2.headers[b"Content-Type"] == b"text/plain" + assert req2.headers[b"Content-Length"] == str(len(body)).encode() + + @pytest.mark.parametrize("method", ["PUT", "DELETE"]) + def test_method_converted_on_303(self, method): + status = 303 + url = f"http://www.example.com/{status}" + url2 = "http://www.example.com/redirected" + req = Request(url, method=method) + rsp = Response(url, headers={"Location": url2}, status=status) + + req2 = self.mw.process_response(req, rsp) + assert isinstance(req2, Request) + assert req2.url == url2 + assert req2.method == "GET" + + def test_get_method_body_preserved_on_303(self): + status = 303 + url = f"http://www.example.com/{status}" + url2 = "http://www.example.com/redirected" + body = b"test-body" + req = Request( + url, + method="GET", + body=body, + headers={"Content-Type": "text/plain", "Content-Length": str(len(body))}, + ) + rsp = Response(url, headers={"Location": url2}, status=status) + + req2 = self.mw.process_response(req, rsp) + assert isinstance(req2, Request) + assert req2.url == url2 + assert req2.method == "GET" + assert req2.body == body + assert req2.headers[b"Content-Type"] == b"text/plain" + assert req2.headers[b"Content-Length"] == str(len(body)).encode() + + def test_redirect_strips_content_headers(self): + url = "http://www.example.com/303" + url2 = "http://www.example.com/redirected" + headers = { + "Content-Type": "application/json", + "Content-Length": "100", + "Content-Encoding": "gzip", + "Content-Language": "en", + "Content-Location": "http://www.example.com/original", + "X-Custom": "foo", + } + req = Request(url, method="POST", headers=headers, body=b"foo") + rsp = Response(url, headers={"Location": url2}, status=303) + + req2 = self.mw.process_response(req, rsp) + assert isinstance(req2, Request) + assert req2.url == url2 + assert req2.method == "GET" + assert req2.body == b"" + assert "Content-Type" not in req2.headers + assert "Content-Length" not in req2.headers + assert "Content-Encoding" not in req2.headers + assert "Content-Language" not in req2.headers + assert "Content-Location" not in req2.headers + assert req2.headers["X-Custom"] == b"foo" + + @pytest.mark.parametrize( + ( + "referer", + "source_url", + "target_url", + "policy_header", + "expected_referer", + ), + [ + ( + None, + "http://www.example.com/302", + "http://www.example.com/redirected", + None, + b"http://www.example.com/302", + ), + ( + "http://example.com/old", + "http://www.example.com/302", + "http://www.example.com/redirected", + None, + b"http://www.example.com/302", + ), + ( + "https://example.com/old", + "https://www.example.com/302", + "http://www.example.com/redirected", + None, + None, + ), + ( + "http://example.com/old", + "http://www.example.com/foo/bar", + "http://www.example.com/redirected", + "origin", + b"http://www.example.com/", + ), + ], + ) + def test_redirect_referer( + self, referer, source_url, target_url, policy_header, expected_referer + ): + headers = {"Referer": referer} if referer else {} + source_request = Request(source_url, headers=headers) + resp_headers = {"Location": target_url} + if policy_header: + resp_headers["Referrer-Policy"] = policy_header + response = Response(source_url, headers=resp_headers, status=302) + crawler = get_crawler() + referer_mw = build_from_crawler(RefererMiddleware, crawler) + redirect_mw = self.mwcls.from_crawler(crawler) + redirect_mw._referer_spider_middleware = referer_mw + redirect_request = redirect_mw.process_response(source_request, response) + if expected_referer: + assert redirect_request.headers.get("Referer") == expected_referer + else: + assert "Referer" not in redirect_request.headers + + def test_redirect_strips_referer_no_middleware(self): + source_url = "http://www.example.com/302" + redirect_url = "http://www.example.com/redirected" + source_request = Request( + source_url, headers={"Referer": "http://example.com/old"} + ) + response = Response(source_url, headers={"Location": redirect_url}, status=302) + redirect_mw = self.mwcls.from_crawler(get_crawler()) + redirect_mw._referer_spider_middleware = None + redirect_request = redirect_mw.process_response(source_request, response) + assert "Referer" not in redirect_request.headers + + @pytest.mark.parametrize("status", [307, 308]) + def test_cross_origin_maintain_body(self, status): + source_url = "https://example.com" + target_url = "https://attacker.example" + body = b"secret" + request = Request( + source_url, + method="POST", + body=body, + headers={ + "Content-Type": "application/json", + "Content-Length": str(len(body)), + }, + ) + response1 = Response( + source_url, headers={"Location": target_url}, status=status + ) + redirect_request = self.mw.process_response(request, response1) + assert isinstance(redirect_request, Request) + assert redirect_request.url == target_url + assert redirect_request.method == "POST" + assert redirect_request.body == body + assert redirect_request.headers[b"Content-Type"] == b"application/json" + assert redirect_request.headers[b"Content-Length"] == str(len(body)).encode() + + def test_redirect_keeps_fragment(self): + url = "http://www.example.com/301#frag" + url2 = "http://www.example.com/redirected" + req = Request(url) + rsp = Response(url, headers={"Location": url2}, status=302) + + req2 = self.mw.process_response(req, rsp) + assert isinstance(req2, Request) + assert req2.url == "http://www.example.com/redirected#frag" + def test_redirect_302_head(self): url = "http://www.example.com/302" url2 = "http://www.example.com/redirected2" req = Request(url, method="HEAD") rsp = Response(url, headers={"Location": url2}, status=302) - req2 = self.mw.process_response(req, rsp, self.spider) + req2 = self.mw.process_response(req, rsp) assert isinstance(req2, Request) assert req2.url == url2 assert req2.method == "HEAD" @@ -1066,19 +283,18 @@ class TestRedirectMiddleware(Base.Test): req = Request(url, method="HEAD") rsp = Response(url, headers={"Location": url2}, status=302) - req2 = self.mw.process_response(req, rsp, self.spider) + req2 = self.mw.process_response(req, rsp) assert isinstance(req2, Request) assert req2.url == url3 assert req2.method == "HEAD" def test_spider_handling(self): - smartspider = self.crawler._create_spider("smarty") - smartspider.handle_httpstatus_list = [404, 301, 302] + self.mw.crawler.spider.handle_httpstatus_list = [404, 301, 302] url = "http://www.example.com/301" url2 = "http://www.example.com/redirected" req = Request(url) rsp = Response(url, headers={"Location": url2}, status=301) - r = self.mw.process_response(req, rsp, smartspider) + r = self.mw.process_response(req, rsp) assert r is rsp def test_request_meta_handling(self): @@ -1087,7 +303,7 @@ class TestRedirectMiddleware(Base.Test): def _test_passthrough(req): rsp = Response(url, headers={"Location": url2}, status=301, request=req) - r = self.mw.process_response(req, rsp, self.spider) + r = self.mw.process_response(req, rsp) assert r is rsp _test_passthrough( @@ -1103,7 +319,7 @@ class TestRedirectMiddleware(Base.Test): headers={"Location": latin1_location}, status=302, ) - req_result = self.mw.process_response(req, resp, self.spider) + req_result = self.mw.process_response(req, resp) perc_encoded_utf8_url = "http://scrapytest.org/a%E7%E3o" assert perc_encoded_utf8_url == req_result.url @@ -1115,62 +331,23 @@ class TestRedirectMiddleware(Base.Test): headers={"Location": utf8_location}, status=302, ) - req_result = self.mw.process_response(req, resp, self.spider) + req_result = self.mw.process_response(req, resp) perc_encoded_utf8_url = "http://scrapytest.org/a%C3%A7%C3%A3o" assert perc_encoded_utf8_url == req_result.url def test_no_location(self): request = Request("https://example.com") response = Response(request.url, status=302) - assert self.mw.process_response(request, response, self.spider) is response - - -SCHEME_PARAMS = ("url", "location", "target") -HTTP_SCHEMES = ("http", "https") -NON_HTTP_SCHEMES = ("data", "file", "ftp", "s3", "foo") -REDIRECT_SCHEME_CASES = ( - # http/https → http/https redirects - *( - ( - f"{input_scheme}://example.com/a", - f"{output_scheme}://example.com/b", - f"{output_scheme}://example.com/b", - ) - for input_scheme, output_scheme in product(HTTP_SCHEMES, repeat=2) - ), - # http/https → data/file/ftp/s3/foo does not redirect - *( - ( - f"{input_scheme}://example.com/a", - f"{output_scheme}://example.com/b", - None, - ) - for input_scheme in HTTP_SCHEMES - for output_scheme in NON_HTTP_SCHEMES - ), - # http/https → relative redirects - *( - ( - f"{scheme}://example.com/a", - location, - f"{scheme}://example.com/b", - ) - for scheme in HTTP_SCHEMES - for location in ("//example.com/b", "/b") - ), - # Note: We do not test data/file/ftp/s3 schemes for the initial URL - # because their download handlers cannot return a status code of 3xx. -) + assert self.mw.process_response(request, response) is response @pytest.mark.parametrize(SCHEME_PARAMS, REDIRECT_SCHEME_CASES) def test_redirect_schemes(url, location, target): crawler = get_crawler(Spider) - spider = crawler._create_spider("foo") mw = RedirectMiddleware.from_crawler(crawler) request = Request(url) response = Response(url, headers={"Location": location}, status=301) - redirect = mw.process_response(request, response, spider) + redirect = mw.process_response(request, response) if target is None: assert redirect == response else: @@ -1178,123 +355,106 @@ def test_redirect_schemes(url, location, target): assert redirect.url == target -def meta_refresh_body(url, interval=5): - html = f"""""" - return html.encode("utf-8") - - -class TestMetaRefreshMiddleware(Base.Test): - mwcls = MetaRefreshMiddleware - reason = "meta refresh" - - def setup_method(self): - crawler = get_crawler(Spider) - self.spider = crawler._create_spider("foo") - self.mw = self.mwcls.from_crawler(crawler) - - def _body(self, interval=5, url="http://example.org/newpage"): - return meta_refresh_body(url, interval) - - def get_response(self, request, location): - return HtmlResponse(request.url, body=self._body(url=location)) - - def test_meta_refresh(self): - req = Request(url="http://example.org") - rsp = HtmlResponse(req.url, body=self._body()) - req2 = self.mw.process_response(req, rsp, self.spider) - assert isinstance(req2, Request) - assert req2.url == "http://example.org/newpage" - - def test_meta_refresh_with_high_interval(self): - # meta-refresh with high intervals don't trigger redirects - req = Request(url="http://example.org") - rsp = HtmlResponse( - url="http://example.org", body=self._body(interval=1000), encoding="utf-8" - ) - rsp2 = self.mw.process_response(req, rsp, self.spider) - assert rsp is rsp2 - - def test_meta_refresh_trough_posted_request(self): - req = Request( - url="http://example.org", - method="POST", - body="test", - headers={"Content-Type": "text/plain", "Content-length": "4"}, - ) - rsp = HtmlResponse(req.url, body=self._body()) - req2 = self.mw.process_response(req, rsp, self.spider) - - assert isinstance(req2, Request) - assert req2.url == "http://example.org/newpage" - assert req2.method == "GET" - assert "Content-Type" not in req2.headers, ( - "Content-Type header must not be present in redirected request" - ) - assert "Content-Length" not in req2.headers, ( - "Content-Length header must not be present in redirected request" - ) - assert not req2.body, f"Redirected body must be empty, not '{req2.body}'" - - def test_ignore_tags_default(self): - req = Request(url="http://example.org") - body = ( - """""" - ) - rsp = HtmlResponse(req.url, body=body.encode()) - response = self.mw.process_response(req, rsp, self.spider) - assert isinstance(response, Response) - - def test_ignore_tags_1_x_list(self): - """Test that Scrapy 1.x behavior remains possible""" - settings = {"METAREFRESH_IGNORE_TAGS": ["script", "noscript"]} - crawler = get_crawler(Spider, settings) - mw = MetaRefreshMiddleware.from_crawler(crawler) - req = Request(url="http://example.org") - body = ( - """""" - ) - rsp = HtmlResponse(req.url, body=body.encode()) - response = mw.process_response(req, rsp, self.spider) - assert isinstance(response, Response) - - @pytest.mark.parametrize( - SCHEME_PARAMS, + ("policy", "source_url", "target_url", "expected_referrer"), [ - *REDIRECT_SCHEME_CASES, - # data/file/ftp/s3/foo → * does not redirect - *( - ( - f"{input_scheme}://example.com/a", - f"{output_scheme}://example.com/b", - None, - ) - for input_scheme in NON_HTTP_SCHEMES - for output_scheme in chain(HTTP_SCHEMES, NON_HTTP_SCHEMES) + # The policy header affects the outcome. + # (without it, the https → http switch would drop the referer) + ( + POLICY_UNSAFE_URL, + "https://a.example/1", + "http://a.example/2", + b"https://a.example/1", ), - # data/file/ftp/s3/foo → relative does not redirect - *( - ( - f"{scheme}://example.com/a", - location, - None, - ) - for scheme in NON_HTTP_SCHEMES - for location in ("//example.com/b", "/b") + # The policy header can get the Referer header removed. + ( + POLICY_NO_REFERRER, + "http://a.example/1", + "http://a.example/2", + None, + ), + # The policy header can get the Referer header edited (path stripped). + ( + POLICY_ORIGIN, + "http://a.example/1", + "http://a.example/2", + b"http://a.example/", ), ], ) -def test_meta_refresh_schemes(url, location, target): - crawler = get_crawler(Spider) - spider = crawler._create_spider("foo") - mw = MetaRefreshMiddleware.from_crawler(crawler) - request = Request(url) - response = HtmlResponse(url, body=meta_refresh_body(location)) - redirect = mw.process_response(request, response, spider) - if target is None: - assert redirect == response - else: - assert isinstance(redirect, Request) - assert redirect.url == target +def test_response_referrer_policy(policy, source_url, target_url, expected_referrer): + crawler = get_crawler() + referrer_mw = build_from_crawler(RefererMiddleware, crawler) + redirect_mw = build_from_crawler(RedirectMiddleware, crawler) + redirect_mw._referer_spider_middleware = referrer_mw + source_request = Request(source_url) + extra_headers = {} + if policy: + extra_headers["Referrer-Policy"] = policy + response_redirect = Response( + source_request.url, + status=301, + headers={"Location": target_url, **extra_headers}, + ) + source_request = redirect_mw.process_response(source_request, response_redirect) + assert isinstance(source_request, Request) + + assert source_request.headers.get("Referer") == expected_referrer + + +def test_no_warning_when_referer_middleware_present(caplog): + crawler = get_crawler() + crawler.get_spider_middleware = MagicMock(return_value=MagicMock()) + mw = build_from_crawler(RedirectMiddleware, crawler) + caplog.clear() + with caplog.at_level(logging.WARNING): + mw._engine_started() + assert not [ + record + for record in caplog.records + if record.name == "scrapy.downloadermiddlewares.redirect" + ] + + +def test_warning_redirect_middleware(caplog): + crawler = get_crawler() + crawler.get_spider_middleware = MagicMock(return_value=None) + mw = build_from_crawler(RedirectMiddleware, crawler) + with caplog.at_level(logging.WARNING): + mw._engine_started() + assert ( + "scrapy.downloadermiddlewares.redirect.RedirectMiddleware found no " + "scrapy.spidermiddlewares.referer.RefererMiddleware" + ) in caplog.text + assert ( + "enable scrapy.spidermiddlewares.referer.RefererMiddleware (or a subclass)" + in caplog.text + ) + assert ( + "replace scrapy.downloadermiddlewares.redirect.RedirectMiddleware " + "with a subclass that overrides the handle_referer() method" + ) in caplog.text + + +def test_warning_subclass(caplog): + class MyRedirectMiddleware(RedirectMiddleware): + pass + + crawler = get_crawler() + crawler.get_spider_middleware = MagicMock(return_value=None) + mw = build_from_crawler(MyRedirectMiddleware, crawler) + with caplog.at_level(logging.WARNING): + mw._engine_started() + assert ( + "test_warning_subclass..MyRedirectMiddleware found no " + "scrapy.spidermiddlewares.referer.RefererMiddleware" + ) in caplog.text + assert ( + "enable scrapy.spidermiddlewares.referer.RefererMiddleware (or a subclass)" + in caplog.text + ) + assert "edit " in caplog.text + assert "test_warning_subclass..MyRedirectMiddleware" in caplog.text + assert ( + "(if defined in your code base) to override the handle_referer() method" + ) in caplog.text diff --git a/tests/test_downloadermiddleware_redirect_base.py b/tests/test_downloadermiddleware_redirect_base.py new file mode 100644 index 000000000..32935769f --- /dev/null +++ b/tests/test_downloadermiddleware_redirect_base.py @@ -0,0 +1,1023 @@ +from __future__ import annotations + +from itertools import product + +import pytest + +from scrapy.downloadermiddlewares.httpproxy import HttpProxyMiddleware +from scrapy.exceptions import IgnoreRequest +from scrapy.http import Request, Response +from scrapy.utils.misc import set_environ +from scrapy.utils.test import get_crawler + +SCHEME_PARAMS = ("url", "location", "target") +HTTP_SCHEMES = ("http", "https") +NON_HTTP_SCHEMES = ("data", "file", "ftp", "s3", "foo") +REDIRECT_SCHEME_CASES = ( + # http/https → http/https redirects + *( + ( + f"{input_scheme}://example.com/a", + f"{output_scheme}://example.com/b", + f"{output_scheme}://example.com/b", + ) + for input_scheme, output_scheme in product(HTTP_SCHEMES, repeat=2) + ), + # http/https → data/file/ftp/s3/foo does not redirect + *( + ( + f"{input_scheme}://example.com/a", + f"{output_scheme}://example.com/b", + None, + ) + for input_scheme in HTTP_SCHEMES + for output_scheme in NON_HTTP_SCHEMES + ), + # http/https → relative redirects + *( + ( + f"{scheme}://example.com/a", + location, + f"{scheme}://example.com/b", + ) + for scheme in HTTP_SCHEMES + for location in ("//example.com/b", "/b") + ), + # Note: We do not test data/file/ftp/s3 schemes for the initial URL + # because their download handlers cannot return a status code of 3xx. +) + + +class Base: + class Test: + def test_priority_adjust(self): + req = Request("http://a.example") + rsp = self.get_response(req, "http://a.example/redirected") + req2 = self.mw.process_response(req, rsp) + assert req2.priority > req.priority + + def test_dont_redirect(self): + url = "http://www.example.com/301" + url2 = "http://www.example.com/redirected" + req = Request(url, meta={"dont_redirect": True}) + rsp = self.get_response(req, url2) + + r = self.mw.process_response(req, rsp) + assert isinstance(r, Response) + assert r is rsp + + # Test that it redirects when dont_redirect is False + req = Request(url, meta={"dont_redirect": False}) + rsp = self.get_response(req, url2) + + r = self.mw.process_response(req, rsp) + assert isinstance(r, Request) + + def test_post(self): + url = "http://www.example.com/302" + url2 = "http://www.example.com/redirected2" + req = Request( + url, + method="POST", + body="test", + headers={"Content-Type": "text/plain", "Content-length": "4"}, + ) + rsp = self.get_response(req, url2) + + req2 = self.mw.process_response(req, rsp) + assert isinstance(req2, Request) + assert req2.url == url2 + assert req2.method == "GET" + assert "Content-Type" not in req2.headers, ( + "Content-Type header must not be present in redirected request" + ) + assert "Content-Length" not in req2.headers, ( + "Content-Length header must not be present in redirected request" + ) + assert not req2.body, f"Redirected body must be empty, not '{req2.body}'" + + def test_max_redirect_times(self): + self.mw.max_redirect_times = 1 + req = Request("http://a.example/302") + rsp = self.get_response(req, "/redirected") + + req = self.mw.process_response(req, rsp) + assert isinstance(req, Request) + assert "redirect_times" in req.meta + assert req.meta["redirect_times"] == 1 + with pytest.raises(IgnoreRequest): + self.mw.process_response(req, rsp) + + def test_ttl(self): + self.mw.max_redirect_times = 100 + req = Request("http://a.example/302", meta={"redirect_ttl": 1}) + rsp = self.get_response(req, "/a") + + req = self.mw.process_response(req, rsp) + assert isinstance(req, Request) + with pytest.raises(IgnoreRequest): + self.mw.process_response(req, rsp) + + def test_redirect_urls(self): + req1 = Request("http://a.example/first") + rsp1 = self.get_response(req1, "/redirected") + req2 = self.mw.process_response(req1, rsp1) + rsp2 = self.get_response(req2, "/redirected2") + req3 = self.mw.process_response(req2, rsp2) + + assert req2.url == "http://a.example/redirected" + assert req2.meta["redirect_urls"] == ["http://a.example/first"] + assert req3.url == "http://a.example/redirected2" + assert req3.meta["redirect_urls"] == [ + "http://a.example/first", + "http://a.example/redirected", + ] + + def test_redirect_reasons(self): + req1 = Request("http://a.example/first") + rsp1 = self.get_response(req1, "/redirected1") + req2 = self.mw.process_response(req1, rsp1) + rsp2 = self.get_response(req2, "/redirected2") + req3 = self.mw.process_response(req2, rsp2) + assert req2.meta["redirect_reasons"] == [self.reason] + assert req3.meta["redirect_reasons"] == [self.reason, self.reason] + + def test_cross_origin_header_dropping(self): + safe_headers = {"A": "B"} + cookie_header = {"Cookie": "a=b"} + authorization_header = {"Authorization": "Bearer 123456"} + + original_request = Request( + "https://example.com", + headers={**safe_headers, **cookie_header, **authorization_header}, + ) + + # Redirects to the same origin (same scheme, same domain, same port) + # keep all headers. + internal_response = self.get_response( + original_request, "https://example.com/a" + ) + internal_redirect_request = self.mw.process_response( + original_request, internal_response + ) + assert isinstance(internal_redirect_request, Request) + assert original_request.headers == internal_redirect_request.headers + + # Redirects to the same origin (same scheme, same domain, same port) + # keep all headers also when the scheme is http. + http_request = Request( + "http://example.com", + headers={**safe_headers, **cookie_header, **authorization_header}, + ) + http_response = self.get_response(http_request, "http://example.com/a") + http_redirect_request = self.mw.process_response( + http_request, http_response + ) + assert isinstance(http_redirect_request, Request) + assert http_request.headers == http_redirect_request.headers + + # For default ports, whether the port is explicit or implicit does not + # affect the outcome, it is still the same origin. + to_explicit_port_response = self.get_response( + original_request, "https://example.com:443/a" + ) + to_explicit_port_redirect_request = self.mw.process_response( + original_request, to_explicit_port_response + ) + assert isinstance(to_explicit_port_redirect_request, Request) + assert original_request.headers == to_explicit_port_redirect_request.headers + + # For default ports, whether the port is explicit or implicit does not + # affect the outcome, it is still the same origin. + to_implicit_port_response = self.get_response( + original_request, "https://example.com/a" + ) + to_implicit_port_redirect_request = self.mw.process_response( + original_request, to_implicit_port_response + ) + assert isinstance(to_implicit_port_redirect_request, Request) + assert original_request.headers == to_implicit_port_redirect_request.headers + + # A port change drops the Authorization header because the origin + # changes, but keeps the Cookie header because the domain remains the + # same. + different_port_response = self.get_response( + original_request, "https://example.com:8080/a" + ) + different_port_redirect_request = self.mw.process_response( + original_request, different_port_response + ) + assert isinstance(different_port_redirect_request, Request) + assert { + **safe_headers, + **cookie_header, + } == different_port_redirect_request.headers.to_unicode_dict() + + # A domain change drops both the Authorization and the Cookie header. + external_response = self.get_response( + original_request, "https://example.org/a" + ) + external_redirect_request = self.mw.process_response( + original_request, external_response + ) + assert isinstance(external_redirect_request, Request) + assert safe_headers == external_redirect_request.headers.to_unicode_dict() + + # A scheme upgrade (http → https) drops the Authorization header + # because the origin changes, but keeps the Cookie header because the + # domain remains the same. + upgrade_response = self.get_response(http_request, "https://example.com/a") + upgrade_redirect_request = self.mw.process_response( + http_request, upgrade_response + ) + assert isinstance(upgrade_redirect_request, Request) + assert { + **safe_headers, + **cookie_header, + } == upgrade_redirect_request.headers.to_unicode_dict() + + # A scheme downgrade (https → http) drops the Authorization header + # because the origin changes, and the Cookie header because its value + # cannot indicate whether the cookies were secure (HTTPS-only) or not. + # + # Note: If the Cookie header is set by the cookie management + # middleware, as recommended in the docs, the dropping of Cookie on + # scheme downgrade is not an issue, because the cookie management + # middleware will add again the Cookie header to the new request if + # appropriate. + downgrade_response = self.get_response( + original_request, "http://example.com/a" + ) + downgrade_redirect_request = self.mw.process_response( + original_request, downgrade_response + ) + assert isinstance(downgrade_redirect_request, Request) + assert safe_headers == downgrade_redirect_request.headers.to_unicode_dict() + + def test_meta_proxy_http_absolute(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + meta = {"proxy": "https://a:@a.example"} + request1 = Request("http://example.com", meta=meta) + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "http://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "http://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_meta_proxy_http_relative(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + meta = {"proxy": "https://a:@a.example"} + request1 = Request("http://example.com", meta=meta) + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "/a") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "/a") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_meta_proxy_https_absolute(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + meta = {"proxy": "https://a:@a.example"} + request1 = Request("https://example.com", meta=meta) + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "https://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "https://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_meta_proxy_https_relative(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + meta = {"proxy": "https://a:@a.example"} + request1 = Request("https://example.com", meta=meta) + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "/a") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "/a") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_meta_proxy_http_to_https(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + meta = {"proxy": "https://a:@a.example"} + request1 = Request("http://example.com", meta=meta) + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "https://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "http://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_meta_proxy_https_to_http(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + meta = {"proxy": "https://a:@a.example"} + request1 = Request("https://example.com", meta=meta) + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "http://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "https://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_system_proxy_http_absolute(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + env = { + "http_proxy": "https://a:@a.example", + } + with set_environ(**env): + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("http://example.com") + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "http://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "http://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_system_proxy_http_relative(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + env = { + "http_proxy": "https://a:@a.example", + } + with set_environ(**env): + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("http://example.com") + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "/a") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "/a") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_system_proxy_https_absolute(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + env = { + "https_proxy": "https://a:@a.example", + } + with set_environ(**env): + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("https://example.com") + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "https://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "https://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_system_proxy_https_relative(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + env = { + "https_proxy": "https://a:@a.example", + } + with set_environ(**env): + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("https://example.com") + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "/a") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "/a") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_system_proxy_proxied_http_to_proxied_https(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + env = { + "http_proxy": "https://a:@a.example", + "https_proxy": "https://b:@b.example", + } + with set_environ(**env): + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("http://example.com") + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "https://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic Yjo=" + assert request2.meta["_auth_proxy"] == "https://b.example" + assert request2.meta["proxy"] == "https://b.example" + + response2 = self.get_response(request2, "http://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_system_proxy_proxied_http_to_unproxied_https(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + env = { + "http_proxy": "https://a:@a.example", + } + with set_environ(**env): + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("http://example.com") + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request1.meta["_auth_proxy"] == "https://a.example" + assert request1.meta["proxy"] == "https://a.example" + + response1 = self.get_response(request1, "https://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + proxy_mw.process_request(request2) + + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + response2 = self.get_response(request2, "http://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request3.meta["_auth_proxy"] == "https://a.example" + assert request3.meta["proxy"] == "https://a.example" + + def test_system_proxy_unproxied_http_to_proxied_https(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + env = { + "https_proxy": "https://b:@b.example", + } + with set_environ(**env): + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("http://example.com") + proxy_mw.process_request(request1) + + assert "Proxy-Authorization" not in request1.headers + assert "_auth_proxy" not in request1.meta + assert "proxy" not in request1.meta + + response1 = self.get_response(request1, "https://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic Yjo=" + assert request2.meta["_auth_proxy"] == "https://b.example" + assert request2.meta["proxy"] == "https://b.example" + + response2 = self.get_response(request2, "http://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + proxy_mw.process_request(request3) + + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + def test_system_proxy_unproxied_http_to_unproxied_https(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("http://example.com") + proxy_mw.process_request(request1) + + assert "Proxy-Authorization" not in request1.headers + assert "_auth_proxy" not in request1.meta + assert "proxy" not in request1.meta + + response1 = self.get_response(request1, "https://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + proxy_mw.process_request(request2) + + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + response2 = self.get_response(request2, "http://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + proxy_mw.process_request(request3) + + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + def test_system_proxy_proxied_https_to_proxied_http(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + env = { + "http_proxy": "https://a:@a.example", + "https_proxy": "https://b:@b.example", + } + with set_environ(**env): + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("https://example.com") + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic Yjo=" + assert request1.meta["_auth_proxy"] == "https://b.example" + assert request1.meta["proxy"] == "https://b.example" + + response1 = self.get_response(request1, "http://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "https://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic Yjo=" + assert request3.meta["_auth_proxy"] == "https://b.example" + assert request3.meta["proxy"] == "https://b.example" + + def test_system_proxy_proxied_https_to_unproxied_http(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + env = { + "https_proxy": "https://b:@b.example", + } + with set_environ(**env): + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("https://example.com") + proxy_mw.process_request(request1) + + assert request1.headers["Proxy-Authorization"] == b"Basic Yjo=" + assert request1.meta["_auth_proxy"] == "https://b.example" + assert request1.meta["proxy"] == "https://b.example" + + response1 = self.get_response(request1, "http://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + proxy_mw.process_request(request2) + + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + response2 = self.get_response(request2, "https://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + proxy_mw.process_request(request3) + + assert request3.headers["Proxy-Authorization"] == b"Basic Yjo=" + assert request3.meta["_auth_proxy"] == "https://b.example" + assert request3.meta["proxy"] == "https://b.example" + + def test_system_proxy_unproxied_https_to_proxied_http(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + env = { + "http_proxy": "https://a:@a.example", + } + with set_environ(**env): + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("https://example.com") + proxy_mw.process_request(request1) + + assert "Proxy-Authorization" not in request1.headers + assert "_auth_proxy" not in request1.meta + assert "proxy" not in request1.meta + + response1 = self.get_response(request1, "http://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + proxy_mw.process_request(request2) + + assert request2.headers["Proxy-Authorization"] == b"Basic YTo=" + assert request2.meta["_auth_proxy"] == "https://a.example" + assert request2.meta["proxy"] == "https://a.example" + + response2 = self.get_response(request2, "https://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + proxy_mw.process_request(request3) + + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + def test_system_proxy_unproxied_https_to_unproxied_http(self): + crawler = get_crawler() + redirect_mw = self.mwcls.from_crawler(crawler) + proxy_mw = HttpProxyMiddleware.from_crawler(crawler) + + request1 = Request("https://example.com") + proxy_mw.process_request(request1) + + assert "Proxy-Authorization" not in request1.headers + assert "_auth_proxy" not in request1.meta + assert "proxy" not in request1.meta + + response1 = self.get_response(request1, "http://example.com") + request2 = redirect_mw.process_response(request1, response1) + + assert isinstance(request2, Request) + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + proxy_mw.process_request(request2) + + assert "Proxy-Authorization" not in request2.headers + assert "_auth_proxy" not in request2.meta + assert "proxy" not in request2.meta + + response2 = self.get_response(request2, "https://example.com") + request3 = redirect_mw.process_response(request2, response2) + + assert isinstance(request3, Request) + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta + + proxy_mw.process_request(request3) + + assert "Proxy-Authorization" not in request3.headers + assert "_auth_proxy" not in request3.meta + assert "proxy" not in request3.meta diff --git a/tests/test_downloadermiddleware_redirect_metarefresh.py b/tests/test_downloadermiddleware_redirect_metarefresh.py new file mode 100644 index 000000000..416fbc2aa --- /dev/null +++ b/tests/test_downloadermiddleware_redirect_metarefresh.py @@ -0,0 +1,159 @@ +from __future__ import annotations + +import logging +from itertools import chain +from unittest.mock import MagicMock + +import pytest + +from scrapy.downloadermiddlewares.redirect import MetaRefreshMiddleware +from scrapy.http import HtmlResponse, Request, Response +from scrapy.spiders import Spider +from scrapy.utils.misc import build_from_crawler +from scrapy.utils.test import get_crawler +from tests.test_downloadermiddleware_redirect_base import ( + HTTP_SCHEMES, + NON_HTTP_SCHEMES, + REDIRECT_SCHEME_CASES, + SCHEME_PARAMS, + Base, +) + + +def meta_refresh_body(url, interval=5): + html = f"""""" + return html.encode("utf-8") + + +class TestMetaRefreshMiddleware(Base.Test): + mwcls = MetaRefreshMiddleware + reason = "meta refresh" + + def setup_method(self): + crawler = get_crawler(Spider) + self.mw = self.mwcls.from_crawler(crawler) + + def _body(self, interval=5, url="http://example.org/newpage"): + return meta_refresh_body(url, interval) + + def get_response(self, request, location): + return HtmlResponse(request.url, body=self._body(url=location)) + + def test_meta_refresh(self): + req = Request(url="http://example.org") + rsp = HtmlResponse(req.url, body=self._body()) + req2 = self.mw.process_response(req, rsp) + assert isinstance(req2, Request) + assert req2.url == "http://example.org/newpage" + + def test_meta_refresh_with_high_interval(self): + # meta-refresh with high intervals don't trigger redirects + req = Request(url="http://example.org") + rsp = HtmlResponse( + url="http://example.org", body=self._body(interval=1000), encoding="utf-8" + ) + rsp2 = self.mw.process_response(req, rsp) + assert rsp is rsp2 + + def test_meta_refresh_trough_posted_request(self): + req = Request( + url="http://example.org", + method="POST", + body="test", + headers={"Content-Type": "text/plain", "Content-length": "4"}, + ) + rsp = HtmlResponse(req.url, body=self._body()) + req2 = self.mw.process_response(req, rsp) + + assert isinstance(req2, Request) + assert req2.url == "http://example.org/newpage" + assert req2.method == "GET" + assert "Content-Type" not in req2.headers, ( + "Content-Type header must not be present in redirected request" + ) + assert "Content-Length" not in req2.headers, ( + "Content-Length header must not be present in redirected request" + ) + assert not req2.body, f"Redirected body must be empty, not '{req2.body}'" + + def test_ignore_tags_default(self): + req = Request(url="http://example.org") + body = ( + """""" + ) + rsp = HtmlResponse(req.url, body=body.encode()) + response = self.mw.process_response(req, rsp) + assert isinstance(response, Response) + + def test_ignore_tags_1_x_list(self): + """Test that Scrapy 1.x behavior remains possible""" + settings = {"METAREFRESH_IGNORE_TAGS": ["script", "noscript"]} + crawler = get_crawler(Spider, settings) + mw = MetaRefreshMiddleware.from_crawler(crawler) + req = Request(url="http://example.org") + body = ( + """""" + ) + rsp = HtmlResponse(req.url, body=body.encode()) + response = mw.process_response(req, rsp) + assert isinstance(response, Response) + + +@pytest.mark.parametrize( + SCHEME_PARAMS, + [ + *REDIRECT_SCHEME_CASES, + # data/file/ftp/s3/foo → * does not redirect + *( + ( + f"{input_scheme}://example.com/a", + f"{output_scheme}://example.com/b", + None, + ) + for input_scheme in NON_HTTP_SCHEMES + for output_scheme in chain(HTTP_SCHEMES, NON_HTTP_SCHEMES) + ), + # data/file/ftp/s3/foo → relative does not redirect + *( + ( + f"{scheme}://example.com/a", + location, + None, + ) + for scheme in NON_HTTP_SCHEMES + for location in ("//example.com/b", "/b") + ), + ], +) +def test_meta_refresh_schemes(url, location, target): + crawler = get_crawler(Spider) + mw = MetaRefreshMiddleware.from_crawler(crawler) + request = Request(url) + response = HtmlResponse(url, body=meta_refresh_body(location)) + redirect = mw.process_response(request, response) + if target is None: + assert redirect == response + else: + assert isinstance(redirect, Request) + + +def test_warning_meta_refresh_middleware(caplog): + crawler = get_crawler() + crawler.get_spider_middleware = MagicMock(return_value=None) + mw = build_from_crawler(MetaRefreshMiddleware, crawler) + with caplog.at_level(logging.WARNING): + mw._engine_started() + assert ( + "scrapy.downloadermiddlewares.redirect.MetaRefreshMiddleware found no " + "scrapy.spidermiddlewares.referer.RefererMiddleware" + ) in caplog.text + assert ( + "enable scrapy.spidermiddlewares.referer.RefererMiddleware (or a subclass)" + in caplog.text + ) + assert ( + "replace scrapy.downloadermiddlewares.redirect.MetaRefreshMiddleware " + "with a subclass that overrides the handle_referer() method" + ) in caplog.text diff --git a/tests/test_downloadermiddleware_retry.py b/tests/test_downloadermiddleware_retry.py index ffdcdf49e..56d21a4d2 100644 --- a/tests/test_downloadermiddleware_retry.py +++ b/tests/test_downloadermiddleware_retry.py @@ -2,35 +2,33 @@ import logging import pytest from testfixtures import LogCapture -from twisted.internet import defer -from twisted.internet.error import ( - ConnectError, - ConnectionDone, - ConnectionLost, - DNSLookupError, - TCPTimedOutError, -) -from twisted.web.client import ResponseFailed +from twisted.internet.error import ConnectError, ConnectionDone, ConnectionLost from scrapy.downloadermiddlewares.retry import RetryMiddleware, get_retry_request -from scrapy.exceptions import IgnoreRequest +from scrapy.exceptions import ( + CannotResolveHostError, + DownloadConnectionRefusedError, + DownloadTimeoutError, + IgnoreRequest, +) from scrapy.http import Request, Response from scrapy.settings.default_settings import RETRY_EXCEPTIONS from scrapy.spiders import Spider +from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler class TestRetry: def setup_method(self): - self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider("foo") + self.crawler = get_crawler(DefaultSpider) + self.crawler.spider = self.crawler._create_spider() self.mw = RetryMiddleware.from_crawler(self.crawler) self.mw.max_retry_times = 2 def test_priority_adjust(self): req = Request("http://www.scrapytest.org/503") rsp = Response("http://www.scrapytest.org/503", body=b"", status=503) - req2 = self.mw.process_response(req, rsp, self.spider) + req2 = self.mw.process_response(req, rsp) assert req2.priority < req.priority def test_404(self): @@ -38,14 +36,14 @@ class TestRetry: rsp = Response("http://www.scrapytest.org/404", body=b"", status=404) # dont retry 404s - assert self.mw.process_response(req, rsp, self.spider) is rsp + assert self.mw.process_response(req, rsp) is rsp def test_dont_retry(self): req = Request("http://www.scrapytest.org/503", meta={"dont_retry": True}) rsp = Response("http://www.scrapytest.org/503", body=b"", status=503) # first retry - r = self.mw.process_response(req, rsp, self.spider) + r = self.mw.process_response(req, rsp) assert r is rsp # Test retry when dont_retry set to False @@ -53,13 +51,13 @@ class TestRetry: rsp = Response("http://www.scrapytest.org/503") # first retry - r = self.mw.process_response(req, rsp, self.spider) + r = self.mw.process_response(req, rsp) assert r is rsp def test_dont_retry_exc(self): req = Request("http://www.scrapytest.org/503", meta={"dont_retry": True}) - r = self.mw.process_exception(req, DNSLookupError(), self.spider) + r = self.mw.process_exception(req, CannotResolveHostError()) assert r is None def test_503(self): @@ -67,17 +65,17 @@ class TestRetry: rsp = Response("http://www.scrapytest.org/503", body=b"", status=503) # first retry - req = self.mw.process_response(req, rsp, self.spider) + req = self.mw.process_response(req, rsp) assert isinstance(req, Request) assert req.meta["retry_times"] == 1 # second retry - req = self.mw.process_response(req, rsp, self.spider) + req = self.mw.process_response(req, rsp) assert isinstance(req, Request) assert req.meta["retry_times"] == 2 # discard it - assert self.mw.process_response(req, rsp, self.spider) is rsp + assert self.mw.process_response(req, rsp) is rsp assert self.crawler.stats.get_value("retry/max_reached") == 1 assert ( @@ -86,17 +84,47 @@ class TestRetry: ) assert self.crawler.stats.get_value("retry/count") == 2 + def test_give_up_log_level_setting(self): + crawler = get_crawler( + DefaultSpider, settings_dict={"RETRY_GIVE_UP_LOG_LEVEL": "WARNING"} + ) + crawler.spider = crawler._create_spider() + mw = RetryMiddleware.from_crawler(crawler) + mw.max_retry_times = 0 + req = Request("http://example.com/503") + rsp = Response("http://example.com/503", body=b"", status=503) + with LogCapture() as log: + assert mw.process_response(req, rsp) is rsp + log.check_present( + ( + "scrapy.downloadermiddlewares.retry", + "WARNING", + f"Gave up retrying {req} (failed 1 times): 503 Service Unavailable", + ) + ) + + def test_give_up_log_level_meta(self): + self.mw.max_retry_times = 0 + req = Request("http://example.com/503", meta={"give_up_log_level": "WARNING"}) + rsp = Response("http://example.com/503", body=b"", status=503) + with LogCapture() as log: + assert self.mw.process_response(req, rsp) is rsp + log.check_present( + ( + "scrapy.downloadermiddlewares.retry", + "WARNING", + f"Gave up retrying {req} (failed 1 times): 503 Service Unavailable", + ) + ) + def test_twistederrors(self): exceptions = [ ConnectError, ConnectionDone, ConnectionLost, - ConnectionRefusedError, - defer.TimeoutError, - DNSLookupError, - ResponseFailed, - TCPTimedOutError, - TimeoutError, + DownloadTimeoutError, + DownloadConnectionRefusedError, + CannotResolveHostError, ] for exc in exceptions: @@ -107,7 +135,7 @@ class TestRetry: assert stats.get_value("retry/max_reached") == len(exceptions) assert stats.get_value("retry/count") == len(exceptions) * 2 assert ( - stats.get_value("retry/reason_count/twisted.internet.defer.TimeoutError") + stats.get_value("retry/reason_count/scrapy.exceptions.DownloadTimeoutError") == 2 ) @@ -116,7 +144,8 @@ class TestRetry: settings_dict = { "RETRY_EXCEPTIONS": [*RETRY_EXCEPTIONS, exc], } - crawler = get_crawler(Spider, settings_dict=settings_dict) + crawler = get_crawler(DefaultSpider, settings_dict=settings_dict) + crawler.spider = crawler._create_spider() mw = RetryMiddleware.from_crawler(crawler) req = Request(f"http://www.scrapytest.org/{exc.__name__}") self._test_retry_exception(req, exc("foo"), mw) @@ -126,65 +155,61 @@ class TestRetry: mw = self.mw # first retry - req = mw.process_exception(req, exception, self.spider) + req = mw.process_exception(req, exception) assert isinstance(req, Request) assert req.meta["retry_times"] == 1 # second retry - req = mw.process_exception(req, exception, self.spider) + req = mw.process_exception(req, exception) assert isinstance(req, Request) assert req.meta["retry_times"] == 2 # discard it - req = mw.process_exception(req, exception, self.spider) + req = mw.process_exception(req, exception) assert req is None class TestMaxRetryTimes: invalid_url = "http://www.scrapytest.org/invalid_url" - def get_spider_and_middleware(self, settings=None): - crawler = get_crawler(Spider, settings or {}) - spider = crawler._create_spider("foo") - middleware = RetryMiddleware.from_crawler(crawler) - return spider, middleware + def get_middleware(self, settings=None): + crawler = get_crawler(DefaultSpider, settings or {}) + crawler.spider = crawler._create_spider() + return RetryMiddleware.from_crawler(crawler) def test_with_settings_zero(self): max_retry_times = 0 settings = {"RETRY_TIMES": max_retry_times} - spider, middleware = self.get_spider_and_middleware(settings) + middleware = self.get_middleware(settings) req = Request(self.invalid_url) self._test_retry( req, - DNSLookupError("foo"), + CannotResolveHostError("foo"), max_retry_times, - spider=spider, middleware=middleware, ) def test_with_metakey_zero(self): max_retry_times = 0 - spider, middleware = self.get_spider_and_middleware() + middleware = self.get_middleware() meta = {"max_retry_times": max_retry_times} req = Request(self.invalid_url, meta=meta) self._test_retry( req, - DNSLookupError("foo"), + CannotResolveHostError("foo"), max_retry_times, - spider=spider, middleware=middleware, ) def test_without_metakey(self): max_retry_times = 5 settings = {"RETRY_TIMES": max_retry_times} - spider, middleware = self.get_spider_and_middleware(settings) + middleware = self.get_middleware(settings) req = Request(self.invalid_url) self._test_retry( req, - DNSLookupError("foo"), + CannotResolveHostError("foo"), max_retry_times, - spider=spider, middleware=middleware, ) @@ -196,20 +221,18 @@ class TestMaxRetryTimes: req2 = Request(self.invalid_url) settings = {"RETRY_TIMES": middleware_max_retry_times} - spider, middleware = self.get_spider_and_middleware(settings) + middleware = self.get_middleware(settings) self._test_retry( req1, - DNSLookupError("foo"), + CannotResolveHostError("foo"), meta_max_retry_times, - spider=spider, middleware=middleware, ) self._test_retry( req2, - DNSLookupError("foo"), + CannotResolveHostError("foo"), middleware_max_retry_times, - spider=spider, middleware=middleware, ) @@ -221,26 +244,24 @@ class TestMaxRetryTimes: req2 = Request(self.invalid_url) settings = {"RETRY_TIMES": middleware_max_retry_times} - spider, middleware = self.get_spider_and_middleware(settings) + middleware = self.get_middleware(settings) self._test_retry( req1, - DNSLookupError("foo"), + CannotResolveHostError("foo"), meta_max_retry_times, - spider=spider, middleware=middleware, ) self._test_retry( req2, - DNSLookupError("foo"), + CannotResolveHostError("foo"), middleware_max_retry_times, - spider=spider, middleware=middleware, ) def test_with_dont_retry(self): max_retry_times = 4 - spider, middleware = self.get_spider_and_middleware() + middleware = self.get_middleware() meta = { "max_retry_times": max_retry_times, "dont_retry": True, @@ -248,9 +269,8 @@ class TestMaxRetryTimes: req = Request(self.invalid_url, meta=meta) self._test_retry( req, - DNSLookupError("foo"), + CannotResolveHostError("foo"), 0, - spider=spider, middleware=middleware, ) @@ -259,18 +279,16 @@ class TestMaxRetryTimes: req, exception, max_retry_times, - spider=None, middleware=None, ): - spider = spider or self.spider middleware = middleware or self.mw - for i in range(max_retry_times): - req = middleware.process_exception(req, exception, spider) + for _ in range(max_retry_times): + req = middleware.process_exception(req, exception) assert isinstance(req, Request) # discard it - req = middleware.process_exception(req, exception, spider) + req = middleware.process_exception(req, exception) assert req is None @@ -627,6 +645,87 @@ class TestGetRetryRequest: ) ) + def test_give_up_log_level_default(self): + request = Request("https://example.com") + spider = self.get_spider() + with LogCapture() as log: + get_retry_request( + request, + spider=spider, + max_retry_times=0, + ) + log.check_present( + ( + "scrapy.downloadermiddlewares.retry", + "ERROR", + f"Gave up retrying {request} (failed 1 times): unspecified", + ) + ) + + def test_give_up_log_level_argument_name(self): + request = Request("https://example.com") + spider = self.get_spider() + with LogCapture() as log: + get_retry_request( + request, + spider=spider, + max_retry_times=0, + give_up_log_level="WARNING", + ) + log.check_present( + ( + "scrapy.downloadermiddlewares.retry", + "WARNING", + f"Gave up retrying {request} (failed 1 times): unspecified", + ) + ) + + def test_give_up_log_level_argument_number(self): + request = Request("https://example.com") + spider = self.get_spider() + with LogCapture() as log: + get_retry_request( + request, + spider=spider, + max_retry_times=0, + give_up_log_level=logging.WARNING, + ) + log.check_present( + ( + "scrapy.downloadermiddlewares.retry", + "WARNING", + f"Gave up retrying {request} (failed 1 times): unspecified", + ) + ) + + def test_give_up_log_level_setting(self): + request = Request("https://example.com") + spider = self.get_spider({"RETRY_GIVE_UP_LOG_LEVEL": "WARNING"}) + with LogCapture() as log: + get_retry_request( + request, + spider=spider, + max_retry_times=0, + ) + log.check_present( + ( + "scrapy.downloadermiddlewares.retry", + "WARNING", + f"Gave up retrying {request} (failed 1 times): unspecified", + ) + ) + + def test_give_up_log_level_invalid(self): + request = Request("https://example.com") + spider = self.get_spider() + with pytest.raises(ValueError, match="Invalid give-up log level"): + get_retry_request( + request, + spider=spider, + max_retry_times=0, + give_up_log_level="NOT_A_LEVEL", + ) + def test_custom_stats_key(self): request = Request("https://example.com") spider = self.get_spider() diff --git a/tests/test_downloadermiddleware_robotstxt.py b/tests/test_downloadermiddleware_robotstxt.py index dd5d47cab..082fc743e 100644 --- a/tests/test_downloadermiddleware_robotstxt.py +++ b/tests/test_downloadermiddleware_robotstxt.py @@ -1,34 +1,34 @@ from __future__ import annotations +import asyncio from typing import TYPE_CHECKING from unittest import mock import pytest -from twisted.internet import error -from twisted.internet.defer import Deferred, maybeDeferred +from twisted.internet.defer import Deferred, DeferredList from twisted.python import failure -from twisted.trial import unittest from scrapy.downloadermiddlewares.robotstxt import RobotsTxtMiddleware -from scrapy.downloadermiddlewares.robotstxt import logger as mw_module_logger -from scrapy.exceptions import IgnoreRequest, NotConfigured +from scrapy.exceptions import CannotResolveHostError, IgnoreRequest, NotConfigured from scrapy.http import Request, Response, TextResponse from scrapy.http.request import NO_CALLBACK from scrapy.settings import Settings -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future +from scrapy.utils.asyncio import call_later +from scrapy.utils.defer import deferred_from_coro, maybe_deferred_to_future from tests.test_robotstxt_interface import rerp_available +from tests.utils.decorators import coroutine_test if TYPE_CHECKING: from scrapy.crawler import Crawler -class TestRobotsTxtMiddleware(unittest.TestCase): - def setUp(self): - self.crawler = mock.MagicMock() +class TestRobotsTxtMiddleware: + def setup_method(self) -> None: + self.crawler: mock.MagicMock = mock.MagicMock() self.crawler.settings = Settings() - self.crawler.engine.download = mock.MagicMock() + self.crawler.engine.download_async = mock.AsyncMock() - def tearDown(self): + def teardown_method(self): del self.crawler def test_robotstxt_settings(self): @@ -52,17 +52,15 @@ Disallow: /some/randome/page.html """.encode() response = TextResponse("http://site.local/robots.txt", body=ROBOTS) - def return_response(request): - from twisted.internet import reactor - + async def return_response(request): deferred = Deferred() - reactor.callFromThread(deferred.callback, response) - return deferred + call_later(0, deferred.callback, response) + return await maybe_deferred_to_future(deferred) - crawler.engine.download.side_effect = return_response + crawler.engine.download_async.side_effect = return_response return crawler - @deferred_f_from_coro_f + @coroutine_test async def test_robotstxt(self): middleware = RobotsTxtMiddleware(self._get_successful_crawler()) await self.assertNotIgnored(Request("http://site.local/allowed"), middleware) @@ -76,13 +74,32 @@ Disallow: /some/randome/page.html Request("http://site.local/wiki/Käyttäjä:"), middleware ) - @deferred_f_from_coro_f + @coroutine_test + async def test_robotstxt_multiple_reqs(self) -> None: + middleware = RobotsTxtMiddleware(self._get_successful_crawler()) + d1 = deferred_from_coro( + middleware.process_request(Request("http://site.local/allowed1")) + ) + d2 = deferred_from_coro( + middleware.process_request(Request("http://site.local/allowed2")) + ) + await maybe_deferred_to_future(DeferredList([d1, d2], fireOnOneErrback=True)) + + @pytest.mark.only_asyncio + @coroutine_test + async def test_robotstxt_multiple_reqs_asyncio(self) -> None: + middleware = RobotsTxtMiddleware(self._get_successful_crawler()) + c1 = middleware.process_request(Request("http://site.local/allowed1")) + c2 = middleware.process_request(Request("http://site.local/allowed2")) + await asyncio.gather(c1, c2) + + @coroutine_test async def test_robotstxt_ready_parser(self): middleware = RobotsTxtMiddleware(self._get_successful_crawler()) await self.assertNotIgnored(Request("http://site.local/allowed"), middleware) await self.assertNotIgnored(Request("http://site.local/allowed"), middleware) - @deferred_f_from_coro_f + @coroutine_test async def test_robotstxt_meta(self): middleware = RobotsTxtMiddleware(self._get_successful_crawler()) meta = {"dont_obey_robotstxt": True} @@ -103,17 +120,15 @@ Disallow: /some/randome/page.html "http://site.local/robots.txt", body=b"GIF89a\xd3\x00\xfe\x00\xa2" ) - def return_response(request): - from twisted.internet import reactor - + async def return_response(request): deferred = Deferred() - reactor.callFromThread(deferred.callback, response) - return deferred + call_later(0, deferred.callback, response) + return await maybe_deferred_to_future(deferred) - crawler.engine.download.side_effect = return_response + crawler.engine.download_async.side_effect = return_response return crawler - @deferred_f_from_coro_f + @coroutine_test async def test_robotstxt_garbage(self): # garbage response should be discarded, equal 'allow all' middleware = RobotsTxtMiddleware(self._get_garbage_crawler()) @@ -127,17 +142,15 @@ Disallow: /some/randome/page.html crawler.settings.set("ROBOTSTXT_OBEY", True) response = Response("http://site.local/robots.txt") - def return_response(request): - from twisted.internet import reactor - + async def return_response(request): deferred = Deferred() - reactor.callFromThread(deferred.callback, response) - return deferred + call_later(0, deferred.callback, response) + return await maybe_deferred_to_future(deferred) - crawler.engine.download.side_effect = return_response + crawler.engine.download_async.side_effect = return_response return crawler - @deferred_f_from_coro_f + @coroutine_test async def test_robotstxt_empty_response(self): # empty response should equal 'allow all' middleware = RobotsTxtMiddleware(self._get_emptybody_crawler()) @@ -145,60 +158,54 @@ Disallow: /some/randome/page.html await self.assertNotIgnored(Request("http://site.local/admin/main"), middleware) await self.assertNotIgnored(Request("http://site.local/static/"), middleware) - @deferred_f_from_coro_f - async def test_robotstxt_error(self): + @coroutine_test + async def test_robotstxt_error(self, caplog: pytest.LogCaptureFixture) -> None: self.crawler.settings.set("ROBOTSTXT_OBEY", True) - err = error.DNSLookupError("Robotstxt address not found") - - def return_failure(request): - from twisted.internet import reactor + err = CannotResolveHostError("Robotstxt address not found") + async def return_failure(request): deferred = Deferred() - reactor.callFromThread(deferred.errback, failure.Failure(err)) - return deferred + call_later(0, deferred.errback, failure.Failure(err)) + return await maybe_deferred_to_future(deferred) - self.crawler.engine.download.side_effect = return_failure + self.crawler.engine.download_async.side_effect = return_failure middleware = RobotsTxtMiddleware(self.crawler) - middleware._logerror = mock.MagicMock(side_effect=middleware._logerror) - await maybe_deferred_to_future( - middleware.process_request(Request("http://site.local"), None) - ) - assert middleware._logerror.called + await middleware.process_request(Request("http://site.local")) + assert "Robotstxt address not found" in caplog.text - @deferred_f_from_coro_f + @coroutine_test async def test_robotstxt_immediate_error(self): self.crawler.settings.set("ROBOTSTXT_OBEY", True) - err = error.DNSLookupError("Robotstxt address not found") + err = CannotResolveHostError("Robotstxt address not found") - def immediate_failure(request): - deferred = Deferred() - deferred.errback(failure.Failure(err)) - return deferred + async def immediate_failure(request): + raise err - self.crawler.engine.download.side_effect = immediate_failure + self.crawler.engine.download_async.side_effect = immediate_failure middleware = RobotsTxtMiddleware(self.crawler) await self.assertNotIgnored(Request("http://site.local"), middleware) - @deferred_f_from_coro_f + @coroutine_test async def test_ignore_robotstxt_request(self): self.crawler.settings.set("ROBOTSTXT_OBEY", True) - def ignore_request(request): - from twisted.internet import reactor - + async def ignore_request(request): deferred = Deferred() - reactor.callFromThread(deferred.errback, failure.Failure(IgnoreRequest())) - return deferred + call_later(0, deferred.errback, failure.Failure(IgnoreRequest())) + return await maybe_deferred_to_future(deferred) - self.crawler.engine.download.side_effect = ignore_request + self.crawler.engine.download_async.side_effect = ignore_request middleware = RobotsTxtMiddleware(self.crawler) - mw_module_logger.error = mock.MagicMock() - - await self.assertNotIgnored(Request("http://site.local/allowed"), middleware) - assert not mw_module_logger.error.called # type: ignore[attr-defined] + with mock.patch( + "scrapy.downloadermiddlewares.robotstxt.logger" + ) as mw_module_logger: + await self.assertNotIgnored( + Request("http://site.local/allowed"), middleware + ) + assert not mw_module_logger.error.called def test_robotstxt_user_agent_setting(self): crawler = self._get_successful_crawler() @@ -206,42 +213,41 @@ Disallow: /some/randome/page.html crawler.settings.set("USER_AGENT", "Mozilla/5.0 (X11; Linux x86_64)") middleware = RobotsTxtMiddleware(crawler) rp = mock.MagicMock(return_value=True) - middleware.process_request_2(rp, Request("http://site.local/allowed"), None) + middleware.process_request_2(rp, Request("http://site.local/allowed")) rp.allowed.assert_called_once_with("http://site.local/allowed", "Examplebot") - def test_robotstxt_local_file(self): + @coroutine_test + async def test_robotstxt_local_file(self): middleware = RobotsTxtMiddleware(self._get_emptybody_crawler()) - assert not middleware.process_request( - Request("data:text/plain,Hello World data"), None - ) - assert not middleware.process_request( - Request("file:///tests/sample_data/test_site/nothinghere.html"), None - ) - assert isinstance( - middleware.process_request(Request("http://site.local/allowed"), None), - Deferred, + middleware.process_request_2 = mock.MagicMock() + + await middleware.process_request(Request("data:text/plain,Hello World data")) + assert not middleware.process_request_2.called + + await middleware.process_request( + Request("file:///tests/sample_data/test_site/nothinghere.html") ) + assert not middleware.process_request_2.called + + await middleware.process_request(Request("http://site.local/allowed")) + assert middleware.process_request_2.called async def assertNotIgnored( self, request: Request, middleware: RobotsTxtMiddleware ) -> None: - spider = None # not actually used - result = await maybe_deferred_to_future( - maybeDeferred(middleware.process_request, request, spider) # type: ignore[call-overload] - ) - assert result is None + try: + await middleware.process_request(request) + except IgnoreRequest: + pytest.fail("IgnoreRequest was raised unexpectedly") async def assertIgnored( self, request: Request, middleware: RobotsTxtMiddleware ) -> None: - spider = None # not actually used with pytest.raises(IgnoreRequest): - await maybe_deferred_to_future( - maybeDeferred(middleware.process_request, request, spider) # type: ignore[call-overload] - ) + await middleware.process_request(request) def assertRobotsTxtRequested(self, base_url: str) -> None: - calls = self.crawler.engine.download.call_args_list + calls = self.crawler.engine.download_async.call_args_list request = calls[0][0][0] assert request.url == f"{base_url}/robots.txt" assert request.callback == NO_CALLBACK @@ -249,8 +255,8 @@ Disallow: /some/randome/page.html @pytest.mark.skipif(not rerp_available(), reason="Rerp parser is not installed") class TestRobotsTxtMiddlewareWithRerp(TestRobotsTxtMiddleware): - def setUp(self): - super().setUp() + def setup_method(self): + super().setup_method() self.crawler.settings.set( "ROBOTSTXT_PARSER", "scrapy.robotstxt.RerpRobotParser" ) diff --git a/tests/test_downloadermiddleware_stats.py b/tests/test_downloadermiddleware_stats.py index 748ef7d76..cf7b614c4 100644 --- a/tests/test_downloadermiddleware_stats.py +++ b/tests/test_downloadermiddleware_stats.py @@ -11,29 +11,28 @@ class MyException(Exception): class TestDownloaderStats: def setup_method(self): self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider("scrapytest.org") self.mw = DownloaderStats(self.crawler.stats) - self.crawler.stats.open_spider(self.spider) + self.crawler.stats.open_spider() self.req = Request("http://scrapytest.org") - self.res = Response("scrapytest.org", status=400) + self.res = Response("http://scrapytest.org", status=400) def assertStatsEqual(self, key, value): - assert self.crawler.stats.get_value(key, spider=self.spider) == value, str( - self.crawler.stats.get_stats(self.spider) + assert self.crawler.stats.get_value(key) == value, str( + self.crawler.stats.get_stats() ) def test_process_request(self): - self.mw.process_request(self.req, self.spider) + self.mw.process_request(self.req) self.assertStatsEqual("downloader/request_count", 1) def test_process_response(self): - self.mw.process_response(self.req, self.res, self.spider) + self.mw.process_response(self.req, self.res) self.assertStatsEqual("downloader/response_count", 1) def test_process_exception(self): - self.mw.process_exception(self.req, MyException(), self.spider) + self.mw.process_exception(self.req, MyException()) self.assertStatsEqual("downloader/exception_count", 1) self.assertStatsEqual( "downloader/exception_type_count/tests.test_downloadermiddleware_stats.MyException", @@ -41,4 +40,4 @@ class TestDownloaderStats: ) def teardown_method(self): - self.crawler.stats.close_spider(self.spider, "") + self.crawler.stats.close_spider() diff --git a/tests/test_downloadermiddleware_useragent.py b/tests/test_downloadermiddleware_useragent.py index 1497f8c67..539183cd6 100644 --- a/tests/test_downloadermiddleware_useragent.py +++ b/tests/test_downloadermiddleware_useragent.py @@ -11,42 +11,23 @@ class TestUserAgentMiddleware: return spider, UserAgentMiddleware.from_crawler(crawler) def test_default_agent(self): - spider, mw = self.get_spider_and_mw("default_useragent") + _, mw = self.get_spider_and_mw("default_useragent") req = Request("http://scrapytest.org/") - assert mw.process_request(req, spider) is None + assert mw.process_request(req) is None assert req.headers["User-Agent"] == b"default_useragent" - def test_remove_agent(self): - # settings USER_AGENT to None should remove the user agent - spider, mw = self.get_spider_and_mw("default_useragent") - spider.user_agent = None - mw.spider_opened(spider) - req = Request("http://scrapytest.org/") - assert mw.process_request(req, spider) is None - assert req.headers.get("User-Agent") is None - - def test_spider_agent(self): - spider, mw = self.get_spider_and_mw("default_useragent") - spider.user_agent = "spider_useragent" - mw.spider_opened(spider) - req = Request("http://scrapytest.org/") - assert mw.process_request(req, spider) is None - assert req.headers["User-Agent"] == b"spider_useragent" - def test_header_agent(self): spider, mw = self.get_spider_and_mw("default_useragent") - spider.user_agent = "spider_useragent" mw.spider_opened(spider) req = Request( "http://scrapytest.org/", headers={"User-Agent": "header_useragent"} ) - assert mw.process_request(req, spider) is None + assert mw.process_request(req) is None assert req.headers["User-Agent"] == b"header_useragent" def test_no_agent(self): spider, mw = self.get_spider_and_mw(None) - spider.user_agent = None mw.spider_opened(spider) req = Request("http://scrapytest.org/") - assert mw.process_request(req, spider) is None + assert mw.process_request(req) is None assert "User-Agent" not in req.headers diff --git a/tests/test_downloaderslotssettings.py b/tests/test_downloaderslotssettings.py index ddac95edf..9d58a6e09 100644 --- a/tests/test_downloaderslotssettings.py +++ b/tests/test_downloaderslotssettings.py @@ -1,14 +1,16 @@ import time +from typing import Any -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase +import pytest from scrapy import Request from scrapy.core.downloader import Downloader, Slot -from scrapy.crawler import CrawlerRunner +from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer from tests.spiders import MetaSpider +from tests.utils.decorators import coroutine_test, inline_callbacks_test class DownloaderSlotsSettingsTestSpider(MetaSpider): @@ -28,41 +30,41 @@ class DownloaderSlotsSettingsTestSpider(MetaSpider): }, } + def __init__(self, *args: Any, **kwargs: Any): + super().__init__(*args, **kwargs) + assert self.mockserver + self.default_slot = self.mockserver.host + self.times: dict[str, list[float]] = {} + async def start(self): - self.times = {None: []} - slots = [*self.custom_settings.get("DOWNLOAD_SLOTS", {}), None] - for slot in slots: url = self.mockserver.url(f"/?downloader_slot={slot}") - self.times[slot] = [] + self.times[slot or self.default_slot] = [] yield Request(url, callback=self.parse, meta={"download_slot": slot}) def parse(self, response): - slot = response.meta.get("download_slot", None) + slot = response.meta.get("download_slot", self.default_slot) self.times[slot].append(time.time()) url = self.mockserver.url(f"/?downloader_slot={slot}&req=2") yield Request(url, callback=self.not_parse, meta={"download_slot": slot}) def not_parse(self, response): - slot = response.meta.get("download_slot", None) + slot = response.meta.get("download_slot", self.default_slot) self.times[slot].append(time.time()) -class TestCrawl(TestCase): +class TestCrawl: @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) - def setUp(self): - self.runner = CrawlerRunner() - - @inlineCallbacks + @inline_callbacks_test def test_delay(self): crawler = get_crawler(DownloaderSlotsSettingsTestSpider) yield crawler.crawl(mockserver=self.mockserver) @@ -79,7 +81,8 @@ class TestCrawl(TestCase): assert max(list(error_delta.values())) < tolerance -def test_params(): +@coroutine_test +async def test_params(): params = { "concurrency": 1, "delay": 2, @@ -90,13 +93,63 @@ def test_params(): "example.com": params, }, } - crawler = get_crawler(settings_dict=settings) + crawler = get_crawler(DefaultSpider, settings_dict=settings) + crawler.spider = crawler._create_spider() downloader = Downloader(crawler) - downloader._slot_gc_loop.stop() # Prevent an unclean reactor. request = Request("https://example.com") - _, actual = downloader._get_slot(request, spider=None) + _, actual = downloader._get_slot(request) + downloader.close() expected = Slot(**params) for param in params: assert getattr(expected, param) == getattr(actual, param), ( f"Slot.{param}: {getattr(expected, param)!r} != {getattr(actual, param)!r}" ) + + +@coroutine_test +async def test_get_slot_deprecated_spider_arg(): + crawler = get_crawler(DefaultSpider) + crawler.spider = crawler._create_spider() + downloader = Downloader(crawler) + request = Request("https://example.com") + + with pytest.warns( + ScrapyDeprecationWarning, + match=r"Passing a 'spider' argument to Downloader\._get_slot\(\) is deprecated", + ): + key1, slot1 = downloader._get_slot(request, spider=crawler.spider) + key2, slot2 = downloader._get_slot(request) + downloader.close() + + assert key1 == key2 + assert slot1 == slot2 + + +@pytest.mark.parametrize( + "priority_queue_class", + [ + "scrapy.pqueues.ScrapyPriorityQueue", + "scrapy.pqueues.DownloaderAwarePriorityQueue", + ], +) +@coroutine_test +async def test_none_slot_with_priority_queue( + mockserver: MockServer, priority_queue_class: str +) -> None: + """Test specific cases for None slot handling with different priority queues.""" + crawler = get_crawler( + DownloaderSlotsSettingsTestSpider, + settings_dict={"SCHEDULER_PRIORITY_QUEUE": priority_queue_class}, + ) + await crawler.crawl_async(mockserver=mockserver) + assert isinstance(crawler.spider, DownloaderSlotsSettingsTestSpider) + + assert hasattr(crawler.spider, "times") + assert None not in crawler.spider.times + assert crawler.spider.default_slot in crawler.spider.times + assert len(crawler.spider.times[crawler.spider.default_slot]) == 2 + + assert crawler.stats + stats = crawler.stats + assert stats.get_value("spider_exceptions", 0) == 0 + assert stats.get_value("downloader/exception_count", 0) == 0 diff --git a/tests/test_dupefilters.py b/tests/test_dupefilters.py index d5e1b37f7..5d79691b2 100644 --- a/tests/test_dupefilters.py +++ b/tests/test_dupefilters.py @@ -3,8 +3,8 @@ import shutil import sys import tempfile from pathlib import Path -from warnings import catch_warnings +import pytest from testfixtures import LogCapture from scrapy.core.scheduler import Scheduler @@ -16,12 +16,12 @@ from scrapy.utils.test import get_crawler from tests.spiders import SimpleSpider -def _get_dupefilter(*, crawler=None, settings=None, open=True): +def _get_dupefilter(*, crawler=None, settings=None, open_=True): if crawler is None: crawler = get_crawler(settings_dict=settings) scheduler = Scheduler.from_crawler(crawler) dupefilter = scheduler.df - if open: + if open_: dupefilter.open() return dupefilter @@ -77,7 +77,7 @@ class TestRFPDupeFilter: path = tempfile.mkdtemp() try: - df = _get_dupefilter(settings={"JOBDIR": path}, open=False) + df = _get_dupefilter(settings={"JOBDIR": path}, open_=False) try: df.open() assert not df.request_seen(r1) @@ -85,8 +85,8 @@ class TestRFPDupeFilter: finally: df.close("finished") - df2 = _get_dupefilter(settings={"JOBDIR": path}, open=False) - assert df != df2 + df2 = _get_dupefilter(settings={"JOBDIR": path}, open_=False) + assert df is not df2 try: df2.open() assert df2.request_seen(r1) @@ -260,11 +260,8 @@ class TestBaseDupeFilter: dupefilter = _get_dupefilter( settings={"DUPEFILTER_CLASS": BaseDupeFilter}, ) - with catch_warnings(record=True) as warning_list: + with pytest.warns( + ScrapyDeprecationWarning, + match=r"Calling BaseDupeFilter\.log\(\) is deprecated.", + ): dupefilter.log(None, None) - assert len(warning_list) == 1 - assert ( - str(warning_list[0].message) - == "Calling BaseDupeFilter.log() is deprecated." - ) - assert warning_list[0].category == ScrapyDeprecationWarning diff --git a/tests/test_engine.py b/tests/test_engine.py index d9d25c240..e51eb4664 100644 --- a/tests/test_engine.py +++ b/tests/test_engine.py @@ -1,24 +1,13 @@ -""" -Scrapy engine tests - -This starts a testing web server (using twisted.server.Site) and then crawls it -with the Scrapy crawler. - -To view the testing web server in a browser you can start it by running this -module with the ``runserver`` argument:: - - python test_engine.py runserver -""" +from __future__ import annotations +import asyncio import re import subprocess import sys from collections import defaultdict from dataclasses import dataclass -from logging import DEBUG -from pathlib import Path -from threading import Timer -from unittest.mock import Mock +from typing import TYPE_CHECKING, Any, cast +from unittest.mock import Mock, call from urllib.parse import urlparse import attr @@ -27,22 +16,33 @@ from itemadapter import ItemAdapter from pydispatch import dispatcher from testfixtures import LogCapture from twisted.internet import defer -from twisted.internet.defer import inlineCallbacks -from twisted.trial import unittest -from twisted.web import server, static, util from scrapy import signals from scrapy.core.engine import ExecutionEngine, _Slot from scrapy.core.scheduler import BaseScheduler from scrapy.exceptions import CloseSpider, IgnoreRequest -from scrapy.http import Request +from scrapy.http import Headers, Request, Response from scrapy.item import Field, Item from scrapy.linkextractors import LinkExtractor -from scrapy.signals import request_scheduled from scrapy.spiders import Spider +from scrapy.statscollectors import MemoryStatsCollector +from scrapy.utils.defer import ( + _schedule_coro, + deferred_from_coro, + maybe_deferred_to_future, +) from scrapy.utils.signal import disconnect_all +from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler -from tests import get_testdata, tests_datadir +from tests import get_testdata +from tests.utils.decorators import coroutine_test, inline_callbacks_test + +if TYPE_CHECKING: + from twisted.python.failure import Failure + + from scrapy.core.scheduler import Scheduler + from scrapy.crawler import Crawler + from tests.mockserver.http import MockServer class MyItem(Item): @@ -67,7 +67,6 @@ class DataClassItem: class MySpider(Spider): name = "scrapytest.org" - allowed_domains = ["scrapytest.org", "localhost"] itemurl_re = re.compile(r"item\d+.html") name_re = re.compile(r"

(.*?)

", re.MULTILINE) @@ -132,46 +131,26 @@ class ChangeCloseReasonSpider(MySpider): raise CloseSpider(reason="custom_reason") -def start_test_site(debug=False): - from twisted.internet import reactor - - root_dir = Path(tests_datadir, "test_site") - r = static.File(str(root_dir)) - r.putChild(b"redirect", util.Redirect(b"/redirected")) - r.putChild(b"redirected", static.Data(b"Redirected here", "text/plain")) - numbers = [str(x).encode("utf8") for x in range(2**18)] - r.putChild(b"numbers", static.Data(b"".join(numbers), "text/plain")) - - port = reactor.listenTCP(0, server.Site(r), interface="127.0.0.1") - if debug: - print( - f"Test server running at http://localhost:{port.getHost().port}/ " - "- hit Ctrl-C to finish." - ) - return port - - class CrawlerRun: """A class to run the crawler and keep track of events occurred""" - def __init__(self, spider_class): - self.respplug = [] - self.reqplug = [] - self.reqdropped = [] - self.reqreached = [] - self.itemerror = [] - self.itemresp = [] - self.headers = {} - self.bytes = defaultdict(list) - self.signals_caught = {} + def __init__(self, spider_class: type[Spider]): + self.respplug: list[tuple[Response, Spider]] = [] + self.reqplug: list[tuple[Request, Spider]] = [] + self.reqdropped: list[tuple[Request, Spider]] = [] + self.reqreached: list[tuple[Request, Spider]] = [] + self.itemerror: list[tuple[Any, Response, Spider, Failure]] = [] + self.itemresp: list[tuple[Any, Response]] = [] + self.headers: dict[Request, Headers] = {} + self.bytes: defaultdict[Request, list[bytes]] = defaultdict(list) + self.signals_caught: dict[Any, dict[str, Any]] = {} self.spider_class = spider_class - def run(self): - self.port = start_test_site() - self.portno = self.port.getHost().port + async def run(self, mockserver: MockServer) -> None: + self.mockserver = mockserver start_urls = [ - self.geturl("/"), + self.geturl("/static/"), self.geturl("/redirect"), self.geturl("/redirect"), # duplicate self.geturl("/numbers"), @@ -196,50 +175,53 @@ class CrawlerRun: ) self.crawler.crawl(start_urls=start_urls) - self.deferred = defer.Deferred() + self.deferred: defer.Deferred[None] = defer.Deferred() dispatcher.connect(self.stop, signals.engine_stopped) - return self.deferred + await maybe_deferred_to_future(self.deferred) - def stop(self): - self.port.stopListening() # FIXME: wait for this Deferred + async def stop(self): for name, signal in vars(signals).items(): if not name.startswith("_"): disconnect_all(signal) self.deferred.callback(None) - return self.crawler.stop() + await self.crawler.stop_async() - def geturl(self, path): - return f"http://localhost:{self.portno}{path}" + def geturl(self, path: str) -> str: + return self.mockserver.url(path) - def getpath(self, url): + def getpath(self, url: str) -> str: u = urlparse(url) return u.path - def item_error(self, item, response, spider, failure): + def item_error( + self, item: Any, response: Response, spider: Spider, failure: Failure + ) -> None: self.itemerror.append((item, response, spider, failure)) - def item_scraped(self, item, spider, response): + def item_scraped(self, item: Any, spider: Spider, response: Response) -> None: self.itemresp.append((item, response)) - def headers_received(self, headers, body_length, request, spider): + def headers_received( + self, headers: Headers, body_length: int, request: Request, spider: Spider + ) -> None: self.headers[request] = headers - def bytes_received(self, data, request, spider): + def bytes_received(self, data: bytes, request: Request, spider: Spider) -> None: self.bytes[request].append(data) - def request_scheduled(self, request, spider): + def request_scheduled(self, request: Request, spider: Spider) -> None: self.reqplug.append((request, spider)) - def request_reached(self, request, spider): + def request_reached(self, request: Request, spider: Spider) -> None: self.reqreached.append((request, spider)) - def request_dropped(self, request, spider): + def request_dropped(self, request: Request, spider: Spider) -> None: self.reqdropped.append((request, spider)) - def response_downloaded(self, response, spider): + def response_downloaded(self, response: Response, spider: Spider) -> None: self.respplug.append((response, spider)) - def record_signal(self, *args, **kwargs): + def record_signal(self, *args: Any, **kwargs: Any) -> None: """Record a signal and its parameters""" signalargs = kwargs.copy() sig = signalargs.pop("signal") @@ -247,16 +229,16 @@ class CrawlerRun: self.signals_caught[sig] = signalargs -class TestEngineBase(unittest.TestCase): +class TestEngineBase: @staticmethod def _assert_visited_urls(run: CrawlerRun) -> None: must_be_visited = [ - "/", + "/static/", "/redirect", "/redirected", - "/item1.html", - "/item2.html", - "/item999.html", + "/static/item1.html", + "/static/item2.html", + "/static/item999.html", ] urls_visited = {rp[0].url for rp in run.respplug} urls_expected = {run.geturl(p) for p in must_be_visited} @@ -268,7 +250,11 @@ class TestEngineBase(unittest.TestCase): def _assert_scheduled_requests(run: CrawlerRun, count: int) -> None: assert len(run.reqplug) == count - paths_expected = ["/item999.html", "/item2.html", "/item1.html"] + paths_expected = [ + "/static/item999.html", + "/static/item2.html", + "/static/item1.html", + ] urls_requested = {rq[0].url for rq in run.reqplug} urls_expected = {run.geturl(p) for p in paths_expected} @@ -290,7 +276,7 @@ class TestEngineBase(unittest.TestCase): assert len(run.reqreached) == count for response, _ in run.respplug: - if run.getpath(response.url) == "/item999.html": + if run.getpath(response.url) == "/static/item999.html": assert response.status == 404 if run.getpath(response.url) == "/redirect": assert response.status == 302 @@ -313,8 +299,8 @@ class TestEngineBase(unittest.TestCase): @staticmethod def _assert_scraped_items(run: CrawlerRun) -> None: assert len(run.itemresp) == 2 - for item, response in run.itemresp: - item = ItemAdapter(item) + for item_, response in run.itemresp: + item = ItemAdapter(item_) assert item["url"] == response.url if "item1.html" in item["url"]: assert item["name"] == "Item 1 name" @@ -327,6 +313,7 @@ class TestEngineBase(unittest.TestCase): def _assert_headers_received(run: CrawlerRun) -> None: for headers in run.headers.values(): assert b"Server" in headers + assert headers[b"Server"] assert b"TwistedWeb" in headers[b"Server"] assert b"Date" in headers assert b"Content-Type" in headers @@ -336,11 +323,11 @@ class TestEngineBase(unittest.TestCase): assert len(run.bytes) == 9 for request, data in run.bytes.items(): joined_data = b"".join(data) - if run.getpath(request.url) == "/": + if run.getpath(request.url) == "/static/": assert joined_data == get_testdata("test_site", "index.html") - elif run.getpath(request.url) == "/item1.html": + elif run.getpath(request.url) == "/static/item1.html": assert joined_data == get_testdata("test_site", "item1.html") - elif run.getpath(request.url) == "/item2.html": + elif run.getpath(request.url) == "/static/item2.html": assert joined_data == get_testdata("test_site", "item2.html") elif run.getpath(request.url) == "/redirected": assert joined_data == b"Redirected here" @@ -355,7 +342,7 @@ class TestEngineBase(unittest.TestCase): b" \n" b"\n" ) - elif run.getpath(request.url) == "/tem999.html": + elif run.getpath(request.url) == "/static/item999.html": assert ( joined_data == b"\n\n" b" 404 - No Such Resource\n" @@ -392,8 +379,8 @@ class TestEngineBase(unittest.TestCase): class TestEngine(TestEngineBase): - @inlineCallbacks - def test_crawler(self): + @coroutine_test + async def test_crawler(self, mockserver: MockServer) -> None: for spider in ( MySpider, DictItemsSpider, @@ -401,40 +388,43 @@ class TestEngine(TestEngineBase): DataClassItemsSpider, ): run = CrawlerRun(spider) - yield run.run() + await run.run(mockserver) self._assert_visited_urls(run) self._assert_scheduled_requests(run, count=9) self._assert_downloaded_responses(run, count=9) self._assert_scraped_items(run) self._assert_signals_caught(run) + self._assert_headers_received(run) self._assert_bytes_received(run) - @inlineCallbacks - def test_crawler_dupefilter(self): + @coroutine_test + async def test_crawler_dupefilter(self, mockserver: MockServer) -> None: run = CrawlerRun(DupeFilterSpider) - yield run.run() + await run.run(mockserver) self._assert_scheduled_requests(run, count=8) self._assert_dropped_requests(run) - @inlineCallbacks - def test_crawler_itemerror(self): + @coroutine_test + async def test_crawler_itemerror(self, mockserver: MockServer) -> None: run = CrawlerRun(ItemZeroDivisionErrorSpider) - yield run.run() + await run.run(mockserver) self._assert_items_error(run) - @inlineCallbacks - def test_crawler_change_close_reason_on_idle(self): + @coroutine_test + async def test_crawler_change_close_reason_on_idle( + self, mockserver: MockServer + ) -> None: run = CrawlerRun(ChangeCloseReasonSpider) - yield run.run() + await run.run(mockserver) assert { "spider": run.crawler.spider, "reason": "custom_reason", } == run.signals_caught[signals.spider_closed] - @inlineCallbacks - def test_close_downloader(self): + @coroutine_test + async def test_close_downloader(self): e = ExecutionEngine(get_crawler(MySpider), lambda _: None) - yield e.close() + await e.close_async() def test_close_without_downloader(self): class CustomException(Exception): @@ -449,16 +439,31 @@ class TestEngine(TestEngineBase): get_crawler(MySpider, {"DOWNLOADER": BadDownloader}), lambda _: None ) - @inlineCallbacks + @inline_callbacks_test def test_start_already_running_exception(self): - e = ExecutionEngine(get_crawler(MySpider), lambda _: None) - yield e.open_spider(MySpider()) - e.start() + crawler = get_crawler(DefaultSpider) + crawler.spider = crawler._create_spider() + e = ExecutionEngine(crawler, lambda _: None) + crawler.engine = e + yield deferred_from_coro(e.open_spider_async()) + _schedule_coro(e.start_async()) with pytest.raises(RuntimeError, match="Engine already running"): - yield e.start() - yield e.stop() + yield deferred_from_coro(e.start_async()) + yield deferred_from_coro(e.stop_async()) - @inlineCallbacks + @pytest.mark.only_asyncio + @coroutine_test + async def test_start_already_running_exception_asyncio(self): + crawler = get_crawler(DefaultSpider) + crawler.spider = crawler._create_spider() + e = ExecutionEngine(crawler, lambda _: None) + crawler.engine = e + await e.open_spider_async() + with pytest.raises(RuntimeError, match="Engine already running"): + await asyncio.gather(e.start_async(), e.start_async()) + await e.stop_async() + + @inline_callbacks_test def test_start_request_processing_exception(self): class BadRequestFingerprinter: def fingerprint(self, request): @@ -492,25 +497,116 @@ class TestEngine(TestEngineBase): ) p = subprocess.Popen( args, + stdout=subprocess.DEVNULL, stderr=subprocess.PIPE, ) - def kill_proc(): + try: + _, stderr = p.communicate(timeout=15) + except subprocess.TimeoutExpired: p.kill() p.communicate() - raise AssertionError("Command took too much time to complete") + pytest.fail("Command took too much time to complete") - timer = Timer(15, kill_proc) - try: - timer.start() - _, stderr = p.communicate() - finally: - timer.cancel() - - assert b"Traceback" not in stderr, stderr + stderr_str = stderr.decode("utf-8") + assert "AttributeError" not in stderr_str, stderr_str + assert "AssertionError" not in stderr_str, stderr_str -def test_request_scheduled_signal(caplog): +class TestEngineDownloadAsync: + """Test cases for ExecutionEngine.download_async().""" + + @pytest.fixture + def engine(self) -> ExecutionEngine: + crawler = get_crawler(MySpider) + engine = ExecutionEngine(crawler, lambda _: None) + engine.downloader.close() + engine.downloader = Mock() + engine._slot = Mock() + engine._slot.inprogress = set() + return engine + + @staticmethod + async def _download(engine: ExecutionEngine, request: Request) -> Response: + return await engine.download_async(request) + + @coroutine_test + async def test_download_async_success(self, engine): + """Test basic successful async download of a request.""" + request = Request("http://example.com") + response = Response("http://example.com", body=b"test body") + engine.spider = Mock() + engine.downloader.fetch.return_value = defer.succeed(response) + engine._slot.add_request = Mock() + engine._slot.remove_request = Mock() + + result = await self._download(engine, request) + assert result == response + engine._slot.add_request.assert_called_once_with(request) + engine._slot.remove_request.assert_called_once_with(request) + engine.downloader.fetch.assert_called_once_with(request) + + @coroutine_test + async def test_download_async_redirect(self, engine): + """Test async download with a redirect request.""" + original_request = Request("http://example.com") + redirect_request = Request("http://example.com/redirect") + final_response = Response("http://example.com/redirect", body=b"redirected") + + # First call returns redirect request, second call returns final response + engine.downloader.fetch.side_effect = [ + defer.succeed(redirect_request), + defer.succeed(final_response), + ] + engine.spider = Mock() + engine._slot.add_request = Mock() + engine._slot.remove_request = Mock() + + result = await self._download(engine, original_request) + assert result == final_response + assert engine.downloader.fetch.call_count == 2 + engine._slot.add_request.assert_has_calls( + [call(original_request), call(redirect_request)] + ) + engine._slot.remove_request.assert_has_calls( + [call(original_request), call(redirect_request)] + ) + + @coroutine_test + async def test_download_async_no_spider(self, engine): + """Test async download attempt when no spider is available.""" + request = Request("http://example.com") + engine.spider = None + with pytest.raises(RuntimeError, match="No open spider to crawl:"): + await self._download(engine, request) + + @coroutine_test + async def test_download_async_failure(self, engine): + """Test async download when the downloader raises an exception.""" + request = Request("http://example.com") + error = RuntimeError("Download failed") + engine.spider = Mock() + engine.downloader.fetch.return_value = defer.fail(error) + engine._slot.add_request = Mock() + engine._slot.remove_request = Mock() + + with pytest.raises(RuntimeError, match="Download failed"): + await self._download(engine, request) + engine._slot.add_request.assert_called_once_with(request) + engine._slot.remove_request.assert_called_once_with(request) + + +@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") +class TestEngineDownload(TestEngineDownloadAsync): + """Test cases for ExecutionEngine.download().""" + + @staticmethod + async def _download(engine: ExecutionEngine, request: Request) -> Response: + return await maybe_deferred_to_future(engine.download(request)) + + +@coroutine_test +async def test_request_scheduled_signal(): class TestScheduler(BaseScheduler): def __init__(self): self.enqueued = [] @@ -525,7 +621,6 @@ def test_request_scheduled_signal(caplog): crawler = get_crawler(MySpider) engine = ExecutionEngine(crawler, lambda _: None) - engine.downloader._slot_gc_loop.stop() scheduler = TestScheduler() async def start(): @@ -534,21 +629,141 @@ def test_request_scheduled_signal(caplog): engine._start = start() engine._slot = _Slot(False, Mock(), scheduler) - crawler.signals.connect(signal_handler, request_scheduled) + crawler.signals.connect(signal_handler, signals.request_scheduled) keep_request = Request("https://keep.example") engine._schedule_request(keep_request) drop_request = Request("https://drop.example") - caplog.set_level(DEBUG) engine._schedule_request(drop_request) assert scheduler.enqueued == [keep_request], ( f"{scheduler.enqueued!r} != [{keep_request!r}]" ) - crawler.signals.disconnect(signal_handler, request_scheduled) + crawler.signals.disconnect(signal_handler, signals.request_scheduled) -if __name__ == "__main__": - from twisted.internet import reactor # pylint: disable=ungrouped-imports +class TestEngineCloseSpider: + """Tests for exception handling coverage during close_spider_async().""" - if len(sys.argv) > 1 and sys.argv[1] == "runserver": - start_test_site(debug=True) - reactor.run() + @pytest.fixture + def crawler(self) -> Crawler: + crawler = get_crawler(DefaultSpider) + crawler.spider = crawler._create_spider() + return crawler + + @coroutine_test + async def test_no_slot(self, crawler: Crawler) -> None: + engine = ExecutionEngine(crawler, lambda _: None) + crawler.engine = engine + await engine.open_spider_async() + slot = engine._slot + engine._slot = None + with pytest.raises(RuntimeError, match="Engine slot not assigned"): + await engine.close_spider_async() + # close it correctly + engine._slot = slot + await engine.close_spider_async() + + @coroutine_test + async def test_no_spider(self, crawler: Crawler) -> None: + engine = ExecutionEngine(crawler, lambda _: None) + with pytest.raises(RuntimeError, match="Spider not opened"): + await engine.close_spider_async() + engine.downloader.close() # cleanup + + @coroutine_test + async def test_exception_slot( + self, crawler: Crawler, caplog: pytest.LogCaptureFixture + ) -> None: + engine = ExecutionEngine(crawler, lambda _: None) + crawler.engine = engine + await engine.open_spider_async() + assert engine._slot + del engine._slot.heartbeat + await engine.close_spider_async() + assert "Slot close failure" in caplog.text + + @coroutine_test + async def test_exception_downloader( + self, crawler: Crawler, caplog: pytest.LogCaptureFixture + ) -> None: + engine = ExecutionEngine(crawler, lambda _: None) + crawler.engine = engine + await engine.open_spider_async() + del engine.downloader.slots + await engine.close_spider_async() + assert "Downloader close failure" in caplog.text + + @coroutine_test + async def test_exception_scraper( + self, crawler: Crawler, caplog: pytest.LogCaptureFixture + ) -> None: + engine = ExecutionEngine(crawler, lambda _: None) + crawler.engine = engine + await engine.open_spider_async() + engine.scraper.slot = None + await engine.close_spider_async() + assert "Scraper close failure" in caplog.text + + @coroutine_test + async def test_exception_scheduler( + self, crawler: Crawler, caplog: pytest.LogCaptureFixture + ) -> None: + engine = ExecutionEngine(crawler, lambda _: None) + crawler.engine = engine + await engine.open_spider_async() + assert engine._slot + del cast("Scheduler", engine._slot.scheduler).dqs + await engine.close_spider_async() + assert "Scheduler close failure" in caplog.text + + @coroutine_test + async def test_exception_signal( + self, crawler: Crawler, caplog: pytest.LogCaptureFixture + ) -> None: + engine = ExecutionEngine(crawler, lambda _: None) + crawler.engine = engine + await engine.open_spider_async() + signal_manager = engine.signals + del engine.signals + await engine.close_spider_async() + assert "Error while sending spider_close signal" in caplog.text + # send the spider_closed signal to close various components + await signal_manager.send_catch_log_async( + signal=signals.spider_closed, + spider=engine.spider, + reason="cancelled", + ) + + @coroutine_test + async def test_exception_stats( + self, crawler: Crawler, caplog: pytest.LogCaptureFixture + ) -> None: + engine = ExecutionEngine(crawler, lambda _: None) + crawler.engine = engine + await engine.open_spider_async() + assert isinstance(crawler.stats, MemoryStatsCollector) + del crawler.stats.spider_stats + await engine.close_spider_async() + assert "Stats close failure" in caplog.text + + @coroutine_test + async def test_exception_callback( + self, crawler: Crawler, caplog: pytest.LogCaptureFixture + ) -> None: + engine = ExecutionEngine(crawler, lambda _: defer.fail(ValueError())) + crawler.engine = engine + await engine.open_spider_async() + await engine.close_spider_async() + assert "Error running spider_closed_callback" in caplog.text + + @coroutine_test + async def test_exception_async_callback( + self, crawler: Crawler, caplog: pytest.LogCaptureFixture + ) -> None: + async def cb(_): + raise ValueError + + engine = ExecutionEngine(crawler, cb) + crawler.engine = engine + await engine.open_spider_async() + await engine.close_spider_async() + assert "Error running spider_closed_callback" in caplog.text diff --git a/tests/test_engine_loop.py b/tests/test_engine_loop.py index 4e82ad4ba..6cc8c0650 100644 --- a/tests/test_engine_loop.py +++ b/tests/test_engine_loop.py @@ -4,31 +4,22 @@ from collections import deque from logging import ERROR from typing import TYPE_CHECKING -from testfixtures import LogCapture -from twisted.internet.defer import Deferred -from twisted.trial.unittest import TestCase - from scrapy import Request, Spider, signals -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future +from scrapy.utils.asyncio import call_later from scrapy.utils.test import get_crawler - -from .mockserver import MockServer -from .test_scheduler import MemoryScheduler +from tests.mockserver.http import MockServer +from tests.test_scheduler import MemoryScheduler +from tests.utils import async_sleep +from tests.utils.decorators import coroutine_test if TYPE_CHECKING: + import pytest + from scrapy.http import Response -async def sleep(seconds: float = 0.001) -> None: - from twisted.internet import reactor - - deferred: Deferred[None] = Deferred() - reactor.callLater(seconds, deferred.callback, None) - await maybe_deferred_to_future(deferred) - - -class TestMain(TestCase): - @deferred_f_from_coro_f +class TestMain: + @coroutine_test async def test_sleep(self): """Neither asynchronous sleeps on Spider.start() nor the equivalent on the scheduler (returning no requests while also returning True from @@ -40,27 +31,25 @@ class TestMain(TestCase): name = "test" async def start(self): - from twisted.internet import reactor - yield Request("data:,a") - await sleep(seconds) + await async_sleep(seconds) self.crawler.engine._slot.scheduler.pause() self.crawler.engine._slot.scheduler.enqueue_request(Request("data:,b")) # During this time, the scheduler reports having requests but # returns None. - await sleep(seconds) + await async_sleep(seconds) self.crawler.engine._slot.scheduler.unpause() # The scheduler request is processed. - await sleep(seconds) + await async_sleep(seconds) yield Request("data:,c") - await sleep(seconds) + await async_sleep(seconds) self.crawler.engine._slot.scheduler.pause() self.crawler.engine._slot.scheduler.enqueue_request(Request("data:,d")) @@ -69,7 +58,7 @@ class TestMain(TestCase): # delayed call below, proving that the start iteration can # finish before a scheduler “sleep” without causing the # scheduler to finish. - reactor.callLater(seconds, self.crawler.engine._slot.scheduler.unpause) + call_later(seconds, self.crawler.engine._slot.scheduler.unpause) def parse(self, response): pass @@ -82,19 +71,21 @@ class TestMain(TestCase): settings = {"SCHEDULER": MemoryScheduler} crawler = get_crawler(TestSpider, settings_dict=settings) crawler.signals.connect(track_url, signals.request_reached_downloader) - await maybe_deferred_to_future(crawler.crawl()) + await crawler.crawl_async() assert crawler.stats.get_value("finish_reason") == "finished" expected_urls = ["data:,a", "data:,b", "data:,c", "data:,d"] assert actual_urls == expected_urls, f"{actual_urls=} != {expected_urls=}" - @deferred_f_from_coro_f - async def test_close_during_start_iteration(self): + @coroutine_test + async def test_close_during_start_iteration( + self, caplog: pytest.LogCaptureFixture + ) -> None: class TestSpider(Spider): name = "test" async def start(self): assert self.crawler.engine is not None - await maybe_deferred_to_future(self.crawler.engine.close()) + await self.crawler.engine.close_async() yield Request("data:,a") def parse(self, response): @@ -109,26 +100,26 @@ class TestMain(TestCase): crawler = get_crawler(TestSpider, settings_dict=settings) crawler.signals.connect(track_url, signals.request_reached_downloader) - with LogCapture(level=ERROR) as log: - await maybe_deferred_to_future(crawler.crawl()) + caplog.clear() + with caplog.at_level(ERROR): + await crawler.crawl_async() - assert not log.records - finish_reason = crawler.stats.get_value("finish_reason") - assert finish_reason == "shutdown", f"{finish_reason=}" - expected_urls = [] - assert actual_urls == expected_urls, f"{actual_urls=} != {expected_urls=}" + assert not caplog.records + assert crawler.stats + assert crawler.stats.get_value("finish_reason") == "shutdown" + assert not actual_urls -class TestRequestSendOrder(TestCase): +class TestRequestSendOrder: seconds = 0.1 # increase if flaky @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) # increase if flaky def request(self, num, response_seconds, download_slots, priority=0): @@ -139,7 +130,6 @@ class TestRequestSendOrder(TestCase): def get_num(self, request_or_response: Request | Response): return int(request_or_response.url.rsplit("&", maxsplit=1)[1]) - @deferred_f_from_coro_f async def _test_request_order( self, start_nums, @@ -182,12 +172,12 @@ class TestRequestSendOrder(TestCase): crawler = get_crawler(TestSpider, settings_dict=settings) crawler.signals.connect(track_num, signals.request_reached_downloader) - await maybe_deferred_to_future(crawler.crawl()) + await crawler.crawl_async() assert crawler.stats.get_value("finish_reason") == "finished" expected_nums = sorted(start_nums + cb_nums) assert actual_nums == expected_nums, f"{actual_nums=} != {expected_nums=}" - @deferred_f_from_coro_f + @coroutine_test async def test_default(self): """By default, callback requests take priority over start requests and are sent in order. Priority matters, but given the same priority, a @@ -219,17 +209,15 @@ class TestRequestSendOrder(TestCase): return yield - await maybe_deferred_to_future( - self._test_request_order( - start_nums=nums, - settings={"CONCURRENT_REQUESTS": 1}, - response_seconds=response_seconds, - start_fn=start, - parse_fn=parse, - ) + await self._test_request_order( + start_nums=nums, + settings={"CONCURRENT_REQUESTS": 1}, + response_seconds=response_seconds, + start_fn=start, + parse_fn=parse, ) - @deferred_f_from_coro_f + @coroutine_test async def test_lifo_start(self): """Changing the queues of start requests to LIFO, matching the queues of non-start requests, does not cause all requests to be stored in the @@ -261,23 +249,21 @@ class TestRequestSendOrder(TestCase): return yield - await maybe_deferred_to_future( - self._test_request_order( - start_nums=nums, - settings={ - "CONCURRENT_REQUESTS": 1, - "SCHEDULER_START_MEMORY_QUEUE": "scrapy.squeues.LifoMemoryQueue", - }, - response_seconds=response_seconds, - start_fn=start, - parse_fn=parse, - ) + await self._test_request_order( + start_nums=nums, + settings={ + "CONCURRENT_REQUESTS": 1, + "SCHEDULER_START_MEMORY_QUEUE": "scrapy.squeues.LifoMemoryQueue", + }, + response_seconds=response_seconds, + start_fn=start, + parse_fn=parse, ) - @deferred_f_from_coro_f + @coroutine_test async def test_shared_queues(self): """If SCHEDULER_START_*_QUEUE is falsy, start requests and other - requests share the same queue, i.e. start requests are not priorized + requests share the same queue, i.e. start requests are not prioritized over other requests if their priority matches.""" nums = list(range(1, 14)) response_seconds = 0 @@ -321,23 +307,21 @@ class TestRequestSendOrder(TestCase): return yield - await maybe_deferred_to_future( - self._test_request_order( - start_nums=nums, - settings={ - "CONCURRENT_REQUESTS": 1, - "SCHEDULER_START_MEMORY_QUEUE": None, - }, - response_seconds=response_seconds, - start_fn=start, - parse_fn=parse, - ) + await self._test_request_order( + start_nums=nums, + settings={ + "CONCURRENT_REQUESTS": 1, + "SCHEDULER_START_MEMORY_QUEUE": None, + }, + response_seconds=response_seconds, + start_fn=start, + parse_fn=parse, ) # Examples from the “Start requests” section of the documentation about # spiders. - @deferred_f_from_coro_f + @coroutine_test async def test_lazy(self): start_nums = [1, 2, 4] cb_nums = [3] @@ -351,14 +335,12 @@ class TestRequestSendOrder(TestCase): request = self.request(num, response_seconds, download_slots) yield request - await maybe_deferred_to_future( - self._test_request_order( - start_nums=start_nums, - cb_nums=cb_nums, - settings={ - "CONCURRENT_REQUESTS": 1, - }, - response_seconds=response_seconds, - start_fn=start, - ) + await self._test_request_order( + start_nums=start_nums, + cb_nums=cb_nums, + settings={ + "CONCURRENT_REQUESTS": 1, + }, + response_seconds=response_seconds, + start_fn=start, ) diff --git a/tests/test_engine_stop_download_bytes.py b/tests/test_engine_stop_download_bytes.py index 2662e45e1..091485781 100644 --- a/tests/test_engine_stop_download_bytes.py +++ b/tests/test_engine_stop_download_bytes.py @@ -1,5 +1,6 @@ -from testfixtures import LogCapture -from twisted.internet.defer import inlineCallbacks +from __future__ import annotations + +from typing import TYPE_CHECKING from scrapy.exceptions import StopDownload from tests.test_engine import ( @@ -10,6 +11,12 @@ from tests.test_engine import ( MySpider, TestEngineBase, ) +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + import pytest + + from tests.mockserver.http import MockServer class BytesReceivedCrawlerRun(CrawlerRun): @@ -19,8 +26,10 @@ class BytesReceivedCrawlerRun(CrawlerRun): class TestBytesReceivedEngine(TestEngineBase): - @inlineCallbacks - def test_crawler(self): + @coroutine_test + async def test_crawler( + self, mockserver: MockServer, caplog: pytest.LogCaptureFixture + ) -> None: for spider in ( MySpider, DictItemsSpider, @@ -28,32 +37,13 @@ class TestBytesReceivedEngine(TestEngineBase): DataClassItemsSpider, ): run = BytesReceivedCrawlerRun(spider) - with LogCapture() as log: - yield run.run() - log.check_present( - ( - "scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for " - "from signal handler BytesReceivedCrawlerRun.bytes_received", - ) - ) - log.check_present( - ( - "scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for " - "from signal handler BytesReceivedCrawlerRun.bytes_received", - ) - ) - log.check_present( - ( - "scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for " - "from signal handler BytesReceivedCrawlerRun.bytes_received", - ) - ) + with caplog.at_level("DEBUG"): + await run.run(mockserver) + for url in ("/redirected", "/static/", "/numbers"): + assert ( + f"Download stopped for " + "from signal handler BytesReceivedCrawlerRun.bytes_received" + ) in caplog.text self._assert_visited_urls(run) self._assert_scheduled_requests(run, count=9) self._assert_downloaded_responses(run, count=9) diff --git a/tests/test_engine_stop_download_headers.py b/tests/test_engine_stop_download_headers.py index 142715927..8ebc948e2 100644 --- a/tests/test_engine_stop_download_headers.py +++ b/tests/test_engine_stop_download_headers.py @@ -1,5 +1,6 @@ -from testfixtures import LogCapture -from twisted.internet.defer import inlineCallbacks +from __future__ import annotations + +from typing import TYPE_CHECKING from scrapy.exceptions import StopDownload from tests.test_engine import ( @@ -10,6 +11,12 @@ from tests.test_engine import ( MySpider, TestEngineBase, ) +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + import pytest + + from tests.mockserver.http import MockServer class HeadersReceivedCrawlerRun(CrawlerRun): @@ -19,8 +26,10 @@ class HeadersReceivedCrawlerRun(CrawlerRun): class TestHeadersReceivedEngine(TestEngineBase): - @inlineCallbacks - def test_crawler(self): + @coroutine_test + async def test_crawler( + self, mockserver: MockServer, caplog: pytest.LogCaptureFixture + ) -> None: for spider in ( MySpider, DictItemsSpider, @@ -28,32 +37,13 @@ class TestHeadersReceivedEngine(TestEngineBase): DataClassItemsSpider, ): run = HeadersReceivedCrawlerRun(spider) - with LogCapture() as log: - yield run.run() - log.check_present( - ( - "scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for from" - " signal handler HeadersReceivedCrawlerRun.headers_received", - ) - ) - log.check_present( - ( - "scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for from signal" - " handler HeadersReceivedCrawlerRun.headers_received", - ) - ) - log.check_present( - ( - "scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for from" - " signal handler HeadersReceivedCrawlerRun.headers_received", - ) - ) + with caplog.at_level("DEBUG"): + await run.run(mockserver) + for url in ("/redirected", "/static/", "/numbers"): + assert ( + f"Download stopped for " + "from signal handler HeadersReceivedCrawlerRun.headers_received" + ) in caplog.text self._assert_visited_urls(run) self._assert_downloaded_responses(run, count=6) self._assert_signals_caught(run) @@ -66,7 +56,7 @@ class TestHeadersReceivedEngine(TestEngineBase): @staticmethod def _assert_visited_urls(run: CrawlerRun) -> None: - must_be_visited = ["/", "/redirect", "/redirected"] + must_be_visited = ["/static/", "/redirect", "/redirected"] urls_visited = {rp[0].url for rp in run.respplug} urls_expected = {run.geturl(p) for p in must_be_visited} assert urls_expected <= urls_visited, ( diff --git a/tests/test_exporters.py b/tests/test_exporters.py index 05e8865bc..2fded613d 100644 --- a/tests/test_exporters.py +++ b/tests/test_exporters.py @@ -4,6 +4,7 @@ import marshal import pickle import re import tempfile +from abc import ABC, abstractmethod from datetime import datetime from io import BytesIO from typing import Any @@ -53,7 +54,7 @@ class CustomFieldDataclass: age: int = dataclasses.field(metadata={"serializer": custom_serializer}) -class TestBaseItemExporter: +class TestBaseItemExporter(ABC): item_class: type = MyItem custom_field_item_class: type = CustomFieldItem @@ -62,10 +63,11 @@ class TestBaseItemExporter: self.output = BytesIO() self.ie = self._get_exporter() - def _get_exporter(self, **kwargs): - return BaseItemExporter(**kwargs) + @abstractmethod + def _get_exporter(self, **kwargs) -> BaseItemExporter: + raise NotImplementedError - def _check_output(self): + def _check_output(self): # noqa: B027 pass def _assert_expected_item(self, exported_dict): @@ -83,11 +85,7 @@ class TestBaseItemExporter: def assertItemExportWorks(self, item): self.ie.start_exporting() - try: - self.ie.export_item(item) - except NotImplementedError: - if self.ie.__class__ is not BaseItemExporter: - raise + self.ie.export_item(item) self.ie.finish_exporting() # Delete the item exporter object, so that if it causes the output # file handle to be closed, which should not be the case, follow-up @@ -132,11 +130,6 @@ class TestBaseItemExporter: assert ie.serialize_field(a.get_field_meta("age"), "age", a["age"]) == "24" -class TestBaseItemExporterDataclass(TestBaseItemExporter): - item_class = MyDataClass - custom_field_item_class = CustomFieldDataclass - - class TestPythonItemExporter(TestBaseItemExporter): def _get_exporter(self, **kwargs): return PythonItemExporter(**kwargs) @@ -202,9 +195,7 @@ class TestPprintItemExporter(TestBaseItemExporter): return PprintItemExporter(self.output, **kwargs) def _check_output(self): - self._assert_expected_item( - eval(self.output.getvalue()) # pylint: disable=eval-used - ) + self._assert_expected_item(eval(self.output.getvalue())) class TestPprintItemExporterDataclass(TestPprintItemExporter): @@ -670,6 +661,9 @@ class TestCustomExporterItem: return str(int(value) + 1) return super().serialize_field(field, name, value) + def export_item(self, item: Any) -> None: + pass + i = self.item_class(name="John", age="22") a = ItemAdapter(i) ie = CustomItemExporter() diff --git a/tests/test_extension_memusage.py b/tests/test_extension_memusage.py new file mode 100644 index 000000000..a474725d8 --- /dev/null +++ b/tests/test_extension_memusage.py @@ -0,0 +1,115 @@ +from __future__ import annotations + +import logging +import sys + +import pytest + +from scrapy import signals +from scrapy.core import engine as engine_mod +from scrapy.exceptions import NotConfigured +from scrapy.extensions import memusage as memusage_mod +from scrapy.extensions.memusage import MemoryUsage +from scrapy.spiders import Spider +from scrapy.utils.test import get_crawler +from tests.utils import OneShotLoop +from tests.utils.decorators import coroutine_test + +# MemoryUsage relies on the stdlib 'resource' module (not available on Windows) +pytestmark = pytest.mark.skipif( + sys.platform.startswith("win"), + reason="MemoryUsage extension not available on Windows", +) + + +MB = 1024 * 1024 + + +class _LoopSpider(Spider): + name = "loop-data-spider" + + def __init__(self, url: str, loops: int = 60, **kw): + super().__init__(**kw) + self.url = url + self.loops = loops + self.start_urls = [url] + + def parse(self, response): + count = response.meta.get("count", 0) + if count + 1 < self.loops: + yield response.follow( + self.url, callback=self.parse, meta={"count": count + 1} + ) + + +def test_memusage_disabled() -> None: + settings = { + "MEMUSAGE_ENABLED": False, + } + with pytest.raises(NotConfigured): + MemoryUsage.from_crawler(get_crawler(settings_dict=settings)) + + +@coroutine_test +async def test_memusage_limit_closes_spider_with_reason_and_error_log( + caplog: pytest.LogCaptureFixture, monkeypatch: pytest.MonkeyPatch +) -> None: + settings = { + "MEMUSAGE_LIMIT_MB": 10, + "MEMUSAGE_CHECK_INTERVAL_SECONDS": 0.01, + "TELNETCONSOLE_ENABLED": False, + "LOG_LEVEL": "INFO", + } + + # Avoid background LoopingCall that can log after the test finishes. + monkeypatch.setattr(memusage_mod, "create_looping_call", OneShotLoop) + # Avoid engine start/stop races (the extension stops the engine in engine_started). + monkeypatch.setattr(engine_mod, "create_looping_call", OneShotLoop) + monkeypatch.setattr(MemoryUsage, "get_virtual_size", lambda _: 250 * MB) + + crawler = get_crawler(spidercls=_LoopSpider, settings_dict=settings) + + with caplog.at_level(logging.ERROR, logger="scrapy.extensions.memusage"): + await crawler.crawl_async(url="data:,", loops=100) + + assert crawler.stats + assert crawler.stats.get_value("memusage/limit_reached") == 1 + assert crawler.stats.get_value("finish_reason") == "memusage_exceeded" + assert any( + "memory usage exceeded" in r.getMessage().lower() for r in caplog.records + ) + + +@coroutine_test +async def test_memusage_warning_logs_but_allows_normal_finish( + caplog: pytest.LogCaptureFixture, monkeypatch: pytest.MonkeyPatch +) -> None: + settings = { + "MEMUSAGE_WARNING_MB": 50, + "MEMUSAGE_LIMIT_MB": 0, # no hard limit + "MEMUSAGE_CHECK_INTERVAL_SECONDS": 0.01, + "TELNETCONSOLE_ENABLED": False, + "LOG_LEVEL": "INFO", + } + + # Avoid background LoopingCall that can log after the test finishes. + monkeypatch.setattr(memusage_mod, "create_looping_call", OneShotLoop) + monkeypatch.setattr(MemoryUsage, "get_virtual_size", lambda self: 75 * MB) + + crawler = get_crawler(spidercls=_LoopSpider, settings_dict=settings) + + warning_signals: list[int] = [] + + def on_warning_reached() -> None: + warning_signals.append(1) + + crawler.signals.connect(on_warning_reached, signal=signals.memusage_warning_reached) + + with caplog.at_level(logging.WARNING, logger="scrapy.extensions.memusage"): + await crawler.crawl_async(url="data:,", loops=60) + + assert warning_signals == [1] + assert crawler.stats + assert crawler.stats.get_value("memusage/warning_reached") == 1 + assert crawler.stats.get_value("finish_reason") == "finished" + assert any("memory usage reached" in r.getMessage().lower() for r in caplog.records) diff --git a/tests/test_extension_periodic_log.py b/tests/test_extension_periodic_log.py index b86f3c7f2..18782fb70 100644 --- a/tests/test_extension_periodic_log.py +++ b/tests/test_extension_periodic_log.py @@ -1,12 +1,17 @@ from __future__ import annotations import datetime -from typing import Any, Callable +from typing import TYPE_CHECKING, Any from scrapy.extensions.periodic_log import PeriodicLog from scrapy.utils.test import get_crawler from .spiders import MetaSpider +from .utils.decorators import coroutine_test + +if TYPE_CHECKING: + from collections.abc import Callable + stats_dump_1 = { "log_count/INFO": 10, @@ -53,10 +58,10 @@ stats_dump_2 = { class CustomPeriodicLog(PeriodicLog): - def set_a(self): + def set_a(self) -> None: self.stats._stats = stats_dump_1 - def set_b(self): + def set_b(self) -> None: self.stats._stats = stats_dump_2 @@ -82,14 +87,17 @@ class TestPeriodicLog: assert extension({"PERIODIC_LOG_DELTA": True, "LOGSTATS_INTERVAL": 60}) assert extension({"PERIODIC_LOG_DELTA": "True", "LOGSTATS_INTERVAL": 60}) - def test_log_delta(self): - def emulate(settings=None): + @coroutine_test + async def test_log_delta(self): + def emulate( + settings: dict[str, Any] | None = None, + ) -> tuple[PeriodicLog, dict[str, Any], dict[str, Any]]: spider = MetaSpider() ext = extension(settings) ext.spider_opened(spider) ext.set_a() a = ext.log_delta() - ext.set_a() + ext.set_b() b = ext.log_delta() ext.spider_closed(spider, reason="finished") return ext, a, b @@ -115,8 +123,10 @@ class TestPeriodicLog: # include multiple check( {"PERIODIC_LOG_DELTA": {"include": ["downloader/", "scheduler/"]}}, - lambda k, v: isinstance(v, (int, float)) - and ("downloader/" in k or "scheduler/" in k), + lambda k, v: ( + isinstance(v, (int, float)) + and ("downloader/" in k or "scheduler/" in k) + ), ) # exclude @@ -128,25 +138,32 @@ class TestPeriodicLog: # exclude multiple check( {"PERIODIC_LOG_DELTA": {"exclude": ["downloader/", "scheduler/"]}}, - lambda k, v: isinstance(v, (int, float)) - and ("downloader/" not in k and "scheduler/" not in k), + lambda k, v: ( + isinstance(v, (int, float)) + and ("downloader/" not in k and "scheduler/" not in k) + ), ) # include exclude combined check( {"PERIODIC_LOG_DELTA": {"include": ["downloader/"], "exclude": ["bytes"]}}, - lambda k, v: isinstance(v, (int, float)) - and ("downloader/" in k and "bytes" not in k), + lambda k, v: ( + isinstance(v, (int, float)) + and ("downloader/" in k and "bytes" not in k) + ), ) - def test_log_stats(self): - def emulate(settings=None): + @coroutine_test + async def test_log_stats(self): + def emulate( + settings: dict[str, Any] | None = None, + ) -> tuple[PeriodicLog, dict[str, Any], dict[str, Any]]: spider = MetaSpider() ext = extension(settings) ext.spider_opened(spider) ext.set_a() a = ext.log_crawler_stats() - ext.set_a() + ext.set_b() b = ext.log_crawler_stats() ext.spider_closed(spider, reason="finished") return ext, a, b diff --git a/tests/test_extension_statsmailer.py b/tests/test_extension_statsmailer.py new file mode 100644 index 000000000..4d208a1ea --- /dev/null +++ b/tests/test_extension_statsmailer.py @@ -0,0 +1,95 @@ +import warnings +from unittest.mock import MagicMock + +import pytest + +from scrapy import signals +from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning +from scrapy.signalmanager import SignalManager +from scrapy.statscollectors import StatsCollector +from scrapy.utils.spider import DefaultSpider + +with warnings.catch_warnings(): + warnings.filterwarnings( + "ignore", + r"The scrapy\.extensions\.statsmailer module is deprecated", + ScrapyDeprecationWarning, + ) + warnings.filterwarnings( + "ignore", + r"The scrapy\.mail module is deprecated", + ScrapyDeprecationWarning, + ) + from scrapy.extensions import statsmailer + from scrapy.mail import MailSender + + +@pytest.fixture +def dummy_stats(): + class DummyStats(StatsCollector): + def __init__(self): + # pylint: disable=super-init-not-called + self._stats = {"global_item_scraped_count": 42} + + def get_stats(self): + return {"item_scraped_count": 10, **self._stats} + + return DummyStats() + + +def test_from_crawler_without_recipients_raises_notconfigured(): + crawler = MagicMock() + crawler.settings.getlist.return_value = [] + crawler.stats = MagicMock() + + with pytest.raises(NotConfigured): + statsmailer.StatsMailer.from_crawler(crawler) + + +def test_from_crawler_with_recipients_initializes_extension(dummy_stats, monkeypatch): + crawler = MagicMock() + crawler.settings.getlist.return_value = ["test@example.com"] + crawler.stats = dummy_stats + crawler.signals = SignalManager(crawler) + + mailer = MagicMock(spec=MailSender) + monkeypatch.setattr(statsmailer.MailSender, "from_crawler", lambda _: mailer) + + ext = statsmailer.StatsMailer.from_crawler(crawler) + + assert isinstance(ext, statsmailer.StatsMailer) + assert ext.recipients == ["test@example.com"] + assert ext.mail is mailer + + +def test_from_crawler_connects_spider_closed_signal(dummy_stats, monkeypatch): + crawler = MagicMock() + crawler.settings.getlist.return_value = ["test@example.com"] + crawler.stats = dummy_stats + crawler.signals = SignalManager(crawler) + + mailer = MagicMock(spec=MailSender) + monkeypatch.setattr(statsmailer.MailSender, "from_crawler", lambda _: mailer) + + statsmailer.StatsMailer.from_crawler(crawler) + + connected = crawler.signals.send_catch_log( + signals.spider_closed, spider=DefaultSpider(name="dummy") + ) + assert connected is not None + + +def test_spider_closed_sends_email(dummy_stats): + recipients = ["test@example.com"] + mail = MagicMock(spec=MailSender) + ext = statsmailer.StatsMailer(dummy_stats, recipients, mail) + + spider = DefaultSpider(name="dummy") + ext.spider_closed(spider) + + args, _ = mail.send.call_args + to, subject, body = args + assert to == recipients + assert "Scrapy stats for: dummy" in subject + assert "global_item_scraped_count" in body + assert "item_scraped_count" in body diff --git a/tests/test_extension_telnet.py b/tests/test_extension_telnet.py index f9e54cb28..3f9135867 100644 --- a/tests/test_extension_telnet.py +++ b/tests/test_extension_telnet.py @@ -1,14 +1,15 @@ import pytest from twisted.conch.telnet import ITelnetProtocol from twisted.cred import credentials -from twisted.internet.defer import inlineCallbacks -from twisted.trial import unittest from scrapy.extensions.telnet import TelnetConsole from scrapy.utils.test import get_crawler +from tests.utils.decorators import inline_callbacks_test + +pytestmark = pytest.mark.requires_reactor # TelnetConsole requires a reactor -class TestTelnetExtension(unittest.TestCase): +class TestTelnetExtension: def _get_console_and_portal(self, settings=None): crawler = get_crawler(settings_dict=settings) console = TelnetConsole(crawler) @@ -22,7 +23,7 @@ class TestTelnetExtension(unittest.TestCase): return console, portal - @inlineCallbacks + @inline_callbacks_test def test_bad_credentials(self): console, portal = self._get_console_and_portal() creds = credentials.UsernamePassword(b"username", b"password") @@ -31,7 +32,7 @@ class TestTelnetExtension(unittest.TestCase): yield d console.stop_listening() - @inlineCallbacks + @inline_callbacks_test def test_good_credentials(self): console, portal = self._get_console_and_portal() creds = credentials.UsernamePassword( @@ -41,7 +42,7 @@ class TestTelnetExtension(unittest.TestCase): yield d console.stop_listening() - @inlineCallbacks + @inline_callbacks_test def test_custom_credentials(self): settings = { "TELNETCONSOLE_USERNAME": "user", @@ -52,3 +53,9 @@ class TestTelnetExtension(unittest.TestCase): d = portal.login(creds, None, ITelnetProtocol) yield d console.stop_listening() + + def test_invalid_reversed_portrange(self): + settings = {"TELNETCONSOLE_PORT": [2, 1]} + console = TelnetConsole(get_crawler(settings_dict=settings)) + with pytest.raises(ValueError, match=r"invalid portrange: \[2, 1\]"): + console.start_listening() diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 7073d5a35..c1d6f04eb 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -1,598 +1,54 @@ from __future__ import annotations -import bz2 import csv -import gzip import json -import lzma -import os +import marshal +import pickle import random import shutil -import string -import sys import tempfile -import warnings from abc import ABC, abstractmethod -from collections import defaultdict -from io import BytesIO from logging import getLogger from pathlib import Path from string import ascii_letters, digits -from typing import TYPE_CHECKING, Any +from typing import IO, TYPE_CHECKING, Any from unittest import mock -from urllib.parse import quote, urljoin +from urllib.parse import urljoin from urllib.request import pathname2url import lxml.etree import pytest from testfixtures import LogCapture -from twisted.internet import defer -from twisted.internet.defer import inlineCallbacks -from twisted.trial import unittest -from w3lib.url import file_uri_to_path, path_to_file_uri +from w3lib.url import file_uri_to_path from zope.interface import implementer -from zope.interface.verify import verifyObject import scrapy from scrapy import Spider, signals -from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning +from scrapy.exceptions import NotConfigured from scrapy.exporters import CsvItemExporter, JsonItemExporter from scrapy.extensions.feedexport import ( BlockingFeedStorage, FeedExporter, FeedSlot, FileFeedStorage, - FTPFeedStorage, - GCSFeedStorage, IFeedStorage, - S3FeedStorage, - StdoutFeedStorage, ) -from scrapy.settings import Settings -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future from scrapy.utils.python import to_unicode from scrapy.utils.test import get_crawler -from tests.mockserver import MockFTPServer, MockServer +from tests.mockserver.http import MockServer from tests.spiders import ItemSpider +from tests.utils.decorators import coroutine_test, inline_callbacks_test if TYPE_CHECKING: - from collections.abc import Iterable - from os import PathLike + from collections.abc import Awaitable, Callable, Iterable -def path_to_url(path): +def path_to_url(path: str | Path) -> str: return urljoin("file:", pathname2url(str(path))) -def printf_escape(string): - return string.replace("%", "%%") - - -def build_url(path: str | PathLike) -> str: - path_str = str(path) - if path_str[0] != "/": - path_str = "/" + path_str - return urljoin("file:", path_str) - - -def mock_google_cloud_storage() -> tuple[Any, Any, Any]: - """Creates autospec mocks for google-cloud-storage Client, Bucket and Blob - classes and set their proper return values. - """ - from google.cloud.storage import Blob, Bucket, Client - - client_mock = mock.create_autospec(Client) - - bucket_mock = mock.create_autospec(Bucket) - client_mock.get_bucket.return_value = bucket_mock - - blob_mock = mock.create_autospec(Blob) - bucket_mock.blob.return_value = blob_mock - - return (client_mock, bucket_mock, blob_mock) - - -class TestFileFeedStorage: - def test_store_file_uri(self, tmp_path): - path = tmp_path / "file.txt" - uri = path_to_file_uri(str(path)) - self._assert_stores(FileFeedStorage(uri), path) - - def test_store_file_uri_makedirs(self, tmp_path): - path = tmp_path / "more" / "paths" / "file.txt" - uri = path_to_file_uri(str(path)) - self._assert_stores(FileFeedStorage(uri), path) - - def test_store_direct_path(self, tmp_path): - path = tmp_path / "file.txt" - self._assert_stores(FileFeedStorage(str(path)), path) - - def test_store_direct_path_relative(self, tmp_path): - old_cwd = Path.cwd() - try: - os.chdir(tmp_path) - path = Path("foo", "bar") - self._assert_stores(FileFeedStorage(str(path)), path) - finally: - os.chdir(old_cwd) - - def test_interface(self, tmp_path): - path = tmp_path / "file.txt" - st = FileFeedStorage(str(path)) - verifyObject(IFeedStorage, st) - - @staticmethod - def _store(path: Path, feed_options: dict[str, Any] | None = None) -> None: - storage = FileFeedStorage(str(path), feed_options=feed_options) - spider = scrapy.Spider("default") - file = storage.open(spider) - file.write(b"content") - storage.store(file) - - def test_append(self, tmp_path): - path = tmp_path / "file.txt" - self._store(path) - self._assert_stores(FileFeedStorage(str(path)), path, b"contentcontent") - - def test_overwrite(self, tmp_path): - path = tmp_path / "file.txt" - self._store(path, {"overwrite": True}) - self._assert_stores( - FileFeedStorage(str(path), feed_options={"overwrite": True}), path - ) - - @staticmethod - def _assert_stores( - storage: FileFeedStorage, path: Path, expected_content: bytes = b"content" - ) -> None: - spider = scrapy.Spider("default") - file = storage.open(spider) - file.write(b"content") - storage.store(file) - assert path.exists() - try: - assert path.read_bytes() == expected_content - finally: - path.unlink() - - def test_preserves_windows_path_without_file_scheme(self): - path = r"C:\Users\user\Desktop\test.txt" - storage = FileFeedStorage(path) - assert storage.path == path - - -class TestFTPFeedStorage(unittest.TestCase): - def get_test_spider(self, settings=None): - class TestSpider(scrapy.Spider): - name = "test_spider" - - crawler = get_crawler(settings_dict=settings) - return TestSpider.from_crawler(crawler) - - async def _store(self, uri, content, feed_options=None, settings=None): - crawler = get_crawler(settings_dict=settings or {}) - storage = FTPFeedStorage.from_crawler( - crawler, - uri, - feed_options=feed_options, - ) - verifyObject(IFeedStorage, storage) - spider = self.get_test_spider() - file = storage.open(spider) - file.write(content) - await maybe_deferred_to_future(storage.store(file)) - - def _assert_stored(self, path: Path, content): - assert path.exists() - try: - assert path.read_bytes() == content - finally: - path.unlink() - - @deferred_f_from_coro_f - async def test_append(self): - with MockFTPServer() as ftp_server: - filename = "file" - url = ftp_server.url(filename) - feed_options = {"overwrite": False} - await self._store(url, b"foo", feed_options=feed_options) - await self._store(url, b"bar", feed_options=feed_options) - self._assert_stored(ftp_server.path / filename, b"foobar") - - @deferred_f_from_coro_f - async def test_overwrite(self): - with MockFTPServer() as ftp_server: - filename = "file" - url = ftp_server.url(filename) - await self._store(url, b"foo") - await self._store(url, b"bar") - self._assert_stored(ftp_server.path / filename, b"bar") - - @deferred_f_from_coro_f - async def test_append_active_mode(self): - with MockFTPServer() as ftp_server: - settings = {"FEED_STORAGE_FTP_ACTIVE": True} - filename = "file" - url = ftp_server.url(filename) - feed_options = {"overwrite": False} - await self._store(url, b"foo", feed_options=feed_options, settings=settings) - await self._store(url, b"bar", feed_options=feed_options, settings=settings) - self._assert_stored(ftp_server.path / filename, b"foobar") - - @deferred_f_from_coro_f - async def test_overwrite_active_mode(self): - with MockFTPServer() as ftp_server: - settings = {"FEED_STORAGE_FTP_ACTIVE": True} - filename = "file" - url = ftp_server.url(filename) - await self._store(url, b"foo", settings=settings) - await self._store(url, b"bar", settings=settings) - self._assert_stored(ftp_server.path / filename, b"bar") - - def test_uri_auth_quote(self): - # RFC3986: 3.2.1. User Information - pw_quoted = quote(string.punctuation, safe="") - st = FTPFeedStorage(f"ftp://foo:{pw_quoted}@example.com/some_path", {}) - assert st.password == string.punctuation - - -class TestBlockingFeedStorage: - def get_test_spider(self, settings=None): - class TestSpider(scrapy.Spider): - name = "test_spider" - - crawler = get_crawler(settings_dict=settings) - return TestSpider.from_crawler(crawler) - - def test_default_temp_dir(self): - b = BlockingFeedStorage() - - storage_file = b.open(self.get_test_spider()) - storage_dir = Path(storage_file.name).parent - assert str(storage_dir) == tempfile.gettempdir() - - def test_temp_file(self, tmp_path): - b = BlockingFeedStorage() - - spider = self.get_test_spider({"FEED_TEMPDIR": str(tmp_path)}) - storage_file = b.open(spider) - storage_dir = Path(storage_file.name).parent - assert storage_dir == tmp_path - - def test_invalid_folder(self, tmp_path): - b = BlockingFeedStorage() - - invalid_path = tmp_path / "invalid_path" - spider = self.get_test_spider({"FEED_TEMPDIR": str(invalid_path)}) - - with pytest.raises(OSError, match="Not a Directory:"): - b.open(spider=spider) - - -@pytest.mark.requires_boto3 -class TestS3FeedStorage(unittest.TestCase): - def test_parse_credentials(self): - aws_credentials = { - "AWS_ACCESS_KEY_ID": "settings_key", - "AWS_SECRET_ACCESS_KEY": "settings_secret", - "AWS_SESSION_TOKEN": "settings_token", - } - crawler = get_crawler(settings_dict=aws_credentials) - # Instantiate with crawler - storage = S3FeedStorage.from_crawler( - crawler, - "s3://mybucket/export.csv", - ) - assert storage.access_key == "settings_key" - assert storage.secret_key == "settings_secret" - assert storage.session_token == "settings_token" - # Instantiate directly - storage = S3FeedStorage( - "s3://mybucket/export.csv", - aws_credentials["AWS_ACCESS_KEY_ID"], - aws_credentials["AWS_SECRET_ACCESS_KEY"], - session_token=aws_credentials["AWS_SESSION_TOKEN"], - ) - assert storage.access_key == "settings_key" - assert storage.secret_key == "settings_secret" - assert storage.session_token == "settings_token" - # URI priority > settings priority - storage = S3FeedStorage( - "s3://uri_key:uri_secret@mybucket/export.csv", - aws_credentials["AWS_ACCESS_KEY_ID"], - aws_credentials["AWS_SECRET_ACCESS_KEY"], - ) - assert storage.access_key == "uri_key" - assert storage.secret_key == "uri_secret" - - @deferred_f_from_coro_f - async def test_store(self): - settings = { - "AWS_ACCESS_KEY_ID": "access_key", - "AWS_SECRET_ACCESS_KEY": "secret_key", - } - crawler = get_crawler(settings_dict=settings) - bucket = "mybucket" - key = "export.csv" - storage = S3FeedStorage.from_crawler(crawler, f"s3://{bucket}/{key}") - verifyObject(IFeedStorage, storage) - - file = mock.MagicMock() - - storage.s3_client = mock.MagicMock() - await maybe_deferred_to_future(storage.store(file)) - assert storage.s3_client.upload_fileobj.call_args == mock.call( - Bucket=bucket, Key=key, Fileobj=file - ) - - def test_init_without_acl(self): - storage = S3FeedStorage("s3://mybucket/export.csv", "access_key", "secret_key") - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.acl is None - - def test_init_with_acl(self): - storage = S3FeedStorage( - "s3://mybucket/export.csv", "access_key", "secret_key", "custom-acl" - ) - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.acl == "custom-acl" - - def test_init_with_endpoint_url(self): - storage = S3FeedStorage( - "s3://mybucket/export.csv", - "access_key", - "secret_key", - endpoint_url="https://example.com", - ) - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.endpoint_url == "https://example.com" - - def test_init_with_region_name(self): - region_name = "ap-east-1" - storage = S3FeedStorage( - "s3://mybucket/export.csv", - "access_key", - "secret_key", - region_name=region_name, - ) - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.region_name == region_name - assert storage.s3_client._client_config.region_name == region_name - - def test_from_crawler_without_acl(self): - settings = { - "AWS_ACCESS_KEY_ID": "access_key", - "AWS_SECRET_ACCESS_KEY": "secret_key", - } - crawler = get_crawler(settings_dict=settings) - storage = S3FeedStorage.from_crawler( - crawler, - "s3://mybucket/export.csv", - ) - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.acl is None - - def test_without_endpoint_url(self): - settings = { - "AWS_ACCESS_KEY_ID": "access_key", - "AWS_SECRET_ACCESS_KEY": "secret_key", - } - crawler = get_crawler(settings_dict=settings) - storage = S3FeedStorage.from_crawler( - crawler, - "s3://mybucket/export.csv", - ) - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.endpoint_url is None - - def test_without_region_name(self): - settings = { - "AWS_ACCESS_KEY_ID": "access_key", - "AWS_SECRET_ACCESS_KEY": "secret_key", - } - crawler = get_crawler(settings_dict=settings) - storage = S3FeedStorage.from_crawler( - crawler, - "s3://mybucket/export.csv", - ) - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.s3_client._client_config.region_name == "us-east-1" - - def test_from_crawler_with_acl(self): - settings = { - "AWS_ACCESS_KEY_ID": "access_key", - "AWS_SECRET_ACCESS_KEY": "secret_key", - "FEED_STORAGE_S3_ACL": "custom-acl", - } - crawler = get_crawler(settings_dict=settings) - storage = S3FeedStorage.from_crawler( - crawler, - "s3://mybucket/export.csv", - ) - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.acl == "custom-acl" - - def test_from_crawler_with_endpoint_url(self): - settings = { - "AWS_ACCESS_KEY_ID": "access_key", - "AWS_SECRET_ACCESS_KEY": "secret_key", - "AWS_ENDPOINT_URL": "https://example.com", - } - crawler = get_crawler(settings_dict=settings) - storage = S3FeedStorage.from_crawler(crawler, "s3://mybucket/export.csv") - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.endpoint_url == "https://example.com" - - def test_from_crawler_with_region_name(self): - region_name = "ap-east-1" - settings = { - "AWS_ACCESS_KEY_ID": "access_key", - "AWS_SECRET_ACCESS_KEY": "secret_key", - "AWS_REGION_NAME": region_name, - } - crawler = get_crawler(settings_dict=settings) - storage = S3FeedStorage.from_crawler(crawler, "s3://mybucket/export.csv") - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.region_name == region_name - assert storage.s3_client._client_config.region_name == region_name - - @deferred_f_from_coro_f - async def test_store_without_acl(self): - storage = S3FeedStorage( - "s3://mybucket/export.csv", - "access_key", - "secret_key", - ) - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.acl is None - - storage.s3_client = mock.MagicMock() - await maybe_deferred_to_future(storage.store(BytesIO(b"test file"))) - acl = ( - storage.s3_client.upload_fileobj.call_args[1] - .get("ExtraArgs", {}) - .get("ACL") - ) - assert acl is None - - @deferred_f_from_coro_f - async def test_store_with_acl(self): - storage = S3FeedStorage( - "s3://mybucket/export.csv", "access_key", "secret_key", "custom-acl" - ) - assert storage.access_key == "access_key" - assert storage.secret_key == "secret_key" - assert storage.acl == "custom-acl" - - storage.s3_client = mock.MagicMock() - await maybe_deferred_to_future(storage.store(BytesIO(b"test file"))) - acl = storage.s3_client.upload_fileobj.call_args[1]["ExtraArgs"]["ACL"] - assert acl == "custom-acl" - - def test_overwrite_default(self): - with LogCapture() as log: - S3FeedStorage( - "s3://mybucket/export.csv", "access_key", "secret_key", "custom-acl" - ) - assert "S3 does not support appending to files" not in str(log) - - def test_overwrite_false(self): - with LogCapture() as log: - S3FeedStorage( - "s3://mybucket/export.csv", - "access_key", - "secret_key", - "custom-acl", - feed_options={"overwrite": False}, - ) - assert "S3 does not support appending to files" in str(log) - - -class TestGCSFeedStorage(unittest.TestCase): - def test_parse_settings(self): - try: - from google.cloud.storage import Client # noqa: F401 - except ImportError: - pytest.skip("GCSFeedStorage requires google-cloud-storage") - - settings = {"GCS_PROJECT_ID": "123", "FEED_STORAGE_GCS_ACL": "publicRead"} - crawler = get_crawler(settings_dict=settings) - storage = GCSFeedStorage.from_crawler(crawler, "gs://mybucket/export.csv") - assert storage.project_id == "123" - assert storage.acl == "publicRead" - assert storage.bucket_name == "mybucket" - assert storage.blob_name == "export.csv" - - def test_parse_empty_acl(self): - try: - from google.cloud.storage import Client # noqa: F401 - except ImportError: - pytest.skip("GCSFeedStorage requires google-cloud-storage") - - settings = {"GCS_PROJECT_ID": "123", "FEED_STORAGE_GCS_ACL": ""} - crawler = get_crawler(settings_dict=settings) - storage = GCSFeedStorage.from_crawler(crawler, "gs://mybucket/export.csv") - assert storage.acl is None - - settings = {"GCS_PROJECT_ID": "123", "FEED_STORAGE_GCS_ACL": None} - crawler = get_crawler(settings_dict=settings) - storage = GCSFeedStorage.from_crawler(crawler, "gs://mybucket/export.csv") - assert storage.acl is None - - @deferred_f_from_coro_f - async def test_store(self): - try: - from google.cloud.storage import Client # noqa: F401 - except ImportError: - pytest.skip("GCSFeedStorage requires google-cloud-storage") - - uri = "gs://mybucket/export.csv" - project_id = "myproject-123" - acl = "publicRead" - (client_mock, bucket_mock, blob_mock) = mock_google_cloud_storage() - with mock.patch("google.cloud.storage.Client") as m: - m.return_value = client_mock - - f = mock.Mock() - storage = GCSFeedStorage(uri, project_id, acl) - await maybe_deferred_to_future(storage.store(f)) - - f.seek.assert_called_once_with(0) - m.assert_called_once_with(project=project_id) - client_mock.get_bucket.assert_called_once_with("mybucket") - bucket_mock.blob.assert_called_once_with("export.csv") - blob_mock.upload_from_file.assert_called_once_with(f, predefined_acl=acl) - - def test_overwrite_default(self): - with LogCapture() as log: - GCSFeedStorage("gs://mybucket/export.csv", "myproject-123", "custom-acl") - assert "GCS does not support appending to files" not in str(log) - - def test_overwrite_false(self): - with LogCapture() as log: - GCSFeedStorage( - "gs://mybucket/export.csv", - "myproject-123", - "custom-acl", - feed_options={"overwrite": False}, - ) - assert "GCS does not support appending to files" in str(log) - - -class TestStdoutFeedStorage: - def test_store(self): - out = BytesIO() - storage = StdoutFeedStorage("stdout:", _stdout=out) - file = storage.open(scrapy.Spider("default")) - file.write(b"content") - storage.store(file) - assert out.getvalue() == b"content" - - def test_overwrite_default(self): - with LogCapture() as log: - StdoutFeedStorage("stdout:") - assert ( - "Standard output (stdout) storage does not support overwriting" - not in str(log) - ) - - def test_overwrite_true(self): - with LogCapture() as log: - StdoutFeedStorage("stdout:", feed_options={"overwrite": True}) - assert "Standard output (stdout) storage does not support overwriting" in str( - log - ) +def printf_escape(s: str) -> str: + return s.replace("%", "%%") class FromCrawlerMixin: @@ -653,7 +109,7 @@ class LogOnStoreFileStorage: file.close() -class TestFeedExportBase(ABC, unittest.TestCase): +class TestFeedExportBase(ABC): mockserver: MockServer class MyItem(scrapy.Item): @@ -671,18 +127,18 @@ class TestFeedExportBase(ABC, unittest.TestCase): return Path(self.temp_dir, inter_dir, filename) @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) - def setUp(self): + def setup_method(self): self.temp_dir = tempfile.mkdtemp() - def tearDown(self): + def teardown_method(self): shutil.rmtree(self.temp_dir, ignore_errors=True) async def exported_data( @@ -727,7 +183,7 @@ class TestFeedExportBase(ABC, unittest.TestCase): await self.assertExportedMarshal(items, rows, settings) await self.assertExportedMultiple(items, rows, settings) - async def assertExportedCsv( + async def assertExportedCsv( # noqa: B027 self, items: Iterable[Any], header: Iterable[str], @@ -736,7 +192,7 @@ class TestFeedExportBase(ABC, unittest.TestCase): ) -> None: pass - async def assertExportedJsonLines( + async def assertExportedJsonLines( # noqa: B027 self, items: Iterable[Any], rows: Iterable[dict[str, Any]], @@ -744,7 +200,7 @@ class TestFeedExportBase(ABC, unittest.TestCase): ) -> None: pass - async def assertExportedXml( + async def assertExportedXml( # noqa: B027 self, items: Iterable[Any], rows: Iterable[dict[str, Any]], @@ -752,7 +208,7 @@ class TestFeedExportBase(ABC, unittest.TestCase): ) -> None: pass - async def assertExportedMultiple( + async def assertExportedMultiple( # noqa: B027 self, items: Iterable[Any], rows: Iterable[dict[str, Any]], @@ -760,7 +216,7 @@ class TestFeedExportBase(ABC, unittest.TestCase): ) -> None: pass - async def assertExportedPickle( + async def assertExportedPickle( # noqa: B027 self, items: Iterable[Any], rows: Iterable[dict[str, Any]], @@ -768,7 +224,7 @@ class TestFeedExportBase(ABC, unittest.TestCase): ) -> None: pass - async def assertExportedMarshal( + async def assertExportedMarshal( # noqa: B027 self, items: Iterable[Any], rows: Iterable[dict[str, Any]], @@ -782,8 +238,10 @@ class TestFeedExportBase(ABC, unittest.TestCase): ) -> dict[str, Any]: pass - def _load_until_eof(self, data, load_func): - result = [] + def _load_until_eof( + self, data: bytes, load_func: Callable[[IO[bytes]], Any] + ) -> list[Any]: + result: list[Any] = [] with tempfile.TemporaryFile() as temp: temp.write(data) temp.seek(0) @@ -829,7 +287,7 @@ class IsExportingListener: if self.start_without_finish: self.start_without_finish = False else: - self.finish_before_start = True + self.finish_without_start = True class ExceptionJsonItemExporter(JsonItemExporter): @@ -855,7 +313,7 @@ class TestFeedExport(TestFeedExportBase): try: spider_cls.start_urls = [self.mockserver.url("/")] crawler = get_crawler(spider_cls, settings) - await maybe_deferred_to_future(crawler.crawl()) + await crawler.crawl_async() for file_path, feed_options in FEEDS.items(): content[feed_options["format"]] = ( @@ -971,7 +429,6 @@ class TestFeedExport(TestFeedExportBase): ) data = await self.exported_data(items, settings) expected = [{k: v for k, v in row.items() if v} for row in rows] - import pickle result = self._load_until_eof(data["pickle"], load_func=pickle.load) assert result == expected @@ -992,12 +449,11 @@ class TestFeedExport(TestFeedExportBase): ) data = await self.exported_data(items, settings) expected = [{k: v for k, v in row.items() if v} for row in rows] - import marshal result = self._load_until_eof(data["marshal"], load_func=marshal.load) assert result == expected - @inlineCallbacks + @inline_callbacks_test def test_stats_file_success(self): settings = { "FEEDS": { @@ -1011,7 +467,7 @@ class TestFeedExport(TestFeedExportBase): assert "feedexport/success_count/FileFeedStorage" in crawler.stats.get_stats() assert crawler.stats.get_value("feedexport/success_count/FileFeedStorage") == 1 - @inlineCallbacks + @inline_callbacks_test def test_stats_file_failed(self): settings = { "FEEDS": { @@ -1029,7 +485,7 @@ class TestFeedExport(TestFeedExportBase): assert "feedexport/failed_count/FileFeedStorage" in crawler.stats.get_stats() assert crawler.stats.get_value("feedexport/failed_count/FileFeedStorage") == 1 - @inlineCallbacks + @inline_callbacks_test def test_stats_multiple_file(self): settings = { "FEEDS": { @@ -1042,8 +498,7 @@ class TestFeedExport(TestFeedExportBase): }, } crawler = get_crawler(ItemSpider, settings) - with mock.patch.object(S3FeedStorage, "store"): - yield crawler.crawl(mockserver=self.mockserver) + yield crawler.crawl(mockserver=self.mockserver) assert "feedexport/success_count/FileFeedStorage" in crawler.stats.get_stats() assert "feedexport/success_count/StdoutFeedStorage" in crawler.stats.get_stats() assert crawler.stats.get_value("feedexport/success_count/FileFeedStorage") == 1 @@ -1051,7 +506,7 @@ class TestFeedExport(TestFeedExportBase): crawler.stats.get_value("feedexport/success_count/StdoutFeedStorage") == 1 ) - @deferred_f_from_coro_f + @coroutine_test async def test_export_items(self): # feed exporters use field names from Item items = [ @@ -1065,7 +520,7 @@ class TestFeedExport(TestFeedExportBase): header = self.MyItem.fields.keys() await self.assertExported(items, header, rows) - @deferred_f_from_coro_f + @coroutine_test async def test_export_no_items_not_store_empty(self): for fmt in ("json", "jsonlines", "xml", "csv"): settings = { @@ -1077,7 +532,7 @@ class TestFeedExport(TestFeedExportBase): data = await self.exported_no_data(settings) assert data[fmt] is None - @deferred_f_from_coro_f + @coroutine_test async def test_start_finish_exporting_items(self): items = [ self.MyItem({"foo": "bar1", "egg": "spam1"}), @@ -1097,7 +552,7 @@ class TestFeedExport(TestFeedExportBase): assert not listener.start_without_finish assert not listener.finish_without_start - @deferred_f_from_coro_f + @coroutine_test async def test_start_finish_exporting_no_items(self): items = [] settings = { @@ -1115,7 +570,7 @@ class TestFeedExport(TestFeedExportBase): assert not listener.start_without_finish assert not listener.finish_without_start - @deferred_f_from_coro_f + @coroutine_test async def test_start_finish_exporting_items_exception(self): items = [ self.MyItem({"foo": "bar1", "egg": "spam1"}), @@ -1136,7 +591,7 @@ class TestFeedExport(TestFeedExportBase): assert not listener.start_without_finish assert not listener.finish_without_start - @deferred_f_from_coro_f + @coroutine_test async def test_start_finish_exporting_no_items_exception(self): items = [] settings = { @@ -1155,7 +610,7 @@ class TestFeedExport(TestFeedExportBase): assert not listener.start_without_finish assert not listener.finish_without_start - @deferred_f_from_coro_f + @coroutine_test async def test_export_no_items_store_empty(self): formats = ( ("json", b"[]"), @@ -1175,7 +630,7 @@ class TestFeedExport(TestFeedExportBase): data = await self.exported_no_data(settings) assert expctd == data[fmt] - @deferred_f_from_coro_f + @coroutine_test async def test_export_no_items_multiple_feeds(self): """Make sure that `storage.store` is called for every feed.""" settings = { @@ -1193,7 +648,7 @@ class TestFeedExport(TestFeedExportBase): assert str(log).count("Storage.store is called") == 0 - @deferred_f_from_coro_f + @coroutine_test async def test_export_multiple_item_classes(self): items = [ self.MyItem({"foo": "bar1", "egg": "spam1"}), @@ -1215,7 +670,7 @@ class TestFeedExport(TestFeedExportBase): await self.assertExportedCsv(items, header, rows_csv) await self.assertExportedJsonLines(items, rows_jl) - @deferred_f_from_coro_f + @coroutine_test async def test_export_items_empty_field_list(self): # FEED_EXPORT_FIELDS==[] means the same as default None items = [{"foo": "bar"}] @@ -1225,7 +680,7 @@ class TestFeedExport(TestFeedExportBase): await self.assertExportedCsv(items, header, rows) await self.assertExportedJsonLines(items, rows, settings) - @deferred_f_from_coro_f + @coroutine_test async def test_export_items_field_list(self): items = [{"foo": "bar"}] header = ["foo", "baz"] @@ -1233,7 +688,7 @@ class TestFeedExport(TestFeedExportBase): settings = {"FEED_EXPORT_FIELDS": header} await self.assertExported(items, header, rows, settings=settings) - @deferred_f_from_coro_f + @coroutine_test async def test_export_items_comma_separated_field_list(self): items = [{"foo": "bar"}] header = ["foo", "baz"] @@ -1241,7 +696,7 @@ class TestFeedExport(TestFeedExportBase): settings = {"FEED_EXPORT_FIELDS": ",".join(header)} await self.assertExported(items, header, rows, settings=settings) - @deferred_f_from_coro_f + @coroutine_test async def test_export_items_json_field_list(self): items = [{"foo": "bar"}] header = ["foo", "baz"] @@ -1249,7 +704,7 @@ class TestFeedExport(TestFeedExportBase): settings = {"FEED_EXPORT_FIELDS": json.dumps(header)} await self.assertExported(items, header, rows, settings=settings) - @deferred_f_from_coro_f + @coroutine_test async def test_export_items_field_names(self): items = [{"foo": "bar"}] header = {"foo": "Foo"} @@ -1257,7 +712,7 @@ class TestFeedExport(TestFeedExportBase): settings = {"FEED_EXPORT_FIELDS": header} await self.assertExported(items, list(header.values()), rows, settings=settings) - @deferred_f_from_coro_f + @coroutine_test async def test_export_items_dict_field_names(self): items = [{"foo": "bar"}] header = { @@ -1268,7 +723,7 @@ class TestFeedExport(TestFeedExportBase): settings = {"FEED_EXPORT_FIELDS": header} await self.assertExported(items, ["Baz", "Foo"], rows, settings=settings) - @deferred_f_from_coro_f + @coroutine_test async def test_export_items_json_field_names(self): items = [{"foo": "bar"}] header = {"foo": "Foo"} @@ -1276,7 +731,7 @@ class TestFeedExport(TestFeedExportBase): settings = {"FEED_EXPORT_FIELDS": json.dumps(header)} await self.assertExported(items, list(header.values()), rows, settings=settings) - @deferred_f_from_coro_f + @coroutine_test async def test_export_based_on_item_classes(self): items = [ self.MyItem({"foo": "bar1", "egg": "spam1"}), @@ -1322,7 +777,7 @@ class TestFeedExport(TestFeedExportBase): for fmt, expected in formats.items(): assert data[fmt] == expected - @deferred_f_from_coro_f + @coroutine_test async def test_export_based_on_custom_filters(self): items = [ self.MyItem({"foo": "bar1", "egg": "spam1"}), @@ -1381,7 +836,7 @@ class TestFeedExport(TestFeedExportBase): for fmt, expected in formats.items(): assert data[fmt] == expected - @deferred_f_from_coro_f + @coroutine_test async def test_export_dicts(self): # When dicts are used, only keys from the first row are used as # a header for CSV, and all fields are used for JSON Lines. @@ -1394,7 +849,7 @@ class TestFeedExport(TestFeedExportBase): await self.assertExportedCsv(items, ["foo", "egg"], rows_csv) await self.assertExportedJsonLines(items, rows_jl) - @deferred_f_from_coro_f + @coroutine_test async def test_export_tuple(self): items = [ {"foo": "bar1", "egg": "spam1"}, @@ -1405,7 +860,7 @@ class TestFeedExport(TestFeedExportBase): rows = [{"foo": "bar1", "baz": ""}, {"foo": "bar2", "baz": "quux"}] await self.assertExported(items, ["foo", "baz"], rows, settings=settings) - @deferred_f_from_coro_f + @coroutine_test async def test_export_feed_export_fields(self): # FEED_EXPORT_FIELDS option allows to order export fields # and to select a subset of fields to export, both for Items and dicts. @@ -1431,7 +886,7 @@ class TestFeedExport(TestFeedExportBase): rows = [{"egg": "spam1", "baz": ""}, {"egg": "spam2", "baz": "quux2"}] await self.assertExported(items, ["egg", "baz"], rows, settings=settings) - @deferred_f_from_coro_f + @coroutine_test async def test_export_encoding(self): items = [{"foo": "Test\xd6"}] @@ -1476,7 +931,7 @@ class TestFeedExport(TestFeedExportBase): data = await self.exported_data(items, settings) assert data[fmt] == expected - @deferred_f_from_coro_f + @coroutine_test async def test_export_multiple_configs(self): items = [{"foo": "FOO", "bar": "BAR"}] @@ -1516,7 +971,7 @@ class TestFeedExport(TestFeedExportBase): for fmt, expected in formats.items(): assert data[fmt] == expected - @deferred_f_from_coro_f + @coroutine_test async def test_export_indentation(self): items = [ {"foo": ["bar"]}, @@ -1672,7 +1127,7 @@ class TestFeedExport(TestFeedExportBase): data = await self.exported_data(items, settings) assert data[row["format"]] == row["expected"] - @deferred_f_from_coro_f + @coroutine_test async def test_init_exporters_storages_with_crawler(self): settings = { "FEED_EXPORTERS": {"csv": FromCrawlerCsvItemExporter}, @@ -1685,7 +1140,7 @@ class TestFeedExport(TestFeedExportBase): assert FromCrawlerCsvItemExporter.init_with_crawler assert FromCrawlerFileFeedStorage.init_with_crawler - @deferred_f_from_coro_f + @coroutine_test async def test_str_uri(self): settings = { "FEED_STORE_EMPTY": True, @@ -1694,7 +1149,7 @@ class TestFeedExport(TestFeedExportBase): data = await self.exported_no_data(settings) assert data["csv"] == b"" - @deferred_f_from_coro_f + @coroutine_test async def test_multiple_feeds_success_logs_blocking_feed_storage(self): settings = { "FEEDS": { @@ -1711,11 +1166,10 @@ class TestFeedExport(TestFeedExportBase): with LogCapture() as log: await self.exported_data(items, settings) - print(log) for fmt in ["json", "xml", "csv"]: assert f"Stored {fmt} feed (2 items)" in str(log) - @deferred_f_from_coro_f + @coroutine_test async def test_multiple_feeds_failing_logs_blocking_feed_storage(self): settings = { "FEEDS": { @@ -1732,11 +1186,10 @@ class TestFeedExport(TestFeedExportBase): with LogCapture() as log: await self.exported_data(items, settings) - print(log) for fmt in ["json", "xml", "csv"]: assert f"Error storing {fmt} feed (2 items)" in str(log) - @deferred_f_from_coro_f + @coroutine_test async def test_extend_kwargs(self): items = [{"foo": "FOO", "bar": "BAR"}] @@ -1773,7 +1226,7 @@ class TestFeedExport(TestFeedExportBase): data = await self.exported_data(items, settings) assert data[feed_options["format"]] == row["expected"] - @deferred_f_from_coro_f + @coroutine_test async def test_storage_file_no_postprocessing(self): @implementer(IFeedStorage) class Storage: @@ -1795,7 +1248,7 @@ class TestFeedExport(TestFeedExportBase): await self.exported_no_data(settings) assert Storage.open_file is Storage.store_file - @deferred_f_from_coro_f + @coroutine_test async def test_storage_file_postprocessing(self): @implementer(IFeedStorage) class Storage: @@ -1827,945 +1280,6 @@ class TestFeedExport(TestFeedExportBase): assert not Storage.file_was_closed -class TestFeedPostProcessedExports(TestFeedExportBase): - items = [{"foo": "bar"}] - expected = b"foo\r\nbar\r\n" - - class MyPlugin1: - def __init__(self, file, feed_options): - self.file = file - self.feed_options = feed_options - self.char = self.feed_options.get("plugin1_char", b"") - - def write(self, data): - written_count = self.file.write(data) - written_count += self.file.write(self.char) - return written_count - - def close(self): - self.file.close() - - def _named_tempfile(self, name) -> str: - return str(Path(self.temp_dir, name)) - - async def run_and_export( - self, spider_cls: type[Spider], settings: dict[str, Any] - ) -> dict[str, bytes | None]: - """Run spider with specified settings; return exported data with filename.""" - - FEEDS = settings.get("FEEDS") or {} - settings["FEEDS"] = { - printf_escape(path_to_url(file_path)): feed_options - for file_path, feed_options in FEEDS.items() - } - - content: dict[str, bytes | None] = {} - try: - spider_cls.start_urls = [self.mockserver.url("/")] - crawler = get_crawler(spider_cls, settings) - await maybe_deferred_to_future(crawler.crawl()) - - for file_path in FEEDS: - content[str(file_path)] = ( - Path(file_path).read_bytes() if Path(file_path).exists() else None - ) - - finally: - for file_path in FEEDS: - if not Path(file_path).exists(): - continue - - Path(file_path).unlink() - - return content - - def get_gzip_compressed(self, data, compresslevel=9, mtime=0, filename=""): - data_stream = BytesIO() - gzipf = gzip.GzipFile( - fileobj=data_stream, - filename=filename, - mtime=mtime, - compresslevel=compresslevel, - mode="wb", - ) - gzipf.write(data) - gzipf.close() - data_stream.seek(0) - return data_stream.read() - - @deferred_f_from_coro_f - async def test_gzip_plugin(self): - filename = self._named_tempfile("gzip_file") - - settings = { - "FEEDS": { - filename: { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], - }, - }, - } - - data = await self.exported_data(self.items, settings) - try: - gzip.decompress(data[filename]) - except OSError: - pytest.fail("Received invalid gzip data.") - - @deferred_f_from_coro_f - async def test_gzip_plugin_compresslevel(self): - filename_to_compressed = { - self._named_tempfile("compresslevel_0"): self.get_gzip_compressed( - self.expected, compresslevel=0 - ), - self._named_tempfile("compresslevel_9"): self.get_gzip_compressed( - self.expected, compresslevel=9 - ), - } - - settings = { - "FEEDS": { - self._named_tempfile("compresslevel_0"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], - "gzip_compresslevel": 0, - "gzip_mtime": 0, - "gzip_filename": "", - }, - self._named_tempfile("compresslevel_9"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], - "gzip_compresslevel": 9, - "gzip_mtime": 0, - "gzip_filename": "", - }, - }, - } - - data = await self.exported_data(self.items, settings) - - for filename, compressed in filename_to_compressed.items(): - result = gzip.decompress(data[filename]) - assert compressed == data[filename] - assert result == self.expected - - @deferred_f_from_coro_f - async def test_gzip_plugin_mtime(self): - filename_to_compressed = { - self._named_tempfile("mtime_123"): self.get_gzip_compressed( - self.expected, mtime=123 - ), - self._named_tempfile("mtime_123456789"): self.get_gzip_compressed( - self.expected, mtime=123456789 - ), - } - - settings = { - "FEEDS": { - self._named_tempfile("mtime_123"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], - "gzip_mtime": 123, - "gzip_filename": "", - }, - self._named_tempfile("mtime_123456789"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], - "gzip_mtime": 123456789, - "gzip_filename": "", - }, - }, - } - - data = await self.exported_data(self.items, settings) - - for filename, compressed in filename_to_compressed.items(): - result = gzip.decompress(data[filename]) - assert compressed == data[filename] - assert result == self.expected - - @deferred_f_from_coro_f - async def test_gzip_plugin_filename(self): - filename_to_compressed = { - self._named_tempfile("filename_FILE1"): self.get_gzip_compressed( - self.expected, filename="FILE1" - ), - self._named_tempfile("filename_FILE2"): self.get_gzip_compressed( - self.expected, filename="FILE2" - ), - } - - settings = { - "FEEDS": { - self._named_tempfile("filename_FILE1"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], - "gzip_mtime": 0, - "gzip_filename": "FILE1", - }, - self._named_tempfile("filename_FILE2"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], - "gzip_mtime": 0, - "gzip_filename": "FILE2", - }, - }, - } - - data = await self.exported_data(self.items, settings) - - for filename, compressed in filename_to_compressed.items(): - result = gzip.decompress(data[filename]) - assert compressed == data[filename] - assert result == self.expected - - @deferred_f_from_coro_f - async def test_lzma_plugin(self): - filename = self._named_tempfile("lzma_file") - - settings = { - "FEEDS": { - filename: { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], - }, - }, - } - - data = await self.exported_data(self.items, settings) - try: - lzma.decompress(data[filename]) - except lzma.LZMAError: - pytest.fail("Received invalid lzma data.") - - @deferred_f_from_coro_f - async def test_lzma_plugin_format(self): - filename_to_compressed = { - self._named_tempfile("format_FORMAT_XZ"): lzma.compress( - self.expected, format=lzma.FORMAT_XZ - ), - self._named_tempfile("format_FORMAT_ALONE"): lzma.compress( - self.expected, format=lzma.FORMAT_ALONE - ), - } - - settings = { - "FEEDS": { - self._named_tempfile("format_FORMAT_XZ"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], - "lzma_format": lzma.FORMAT_XZ, - }, - self._named_tempfile("format_FORMAT_ALONE"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], - "lzma_format": lzma.FORMAT_ALONE, - }, - }, - } - - data = await self.exported_data(self.items, settings) - - for filename, compressed in filename_to_compressed.items(): - result = lzma.decompress(data[filename]) - assert compressed == data[filename] - assert result == self.expected - - @deferred_f_from_coro_f - async def test_lzma_plugin_check(self): - filename_to_compressed = { - self._named_tempfile("check_CHECK_NONE"): lzma.compress( - self.expected, check=lzma.CHECK_NONE - ), - self._named_tempfile("check_CHECK_CRC256"): lzma.compress( - self.expected, check=lzma.CHECK_SHA256 - ), - } - - settings = { - "FEEDS": { - self._named_tempfile("check_CHECK_NONE"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], - "lzma_check": lzma.CHECK_NONE, - }, - self._named_tempfile("check_CHECK_CRC256"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], - "lzma_check": lzma.CHECK_SHA256, - }, - }, - } - - data = await self.exported_data(self.items, settings) - - for filename, compressed in filename_to_compressed.items(): - result = lzma.decompress(data[filename]) - assert compressed == data[filename] - assert result == self.expected - - @deferred_f_from_coro_f - async def test_lzma_plugin_preset(self): - filename_to_compressed = { - self._named_tempfile("preset_PRESET_0"): lzma.compress( - self.expected, preset=0 - ), - self._named_tempfile("preset_PRESET_9"): lzma.compress( - self.expected, preset=9 - ), - } - - settings = { - "FEEDS": { - self._named_tempfile("preset_PRESET_0"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], - "lzma_preset": 0, - }, - self._named_tempfile("preset_PRESET_9"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], - "lzma_preset": 9, - }, - }, - } - - data = await self.exported_data(self.items, settings) - - for filename, compressed in filename_to_compressed.items(): - result = lzma.decompress(data[filename]) - assert compressed == data[filename] - assert result == self.expected - - @deferred_f_from_coro_f - async def test_lzma_plugin_filters(self): - if "PyPy" in sys.version: - # https://foss.heptapod.net/pypy/pypy/-/issues/3527 - pytest.skip("lzma filters doesn't work in PyPy") - - filters = [{"id": lzma.FILTER_LZMA2}] - compressed = lzma.compress(self.expected, filters=filters) - filename = self._named_tempfile("filters") - - settings = { - "FEEDS": { - filename: { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], - "lzma_filters": filters, - }, - }, - } - - data = await self.exported_data(self.items, settings) - assert compressed == data[filename] - result = lzma.decompress(data[filename]) - assert result == self.expected - - @deferred_f_from_coro_f - async def test_bz2_plugin(self): - filename = self._named_tempfile("bz2_file") - - settings = { - "FEEDS": { - filename: { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.Bz2Plugin"], - }, - }, - } - - data = await self.exported_data(self.items, settings) - try: - bz2.decompress(data[filename]) - except OSError: - pytest.fail("Received invalid bz2 data.") - - @deferred_f_from_coro_f - async def test_bz2_plugin_compresslevel(self): - filename_to_compressed = { - self._named_tempfile("compresslevel_1"): bz2.compress( - self.expected, compresslevel=1 - ), - self._named_tempfile("compresslevel_9"): bz2.compress( - self.expected, compresslevel=9 - ), - } - - settings = { - "FEEDS": { - self._named_tempfile("compresslevel_1"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.Bz2Plugin"], - "bz2_compresslevel": 1, - }, - self._named_tempfile("compresslevel_9"): { - "format": "csv", - "postprocessing": ["scrapy.extensions.postprocessing.Bz2Plugin"], - "bz2_compresslevel": 9, - }, - }, - } - - data = await self.exported_data(self.items, settings) - - for filename, compressed in filename_to_compressed.items(): - result = bz2.decompress(data[filename]) - assert compressed == data[filename] - assert result == self.expected - - @deferred_f_from_coro_f - async def test_custom_plugin(self): - filename = self._named_tempfile("csv_file") - - settings = { - "FEEDS": { - filename: { - "format": "csv", - "postprocessing": [self.MyPlugin1], - }, - }, - } - - data = await self.exported_data(self.items, settings) - assert data[filename] == self.expected - - @deferred_f_from_coro_f - async def test_custom_plugin_with_parameter(self): - expected = b"foo\r\n\nbar\r\n\n" - filename = self._named_tempfile("newline") - - settings = { - "FEEDS": { - filename: { - "format": "csv", - "postprocessing": [self.MyPlugin1], - "plugin1_char": b"\n", - }, - }, - } - - data = await self.exported_data(self.items, settings) - assert data[filename] == expected - - @deferred_f_from_coro_f - async def test_custom_plugin_with_compression(self): - expected = b"foo\r\n\nbar\r\n\n" - - filename_to_decompressor = { - self._named_tempfile("bz2"): bz2.decompress, - self._named_tempfile("lzma"): lzma.decompress, - self._named_tempfile("gzip"): gzip.decompress, - } - - settings = { - "FEEDS": { - self._named_tempfile("bz2"): { - "format": "csv", - "postprocessing": [ - self.MyPlugin1, - "scrapy.extensions.postprocessing.Bz2Plugin", - ], - "plugin1_char": b"\n", - }, - self._named_tempfile("lzma"): { - "format": "csv", - "postprocessing": [ - self.MyPlugin1, - "scrapy.extensions.postprocessing.LZMAPlugin", - ], - "plugin1_char": b"\n", - }, - self._named_tempfile("gzip"): { - "format": "csv", - "postprocessing": [ - self.MyPlugin1, - "scrapy.extensions.postprocessing.GzipPlugin", - ], - "plugin1_char": b"\n", - }, - }, - } - - data = await self.exported_data(self.items, settings) - - for filename, decompressor in filename_to_decompressor.items(): - result = decompressor(data[filename]) - assert result == expected - - @deferred_f_from_coro_f - async def test_exports_compatibility_with_postproc(self): - import marshal - import pickle - - filename_to_expected = { - self._named_tempfile("csv"): b"foo\r\nbar\r\n", - self._named_tempfile("json"): b'[\n{"foo": "bar"}\n]', - self._named_tempfile("jsonlines"): b'{"foo": "bar"}\n', - self._named_tempfile("xml"): b'\n' - b"\nbar\n", - } - - settings = { - "FEEDS": { - self._named_tempfile("csv"): { - "format": "csv", - "postprocessing": [self.MyPlugin1], - # empty plugin to activate postprocessing.PostProcessingManager - }, - self._named_tempfile("json"): { - "format": "json", - "postprocessing": [self.MyPlugin1], - }, - self._named_tempfile("jsonlines"): { - "format": "jsonlines", - "postprocessing": [self.MyPlugin1], - }, - self._named_tempfile("xml"): { - "format": "xml", - "postprocessing": [self.MyPlugin1], - }, - self._named_tempfile("marshal"): { - "format": "marshal", - "postprocessing": [self.MyPlugin1], - }, - self._named_tempfile("pickle"): { - "format": "pickle", - "postprocessing": [self.MyPlugin1], - }, - }, - } - - data = await self.exported_data(self.items, settings) - - for filename, result in data.items(): - if "pickle" in filename: - expected, result = self.items[0], pickle.loads(result) - elif "marshal" in filename: - expected, result = self.items[0], marshal.loads(result) - else: - expected = filename_to_expected[filename] - assert result == expected - - -class TestBatchDeliveries(TestFeedExportBase): - _file_mark = "_%(batch_time)s_#%(batch_id)02d_" - - async def run_and_export( - self, spider_cls: type[Spider], settings: dict[str, Any] - ) -> dict[str, list[bytes]]: - """Run spider with specified settings; return exported data.""" - - FEEDS = settings.get("FEEDS") or {} - settings["FEEDS"] = { - build_url(file_path): feed for file_path, feed in FEEDS.items() - } - content: defaultdict[str, list[bytes]] = defaultdict(list) - spider_cls.start_urls = [self.mockserver.url("/")] - crawler = get_crawler(spider_cls, settings) - await maybe_deferred_to_future(crawler.crawl()) - - for path, feed in FEEDS.items(): - dir_name = Path(path).parent - if not dir_name.exists(): - content[feed["format"]] = [] - continue - for file in sorted(dir_name.iterdir()): - content[feed["format"]].append(file.read_bytes()) - return content - - async def assertExportedJsonLines(self, items, rows, settings=None): - settings = settings or {} - settings.update( - { - "FEEDS": { - self._random_temp_filename() / "jl" / self._file_mark: { - "format": "jl" - }, - }, - } - ) - batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") - rows = [{k: v for k, v in row.items() if v} for row in rows] - data = await self.exported_data(items, settings) - for batch in data["jl"]: - got_batch = [ - json.loads(to_unicode(batch_item)) for batch_item in batch.splitlines() - ] - expected_batch, rows = rows[:batch_size], rows[batch_size:] - assert got_batch == expected_batch - - async def assertExportedCsv(self, items, header, rows, settings=None): - settings = settings or {} - settings.update( - { - "FEEDS": { - self._random_temp_filename() / "csv" / self._file_mark: { - "format": "csv" - }, - }, - } - ) - batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") - data = await self.exported_data(items, settings) - for batch in data["csv"]: - got_batch = csv.DictReader(to_unicode(batch).splitlines()) - assert list(header) == got_batch.fieldnames - expected_batch, rows = rows[:batch_size], rows[batch_size:] - assert list(got_batch) == expected_batch - - async def assertExportedXml(self, items, rows, settings=None): - settings = settings or {} - settings.update( - { - "FEEDS": { - self._random_temp_filename() / "xml" / self._file_mark: { - "format": "xml" - }, - }, - } - ) - batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") - rows = [{k: v for k, v in row.items() if v} for row in rows] - data = await self.exported_data(items, settings) - for batch in data["xml"]: - root = lxml.etree.fromstring(batch) - got_batch = [{e.tag: e.text for e in it} for it in root.findall("item")] - expected_batch, rows = rows[:batch_size], rows[batch_size:] - assert got_batch == expected_batch - - async def assertExportedMultiple(self, items, rows, settings=None): - settings = settings or {} - settings.update( - { - "FEEDS": { - self._random_temp_filename() / "xml" / self._file_mark: { - "format": "xml" - }, - self._random_temp_filename() / "json" / self._file_mark: { - "format": "json" - }, - }, - } - ) - batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") - rows = [{k: v for k, v in row.items() if v} for row in rows] - data = await self.exported_data(items, settings) - # XML - xml_rows = rows.copy() - for batch in data["xml"]: - root = lxml.etree.fromstring(batch) - got_batch = [{e.tag: e.text for e in it} for it in root.findall("item")] - expected_batch, xml_rows = xml_rows[:batch_size], xml_rows[batch_size:] - assert got_batch == expected_batch - # JSON - json_rows = rows.copy() - for batch in data["json"]: - got_batch = json.loads(batch.decode("utf-8")) - expected_batch, json_rows = json_rows[:batch_size], json_rows[batch_size:] - assert got_batch == expected_batch - - async def assertExportedPickle(self, items, rows, settings=None): - settings = settings or {} - settings.update( - { - "FEEDS": { - self._random_temp_filename() / "pickle" / self._file_mark: { - "format": "pickle" - }, - }, - } - ) - batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") - rows = [{k: v for k, v in row.items() if v} for row in rows] - data = await self.exported_data(items, settings) - import pickle - - for batch in data["pickle"]: - got_batch = self._load_until_eof(batch, load_func=pickle.load) - expected_batch, rows = rows[:batch_size], rows[batch_size:] - assert got_batch == expected_batch - - async def assertExportedMarshal(self, items, rows, settings=None): - settings = settings or {} - settings.update( - { - "FEEDS": { - self._random_temp_filename() / "marshal" / self._file_mark: { - "format": "marshal" - }, - }, - } - ) - batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") - rows = [{k: v for k, v in row.items() if v} for row in rows] - data = await self.exported_data(items, settings) - import marshal - - for batch in data["marshal"]: - got_batch = self._load_until_eof(batch, load_func=marshal.load) - expected_batch, rows = rows[:batch_size], rows[batch_size:] - assert got_batch == expected_batch - - @deferred_f_from_coro_f - async def test_export_items(self): - """Test partial deliveries in all supported formats""" - items = [ - self.MyItem({"foo": "bar1", "egg": "spam1"}), - self.MyItem({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), - self.MyItem({"foo": "bar3", "baz": "quux3"}), - ] - rows = [ - {"egg": "spam1", "foo": "bar1", "baz": ""}, - {"egg": "spam2", "foo": "bar2", "baz": "quux2"}, - {"foo": "bar3", "baz": "quux3", "egg": ""}, - ] - settings = {"FEED_EXPORT_BATCH_ITEM_COUNT": 2} - header = self.MyItem.fields.keys() - await self.assertExported(items, header, rows, settings=settings) - - def test_wrong_path(self): - """If path is without %(batch_time)s and %(batch_id) an exception must be raised""" - settings = { - "FEEDS": { - self._random_temp_filename(): {"format": "xml"}, - }, - "FEED_EXPORT_BATCH_ITEM_COUNT": 1, - } - crawler = get_crawler(settings_dict=settings) - with pytest.raises(NotConfigured): - FeedExporter(crawler) - - @deferred_f_from_coro_f - async def test_export_no_items_not_store_empty(self): - for fmt in ("json", "jsonlines", "xml", "csv"): - settings = { - "FEEDS": { - self._random_temp_filename() / fmt / self._file_mark: { - "format": fmt - }, - }, - "FEED_EXPORT_BATCH_ITEM_COUNT": 1, - "FEED_STORE_EMPTY": False, - } - data = await self.exported_no_data(settings) - data = dict(data) - assert len(data[fmt]) == 0 - - @deferred_f_from_coro_f - async def test_export_no_items_store_empty(self): - formats = ( - ("json", b"[]"), - ("jsonlines", b""), - ("xml", b'\n'), - ("csv", b""), - ) - - for fmt, expctd in formats: - settings = { - "FEEDS": { - self._random_temp_filename() / fmt / self._file_mark: { - "format": fmt - }, - }, - "FEED_STORE_EMPTY": True, - "FEED_EXPORT_INDENT": None, - "FEED_EXPORT_BATCH_ITEM_COUNT": 1, - } - data = await self.exported_no_data(settings) - data = dict(data) - assert data[fmt][0] == expctd - - @deferred_f_from_coro_f - async def test_export_multiple_configs(self): - items = [ - {"foo": "FOO", "bar": "BAR"}, - {"foo": "FOO1", "bar": "BAR1"}, - ] - - formats = { - "json": [ - b'[\n{"bar": "BAR"}\n]', - b'[\n{"bar": "BAR1"}\n]', - ], - "xml": [ - ( - b'\n' - b"\n \n FOO\n \n" - ), - ( - b'\n' - b"\n \n FOO1\n \n" - ), - ], - "csv": [ - b"foo,bar\r\nFOO,BAR\r\n", - b"foo,bar\r\nFOO1,BAR1\r\n", - ], - } - - settings = { - "FEEDS": { - self._random_temp_filename() / "json" / self._file_mark: { - "format": "json", - "indent": 0, - "fields": ["bar"], - "encoding": "utf-8", - }, - self._random_temp_filename() / "xml" / self._file_mark: { - "format": "xml", - "indent": 2, - "fields": ["foo"], - "encoding": "latin-1", - }, - self._random_temp_filename() / "csv" / self._file_mark: { - "format": "csv", - "indent": None, - "fields": ["foo", "bar"], - "encoding": "utf-8", - }, - }, - "FEED_EXPORT_BATCH_ITEM_COUNT": 1, - } - data = await self.exported_data(items, settings) - for fmt, expected in formats.items(): - for expected_batch, got_batch in zip(expected, data[fmt]): - assert got_batch == expected_batch - - @deferred_f_from_coro_f - async def test_batch_item_count_feeds_setting(self): - items = [{"foo": "FOO"}, {"foo": "FOO1"}] - formats = { - "json": [ - b'[{"foo": "FOO"}]', - b'[{"foo": "FOO1"}]', - ], - } - settings = { - "FEEDS": { - self._random_temp_filename() / "json" / self._file_mark: { - "format": "json", - "indent": None, - "encoding": "utf-8", - "batch_item_count": 1, - }, - }, - } - data = await self.exported_data(items, settings) - for fmt, expected in formats.items(): - for expected_batch, got_batch in zip(expected, data[fmt]): - assert got_batch == expected_batch - - @deferred_f_from_coro_f - async def test_batch_path_differ(self): - """ - Test that the name of all batch files differ from each other. - So %(batch_id)d replaced with the current id. - """ - items = [ - self.MyItem({"foo": "bar1", "egg": "spam1"}), - self.MyItem({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), - self.MyItem({"foo": "bar3", "baz": "quux3"}), - ] - settings = { - "FEEDS": { - self._random_temp_filename() / "%(batch_id)d": { - "format": "json", - }, - }, - "FEED_EXPORT_BATCH_ITEM_COUNT": 1, - } - data = await self.exported_data(items, settings) - assert len(items) == len(data["json"]) - - @inlineCallbacks - def test_stats_batch_file_success(self): - settings = { - "FEEDS": { - build_url( - str(self._random_temp_filename() / "json" / self._file_mark) - ): { - "format": "json", - } - }, - "FEED_EXPORT_BATCH_ITEM_COUNT": 1, - } - crawler = get_crawler(ItemSpider, settings) - yield crawler.crawl(total=2, mockserver=self.mockserver) - assert "feedexport/success_count/FileFeedStorage" in crawler.stats.get_stats() - assert crawler.stats.get_value("feedexport/success_count/FileFeedStorage") == 12 - - @pytest.mark.requires_boto3 - @inlineCallbacks - def test_s3_export(self): - bucket = "mybucket" - items = [ - self.MyItem({"foo": "bar1", "egg": "spam1"}), - self.MyItem({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), - self.MyItem({"foo": "bar3", "baz": "quux3"}), - ] - - class CustomS3FeedStorage(S3FeedStorage): - stubs = [] - - def open(self, *args, **kwargs): - from botocore import __version__ as botocore_version - from botocore.stub import ANY, Stubber - from packaging.version import Version - - expected_params = { - "Body": ANY, - "Bucket": bucket, - "Key": ANY, - } - if Version(botocore_version) >= Version("1.36.0"): - expected_params["ChecksumAlgorithm"] = ANY - - stub = Stubber(self.s3_client) - stub.activate() - CustomS3FeedStorage.stubs.append(stub) - stub.add_response( - "put_object", - expected_params=expected_params, - service_response={}, - ) - return super().open(*args, **kwargs) - - key = "export.csv" - uri = f"s3://{bucket}/{key}/%(batch_id)d.json" - batch_item_count = 1 - settings = { - "AWS_ACCESS_KEY_ID": "access_key", - "AWS_SECRET_ACCESS_KEY": "secret_key", - "FEED_EXPORT_BATCH_ITEM_COUNT": batch_item_count, - "FEED_STORAGES": { - "s3": CustomS3FeedStorage, - }, - "FEEDS": { - uri: { - "format": "json", - }, - }, - } - crawler = get_crawler(settings_dict=settings) - storage = S3FeedStorage.from_crawler(crawler, uri) - verifyObject(IFeedStorage, storage) - - class TestSpider(scrapy.Spider): - name = "testspider" - - def parse(self, response): - yield from items - - TestSpider.start_urls = [self.mockserver.url("/")] - crawler = get_crawler(TestSpider, settings) - yield crawler.crawl() - - assert len(CustomS3FeedStorage.stubs) == len(items) - for stub in CustomS3FeedStorage.stubs[:-1]: - stub.assert_no_pending_responses() - - # Test that the FeedExporer sends the feed_exporter_closed and feed_slot_closed signals class TestFeedExporterSignals: items = [ @@ -2777,7 +1291,7 @@ class TestFeedExporterSignals: with tempfile.NamedTemporaryFile(suffix="json") as tmp: settings = { "FEEDS": { - f"file:///{tmp.name}": { + printf_escape(path_to_url(tmp.name)): { "format": "json", }, }, @@ -2789,21 +1303,17 @@ class TestFeedExporterSignals: def feed_slot_closed_signal_handler(self, slot): self.feed_slot_closed_received = True - def feed_exporter_closed_signal_handler_deferred(self): - d = defer.Deferred() - d.addCallback(lambda _: setattr(self, "feed_exporter_closed_received", True)) - d.callback(None) - return d + async def feed_exporter_closed_signal_handler_async(self): + self.feed_exporter_closed_received = True - def feed_slot_closed_signal_handler_deferred(self, slot): - d = defer.Deferred() - d.addCallback(lambda _: setattr(self, "feed_slot_closed_received", True)) - d.callback(None) - return d + async def feed_slot_closed_signal_handler_async(self, slot): + self.feed_slot_closed_received = True - def run_signaled_feed_exporter( - self, feed_exporter_signal_handler, feed_slot_signal_handler - ): + async def run_signaled_feed_exporter( + self, + feed_exporter_signal_handler: Callable[[], Awaitable[None] | None], + feed_slot_signal_handler: Callable[[Any], Awaitable[None] | None], + ) -> None: crawler = get_crawler(settings_dict=self.settings) feed_exporter = FeedExporter.from_crawler(crawler) spider = scrapy.Spider("default") @@ -2818,26 +1328,28 @@ class TestFeedExporterSignals: feed_exporter.open_spider(spider) for item in self.items: feed_exporter.item_scraped(item, spider) - defer.ensureDeferred(feed_exporter.close_spider(spider)) + await feed_exporter.close_spider(spider) - def test_feed_exporter_signals_sent(self): + @coroutine_test + async def test_feed_exporter_signals_sent(self) -> None: self.feed_exporter_closed_received = False self.feed_slot_closed_received = False - self.run_signaled_feed_exporter( + await self.run_signaled_feed_exporter( self.feed_exporter_closed_signal_handler, self.feed_slot_closed_signal_handler, ) assert self.feed_slot_closed_received assert self.feed_exporter_closed_received - def test_feed_exporter_signals_sent_deferred(self): + @coroutine_test + async def test_feed_exporter_signals_sent_async(self) -> None: self.feed_exporter_closed_received = False self.feed_slot_closed_received = False - self.run_signaled_feed_exporter( - self.feed_exporter_closed_signal_handler_deferred, - self.feed_slot_closed_signal_handler_deferred, + await self.run_signaled_feed_exporter( + self.feed_exporter_closed_signal_handler_async, + self.feed_slot_closed_signal_handler_async, ) assert self.feed_slot_closed_received assert self.feed_exporter_closed_received @@ -2890,135 +1402,3 @@ class TestFeedExportInit: crawler = get_crawler(settings_dict=settings) exporter = FeedExporter.from_crawler(crawler) assert isinstance(exporter, FeedExporter) - - -class TestURIParams(ABC): - spider_name = "uri_params_spider" - deprecated_options = False - - @abstractmethod - def build_settings(self, uri="file:///tmp/foobar", uri_params=None): - raise NotImplementedError - - def _crawler_feed_exporter(self, settings): - if self.deprecated_options: - with pytest.warns( - ScrapyDeprecationWarning, - match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated", - ): - crawler = get_crawler(settings_dict=settings) - feed_exporter = FeedExporter.from_crawler(crawler) - else: - crawler = get_crawler(settings_dict=settings) - feed_exporter = FeedExporter.from_crawler(crawler) - return crawler, feed_exporter - - def test_default(self): - settings = self.build_settings( - uri="file:///tmp/%(name)s", - ) - crawler, feed_exporter = self._crawler_feed_exporter(settings) - spider = scrapy.Spider(self.spider_name) - spider.crawler = crawler - - with warnings.catch_warnings(): - warnings.simplefilter("error", ScrapyDeprecationWarning) - feed_exporter.open_spider(spider) - - assert feed_exporter.slots[0].uri == f"file:///tmp/{self.spider_name}" - - def test_none(self): - def uri_params(params, spider): - pass - - settings = self.build_settings( - uri="file:///tmp/%(name)s", - uri_params=uri_params, - ) - crawler, feed_exporter = self._crawler_feed_exporter(settings) - spider = scrapy.Spider(self.spider_name) - spider.crawler = crawler - - feed_exporter.open_spider(spider) - - assert feed_exporter.slots[0].uri == f"file:///tmp/{self.spider_name}" - - def test_empty_dict(self): - def uri_params(params, spider): - return {} - - settings = self.build_settings( - uri="file:///tmp/%(name)s", - uri_params=uri_params, - ) - crawler, feed_exporter = self._crawler_feed_exporter(settings) - spider = scrapy.Spider(self.spider_name) - spider.crawler = crawler - - with warnings.catch_warnings(): - warnings.simplefilter("error", ScrapyDeprecationWarning) - with pytest.raises(KeyError): - feed_exporter.open_spider(spider) - - def test_params_as_is(self): - def uri_params(params, spider): - return params - - settings = self.build_settings( - uri="file:///tmp/%(name)s", - uri_params=uri_params, - ) - crawler, feed_exporter = self._crawler_feed_exporter(settings) - spider = scrapy.Spider(self.spider_name) - spider.crawler = crawler - with warnings.catch_warnings(): - warnings.simplefilter("error", ScrapyDeprecationWarning) - feed_exporter.open_spider(spider) - - assert feed_exporter.slots[0].uri == f"file:///tmp/{self.spider_name}" - - def test_custom_param(self): - def uri_params(params, spider): - return {**params, "foo": self.spider_name} - - settings = self.build_settings( - uri="file:///tmp/%(foo)s", - uri_params=uri_params, - ) - crawler, feed_exporter = self._crawler_feed_exporter(settings) - spider = scrapy.Spider(self.spider_name) - spider.crawler = crawler - with warnings.catch_warnings(): - warnings.simplefilter("error", ScrapyDeprecationWarning) - feed_exporter.open_spider(spider) - - assert feed_exporter.slots[0].uri == f"file:///tmp/{self.spider_name}" - - -class TestURIParamsSetting(TestURIParams): - deprecated_options = True - - def build_settings(self, uri="file:///tmp/foobar", uri_params=None): - extra_settings = {} - if uri_params: - extra_settings["FEED_URI_PARAMS"] = uri_params - return { - "FEED_URI": uri, - **extra_settings, - } - - -class TestURIParamsFeedOption(TestURIParams): - deprecated_options = False - - def build_settings(self, uri="file:///tmp/foobar", uri_params=None): - options = { - "format": "jl", - } - if uri_params: - options["uri_params"] = uri_params - return { - "FEEDS": { - uri: options, - }, - } diff --git a/tests/test_feedexport_batch.py b/tests/test_feedexport_batch.py new file mode 100644 index 000000000..0a926479b --- /dev/null +++ b/tests/test_feedexport_batch.py @@ -0,0 +1,457 @@ +from __future__ import annotations + +import csv +import json +import marshal +import pickle +from collections import defaultdict +from pathlib import Path +from typing import TYPE_CHECKING, Any +from urllib.parse import urljoin + +import lxml.etree +import pytest +from packaging.version import Version +from zope.interface.verify import verifyObject + +import scrapy +from scrapy import Spider +from scrapy.exceptions import NotConfigured +from scrapy.extensions.feedexport import FeedExporter, IFeedStorage, S3FeedStorage +from scrapy.settings import Settings +from scrapy.utils.python import to_unicode +from scrapy.utils.test import get_crawler +from tests.spiders import ItemSpider +from tests.test_feedexport import TestFeedExportBase +from tests.utils.decorators import coroutine_test, inline_callbacks_test + +if TYPE_CHECKING: + from os import PathLike + + +def build_url(path: str | PathLike[str]) -> str: + path_str = str(path) + if path_str[0] != "/": + path_str = "/" + path_str + return urljoin("file:", path_str) + + +class TestBatchDeliveries(TestFeedExportBase): + _file_mark = "_%(batch_time)s_#%(batch_id)02d_" + + async def run_and_export( + self, spider_cls: type[Spider], settings: dict[str, Any] + ) -> dict[str, list[bytes]]: + """Run spider with specified settings; return exported data.""" + + FEEDS = settings.get("FEEDS") or {} + settings["FEEDS"] = { + build_url(file_path): feed for file_path, feed in FEEDS.items() + } + content: defaultdict[str, list[bytes]] = defaultdict(list) + spider_cls.start_urls = [self.mockserver.url("/")] + crawler = get_crawler(spider_cls, settings) + await crawler.crawl_async() + + for path, feed in FEEDS.items(): + dir_name = Path(path).parent + if not dir_name.exists(): + content[feed["format"]] = [] + continue + for file in sorted(dir_name.iterdir()): + content[feed["format"]].append(file.read_bytes()) + return content + + async def assertExportedJsonLines(self, items, rows, settings=None): + settings = settings or {} + settings.update( + { + "FEEDS": { + self._random_temp_filename() / "jl" / self._file_mark: { + "format": "jl" + }, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") + rows = [{k: v for k, v in row.items() if v} for row in rows] + data = await self.exported_data(items, settings) + for batch in data["jl"]: + got_batch = [ + json.loads(to_unicode(batch_item)) for batch_item in batch.splitlines() + ] + expected_batch, rows = rows[:batch_size], rows[batch_size:] + assert got_batch == expected_batch + + async def assertExportedCsv(self, items, header, rows, settings=None): + settings = settings or {} + settings.update( + { + "FEEDS": { + self._random_temp_filename() / "csv" / self._file_mark: { + "format": "csv" + }, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") + data = await self.exported_data(items, settings) + for batch in data["csv"]: + got_batch = csv.DictReader(to_unicode(batch).splitlines()) + assert list(header) == got_batch.fieldnames + expected_batch, rows = rows[:batch_size], rows[batch_size:] + assert list(got_batch) == expected_batch + + async def assertExportedXml(self, items, rows, settings=None): + settings = settings or {} + settings.update( + { + "FEEDS": { + self._random_temp_filename() / "xml" / self._file_mark: { + "format": "xml" + }, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") + rows = [{k: v for k, v in row.items() if v} for row in rows] + data = await self.exported_data(items, settings) + for batch in data["xml"]: + root = lxml.etree.fromstring(batch) + got_batch = [{e.tag: e.text for e in it} for it in root.findall("item")] + expected_batch, rows = rows[:batch_size], rows[batch_size:] + assert got_batch == expected_batch + + async def assertExportedMultiple(self, items, rows, settings=None): + settings = settings or {} + settings.update( + { + "FEEDS": { + self._random_temp_filename() / "xml" / self._file_mark: { + "format": "xml" + }, + self._random_temp_filename() / "json" / self._file_mark: { + "format": "json" + }, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") + rows = [{k: v for k, v in row.items() if v} for row in rows] + data = await self.exported_data(items, settings) + # XML + xml_rows = rows.copy() + for batch in data["xml"]: + root = lxml.etree.fromstring(batch) + got_batch = [{e.tag: e.text for e in it} for it in root.findall("item")] + expected_batch, xml_rows = xml_rows[:batch_size], xml_rows[batch_size:] + assert got_batch == expected_batch + # JSON + json_rows = rows.copy() + for batch in data["json"]: + got_batch = json.loads(batch.decode("utf-8")) + expected_batch, json_rows = json_rows[:batch_size], json_rows[batch_size:] + assert got_batch == expected_batch + + async def assertExportedPickle(self, items, rows, settings=None): + settings = settings or {} + settings.update( + { + "FEEDS": { + self._random_temp_filename() / "pickle" / self._file_mark: { + "format": "pickle" + }, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") + rows = [{k: v for k, v in row.items() if v} for row in rows] + data = await self.exported_data(items, settings) + + for batch in data["pickle"]: + got_batch = self._load_until_eof(batch, load_func=pickle.load) + expected_batch, rows = rows[:batch_size], rows[batch_size:] + assert got_batch == expected_batch + + async def assertExportedMarshal(self, items, rows, settings=None): + settings = settings or {} + settings.update( + { + "FEEDS": { + self._random_temp_filename() / "marshal" / self._file_mark: { + "format": "marshal" + }, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") + rows = [{k: v for k, v in row.items() if v} for row in rows] + data = await self.exported_data(items, settings) + + for batch in data["marshal"]: + got_batch = self._load_until_eof(batch, load_func=marshal.load) + expected_batch, rows = rows[:batch_size], rows[batch_size:] + assert got_batch == expected_batch + + @coroutine_test + async def test_export_items(self): + """Test partial deliveries in all supported formats""" + items = [ + self.MyItem({"foo": "bar1", "egg": "spam1"}), + self.MyItem({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), + self.MyItem({"foo": "bar3", "baz": "quux3"}), + ] + rows = [ + {"egg": "spam1", "foo": "bar1", "baz": ""}, + {"egg": "spam2", "foo": "bar2", "baz": "quux2"}, + {"foo": "bar3", "baz": "quux3", "egg": ""}, + ] + settings = {"FEED_EXPORT_BATCH_ITEM_COUNT": 2} + header = self.MyItem.fields.keys() + await self.assertExported(items, header, rows, settings=settings) + + def test_wrong_path(self): + """If path is without %(batch_time)s and %(batch_id) an exception must be raised""" + settings = { + "FEEDS": { + self._random_temp_filename(): {"format": "xml"}, + }, + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, + } + crawler = get_crawler(settings_dict=settings) + with pytest.raises(NotConfigured): + FeedExporter(crawler) + + @coroutine_test + async def test_export_no_items_not_store_empty(self): + for fmt in ("json", "jsonlines", "xml", "csv"): + settings = { + "FEEDS": { + self._random_temp_filename() / fmt / self._file_mark: { + "format": fmt + }, + }, + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, + "FEED_STORE_EMPTY": False, + } + data = await self.exported_no_data(settings) + data = dict(data) + assert len(data[fmt]) == 0 + + @coroutine_test + async def test_export_no_items_store_empty(self): + formats = ( + ("json", b"[]"), + ("jsonlines", b""), + ("xml", b'\n'), + ("csv", b""), + ) + + for fmt, expctd in formats: + settings = { + "FEEDS": { + self._random_temp_filename() / fmt / self._file_mark: { + "format": fmt + }, + }, + "FEED_STORE_EMPTY": True, + "FEED_EXPORT_INDENT": None, + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, + } + data = await self.exported_no_data(settings) + data = dict(data) + assert data[fmt][0] == expctd + + @coroutine_test + async def test_export_multiple_configs(self): + items = [ + {"foo": "FOO", "bar": "BAR"}, + {"foo": "FOO1", "bar": "BAR1"}, + ] + + formats = { + "json": [ + b'[\n{"bar": "BAR"}\n]', + b'[\n{"bar": "BAR1"}\n]', + ], + "xml": [ + ( + b'\n' + b"\n \n FOO\n \n" + ), + ( + b'\n' + b"\n \n FOO1\n \n" + ), + ], + "csv": [ + b"foo,bar\r\nFOO,BAR\r\n", + b"foo,bar\r\nFOO1,BAR1\r\n", + ], + } + + settings = { + "FEEDS": { + self._random_temp_filename() / "json" / self._file_mark: { + "format": "json", + "indent": 0, + "fields": ["bar"], + "encoding": "utf-8", + }, + self._random_temp_filename() / "xml" / self._file_mark: { + "format": "xml", + "indent": 2, + "fields": ["foo"], + "encoding": "latin-1", + }, + self._random_temp_filename() / "csv" / self._file_mark: { + "format": "csv", + "indent": None, + "fields": ["foo", "bar"], + "encoding": "utf-8", + }, + }, + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, + } + data = await self.exported_data(items, settings) + for fmt, expected in formats.items(): + for expected_batch, got_batch in zip(expected, data[fmt], strict=True): + assert got_batch == expected_batch + + @coroutine_test + async def test_batch_item_count_feeds_setting(self): + items = [{"foo": "FOO"}, {"foo": "FOO1"}] + formats = { + "json": [ + b'[{"foo": "FOO"}]', + b'[{"foo": "FOO1"}]', + ], + } + settings = { + "FEEDS": { + self._random_temp_filename() / "json" / self._file_mark: { + "format": "json", + "indent": None, + "encoding": "utf-8", + "batch_item_count": 1, + }, + }, + } + data = await self.exported_data(items, settings) + for fmt, expected in formats.items(): + for expected_batch, got_batch in zip(expected, data[fmt], strict=True): + assert got_batch == expected_batch + + @coroutine_test + async def test_batch_path_differ(self): + """ + Test that the name of all batch files differ from each other. + So %(batch_id)d replaced with the current id. + """ + items = [ + self.MyItem({"foo": "bar1", "egg": "spam1"}), + self.MyItem({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), + self.MyItem({"foo": "bar3", "baz": "quux3"}), + ] + settings = { + "FEEDS": { + self._random_temp_filename() / "%(batch_id)d": { + "format": "json", + }, + }, + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, + } + data = await self.exported_data(items, settings) + assert len(items) == len(data["json"]) + + @inline_callbacks_test + def test_stats_batch_file_success(self): + settings = { + "FEEDS": { + build_url( + str(self._random_temp_filename() / "json" / self._file_mark) + ): { + "format": "json", + } + }, + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, + } + crawler = get_crawler(ItemSpider, settings) + yield crawler.crawl(total=2, mockserver=self.mockserver) + assert "feedexport/success_count/FileFeedStorage" in crawler.stats.get_stats() + assert crawler.stats.get_value("feedexport/success_count/FileFeedStorage") == 12 + + @pytest.mark.requires_boto3 + @inline_callbacks_test + def test_s3_export(self): + bucket = "mybucket" + items = [ + self.MyItem({"foo": "bar1", "egg": "spam1"}), + self.MyItem({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), + self.MyItem({"foo": "bar3", "baz": "quux3"}), + ] + + class CustomS3FeedStorage(S3FeedStorage): + stubs = [] + + def open(self, *args, **kwargs): + from botocore import __version__ as botocore_version # noqa: PLC0415 + from botocore.stub import ANY, Stubber # noqa: PLC0415 + + expected_params = { + "Body": ANY, + "Bucket": bucket, + "Key": ANY, + } + if Version(botocore_version) >= Version("1.36.0"): + expected_params["ChecksumAlgorithm"] = ANY + + stub = Stubber(self.s3_client) + stub.activate() + CustomS3FeedStorage.stubs.append(stub) + stub.add_response( + "put_object", + expected_params=expected_params, + service_response={}, + ) + return super().open(*args, **kwargs) + + key = "export.csv" + uri = f"s3://{bucket}/{key}/%(batch_id)d.json" + batch_item_count = 1 + settings = { + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + "FEED_EXPORT_BATCH_ITEM_COUNT": batch_item_count, + "FEED_STORAGES": { + "s3": CustomS3FeedStorage, + }, + "FEEDS": { + uri: { + "format": "json", + }, + }, + } + crawler = get_crawler(settings_dict=settings) + storage = S3FeedStorage.from_crawler(crawler, uri) + verifyObject(IFeedStorage, storage) + + class TestSpider(scrapy.Spider): + name = "testspider" + + def parse(self, response): + yield from items + + TestSpider.start_urls = [self.mockserver.url("/")] + crawler = get_crawler(TestSpider, settings) + yield crawler.crawl() + + assert len(CustomS3FeedStorage.stubs) == len(items) + for stub in CustomS3FeedStorage.stubs: + stub.assert_no_pending_responses() + assert ( + "feedexport/success_count/CustomS3FeedStorage" in crawler.stats.get_stats() + ) + assert ( + crawler.stats.get_value("feedexport/success_count/CustomS3FeedStorage") == 3 + ) diff --git a/tests/test_feedexport_postprocess.py b/tests/test_feedexport_postprocess.py new file mode 100644 index 000000000..6ebcab152 --- /dev/null +++ b/tests/test_feedexport_postprocess.py @@ -0,0 +1,538 @@ +from __future__ import annotations + +import bz2 +import gzip +import lzma +import marshal +import pickle +import sys +from io import BytesIO +from pathlib import Path +from typing import TYPE_CHECKING, Any + +import pytest + +from scrapy.utils.test import get_crawler +from tests.test_feedexport import TestFeedExportBase, path_to_url, printf_escape +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + from scrapy import Spider + + +class TestFeedPostProcessedExports(TestFeedExportBase): + items = [{"foo": "bar"}] + expected = b"foo\r\nbar\r\n" + + class MyPlugin1: + def __init__(self, file, feed_options): + self.file = file + self.feed_options = feed_options + self.char = self.feed_options.get("plugin1_char", b"") + + def write(self, data): + written_count = self.file.write(data) + written_count += self.file.write(self.char) + return written_count + + def close(self): + self.file.close() + + def _named_tempfile(self, name) -> str: + return str(Path(self.temp_dir, name)) + + async def run_and_export( + self, spider_cls: type[Spider], settings: dict[str, Any] + ) -> dict[str, bytes | None]: + """Run spider with specified settings; return exported data with filename.""" + + FEEDS = settings.get("FEEDS") or {} + settings["FEEDS"] = { + printf_escape(path_to_url(file_path)): feed_options + for file_path, feed_options in FEEDS.items() + } + + content: dict[str, bytes | None] = {} + try: + spider_cls.start_urls = [self.mockserver.url("/")] + crawler = get_crawler(spider_cls, settings) + await crawler.crawl_async() + + for file_path in FEEDS: + content[str(file_path)] = ( + Path(file_path).read_bytes() if Path(file_path).exists() else None + ) + + finally: + for file_path in FEEDS: + if not Path(file_path).exists(): + continue + + Path(file_path).unlink() + + return content + + def get_gzip_compressed(self, data, compresslevel=9, mtime=0, filename=""): + data_stream = BytesIO() + gzipf = gzip.GzipFile( + fileobj=data_stream, + filename=filename, + mtime=mtime, + compresslevel=compresslevel, + mode="wb", + ) + gzipf.write(data) + gzipf.close() + data_stream.seek(0) + return data_stream.read() + + @coroutine_test + async def test_gzip_plugin(self): + filename = self._named_tempfile("gzip_file") + + settings = { + "FEEDS": { + filename: { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + }, + }, + } + + data = await self.exported_data(self.items, settings) + try: + gzip.decompress(data[filename]) + except OSError: + pytest.fail("Received invalid gzip data.") + + @coroutine_test + async def test_gzip_plugin_compresslevel(self): + filename_to_compressed = { + self._named_tempfile("compresslevel_0"): self.get_gzip_compressed( + self.expected, compresslevel=0 + ), + self._named_tempfile("compresslevel_9"): self.get_gzip_compressed( + self.expected, compresslevel=9 + ), + } + + settings = { + "FEEDS": { + self._named_tempfile("compresslevel_0"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_compresslevel": 0, + "gzip_mtime": 0, + "gzip_filename": "", + }, + self._named_tempfile("compresslevel_9"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_compresslevel": 9, + "gzip_mtime": 0, + "gzip_filename": "", + }, + }, + } + + data = await self.exported_data(self.items, settings) + + for filename, compressed in filename_to_compressed.items(): + result = gzip.decompress(data[filename]) + assert compressed == data[filename] + assert result == self.expected + + @coroutine_test + async def test_gzip_plugin_mtime(self): + filename_to_compressed = { + self._named_tempfile("mtime_123"): self.get_gzip_compressed( + self.expected, mtime=123 + ), + self._named_tempfile("mtime_123456789"): self.get_gzip_compressed( + self.expected, mtime=123456789 + ), + } + + settings = { + "FEEDS": { + self._named_tempfile("mtime_123"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_mtime": 123, + "gzip_filename": "", + }, + self._named_tempfile("mtime_123456789"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_mtime": 123456789, + "gzip_filename": "", + }, + }, + } + + data = await self.exported_data(self.items, settings) + + for filename, compressed in filename_to_compressed.items(): + result = gzip.decompress(data[filename]) + assert compressed == data[filename] + assert result == self.expected + + @coroutine_test + async def test_gzip_plugin_filename(self): + filename_to_compressed = { + self._named_tempfile("filename_FILE1"): self.get_gzip_compressed( + self.expected, filename="FILE1" + ), + self._named_tempfile("filename_FILE2"): self.get_gzip_compressed( + self.expected, filename="FILE2" + ), + } + + settings = { + "FEEDS": { + self._named_tempfile("filename_FILE1"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_mtime": 0, + "gzip_filename": "FILE1", + }, + self._named_tempfile("filename_FILE2"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_mtime": 0, + "gzip_filename": "FILE2", + }, + }, + } + + data = await self.exported_data(self.items, settings) + + for filename, compressed in filename_to_compressed.items(): + result = gzip.decompress(data[filename]) + assert compressed == data[filename] + assert result == self.expected + + @coroutine_test + async def test_lzma_plugin(self): + filename = self._named_tempfile("lzma_file") + + settings = { + "FEEDS": { + filename: { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + }, + }, + } + + data = await self.exported_data(self.items, settings) + try: + lzma.decompress(data[filename]) + except lzma.LZMAError: + pytest.fail("Received invalid lzma data.") + + @coroutine_test + async def test_lzma_plugin_format(self): + filename_to_compressed = { + self._named_tempfile("format_FORMAT_XZ"): lzma.compress( + self.expected, format=lzma.FORMAT_XZ + ), + self._named_tempfile("format_FORMAT_ALONE"): lzma.compress( + self.expected, format=lzma.FORMAT_ALONE + ), + } + + settings = { + "FEEDS": { + self._named_tempfile("format_FORMAT_XZ"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_format": lzma.FORMAT_XZ, + }, + self._named_tempfile("format_FORMAT_ALONE"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_format": lzma.FORMAT_ALONE, + }, + }, + } + + data = await self.exported_data(self.items, settings) + + for filename, compressed in filename_to_compressed.items(): + result = lzma.decompress(data[filename]) + assert compressed == data[filename] + assert result == self.expected + + @coroutine_test + async def test_lzma_plugin_check(self): + filename_to_compressed = { + self._named_tempfile("check_CHECK_NONE"): lzma.compress( + self.expected, check=lzma.CHECK_NONE + ), + self._named_tempfile("CHECK_SHA256"): lzma.compress( + self.expected, check=lzma.CHECK_SHA256 + ), + } + + settings = { + "FEEDS": { + self._named_tempfile("check_CHECK_NONE"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_check": lzma.CHECK_NONE, + }, + self._named_tempfile("CHECK_SHA256"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_check": lzma.CHECK_SHA256, + }, + }, + } + + data = await self.exported_data(self.items, settings) + + for filename, compressed in filename_to_compressed.items(): + result = lzma.decompress(data[filename]) + assert compressed == data[filename] + assert result == self.expected + + @coroutine_test + async def test_lzma_plugin_preset(self): + filename_to_compressed = { + self._named_tempfile("preset_PRESET_0"): lzma.compress( + self.expected, preset=0 + ), + self._named_tempfile("preset_PRESET_9"): lzma.compress( + self.expected, preset=9 + ), + } + + settings = { + "FEEDS": { + self._named_tempfile("preset_PRESET_0"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_preset": 0, + }, + self._named_tempfile("preset_PRESET_9"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_preset": 9, + }, + }, + } + + data = await self.exported_data(self.items, settings) + + for filename, compressed in filename_to_compressed.items(): + result = lzma.decompress(data[filename]) + assert compressed == data[filename] + assert result == self.expected + + @coroutine_test + async def test_lzma_plugin_filters(self): + if "PyPy" in sys.version: + # https://foss.heptapod.net/pypy/pypy/-/issues/3527 + pytest.skip("lzma filters doesn't work in PyPy") + + filters = [{"id": lzma.FILTER_LZMA2}] + compressed = lzma.compress(self.expected, filters=filters) + filename = self._named_tempfile("filters") + + settings = { + "FEEDS": { + filename: { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_filters": filters, + }, + }, + } + + data = await self.exported_data(self.items, settings) + assert compressed == data[filename] + result = lzma.decompress(data[filename]) + assert result == self.expected + + @coroutine_test + async def test_bz2_plugin(self): + filename = self._named_tempfile("bz2_file") + + settings = { + "FEEDS": { + filename: { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.Bz2Plugin"], + }, + }, + } + + data = await self.exported_data(self.items, settings) + try: + bz2.decompress(data[filename]) + except OSError: + pytest.fail("Received invalid bz2 data.") + + @coroutine_test + async def test_bz2_plugin_compresslevel(self): + filename_to_compressed = { + self._named_tempfile("compresslevel_1"): bz2.compress( + self.expected, compresslevel=1 + ), + self._named_tempfile("compresslevel_9"): bz2.compress( + self.expected, compresslevel=9 + ), + } + + settings = { + "FEEDS": { + self._named_tempfile("compresslevel_1"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.Bz2Plugin"], + "bz2_compresslevel": 1, + }, + self._named_tempfile("compresslevel_9"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.Bz2Plugin"], + "bz2_compresslevel": 9, + }, + }, + } + + data = await self.exported_data(self.items, settings) + + for filename, compressed in filename_to_compressed.items(): + result = bz2.decompress(data[filename]) + assert compressed == data[filename] + assert result == self.expected + + @coroutine_test + async def test_custom_plugin(self): + filename = self._named_tempfile("csv_file") + + settings = { + "FEEDS": { + filename: { + "format": "csv", + "postprocessing": [self.MyPlugin1], + }, + }, + } + + data = await self.exported_data(self.items, settings) + assert data[filename] == self.expected + + @coroutine_test + async def test_custom_plugin_with_parameter(self): + expected = b"foo\r\n\nbar\r\n\n" + filename = self._named_tempfile("newline") + + settings = { + "FEEDS": { + filename: { + "format": "csv", + "postprocessing": [self.MyPlugin1], + "plugin1_char": b"\n", + }, + }, + } + + data = await self.exported_data(self.items, settings) + assert data[filename] == expected + + @coroutine_test + async def test_custom_plugin_with_compression(self): + expected = b"foo\r\n\nbar\r\n\n" + + filename_to_decompressor = { + self._named_tempfile("bz2"): bz2.decompress, + self._named_tempfile("lzma"): lzma.decompress, + self._named_tempfile("gzip"): gzip.decompress, + } + + settings = { + "FEEDS": { + self._named_tempfile("bz2"): { + "format": "csv", + "postprocessing": [ + self.MyPlugin1, + "scrapy.extensions.postprocessing.Bz2Plugin", + ], + "plugin1_char": b"\n", + }, + self._named_tempfile("lzma"): { + "format": "csv", + "postprocessing": [ + self.MyPlugin1, + "scrapy.extensions.postprocessing.LZMAPlugin", + ], + "plugin1_char": b"\n", + }, + self._named_tempfile("gzip"): { + "format": "csv", + "postprocessing": [ + self.MyPlugin1, + "scrapy.extensions.postprocessing.GzipPlugin", + ], + "plugin1_char": b"\n", + }, + }, + } + + data = await self.exported_data(self.items, settings) + + for filename, decompressor in filename_to_decompressor.items(): + result = decompressor(data[filename]) + assert result == expected + + @coroutine_test + async def test_exports_compatibility_with_postproc(self): + filename_to_expected = { + self._named_tempfile("csv"): b"foo\r\nbar\r\n", + self._named_tempfile("json"): b'[\n{"foo": "bar"}\n]', + self._named_tempfile("jsonlines"): b'{"foo": "bar"}\n', + self._named_tempfile("xml"): b'\n' + b"\nbar\n", + } + + settings = { + "FEEDS": { + self._named_tempfile("csv"): { + "format": "csv", + "postprocessing": [self.MyPlugin1], + # empty plugin to activate postprocessing.PostProcessingManager + }, + self._named_tempfile("json"): { + "format": "json", + "postprocessing": [self.MyPlugin1], + }, + self._named_tempfile("jsonlines"): { + "format": "jsonlines", + "postprocessing": [self.MyPlugin1], + }, + self._named_tempfile("xml"): { + "format": "xml", + "postprocessing": [self.MyPlugin1], + }, + self._named_tempfile("marshal"): { + "format": "marshal", + "postprocessing": [self.MyPlugin1], + }, + self._named_tempfile("pickle"): { + "format": "pickle", + "postprocessing": [self.MyPlugin1], + }, + }, + } + + data = await self.exported_data(self.items, settings) + + for filename, result in data.items(): + if "pickle" in filename: + expected, result = self.items[0], pickle.loads(result) + elif "marshal" in filename: + expected, result = self.items[0], marshal.loads(result) + else: + expected = filename_to_expected[filename] + assert result == expected diff --git a/tests/test_feedexport_storages.py b/tests/test_feedexport_storages.py new file mode 100644 index 000000000..11e79775f --- /dev/null +++ b/tests/test_feedexport_storages.py @@ -0,0 +1,583 @@ +from __future__ import annotations + +import os +import string +import tempfile +from io import BytesIO +from pathlib import Path +from typing import IO, Any +from unittest import mock +from urllib.parse import quote + +import pytest +from testfixtures import LogCapture +from w3lib.url import path_to_file_uri +from zope.interface.verify import verifyObject + +import scrapy +from scrapy.extensions.feedexport import ( + BlockingFeedStorage, + FileFeedStorage, + FTPFeedStorage, + GCSFeedStorage, + IFeedStorage, + S3FeedStorage, + StdoutFeedStorage, +) +from scrapy.utils.defer import maybe_deferred_to_future +from scrapy.utils.test import get_crawler +from tests.mockserver.ftp import MockFTPServer +from tests.utils.decorators import coroutine_test + + +def mock_google_cloud_storage() -> tuple[Any, Any, Any]: + """Creates autospec mocks for google-cloud-storage Client, Bucket and Blob + classes and set their proper return values. + """ + from google.cloud.storage import Blob, Bucket, Client # noqa: PLC0415 + + client_mock = mock.create_autospec(Client) + + bucket_mock = mock.create_autospec(Bucket) + client_mock.get_bucket.return_value = bucket_mock + + blob_mock = mock.create_autospec(Blob) + bucket_mock.blob.return_value = blob_mock + + return (client_mock, bucket_mock, blob_mock) + + +class TestFileFeedStorage: + def test_store_file_uri(self, tmp_path): + path = tmp_path / "file.txt" + uri = path_to_file_uri(str(path)) + self._assert_stores(FileFeedStorage(uri), path) + + def test_store_file_uri_makedirs(self, tmp_path): + path = tmp_path / "more" / "paths" / "file.txt" + uri = path_to_file_uri(str(path)) + self._assert_stores(FileFeedStorage(uri), path) + + def test_store_direct_path(self, tmp_path): + path = tmp_path / "file.txt" + self._assert_stores(FileFeedStorage(str(path)), path) + + def test_store_direct_path_relative(self, tmp_path): + old_cwd = Path.cwd() + try: + os.chdir(tmp_path) + path = Path("foo", "bar") + self._assert_stores(FileFeedStorage(str(path)), path) + finally: + os.chdir(old_cwd) + + def test_interface(self, tmp_path): + path = tmp_path / "file.txt" + st = FileFeedStorage(str(path)) + verifyObject(IFeedStorage, st) + + @staticmethod + def _store(path: Path, feed_options: dict[str, Any] | None = None) -> None: + storage = FileFeedStorage(str(path), feed_options=feed_options) + spider = scrapy.Spider("default") + file = storage.open(spider) + file.write(b"content") + storage.store(file) + + def test_append(self, tmp_path): + path = tmp_path / "file.txt" + self._store(path) + self._assert_stores(FileFeedStorage(str(path)), path, b"contentcontent") + + def test_overwrite(self, tmp_path): + path = tmp_path / "file.txt" + self._store(path, {"overwrite": True}) + self._assert_stores( + FileFeedStorage(str(path), feed_options={"overwrite": True}), path + ) + + @staticmethod + def _assert_stores( + storage: FileFeedStorage, path: Path, expected_content: bytes = b"content" + ) -> None: + spider = scrapy.Spider("default") + file = storage.open(spider) + file.write(b"content") + storage.store(file) + assert path.exists() + try: + assert path.read_bytes() == expected_content + finally: + path.unlink() + + def test_preserves_windows_path_without_file_scheme(self): + path = r"C:\Users\user\Desktop\test.txt" + storage = FileFeedStorage(path) + assert storage.path == path + + +class TestFTPFeedStorage: + def get_test_spider(self, settings=None): + class TestSpider(scrapy.Spider): + name = "test_spider" + + crawler = get_crawler(settings_dict=settings) + return TestSpider.from_crawler(crawler) + + async def _store(self, uri, content, feed_options=None, settings=None): + crawler = get_crawler(settings_dict=settings or {}) + storage = FTPFeedStorage.from_crawler( + crawler, + uri, + feed_options=feed_options, + ) + verifyObject(IFeedStorage, storage) + spider = self.get_test_spider() + file = storage.open(spider) + file.write(content) + await maybe_deferred_to_future(storage.store(file)) + + def _assert_stored(self, path: Path, content): + assert path.exists() + try: + assert path.read_bytes() == content + finally: + path.unlink() + + @coroutine_test + async def test_append(self): + with MockFTPServer() as ftp_server: + filename = "file" + url = ftp_server.url(filename) + feed_options = {"overwrite": False} + await self._store(url, b"foo", feed_options=feed_options) + await self._store(url, b"bar", feed_options=feed_options) + self._assert_stored(ftp_server.path / filename, b"foobar") + + @coroutine_test + async def test_overwrite(self): + with MockFTPServer() as ftp_server: + filename = "file" + url = ftp_server.url(filename) + await self._store(url, b"foo") + await self._store(url, b"bar") + self._assert_stored(ftp_server.path / filename, b"bar") + + @coroutine_test + async def test_append_active_mode(self): + with MockFTPServer() as ftp_server: + settings = {"FEED_STORAGE_FTP_ACTIVE": True} + filename = "file" + url = ftp_server.url(filename) + feed_options = {"overwrite": False} + await self._store(url, b"foo", feed_options=feed_options, settings=settings) + await self._store(url, b"bar", feed_options=feed_options, settings=settings) + self._assert_stored(ftp_server.path / filename, b"foobar") + + @coroutine_test + async def test_overwrite_active_mode(self): + with MockFTPServer() as ftp_server: + settings = {"FEED_STORAGE_FTP_ACTIVE": True} + filename = "file" + url = ftp_server.url(filename) + await self._store(url, b"foo", settings=settings) + await self._store(url, b"bar", settings=settings) + self._assert_stored(ftp_server.path / filename, b"bar") + + def test_uri_auth_quote(self): + # RFC3986: 3.2.1. User Information + pw_quoted = quote(string.punctuation, safe="") + st = FTPFeedStorage(f"ftp://foo:{pw_quoted}@example.com/some_path", {}) + assert st.password == string.punctuation + + +class MyBlockingFeedStorage(BlockingFeedStorage): + def _store_in_thread(self, file: IO[bytes]) -> None: + return + + +class TestBlockingFeedStorage: + def get_test_spider(self, settings=None): + class TestSpider(scrapy.Spider): + name = "test_spider" + + crawler = get_crawler(settings_dict=settings) + return TestSpider.from_crawler(crawler) + + def test_default_temp_dir(self): + b = MyBlockingFeedStorage() + + storage_file = b.open(self.get_test_spider()) + storage_dir = Path(storage_file.name).parent + assert str(storage_dir) == tempfile.gettempdir() + + def test_temp_file(self, tmp_path): + b = MyBlockingFeedStorage() + + spider = self.get_test_spider({"FEED_TEMPDIR": str(tmp_path)}) + storage_file = b.open(spider) + storage_dir = Path(storage_file.name).parent + assert storage_dir == tmp_path + + def test_invalid_folder(self, tmp_path): + b = MyBlockingFeedStorage() + + invalid_path = tmp_path / "invalid_path" + spider = self.get_test_spider({"FEED_TEMPDIR": str(invalid_path)}) + + with pytest.raises(OSError, match="Not a Directory:"): + b.open(spider=spider) + + +@pytest.mark.requires_boto3 +class TestS3FeedStorage: + def test_parse_credentials(self): + aws_credentials = { + "AWS_ACCESS_KEY_ID": "settings_key", + "AWS_SECRET_ACCESS_KEY": "settings_secret", + "AWS_SESSION_TOKEN": "settings_token", + } + crawler = get_crawler(settings_dict=aws_credentials) + # Instantiate with crawler + storage = S3FeedStorage.from_crawler( + crawler, + "s3://mybucket/export.csv", + ) + assert storage.access_key == "settings_key" + assert storage.secret_key == "settings_secret" + assert storage.session_token == "settings_token" + # Instantiate directly + storage = S3FeedStorage( + "s3://mybucket/export.csv", + aws_credentials["AWS_ACCESS_KEY_ID"], + aws_credentials["AWS_SECRET_ACCESS_KEY"], + session_token=aws_credentials["AWS_SESSION_TOKEN"], + ) + assert storage.access_key == "settings_key" + assert storage.secret_key == "settings_secret" + assert storage.session_token == "settings_token" + # URI priority > settings priority + storage = S3FeedStorage( + "s3://uri_key:uri_secret@mybucket/export.csv", + aws_credentials["AWS_ACCESS_KEY_ID"], + aws_credentials["AWS_SECRET_ACCESS_KEY"], + ) + assert storage.access_key == "uri_key" + assert storage.secret_key == "uri_secret" + + @coroutine_test + async def test_store(self): + settings = { + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + } + crawler = get_crawler(settings_dict=settings) + bucket = "mybucket" + key = "export.csv" + storage = S3FeedStorage.from_crawler(crawler, f"s3://{bucket}/{key}") + verifyObject(IFeedStorage, storage) + + file = mock.MagicMock() + + storage.s3_client = mock.MagicMock() + await maybe_deferred_to_future(storage.store(file)) + assert storage.s3_client.upload_fileobj.call_args == mock.call( + Bucket=bucket, Key=key, Fileobj=file + ) + + def test_init_without_acl(self): + storage = S3FeedStorage("s3://mybucket/export.csv", "access_key", "secret_key") + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.acl is None + + def test_init_with_acl(self): + storage = S3FeedStorage( + "s3://mybucket/export.csv", "access_key", "secret_key", "custom-acl" + ) + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.acl == "custom-acl" + + def test_init_with_endpoint_url(self): + storage = S3FeedStorage( + "s3://mybucket/export.csv", + "access_key", + "secret_key", + endpoint_url="https://example.com", + ) + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.endpoint_url == "https://example.com" + + def test_init_with_region_name(self): + region_name = "ap-east-1" + storage = S3FeedStorage( + "s3://mybucket/export.csv", + "access_key", + "secret_key", + region_name=region_name, + ) + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.region_name == region_name + assert storage.s3_client._client_config.region_name == region_name + + def test_from_crawler_without_acl(self): + settings = { + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + } + crawler = get_crawler(settings_dict=settings) + storage = S3FeedStorage.from_crawler( + crawler, + "s3://mybucket/export.csv", + ) + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.acl is None + + def test_without_endpoint_url(self): + settings = { + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + } + crawler = get_crawler(settings_dict=settings) + storage = S3FeedStorage.from_crawler( + crawler, + "s3://mybucket/export.csv", + ) + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.endpoint_url is None + + def test_without_region_name(self): + settings = { + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + } + crawler = get_crawler(settings_dict=settings) + storage = S3FeedStorage.from_crawler( + crawler, + "s3://mybucket/export.csv", + ) + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.s3_client._client_config.region_name == "us-east-1" + + def test_from_crawler_with_acl(self): + settings = { + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + "FEED_STORAGE_S3_ACL": "custom-acl", + } + crawler = get_crawler(settings_dict=settings) + storage = S3FeedStorage.from_crawler( + crawler, + "s3://mybucket/export.csv", + ) + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.acl == "custom-acl" + + def test_from_crawler_with_endpoint_url(self): + settings = { + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + "AWS_ENDPOINT_URL": "https://example.com", + } + crawler = get_crawler(settings_dict=settings) + storage = S3FeedStorage.from_crawler(crawler, "s3://mybucket/export.csv") + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.endpoint_url == "https://example.com" + + def test_from_crawler_with_region_name(self): + region_name = "ap-east-1" + settings = { + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + "AWS_REGION_NAME": region_name, + } + crawler = get_crawler(settings_dict=settings) + storage = S3FeedStorage.from_crawler(crawler, "s3://mybucket/export.csv") + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.region_name == region_name + assert storage.s3_client._client_config.region_name == region_name + + @coroutine_test + async def test_store_without_acl(self): + storage = S3FeedStorage( + "s3://mybucket/export.csv", + "access_key", + "secret_key", + ) + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.acl is None + + storage.s3_client = mock.MagicMock() + await maybe_deferred_to_future(storage.store(BytesIO(b"test file"))) + acl = ( + storage.s3_client.upload_fileobj.call_args[1] + .get("ExtraArgs", {}) + .get("ACL") + ) + assert acl is None + + @coroutine_test + async def test_store_with_acl(self): + storage = S3FeedStorage( + "s3://mybucket/export.csv", "access_key", "secret_key", "custom-acl" + ) + assert storage.access_key == "access_key" + assert storage.secret_key == "secret_key" + assert storage.acl == "custom-acl" + + storage.s3_client = mock.MagicMock() + await maybe_deferred_to_future(storage.store(BytesIO(b"test file"))) + acl = storage.s3_client.upload_fileobj.call_args[1]["ExtraArgs"]["ACL"] + assert acl == "custom-acl" + + def test_overwrite_default(self): + with LogCapture() as log: + S3FeedStorage( + "s3://mybucket/export.csv", "access_key", "secret_key", "custom-acl" + ) + assert "S3 does not support appending to files" not in str(log) + + def test_overwrite_false(self): + with LogCapture() as log: + S3FeedStorage( + "s3://mybucket/export.csv", + "access_key", + "secret_key", + "custom-acl", + feed_options={"overwrite": False}, + ) + assert "S3 does not support appending to files" in str(log) + + +class TestGCSFeedStorage: + def test_parse_settings(self): + try: + from google.cloud.storage import Client # noqa: F401,PLC0415 + except ImportError: + pytest.skip("GCSFeedStorage requires google-cloud-storage") + + settings = {"GCS_PROJECT_ID": "123", "FEED_STORAGE_GCS_ACL": "publicRead"} + crawler = get_crawler(settings_dict=settings) + storage = GCSFeedStorage.from_crawler(crawler, "gs://mybucket/export.csv") + assert storage.project_id == "123" + assert storage.acl == "publicRead" + assert storage.bucket_name == "mybucket" + assert storage.blob_name == "export.csv" + + def test_parse_empty_acl(self): + try: + from google.cloud.storage import Client # noqa: F401,PLC0415 + except ImportError: + pytest.skip("GCSFeedStorage requires google-cloud-storage") + + settings = {"GCS_PROJECT_ID": "123", "FEED_STORAGE_GCS_ACL": ""} + crawler = get_crawler(settings_dict=settings) + storage = GCSFeedStorage.from_crawler(crawler, "gs://mybucket/export.csv") + assert storage.acl is None + + settings = {"GCS_PROJECT_ID": "123", "FEED_STORAGE_GCS_ACL": None} + crawler = get_crawler(settings_dict=settings) + storage = GCSFeedStorage.from_crawler(crawler, "gs://mybucket/export.csv") + assert storage.acl is None + + @coroutine_test + async def test_store(self): + try: + from google.cloud.storage import Client # noqa: F401,PLC0415 + except ImportError: + pytest.skip("GCSFeedStorage requires google-cloud-storage") + + uri = "gs://mybucket/export.csv" + project_id = "myproject-123" + acl = "publicRead" + (client_mock, bucket_mock, blob_mock) = mock_google_cloud_storage() + with mock.patch("google.cloud.storage.Client") as m: + m.return_value = client_mock + + f = mock.Mock() + storage = GCSFeedStorage(uri, project_id, acl) + await maybe_deferred_to_future(storage.store(f)) + + f.seek.assert_called_once_with(0) + m.assert_called_once_with(project=project_id) + client_mock.get_bucket.assert_called_once_with("mybucket") + bucket_mock.blob.assert_called_once_with("export.csv") + blob_mock.upload_from_file.assert_called_once_with(f, predefined_acl=acl) + f.close.assert_called_once_with() + + @coroutine_test + async def test_store_closes_file_on_upload_error(self): + try: + from google.cloud.storage import Client # noqa: F401,PLC0415 + except ImportError: + pytest.skip("GCSFeedStorage requires google-cloud-storage") + + uri = "gs://mybucket/export.csv" + project_id = "myproject-123" + acl = "publicRead" + (client_mock, bucket_mock, blob_mock) = mock_google_cloud_storage() + blob_mock.upload_from_file.side_effect = OSError("Upload failed") + with mock.patch("google.cloud.storage.Client") as m: + m.return_value = client_mock + + f = mock.Mock() + storage = GCSFeedStorage(uri, project_id, acl) + with pytest.raises(OSError, match="Upload failed"): + await maybe_deferred_to_future(storage.store(f)) + + f.seek.assert_called_once_with(0) + m.assert_called_once_with(project=project_id) + client_mock.get_bucket.assert_called_once_with("mybucket") + bucket_mock.blob.assert_called_once_with("export.csv") + blob_mock.upload_from_file.assert_called_once_with(f, predefined_acl=acl) + f.close.assert_called_once_with() + + def test_overwrite_default(self): + with LogCapture() as log: + GCSFeedStorage("gs://mybucket/export.csv", "myproject-123", "custom-acl") + assert "GCS does not support appending to files" not in str(log) + + def test_overwrite_false(self): + with LogCapture() as log: + GCSFeedStorage( + "gs://mybucket/export.csv", + "myproject-123", + "custom-acl", + feed_options={"overwrite": False}, + ) + assert "GCS does not support appending to files" in str(log) + + +class TestStdoutFeedStorage: + def test_store(self): + out = BytesIO() + storage = StdoutFeedStorage("stdout:", _stdout=out) + file = storage.open(scrapy.Spider("default")) + file.write(b"content") + storage.store(file) + assert out.getvalue() == b"content" + + def test_overwrite_default(self): + with LogCapture() as log: + StdoutFeedStorage("stdout:") + assert ( + "Standard output (stdout) storage does not support overwriting" + not in str(log) + ) + + def test_overwrite_true(self): + with LogCapture() as log: + StdoutFeedStorage("stdout:", feed_options={"overwrite": True}) + assert "Standard output (stdout) storage does not support overwriting" in str( + log + ) diff --git a/tests/test_feedexport_uri_params.py b/tests/test_feedexport_uri_params.py new file mode 100644 index 000000000..150d8449f --- /dev/null +++ b/tests/test_feedexport_uri_params.py @@ -0,0 +1,142 @@ +from __future__ import annotations + +import warnings +from abc import ABC, abstractmethod + +import pytest + +import scrapy +from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.extensions.feedexport import FeedExporter +from scrapy.utils.test import get_crawler + + +class TestURIParams(ABC): + spider_name = "uri_params_spider" + deprecated_options = False + + @abstractmethod + def build_settings(self, uri="file:///tmp/foobar", uri_params=None): + raise NotImplementedError + + def _crawler_feed_exporter(self, settings): + if self.deprecated_options: + with pytest.warns( + ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated", + ): + crawler = get_crawler(settings_dict=settings) + else: + crawler = get_crawler(settings_dict=settings) + feed_exporter = crawler.get_extension(FeedExporter) + return crawler, feed_exporter + + def test_default(self): + settings = self.build_settings( + uri="file:///tmp/%(name)s", + ) + crawler, feed_exporter = self._crawler_feed_exporter(settings) + spider = scrapy.Spider(self.spider_name) + spider.crawler = crawler + + with warnings.catch_warnings(): + warnings.simplefilter("error", ScrapyDeprecationWarning) + feed_exporter.open_spider(spider) + + assert feed_exporter.slots[0].uri == f"file:///tmp/{self.spider_name}" + + def test_none(self): + def uri_params(params, spider): + pass + + settings = self.build_settings( + uri="file:///tmp/%(name)s", + uri_params=uri_params, + ) + crawler, feed_exporter = self._crawler_feed_exporter(settings) + spider = scrapy.Spider(self.spider_name) + spider.crawler = crawler + + feed_exporter.open_spider(spider) + + assert feed_exporter.slots[0].uri == f"file:///tmp/{self.spider_name}" + + def test_empty_dict(self): + def uri_params(params, spider): + return {} + + settings = self.build_settings( + uri="file:///tmp/%(name)s", + uri_params=uri_params, + ) + crawler, feed_exporter = self._crawler_feed_exporter(settings) + spider = scrapy.Spider(self.spider_name) + spider.crawler = crawler + + with warnings.catch_warnings(): + warnings.simplefilter("error", ScrapyDeprecationWarning) + with pytest.raises(KeyError): + feed_exporter.open_spider(spider) + + def test_params_as_is(self): + def uri_params(params, spider): + return params + + settings = self.build_settings( + uri="file:///tmp/%(name)s", + uri_params=uri_params, + ) + crawler, feed_exporter = self._crawler_feed_exporter(settings) + spider = scrapy.Spider(self.spider_name) + spider.crawler = crawler + with warnings.catch_warnings(): + warnings.simplefilter("error", ScrapyDeprecationWarning) + feed_exporter.open_spider(spider) + + assert feed_exporter.slots[0].uri == f"file:///tmp/{self.spider_name}" + + def test_custom_param(self): + def uri_params(params, spider): + return {**params, "foo": self.spider_name} + + settings = self.build_settings( + uri="file:///tmp/%(foo)s", + uri_params=uri_params, + ) + crawler, feed_exporter = self._crawler_feed_exporter(settings) + spider = scrapy.Spider(self.spider_name) + spider.crawler = crawler + with warnings.catch_warnings(): + warnings.simplefilter("error", ScrapyDeprecationWarning) + feed_exporter.open_spider(spider) + + assert feed_exporter.slots[0].uri == f"file:///tmp/{self.spider_name}" + + +class TestURIParamsSetting(TestURIParams): + deprecated_options = True + + def build_settings(self, uri="file:///tmp/foobar", uri_params=None): + extra_settings = {} + if uri_params: + extra_settings["FEED_URI_PARAMS"] = uri_params + return { + "FEED_URI": uri, + **extra_settings, + } + + +class TestURIParamsFeedOption(TestURIParams): + deprecated_options = False + + def build_settings(self, uri="file:///tmp/foobar", uri_params=None): + options = { + "format": "jl", + } + if uri_params: + options["uri_params"] = uri_params + return { + "FEEDS": { + uri: options, + }, + } diff --git a/tests/test_http2_client_protocol.py b/tests/test_http2_client_protocol.py index 80edd50d6..3c1347fd3 100644 --- a/tests/test_http2_client_protocol.py +++ b/tests/test_http2_client_protocol.py @@ -3,32 +3,25 @@ from __future__ import annotations import json import random import re -import shutil import string from ipaddress import IPv4Address from pathlib import Path -from tempfile import mkdtemp -from typing import TYPE_CHECKING, Any, Callable +from typing import TYPE_CHECKING, Any, cast from unittest import mock from urllib.parse import urlencode import pytest -from twisted.internet.defer import ( - CancelledError, - Deferred, - DeferredList, - inlineCallbacks, -) +from pytest_twisted import async_yield_fixture +from twisted.internet.defer import Deferred, DeferredList, inlineCallbacks from twisted.internet.endpoints import SSL4ClientEndpoint, SSL4ServerEndpoint -from twisted.internet.error import TimeoutError from twisted.internet.ssl import Certificate, PrivateCertificate, optionsForClientTLS -from twisted.trial.unittest import TestCase from twisted.web.client import URI, ResponseFailed from twisted.web.http import H2_ENABLED from twisted.web.http import Request as TxRequest from twisted.web.server import NOT_DONE_YET, Site from twisted.web.static import File +from scrapy.exceptions import DownloadCancelledError, DownloadTimeoutError from scrapy.http import JsonRequest, Request, Response from scrapy.settings import Settings from scrapy.spiders import Spider @@ -37,10 +30,21 @@ from scrapy.utils.defer import ( deferred_from_coro, maybe_deferred_to_future, ) -from tests.mockserver import LeafResource, Status, ssl_context_factory +from tests.mockserver.http_resources import LeafResource, Status +from tests.mockserver.utils import ssl_context_factory if TYPE_CHECKING: - from collections.abc import Coroutine + from collections.abc import AsyncGenerator, Callable, Coroutine, Generator + + from scrapy.core.http2.protocol import H2ClientProtocol + + +pytestmark = [ + pytest.mark.requires_reactor, # H2ClientProtocol requires a reactor + pytest.mark.skipif( + not H2_ENABLED, reason="HTTP/2 support in Twisted is not enabled" + ), +] def generate_random_string(size: int) -> str: @@ -57,7 +61,7 @@ def make_html_body(val: str) -> bytes: class DummySpider(Spider): name = "dummy" - start_urls: list = [] + start_urls = [] def parse(self, response): print(response) @@ -137,7 +141,7 @@ class Dataloss(LeafResource): class NoContentLengthHeader(LeafResource): def render_GET(self, request: TxRequest): - request.requestHeaders.removeHeader("Content-Length") + request.responseHeaders.removeHeader("Content-Length") self.deferRequest(request, 0, self._delayed_render, request) return NOT_DONE_YET @@ -178,24 +182,23 @@ class RequestHeaders(LeafResource): return bytes(json.dumps(headers), "utf-8") -def get_client_certificate( - key_file: Path, certificate_file: Path -) -> PrivateCertificate: - pem = key_file.read_text(encoding="utf-8") + certificate_file.read_text( - encoding="utf-8" - ) - return PrivateCertificate.loadPEM(pem) +def make_request_dfd(client: H2ClientProtocol, request: Request) -> Deferred[Response]: + return client.request(request, DummySpider()) -@pytest.mark.skipif(not H2_ENABLED, reason="HTTP/2 support in Twisted is not enabled") -class TestHttps2ClientProtocol(TestCase): +async def make_request(client: H2ClientProtocol, request: Request) -> Response: + return await maybe_deferred_to_future(make_request_dfd(client, request)) + + +class TestHttps2ClientProtocol: scheme = "https" + host = "localhost" key_file = Path(__file__).parent / "keys" / "localhost.key" certificate_file = Path(__file__).parent / "keys" / "localhost.crt" - def _init_resource(self): - self.temp_directory = mkdtemp() - r = File(self.temp_directory) + @pytest.fixture + def site(self, tmp_path): + r = File(str(tmp_path)) r.putChild(b"get-data-html-small", GetDataHtmlSmall()) r.putChild(b"get-data-html-large", GetDataHtmlLarge()) @@ -208,72 +211,65 @@ class TestHttps2ClientProtocol(TestCase): r.putChild(b"query-params", QueryParams()) r.putChild(b"timeout", TimeoutResponse()) r.putChild(b"request-headers", RequestHeaders()) - return r + return Site(r, timeout=None) - @inlineCallbacks - def setUp(self): + @async_yield_fixture # type: ignore[untyped-decorator] + async def server_port(self, site: Site) -> AsyncGenerator[int]: from twisted.internet import reactor - # Initialize resource tree - root = self._init_resource() - self.site = Site(root, timeout=None) - - # Start server for testing - self.hostname = "localhost" context_factory = ssl_context_factory( str(self.key_file), str(self.certificate_file) ) - server_endpoint = SSL4ServerEndpoint( - reactor, 0, context_factory, interface=self.hostname + reactor, 0, context_factory, interface=self.host ) - self.server = yield server_endpoint.listen(self.site) - self.port_number = self.server.getHost().port + server = await server_endpoint.listen(site) + + yield server.getHost().port + + await server.stopListening() + + @pytest.fixture + def client_certificate(self) -> PrivateCertificate: + pem = self.key_file.read_text( + encoding="utf-8" + ) + self.certificate_file.read_text(encoding="utf-8") + return PrivateCertificate.loadPEM(pem) # type: ignore[no-any-return] + + @async_yield_fixture # type: ignore[untyped-decorator] + async def client( + self, server_port: int, client_certificate: PrivateCertificate + ) -> AsyncGenerator[H2ClientProtocol]: + from twisted.internet import reactor + + from scrapy.core.http2.protocol import H2ClientFactory # noqa: PLC0415 - # Connect H2 client with server - self.client_certificate = get_client_certificate( - self.key_file, self.certificate_file - ) client_options = optionsForClientTLS( - hostname=self.hostname, - trustRoot=self.client_certificate, + hostname=self.host, + trustRoot=client_certificate, acceptableProtocols=[b"h2"], ) - uri = URI.fromBytes(bytes(self.get_url("/"), "utf-8")) - - self.conn_closed_deferred = Deferred() - - from scrapy.core.http2.protocol import H2ClientFactory - - h2_client_factory = H2ClientFactory(uri, Settings(), self.conn_closed_deferred) + uri = URI.fromBytes(bytes(self.get_url(server_port, "/"), "utf-8")) + h2_client_factory = H2ClientFactory(uri, Settings(), Deferred()) client_endpoint = SSL4ClientEndpoint( - reactor, self.hostname, self.port_number, client_options + reactor, self.host, server_port, client_options ) - self.client = yield client_endpoint.connect(h2_client_factory) + client = await client_endpoint.connect(h2_client_factory) - @inlineCallbacks - def tearDown(self): - if self.client.connected: - yield self.client.transport.loseConnection() - yield self.client.transport.abortConnection() - yield self.server.stopListening() - shutil.rmtree(self.temp_directory) - self.conn_closed_deferred = None + yield client - def get_url(self, path: str) -> str: + if client.connected: + client.transport.loseConnection() + client.transport.abortConnection() + + def get_url(self, portno: int, path: str) -> str: """ :param path: Should have / at the starting compulsorily if not empty :return: Complete url """ assert len(path) > 0 assert path[0] == "/" or path[0] == "&" - return f"{self.scheme}://{self.hostname}:{self.port_number}{path}" - - async def make_request(self, request: Request) -> Response: - return await maybe_deferred_to_future(self.make_request_dfd(request)) - - def make_request_dfd(self, request: Request) -> Deferred[Response]: - return self.client.request(request, DummySpider()) + return f"{self.scheme}://{self.host}:{portno}{path}" @staticmethod async def _check_repeat( @@ -287,12 +283,15 @@ class TestHttps2ClientProtocol(TestCase): await maybe_deferred_to_future(DeferredList(d_list, fireOnOneErrback=True)) async def _check_GET( - self, request: Request, expected_body: bytes, expected_status: int + self, + client: H2ClientProtocol, + request: Request, + expected_body: bytes, + expected_status: int, ) -> None: - response = await self.make_request(request) + response = await make_request(client, request) assert response.status == expected_status assert response.body == expected_body - assert response.request == request content_length_header = response.headers.get("Content-Length") assert content_length_header is not None @@ -300,46 +299,64 @@ class TestHttps2ClientProtocol(TestCase): assert len(response.body) == content_length @deferred_f_from_coro_f - async def test_GET_small_body(self): - request = Request(self.get_url("/get-data-html-small")) - await self._check_GET(request, Data.HTML_SMALL, 200) + async def test_GET_small_body( + self, server_port: int, client: H2ClientProtocol + ) -> None: + request = Request(self.get_url(server_port, "/get-data-html-small")) + await self._check_GET(client, request, Data.HTML_SMALL, 200) @deferred_f_from_coro_f - async def test_GET_large_body(self): - request = Request(self.get_url("/get-data-html-large")) - await self._check_GET(request, Data.HTML_LARGE, 200) + async def test_GET_large_body( + self, server_port: int, client: H2ClientProtocol + ) -> None: + request = Request(self.get_url(server_port, "/get-data-html-large")) + await self._check_GET(client, request, Data.HTML_LARGE, 200) async def _check_GET_x10( - self, request: Request, expected_body: bytes, expected_status: int + self, + client: H2ClientProtocol, + request: Request, + expected_body: bytes, + expected_status: int, ) -> None: async def get_coro() -> None: - await self._check_GET(request, expected_body, expected_status) + await self._check_GET(client, request, expected_body, expected_status) await self._check_repeat(get_coro, 10) @deferred_f_from_coro_f - async def test_GET_small_body_x10(self): + async def test_GET_small_body_x10( + self, server_port: int, client: H2ClientProtocol + ) -> None: await self._check_GET_x10( - Request(self.get_url("/get-data-html-small")), Data.HTML_SMALL, 200 + client, + Request(self.get_url(server_port, "/get-data-html-small")), + Data.HTML_SMALL, + 200, ) @deferred_f_from_coro_f - async def test_GET_large_body_x10(self): + async def test_GET_large_body_x10( + self, server_port: int, client: H2ClientProtocol + ) -> None: await self._check_GET_x10( - Request(self.get_url("/get-data-html-large")), Data.HTML_LARGE, 200 + client, + Request(self.get_url(server_port, "/get-data-html-large")), + Data.HTML_LARGE, + 200, ) + @staticmethod async def _check_POST_json( - self, + client: H2ClientProtocol, request: Request, expected_request_body: dict[str, str], expected_extra_data: str, expected_status: int, ) -> None: - response = await self.make_request(request) + response = await make_request(client, request) assert response.status == expected_status - assert response.request == request content_length_header = response.headers.get("Content-Length") assert content_length_header is not None @@ -369,87 +386,123 @@ class TestHttps2ClientProtocol(TestCase): assert request_headers[k_str] == str(v[0], "utf-8") @deferred_f_from_coro_f - async def test_POST_small_json(self): + async def test_POST_small_json( + self, server_port: int, client: H2ClientProtocol + ) -> None: request = JsonRequest( - url=self.get_url("/post-data-json-small"), + url=self.get_url(server_port, "/post-data-json-small"), method="POST", data=Data.JSON_SMALL, ) - await self._check_POST_json(request, Data.JSON_SMALL, Data.EXTRA_SMALL, 200) + await self._check_POST_json( + client, request, Data.JSON_SMALL, Data.EXTRA_SMALL, 200 + ) @deferred_f_from_coro_f - async def test_POST_large_json(self): + async def test_POST_large_json( + self, server_port: int, client: H2ClientProtocol + ) -> None: request = JsonRequest( - url=self.get_url("/post-data-json-large"), + url=self.get_url(server_port, "/post-data-json-large"), method="POST", data=Data.JSON_LARGE, ) - await self._check_POST_json(request, Data.JSON_LARGE, Data.EXTRA_LARGE, 200) + await self._check_POST_json( + client, request, Data.JSON_LARGE, Data.EXTRA_LARGE, 200 + ) - async def _check_POST_json_x10(self, *args, **kwargs): + async def _check_POST_json_x10( + self, + client: H2ClientProtocol, + request: Request, + expected_request_body: dict[str, str], + expected_extra_data: str, + expected_status: int, + ) -> None: async def get_coro() -> None: - await self._check_POST_json(*args, **kwargs) + await self._check_POST_json( + client, + request, + expected_request_body, + expected_extra_data, + expected_status, + ) await self._check_repeat(get_coro, 10) @deferred_f_from_coro_f - async def test_POST_small_json_x10(self): + async def test_POST_small_json_x10( + self, server_port: int, client: H2ClientProtocol + ) -> None: request = JsonRequest( - url=self.get_url("/post-data-json-small"), + url=self.get_url(server_port, "/post-data-json-small"), method="POST", data=Data.JSON_SMALL, ) - await self._check_POST_json_x10(request, Data.JSON_SMALL, Data.EXTRA_SMALL, 200) + await self._check_POST_json_x10( + client, request, Data.JSON_SMALL, Data.EXTRA_SMALL, 200 + ) @deferred_f_from_coro_f - async def test_POST_large_json_x10(self): + async def test_POST_large_json_x10( + self, server_port: int, client: H2ClientProtocol + ) -> None: request = JsonRequest( - url=self.get_url("/post-data-json-large"), + url=self.get_url(server_port, "/post-data-json-large"), method="POST", data=Data.JSON_LARGE, ) - await self._check_POST_json_x10(request, Data.JSON_LARGE, Data.EXTRA_LARGE, 200) + await self._check_POST_json_x10( + client, request, Data.JSON_LARGE, Data.EXTRA_LARGE, 200 + ) @inlineCallbacks - def test_invalid_negotiated_protocol(self): - with mock.patch( - "scrapy.core.http2.protocol.PROTOCOL_NAME", return_value=b"not-h2" - ): - request = Request(url=self.get_url("/status?n=200")) + def test_invalid_negotiated_protocol( + self, server_port: int, client: H2ClientProtocol + ) -> Generator[Deferred[Any], Any, None]: + with mock.patch("scrapy.core.http2.protocol.PROTOCOL_NAME", new=b"not-h2"): + request = Request(url=self.get_url(server_port, "/status?n=200")) with pytest.raises(ResponseFailed): - yield self.make_request_dfd(request) + yield make_request_dfd(client, request) @inlineCallbacks - def test_cancel_request(self): - request = Request(url=self.get_url("/get-data-html-large")) - d = self.make_request_dfd(request) + def test_cancel_request( + self, server_port: int, client: H2ClientProtocol + ) -> Generator[Deferred[Any], Any, None]: + request = Request(url=self.get_url(server_port, "/get-data-html-large")) + d = make_request_dfd(client, request) d.cancel() - response = yield d + response = cast("Response", (yield d)) assert response.status == 499 - assert response.request == request @deferred_f_from_coro_f - async def test_download_maxsize_exceeded(self): + async def test_download_maxsize_exceeded( + self, + caplog: pytest.LogCaptureFixture, + server_port: int, + client: H2ClientProtocol, + ) -> None: request = Request( - url=self.get_url("/get-data-html-large"), meta={"download_maxsize": 1000} + url=self.get_url(server_port, "/get-data-html-large"), + meta={"download_maxsize": 1000}, ) - with pytest.raises(CancelledError) as exc_info: - await self.make_request(request) - error_pattern = re.compile( - rf"Cancelling download of {request.url}: received response " - rf"size \(\d*\) larger than download max size \(1000\)" - ) - assert len(re.findall(error_pattern, str(exc_info.value))) == 1 + with pytest.raises( + DownloadCancelledError, + match=r"Expected to receive \d+ bytes which is larger than download max size \(1000\)", + ): + await make_request(client, request) @inlineCallbacks - def test_received_dataloss_response(self): + def test_received_dataloss_response( + self, server_port: int, client: H2ClientProtocol + ) -> Generator[Deferred[Any], Any, None]: """In case when value of Header Content-Length != len(Received Data) ProtocolError is raised""" - from h2.exceptions import InvalidBodyLengthError + from h2.exceptions import InvalidBodyLengthError # noqa: PLC0415 - request = Request(url=self.get_url("/dataloss")) + request = Request(url=self.get_url(server_port, "/dataloss")) with pytest.raises(ResponseFailed) as exc_info: - yield self.make_request_dfd(request) + yield make_request_dfd(client, request) assert len(exc_info.value.reasons) > 0 assert any( isinstance(error, InvalidBodyLengthError) @@ -457,66 +510,93 @@ class TestHttps2ClientProtocol(TestCase): ) @deferred_f_from_coro_f - async def test_missing_content_length_header(self): - request = Request(url=self.get_url("/no-content-length-header")) - response = await self.make_request(request) + async def test_missing_content_length_header( + self, server_port: int, client: H2ClientProtocol + ) -> None: + request = Request(url=self.get_url(server_port, "/no-content-length-header")) + response = await make_request(client, request) assert response.status == 200 assert response.body == Data.NO_CONTENT_LENGTH - assert response.request == request assert "Content-Length" not in response.headers async def _check_log_warnsize( - self, request: Request, warn_pattern: re.Pattern[str], expected_body: bytes + self, + client: H2ClientProtocol, + request: Request, + warn_pattern: re.Pattern[str], + expected_body: bytes, + caplog: pytest.LogCaptureFixture, ) -> None: - with self.assertLogs("scrapy.core.http2.stream", level="WARNING") as cm: - response = await self.make_request(request) - assert response.status == 200 - assert response.request == request - assert response.body == expected_body + with caplog.at_level("WARNING", "scrapy.core.http2.stream"): + response = await make_request(client, request) + assert response.status == 200 + assert response.body == expected_body - # Check the warning is raised only once for this request - assert sum(len(re.findall(warn_pattern, log)) for log in cm.output) == 1 + # Check the warning is raised only once for this request + assert len(re.findall(warn_pattern, caplog.text)) == 1 @deferred_f_from_coro_f - async def test_log_expected_warnsize(self): + async def test_log_expected_warnsize( + self, + server_port: int, + client: H2ClientProtocol, + caplog: pytest.LogCaptureFixture, + ) -> None: request = Request( - url=self.get_url("/get-data-html-large"), meta={"download_warnsize": 1000} + url=self.get_url(server_port, "/get-data-html-large"), + meta={"download_warnsize": 1000}, ) warn_pattern = re.compile( - rf"Expected response size \(\d*\) larger than " + rf"Expected to receive \d+ bytes which is larger than " rf"download warn size \(1000\) in request {request}" ) - await self._check_log_warnsize(request, warn_pattern, Data.HTML_LARGE) + await self._check_log_warnsize( + client, request, warn_pattern, Data.HTML_LARGE, caplog + ) @deferred_f_from_coro_f - async def test_log_received_warnsize(self): + async def test_log_received_warnsize( + self, + server_port: int, + client: H2ClientProtocol, + caplog: pytest.LogCaptureFixture, + ) -> None: request = Request( - url=self.get_url("/no-content-length-header"), + url=self.get_url(server_port, "/no-content-length-header"), meta={"download_warnsize": 10}, ) warn_pattern = re.compile( - rf"Received more \(\d*\) bytes than download " - rf"warn size \(10\) in request {request}" + rf"Received \d+ bytes which is larger than " + rf"download warn size \(10\) in request {request}" ) - await self._check_log_warnsize(request, warn_pattern, Data.NO_CONTENT_LENGTH) + await self._check_log_warnsize( + client, request, warn_pattern, Data.NO_CONTENT_LENGTH, caplog + ) @deferred_f_from_coro_f - async def test_max_concurrent_streams(self): + async def test_max_concurrent_streams( + self, server_port: int, client: H2ClientProtocol + ) -> None: """Send 500 requests at one to check if we can handle very large number of request. """ async def get_coro() -> None: await self._check_GET( - Request(self.get_url("/get-data-html-small")), Data.HTML_SMALL, 200 + client, + Request(self.get_url(server_port, "/get-data-html-small")), + Data.HTML_SMALL, + 200, ) await self._check_repeat(get_coro, 500) @inlineCallbacks - def test_inactive_stream(self): + def test_inactive_stream( + self, server_port: int, client: H2ClientProtocol + ) -> Generator[Deferred[Any], Any, None]: """Here we send 110 requests considering the MAX_CONCURRENT_STREAMS by default is 100. After sending the first 100 requests we close the connection.""" @@ -525,7 +605,7 @@ class TestHttps2ClientProtocol(TestCase): def assert_inactive_stream(failure): assert failure.check(ResponseFailed) is not None - from scrapy.core.http2.stream import InactiveStreamClosed + from scrapy.core.http2.stream import InactiveStreamClosed # noqa: PLC0415 assert any( isinstance(e, InactiveStreamClosed) for e in failure.value.reasons @@ -533,38 +613,47 @@ class TestHttps2ClientProtocol(TestCase): # Send 100 request (we do not check the result) for _ in range(100): - d = self.make_request_dfd(Request(self.get_url("/get-data-html-small"))) + d = make_request_dfd( + client, Request(self.get_url(server_port, "/get-data-html-small")) + ) d.addBoth(lambda _: None) d_list.append(d) # Now send 10 extra request and save the response deferred in a list for _ in range(10): - d = self.make_request_dfd(Request(self.get_url("/get-data-html-small"))) + d = make_request_dfd( + client, Request(self.get_url(server_port, "/get-data-html-small")) + ) d.addCallback(lambda _: pytest.fail("This request should have failed")) d.addErrback(assert_inactive_stream) d_list.append(d) # Close the connection now to fire all the extra 10 requests errback # with InactiveStreamClosed - self.client.transport.loseConnection() + assert client.transport + client.transport.loseConnection() yield DeferredList(d_list, consumeErrors=True, fireOnOneErrback=True) @deferred_f_from_coro_f - async def test_invalid_request_type(self): + async def test_invalid_request_type(self, client: H2ClientProtocol): with pytest.raises(TypeError): - await self.make_request("https://InvalidDataTypePassed.com") + await make_request(client, "https://InvalidDataTypePassed.com") # type: ignore[arg-type] @deferred_f_from_coro_f - async def test_query_parameters(self): + async def test_query_parameters( + self, server_port: int, client: H2ClientProtocol + ) -> None: params = { "a": generate_random_string(20), "b": generate_random_string(20), "c": generate_random_string(20), "d": generate_random_string(20), } - request = Request(self.get_url(f"/query-params?{urlencode(params)}")) - response = await self.make_request(request) + request = Request( + self.get_url(server_port, f"/query-params?{urlencode(params)}") + ) + response = await make_request(client, request) content_encoding_header = response.headers[b"Content-Encoding"] assert content_encoding_header is not None content_encoding = str(content_encoding_header, "utf-8") @@ -572,67 +661,85 @@ class TestHttps2ClientProtocol(TestCase): assert data == params @deferred_f_from_coro_f - async def test_status_codes(self): + async def test_status_codes( + self, server_port: int, client: H2ClientProtocol + ) -> None: for status in [200, 404]: - request = Request(self.get_url(f"/status?n={status}")) - response = await self.make_request(request) + request = Request(self.get_url(server_port, f"/status?n={status}")) + response = await make_request(client, request) assert response.status == status + @pytest.mark.filterwarnings( + r"ignore:.*You should use cryptography's X\.509 APIs:DeprecationWarning" + ) @deferred_f_from_coro_f - async def test_response_has_correct_certificate_ip_address(self): - request = Request(self.get_url("/status?n=200")) - response = await self.make_request(request) - assert response.request == request + async def test_response_has_correct_certificate_ip_address( + self, + server_port: int, + client: H2ClientProtocol, + client_certificate: PrivateCertificate, + ) -> None: + request = Request(self.get_url(server_port, "/status?n=200")) + response = await make_request(client, request) assert isinstance(response.certificate, Certificate) assert response.certificate.original is not None - assert response.certificate.getIssuer() == self.client_certificate.getIssuer() + assert response.certificate.getIssuer() == client_certificate.getIssuer() assert response.certificate.getPublicKey().matches( - self.client_certificate.getPublicKey() + client_certificate.getPublicKey() ) assert isinstance(response.ip_address, IPv4Address) assert str(response.ip_address) == "127.0.0.1" - async def _check_invalid_netloc(self, url: str) -> None: - from scrapy.core.http2.stream import InvalidHostname + @staticmethod + async def _check_invalid_netloc(client: H2ClientProtocol, url: str) -> None: + from scrapy.core.http2.stream import InvalidHostname # noqa: PLC0415 request = Request(url) with pytest.raises(InvalidHostname) as exc_info: - await self.make_request(request) + await make_request(client, request) error_msg = str(exc_info.value) assert "localhost" in error_msg assert "127.0.0.1" in error_msg assert str(request) in error_msg @deferred_f_from_coro_f - async def test_invalid_hostname(self): - await self._check_invalid_netloc("https://notlocalhost.notlocalhostdomain") + async def test_invalid_hostname(self, client: H2ClientProtocol) -> None: + await self._check_invalid_netloc( + client, "https://notlocalhost.notlocalhostdomain" + ) @deferred_f_from_coro_f - async def test_invalid_host_port(self): - port = self.port_number + 1 - await self._check_invalid_netloc(f"https://127.0.0.1:{port}") + async def test_invalid_host_port( + self, server_port: int, client: H2ClientProtocol + ) -> None: + port = server_port + 1 + await self._check_invalid_netloc(client, f"https://127.0.0.1:{port}") @deferred_f_from_coro_f - async def test_connection_stays_with_invalid_requests(self): - await maybe_deferred_to_future(self.test_invalid_hostname()) - await maybe_deferred_to_future(self.test_invalid_host_port()) - await maybe_deferred_to_future(self.test_GET_small_body()) - await maybe_deferred_to_future(self.test_POST_small_json()) + async def test_connection_stays_with_invalid_requests( + self, server_port: int, client: H2ClientProtocol + ): + await maybe_deferred_to_future(self.test_invalid_hostname(client)) + await maybe_deferred_to_future(self.test_invalid_host_port(server_port, client)) + await maybe_deferred_to_future(self.test_GET_small_body(server_port, client)) + await maybe_deferred_to_future(self.test_POST_small_json(server_port, client)) @inlineCallbacks - def test_connection_timeout(self): - request = Request(self.get_url("/timeout")) + def test_connection_timeout( + self, server_port: int, client: H2ClientProtocol + ) -> Generator[Deferred[Any], Any, None]: + request = Request(self.get_url(server_port, "/timeout")) # Update the timer to 1s to test connection timeout - self.client.setTimeout(1) + client.setTimeout(1) # type: ignore[no-untyped-call] with pytest.raises(ResponseFailed) as exc_info: - yield self.make_request_dfd(request) + yield make_request_dfd(client, request) for err in exc_info.value.reasons: - from scrapy.core.http2.protocol import H2ClientProtocol + from scrapy.core.http2.protocol import H2ClientProtocol # noqa: PLC0415 - if isinstance(err, TimeoutError): + if isinstance(err, DownloadTimeoutError): assert ( f"Connection was IDLE for more than {H2ClientProtocol.IDLE_TIMEOUT}s" in str(err) @@ -642,18 +749,19 @@ class TestHttps2ClientProtocol(TestCase): pytest.fail("No TimeoutError raised.") @deferred_f_from_coro_f - async def test_request_headers_received(self): + async def test_request_headers_received( + self, server_port: int, client: H2ClientProtocol + ) -> None: request = Request( - self.get_url("/request-headers"), + self.get_url(server_port, "/request-headers"), headers={"header-1": "header value 1", "header-2": "header value 2"}, ) - response = await self.make_request(request) + response = await make_request(client, request) assert response.status == 200 - assert response.request == request response_headers = json.loads(str(response.body, "utf-8")) assert isinstance(response_headers, dict) for k, v in request.headers.items(): - k, v = str(k, "utf-8"), str(v[0], "utf-8") - assert k in response_headers - assert v == response_headers[k] + k_decoded, v_decoded = str(k, "utf-8"), str(v[0], "utf-8") + assert k_decoded in response_headers + assert v_decoded == response_headers[k_decoded] diff --git a/tests/test_http_headers.py b/tests/test_http_headers.py index 2fcf9e83c..243aa6afe 100644 --- a/tests/test_http_headers.py +++ b/tests/test_http_headers.py @@ -56,12 +56,12 @@ class TestHeaders: def test_encode_latin1(self): h = Headers({"key": "\xa3"}, encoding="latin1") - key, val = dict(h).popitem() + _, val = dict(h).popitem() assert val[0] == b"\xa3" def test_encode_multiple(self): h = Headers({"key": ["\xa3"]}, encoding="utf-8") - key, val = dict(h).popitem() + _, val = dict(h).popitem() assert val[0] == b"\xc2\xa3" def test_delete_and_contains(self): diff --git a/tests/test_http_request.py b/tests/test_http_request.py index 6bf0b8e3f..e22689d49 100644 --- a/tests/test_http_request.py +++ b/tests/test_http_request.py @@ -1,24 +1,12 @@ -import json -import re import warnings import xmlrpc.client from typing import Any -from unittest import mock -from urllib.parse import parse_qs, unquote_to_bytes import pytest -from scrapy.http import ( - FormRequest, - Headers, - HtmlResponse, - JsonRequest, - Request, - XmlRpcRequest, -) +from scrapy.http import Headers, Request, XmlRpcRequest from scrapy.http.request import NO_CALLBACK -from scrapy.utils.httpobj import urlparse_cached -from scrapy.utils.python import to_bytes, to_unicode +from scrapy.utils.python import to_bytes class TestRequest: @@ -35,7 +23,6 @@ class TestRequest: # url argument must be basestring with pytest.raises(TypeError): self.request_class(123) - r = self.request_class("http://www.example.com") r = self.request_class("http://www.example.com") assert isinstance(r.url, str) @@ -174,6 +161,19 @@ class TestRequest: r4 = self.request_class(url="http://www.example.org/r%E9sum%E9.html") assert r4.url == "http://www.example.org/r%E9sum%E9.html" + def test_url_verbatim(self): + r = self.request_class( + url="http://www.scrapy.org/price/£", + meta={"verbatim_url": True}, + ) + assert r.url == "http://www.scrapy.org/price/£" + + r = self.request_class( + url="http://www.scrapy.org/blank space", + meta={"verbatim_url": True}, + ) + assert r.url == "http://www.scrapy.org/blank space" + def test_body(self): r1 = self.request_class(url="http://www.example.com/") assert r1.body == b"" @@ -210,11 +210,11 @@ class TestRequest: r1.cb_kwargs["key"] = "value" r2 = r1.copy() - # make sure copy does not propagate callbacks + # make sure callbaclks are copied assert r1.callback is somecallback assert r1.errback is somecallback assert r2.callback is r1.callback - assert r2.errback is r2.errback + assert r2.errback is r1.errback # make sure flags list is shallow copied assert r1.flags is not r2.flags, "flags must be a shallow copy, not identical" @@ -329,6 +329,69 @@ class TestRequest: errback="a_function", ) + def test_setters(self): + request = self.request_class("http://example.com") + + request.flags = ["f1"] + assert request.flags == ["f1"] + + request.cookies = {"sid": "1"} + assert request.cookies == {"sid": "1"} + + headers = Headers({b"X-Test": b"1"}) + request.headers = headers + assert request._headers is headers + request.headers = {b"A": b"b"} + assert isinstance(request.headers, Headers) + assert request._headers[b"A"] == b"b" + + def test_setter_mutable_lazy_loading(self): + """Mutable attributes are set internally to None only until they are + read, then they always return the same falsy instance of the + corresponding mutable structure. + + Setting them to None causes the next read to return a different object. + """ + + request = self.request_class("http://example.com") + + assert request._flags is None + assert request.flags == [] + assert request.flags is request.flags + assert request._flags == [] + original_flags = request.flags + request.flags = None + assert request._flags is None + assert request.flags == [] + assert request.flags is not original_flags + + assert request._cookies is None + assert request.cookies == {} + assert request.cookies is request.cookies + assert request._cookies == {} + original_cookies = request.cookies + request.cookies = None + assert request._cookies is None + assert request.cookies == {} + assert request.cookies is not original_cookies + + if self.default_headers: + assert request._headers == self.default_headers + assert request._headers is not self.default_headers + assert request.headers == self.default_headers + else: + assert request._headers is None + assert request.headers == {} + assert request.headers is request.headers + assert isinstance(request.headers, Headers) + assert isinstance(request._headers, Headers) + original_headers = request.headers + request.headers = None + assert request._headers is None + assert request.headers == {} + assert request._headers == {} + assert request.headers is not original_headers + def test_no_callback(self): with pytest.raises(RuntimeError): NO_CALLBACK() @@ -397,11 +460,13 @@ class TestRequest: def test_from_curl_ignore_unknown_options(self): # By default: it works and ignores the unknown options: --foo and -z with warnings.catch_warnings(): # avoid warning when executing tests - warnings.simplefilter("ignore") + warnings.filterwarnings( + "ignore", category=UserWarning, message="Unrecognized options:" + ) r = self.request_class.from_curl( 'curl -X DELETE "http://example.org" --foo -z', ) - assert r.method == "DELETE" + assert r.method == "DELETE" # If `ignore_unknown_options` is set to `False` it raises an error with # the unknown options: --foo and -z @@ -412,1022 +477,6 @@ class TestRequest: ) -class TestFormRequest(TestRequest): - request_class = FormRequest - - def assertQueryEqual(self, first, second, msg=None): - first = to_unicode(first).split("&") - second = to_unicode(second).split("&") - assert sorted(first) == sorted(second), msg - - def test_empty_formdata(self): - r1 = self.request_class("http://www.example.com", formdata={}) - assert r1.body == b"" - - def test_formdata_overrides_querystring(self): - data = (("a", "one"), ("a", "two"), ("b", "2")) - url = self.request_class( - "http://www.example.com/?a=0&b=1&c=3#fragment", method="GET", formdata=data - ).url.split("#", maxsplit=1)[0] - fs = _qs(self.request_class(url, method="GET", formdata=data)) - assert set(fs[b"a"]) == {b"one", b"two"} - assert fs[b"b"] == [b"2"] - assert fs.get(b"c") is None - - data = {"a": "1", "b": "2"} - fs = _qs( - self.request_class("http://www.example.com/", method="GET", formdata=data) - ) - assert fs[b"a"] == [b"1"] - assert fs[b"b"] == [b"2"] - - def test_default_encoding_bytes(self): - # using default encoding (utf-8) - data = {b"one": b"two", b"price": b"\xc2\xa3 100"} - r2 = self.request_class("http://www.example.com", formdata=data) - assert r2.method == "POST" - assert r2.encoding == "utf-8" - self.assertQueryEqual(r2.body, b"price=%C2%A3+100&one=two") - assert r2.headers[b"Content-Type"] == b"application/x-www-form-urlencoded" - - def test_default_encoding_textual_data(self): - # using default encoding (utf-8) - data = {"µ one": "two", "price": "£ 100"} - r2 = self.request_class("http://www.example.com", formdata=data) - assert r2.method == "POST" - assert r2.encoding == "utf-8" - self.assertQueryEqual(r2.body, b"price=%C2%A3+100&%C2%B5+one=two") - assert r2.headers[b"Content-Type"] == b"application/x-www-form-urlencoded" - - def test_default_encoding_mixed_data(self): - # using default encoding (utf-8) - data = {"\u00b5one": b"two", b"price\xc2\xa3": "\u00a3 100"} - r2 = self.request_class("http://www.example.com", formdata=data) - assert r2.method == "POST" - assert r2.encoding == "utf-8" - self.assertQueryEqual(r2.body, b"%C2%B5one=two&price%C2%A3=%C2%A3+100") - assert r2.headers[b"Content-Type"] == b"application/x-www-form-urlencoded" - - def test_custom_encoding_bytes(self): - data = {b"\xb5 one": b"two", b"price": b"\xa3 100"} - r2 = self.request_class( - "http://www.example.com", formdata=data, encoding="latin1" - ) - assert r2.method == "POST" - assert r2.encoding == "latin1" - self.assertQueryEqual(r2.body, b"price=%A3+100&%B5+one=two") - assert r2.headers[b"Content-Type"] == b"application/x-www-form-urlencoded" - - def test_custom_encoding_textual_data(self): - data = {"price": "£ 100"} - r3 = self.request_class( - "http://www.example.com", formdata=data, encoding="latin1" - ) - assert r3.encoding == "latin1" - assert r3.body == b"price=%A3+100" - - def test_multi_key_values(self): - # using multiples values for a single key - data = {"price": "\xa3 100", "colours": ["red", "blue", "green"]} - r3 = self.request_class("http://www.example.com", formdata=data) - self.assertQueryEqual( - r3.body, b"colours=red&colours=blue&colours=green&price=%C2%A3+100" - ) - - def test_from_response_post(self): - response = _buildresponse( - b""" - - - - """, - url="http://www.example.com/this/list.html", - ) - req = self.request_class.from_response( - response, formdata={"one": ["two", "three"], "six": "seven"} - ) - - assert req.method == "POST" - assert req.headers[b"Content-type"] == b"application/x-www-form-urlencoded" - assert req.url == "http://www.example.com/this/post.php" - fs = _qs(req) - assert set(fs[b"test"]) == {b"val1", b"val2"} - assert set(fs[b"one"]) == {b"two", b"three"} - assert fs[b"test2"] == [b"xxx"] - assert fs[b"six"] == [b"seven"] - - def test_from_response_post_nonascii_bytes_utf8(self): - response = _buildresponse( - b"""
- - - -
""", - url="http://www.example.com/this/list.html", - ) - req = self.request_class.from_response( - response, formdata={"one": ["two", "three"], "six": "seven"} - ) - - assert req.method == "POST" - assert req.headers[b"Content-type"] == b"application/x-www-form-urlencoded" - assert req.url == "http://www.example.com/this/post.php" - fs = _qs(req, to_unicode=True) - assert set(fs["test £"]) == {"val1", "val2"} - assert set(fs["one"]) == {"two", "three"} - assert fs["test2"] == ["xxx µ"] - assert fs["six"] == ["seven"] - - def test_from_response_post_nonascii_bytes_latin1(self): - response = _buildresponse( - b"""
- - - -
""", - url="http://www.example.com/this/list.html", - encoding="latin1", - ) - req = self.request_class.from_response( - response, formdata={"one": ["two", "three"], "six": "seven"} - ) - - assert req.method == "POST" - assert req.headers[b"Content-type"] == b"application/x-www-form-urlencoded" - assert req.url == "http://www.example.com/this/post.php" - fs = _qs(req, to_unicode=True, encoding="latin1") - assert set(fs["test £"]) == {"val1", "val2"} - assert set(fs["one"]) == {"two", "three"} - assert fs["test2"] == ["xxx µ"] - assert fs["six"] == ["seven"] - - def test_from_response_post_nonascii_unicode(self): - response = _buildresponse( - """
- - - -
""", - url="http://www.example.com/this/list.html", - ) - req = self.request_class.from_response( - response, formdata={"one": ["two", "three"], "six": "seven"} - ) - - assert req.method == "POST" - assert req.headers[b"Content-type"] == b"application/x-www-form-urlencoded" - assert req.url == "http://www.example.com/this/post.php" - fs = _qs(req, to_unicode=True) - assert set(fs["test £"]) == {"val1", "val2"} - assert set(fs["one"]) == {"two", "three"} - assert fs["test2"] == ["xxx µ"] - assert fs["six"] == ["seven"] - - def test_from_response_duplicate_form_key(self): - response = _buildresponse("
", url="http://www.example.com") - req = self.request_class.from_response( - response=response, - method="GET", - formdata=(("foo", "bar"), ("foo", "baz")), - ) - assert urlparse_cached(req).hostname == "www.example.com" - assert urlparse_cached(req).query == "foo=bar&foo=baz" - - def test_from_response_override_duplicate_form_key(self): - response = _buildresponse( - """
- - -
""" - ) - req = self.request_class.from_response( - response, formdata=(("two", "2"), ("two", "4")) - ) - fs = _qs(req) - assert fs[b"one"] == [b"1"] - assert fs[b"two"] == [b"2", b"4"] - - def test_from_response_extra_headers(self): - response = _buildresponse( - """
- - - -
""" - ) - req = self.request_class.from_response( - response=response, - formdata={"one": ["two", "three"], "six": "seven"}, - headers={"Accept-Encoding": "gzip,deflate"}, - ) - assert req.method == "POST" - assert req.headers["Content-type"] == b"application/x-www-form-urlencoded" - assert req.headers["Accept-Encoding"] == b"gzip,deflate" - - def test_from_response_get(self): - response = _buildresponse( - """
- - - -
""", - url="http://www.example.com/this/list.html", - ) - r1 = self.request_class.from_response( - response, formdata={"one": ["two", "three"], "six": "seven"} - ) - assert r1.method == "GET" - assert urlparse_cached(r1).hostname == "www.example.com" - assert urlparse_cached(r1).path == "/this/get.php" - fs = _qs(r1) - assert set(fs[b"test"]) == {b"val1", b"val2"} - assert set(fs[b"one"]) == {b"two", b"three"} - assert fs[b"test2"] == [b"xxx"] - assert fs[b"six"] == [b"seven"] - - def test_from_response_override_params(self): - response = _buildresponse( - """
- - -
""" - ) - req = self.request_class.from_response(response, formdata={"two": "2"}) - fs = _qs(req) - assert fs[b"one"] == [b"1"] - assert fs[b"two"] == [b"2"] - - def test_from_response_drop_params(self): - response = _buildresponse( - """
- - -
""" - ) - req = self.request_class.from_response(response, formdata={"two": None}) - fs = _qs(req) - assert fs[b"one"] == [b"1"] - assert b"two" not in fs - - def test_from_response_override_method(self): - response = _buildresponse( - """ -
- """ - ) - request = FormRequest.from_response(response) - assert request.method == "GET" - request = FormRequest.from_response(response, method="POST") - assert request.method == "POST" - - def test_from_response_override_url(self): - response = _buildresponse( - """ -
- """ - ) - request = FormRequest.from_response(response) - assert request.url == "http://example.com/app" - request = FormRequest.from_response(response, url="http://foo.bar/absolute") - assert request.url == "http://foo.bar/absolute" - request = FormRequest.from_response(response, url="/relative") - assert request.url == "http://example.com/relative" - - def test_from_response_case_insensitive(self): - response = _buildresponse( - """
- - - -
""" - ) - req = self.request_class.from_response(response) - fs = _qs(req) - assert fs[b"clickable1"] == [b"clicked1"] - assert b"i1" not in fs, fs # xpath in _get_inputs() - assert b"clickable2" not in fs, fs # xpath in _get_clickable() - - def test_from_response_submit_first_clickable(self): - response = _buildresponse( - """
- - - - -
""" - ) - req = self.request_class.from_response(response, formdata={"two": "2"}) - fs = _qs(req) - assert fs[b"clickable1"] == [b"clicked1"] - assert b"clickable2" not in fs, fs - assert fs[b"one"] == [b"1"] - assert fs[b"two"] == [b"2"] - - def test_from_response_submit_not_first_clickable(self): - response = _buildresponse( - """
- - - - -
""" - ) - req = self.request_class.from_response( - response, formdata={"two": "2"}, clickdata={"name": "clickable2"} - ) - fs = _qs(req) - assert fs[b"clickable2"] == [b"clicked2"] - assert b"clickable1" not in fs, fs - assert fs[b"one"] == [b"1"] - assert fs[b"two"] == [b"2"] - - def test_from_response_dont_submit_image_as_input(self): - response = _buildresponse( - """
- - - -
""" - ) - req = self.request_class.from_response(response, dont_click=True) - fs = _qs(req) - assert fs == {b"i1": [b"i1v"]} - - def test_from_response_dont_submit_reset_as_input(self): - response = _buildresponse( - """
- - - - -
""" - ) - req = self.request_class.from_response(response, dont_click=True) - fs = _qs(req) - assert fs == {b"i1": [b"i1v"], b"i2": [b"i2v"]} - - def test_from_response_clickdata_does_not_ignore_image(self): - response = _buildresponse( - """
- - -
""" - ) - req = self.request_class.from_response(response) - fs = _qs(req) - assert fs == {b"i1": [b"i1v"], b"i2": [b"i2v"]} - - def test_from_response_multiple_clickdata(self): - response = _buildresponse( - """
- - - - -
""" - ) - req = self.request_class.from_response( - response, clickdata={"name": "clickable", "value": "clicked2"} - ) - fs = _qs(req) - assert fs[b"clickable"] == [b"clicked2"] - assert fs[b"one"] == [b"clicked1"] - assert fs[b"two"] == [b"clicked2"] - - def test_from_response_unicode_clickdata(self): - response = _buildresponse( - """
- - - - -
""" - ) - req = self.request_class.from_response( - response, clickdata={"name": "price in \u00a3"} - ) - fs = _qs(req, to_unicode=True) - assert fs["price in \u00a3"] - - def test_from_response_unicode_clickdata_latin1(self): - response = _buildresponse( - """
- - - - -
""", - encoding="latin1", - ) - req = self.request_class.from_response( - response, clickdata={"name": "price in \u00a5"} - ) - fs = _qs(req, to_unicode=True, encoding="latin1") - assert fs["price in \u00a5"] - - def test_from_response_multiple_forms_clickdata(self): - response = _buildresponse( - """
- - -
-
- - -
- """ - ) - req = self.request_class.from_response( - response, formname="form2", clickdata={"name": "clickable"} - ) - fs = _qs(req) - assert fs[b"clickable"] == [b"clicked2"] - assert fs[b"field2"] == [b"value2"] - assert b"field1" not in fs, fs - - def test_from_response_override_clickable(self): - response = _buildresponse( - """
""" - ) - req = self.request_class.from_response( - response, formdata={"clickme": "two"}, clickdata={"name": "clickme"} - ) - fs = _qs(req) - assert fs[b"clickme"] == [b"two"] - - def test_from_response_dont_click(self): - response = _buildresponse( - """
- - - - -
""" - ) - r1 = self.request_class.from_response(response, dont_click=True) - fs = _qs(r1) - assert b"clickable1" not in fs, fs - assert b"clickable2" not in fs, fs - - def test_from_response_ambiguous_clickdata(self): - response = _buildresponse( - """ -
- - - - -
""" - ) - with pytest.raises( - ValueError, - match="Multiple elements found .* matching the criteria in clickdata", - ): - self.request_class.from_response(response, clickdata={"type": "submit"}) - - def test_from_response_non_matching_clickdata(self): - response = _buildresponse( - """
- -
""" - ) - with pytest.raises( - ValueError, match="No clickable element matching clickdata:" - ): - self.request_class.from_response( - response, clickdata={"nonexistent": "notme"} - ) - - def test_from_response_nr_index_clickdata(self): - response = _buildresponse( - """
- - -
- """ - ) - req = self.request_class.from_response(response, clickdata={"nr": 1}) - fs = _qs(req) - assert b"clickable2" in fs - assert b"clickable1" not in fs - - def test_from_response_invalid_nr_index_clickdata(self): - response = _buildresponse( - """
- -
- """ - ) - with pytest.raises( - ValueError, match="No clickable element matching clickdata:" - ): - self.request_class.from_response(response, clickdata={"nr": 1}) - - def test_from_response_errors_noform(self): - response = _buildresponse("""""") - with pytest.raises(ValueError, match="No
element found in"): - self.request_class.from_response(response) - - def test_from_response_invalid_html5(self): - response = _buildresponse( - """""" - """""" - """
""" - ) - req = self.request_class.from_response(response, formdata={"bar": "buz"}) - fs = _qs(req) - assert fs == {b"foo": [b"xxx"], b"bar": [b"buz"]} - - def test_from_response_errors_formnumber(self): - response = _buildresponse( - """
- - - -
""" - ) - with pytest.raises(IndexError): - self.request_class.from_response(response, formnumber=1) - - def test_from_response_noformname(self): - response = _buildresponse( - """
- - -
""" - ) - r1 = self.request_class.from_response(response, formdata={"two": "3"}) - assert r1.method == "POST" - assert r1.headers["Content-type"] == b"application/x-www-form-urlencoded" - fs = _qs(r1) - assert fs == {b"one": [b"1"], b"two": [b"3"]} - - def test_from_response_formname_exists(self): - response = _buildresponse( - """
- - -
-
- - -
""" - ) - r1 = self.request_class.from_response(response, formname="form2") - assert r1.method == "POST" - fs = _qs(r1) - assert fs == {b"four": [b"4"], b"three": [b"3"]} - - def test_from_response_formname_nonexistent(self): - response = _buildresponse( - """
- -
-
- -
""" - ) - r1 = self.request_class.from_response(response, formname="form3") - assert r1.method == "POST" - fs = _qs(r1) - assert fs == {b"one": [b"1"]} - - def test_from_response_formname_errors_formnumber(self): - response = _buildresponse( - """
- -
-
- -
""" - ) - with pytest.raises(IndexError): - self.request_class.from_response(response, formname="form3", formnumber=2) - - def test_from_response_formid_exists(self): - response = _buildresponse( - """
- - -
-
- - -
""" - ) - r1 = self.request_class.from_response(response, formid="form2") - assert r1.method == "POST" - fs = _qs(r1) - assert fs == {b"four": [b"4"], b"three": [b"3"]} - - def test_from_response_formname_nonexistent_fallback_formid(self): - response = _buildresponse( - """
- - -
-
- - -
""" - ) - r1 = self.request_class.from_response( - response, formname="form3", formid="form2" - ) - assert r1.method == "POST" - fs = _qs(r1) - assert fs == {b"four": [b"4"], b"three": [b"3"]} - - def test_from_response_formid_nonexistent(self): - response = _buildresponse( - """
- -
-
- -
""" - ) - r1 = self.request_class.from_response(response, formid="form3") - assert r1.method == "POST" - fs = _qs(r1) - assert fs == {b"one": [b"1"]} - - def test_from_response_formid_errors_formnumber(self): - response = _buildresponse( - """
- -
-
- -
""" - ) - with pytest.raises(IndexError): - self.request_class.from_response(response, formid="form3", formnumber=2) - - def test_from_response_select(self): - res = _buildresponse( - """
- - - - - - - - - - - - - - -
""" - ) - req = self.request_class.from_response(res) - fs = _qs(req) - assert fs == {b"i1": [b"iv2"], b"i2": [b"on"]} - - def test_from_response_checkbox(self): - res = _buildresponse( - """
- - - - - - - - -
""" - ) - req = self.request_class.from_response(res) - fs = _qs(req) - assert fs == {b"i1": [b"iv2"], b"i2": [b"on"]} - - def test_from_response_input_text(self): - res = _buildresponse( - """
- - - - - -
""" - ) - req = self.request_class.from_response(res) - fs = _qs(req) - assert fs == {b"i1": [b"i1v1"], b"i2": [b""], b"i4": [b"i4v1"]} - - def test_from_response_input_hidden(self): - res = _buildresponse( - """
- - - - -
""" - ) - req = self.request_class.from_response(res) - fs = _qs(req) - assert fs == {b"i1": [b"i1v1"], b"i2": [b""]} - - def test_from_response_input_textarea(self): - res = _buildresponse( - """
- - - -
""" - ) - req = self.request_class.from_response(res) - fs = _qs(req) - assert fs == {b"i1": [b"i1v"], b"i2": [b""], b"i3": [b""]} - - def test_from_response_descendants(self): - res = _buildresponse( - """
-
-
- - -
- - - - -
- -
""" - ) - req = self.request_class.from_response(res) - fs = _qs(req) - assert set(fs) == {b"h2", b"i2", b"i1", b"i3", b"h1", b"i5", b"i4"} - - def test_from_response_xpath(self): - response = _buildresponse( - """
- - -
-
- - -
""" - ) - r1 = self.request_class.from_response( - response, formxpath="//form[@action='post.php']" - ) - fs = _qs(r1) - assert fs[b"one"] == [b"1"] - - r1 = self.request_class.from_response( - response, formxpath="//form/input[@name='four']" - ) - fs = _qs(r1) - assert fs[b"three"] == [b"3"] - - with pytest.raises(ValueError, match="No
element found with"): - self.request_class.from_response( - response, formxpath="//form/input[@name='abc']" - ) - - def test_from_response_unicode_xpath(self): - response = _buildresponse(b'
') - r = self.request_class.from_response( - response, formxpath="//form[@name='\u044a']" - ) - fs = _qs(r) - assert not fs - - xpath = "//form[@name='\u03b1']" - with pytest.raises(ValueError, match=re.escape(xpath)): - self.request_class.from_response(response, formxpath=xpath) - - def test_from_response_button_submit(self): - response = _buildresponse( - """
- - - -
""", - url="http://www.example.com/this/list.html", - ) - req = self.request_class.from_response(response) - assert req.method == "POST" - assert req.headers["Content-type"] == b"application/x-www-form-urlencoded" - assert req.url == "http://www.example.com/this/post.php" - fs = _qs(req) - assert fs[b"test1"] == [b"val1"] - assert fs[b"test2"] == [b"val2"] - assert fs[b"button1"] == [b"submit1"] - - def test_from_response_button_notype(self): - response = _buildresponse( - """
- - - -
""", - url="http://www.example.com/this/list.html", - ) - req = self.request_class.from_response(response) - assert req.method == "POST" - assert req.headers["Content-type"] == b"application/x-www-form-urlencoded" - assert req.url == "http://www.example.com/this/post.php" - fs = _qs(req) - assert fs[b"test1"] == [b"val1"] - assert fs[b"test2"] == [b"val2"] - assert fs[b"button1"] == [b"submit1"] - - def test_from_response_submit_novalue(self): - response = _buildresponse( - """
- - - Submit -
""", - url="http://www.example.com/this/list.html", - ) - req = self.request_class.from_response(response) - assert req.method == "POST" - assert req.headers["Content-type"] == b"application/x-www-form-urlencoded" - assert req.url == "http://www.example.com/this/post.php" - fs = _qs(req) - assert fs[b"test1"] == [b"val1"] - assert fs[b"test2"] == [b"val2"] - assert fs[b"button1"] == [b""] - - def test_from_response_button_novalue(self): - response = _buildresponse( - """
- - - -
""", - url="http://www.example.com/this/list.html", - ) - req = self.request_class.from_response(response) - assert req.method == "POST" - assert req.headers["Content-type"] == b"application/x-www-form-urlencoded" - assert req.url == "http://www.example.com/this/post.php" - fs = _qs(req) - assert fs[b"test1"] == [b"val1"] - assert fs[b"test2"] == [b"val2"] - assert fs[b"button1"] == [b""] - - def test_html_base_form_action(self): - response = _buildresponse( - """ - - - - - -
-
- - - """, - url="http://a.com/", - ) - req = self.request_class.from_response(response) - assert req.url == "http://b.com/test_form" - - def test_spaces_in_action(self): - resp = _buildresponse('
') - req = self.request_class.from_response(resp) - assert req.url == "http://example.com/path" - - def test_from_response_css(self): - response = _buildresponse( - """
- - -
-
- - -
""" - ) - r1 = self.request_class.from_response( - response, formcss="form[action='post.php']" - ) - fs = _qs(r1) - assert fs[b"one"] == [b"1"] - - r1 = self.request_class.from_response(response, formcss="input[name='four']") - fs = _qs(r1) - assert fs[b"three"] == [b"3"] - - with pytest.raises(ValueError, match="No
element found with"): - self.request_class.from_response(response, formcss="input[name='abc']") - - def test_from_response_valid_form_methods(self): - form_methods = [ - [method, method] for method in self.request_class.valid_form_methods - ] - form_methods.append(["UNKNOWN", "GET"]) - - for method, expected in form_methods: - response = _buildresponse( - f'' - '' - "
" - ) - r = self.request_class.from_response(response) - assert r.method == expected - - def test_form_response_with_invalid_formdata_type_error(self): - """Test that a ValueError is raised for non-iterable and non-dict formdata input""" - response = _buildresponse( - """ -
- -
- """ - ) - with pytest.raises( - ValueError, match="formdata should be a dict or iterable of tuples" - ): - FormRequest.from_response(response, formdata=123) - - def test_form_response_with_custom_invalid_formdata_value_error(self): - """Test that a ValueError is raised for fault-inducing iterable formdata input""" - response = _buildresponse( - """ -
- -
- """ - ) - - with pytest.raises( - ValueError, match="formdata should be a dict or iterable of tuples" - ): - FormRequest.from_response(response, formdata=("a",)) - - def test_get_form_with_xpath_no_form_parent(self): - """Test that _get_from raised a ValueError when an XPath selects an element - not nested within a
and no parent is found""" - response = _buildresponse( - """ -
-

This paragraph is not inside a form.

-
- - -
- """ - ) - - with pytest.raises(ValueError, match="No
element found with"): - FormRequest.from_response(response, formxpath='//div[@id="outside-form"]/p') - - -def _buildresponse(body, **kwargs): - kwargs.setdefault("body", body) - kwargs.setdefault("url", "http://example.com") - kwargs.setdefault("encoding", "utf-8") - return HtmlResponse(**kwargs) - - -def _qs(req, encoding="utf-8", to_unicode=False): - qs = req.body if req.method == "POST" else req.url.partition("?")[2] - uqs = unquote_to_bytes(qs) - if to_unicode: - uqs = uqs.decode(encoding) - return parse_qs(uqs, True) - - class TestXmlRpcRequest(TestRequest): request_class = XmlRpcRequest default_method = "POST" @@ -1441,7 +490,7 @@ class TestXmlRpcRequest(TestRequest): ) assert r.method == "POST" assert r.encoding == kwargs.get("encoding", "utf-8") - assert r.dont_filter, True + assert r.dont_filter def test_xmlrpc_dumps(self): self._test_request(params=("value",)) @@ -1456,190 +505,3 @@ class TestXmlRpcRequest(TestRequest): def test_latin1(self): self._test_request(params=("pas£",), encoding="latin1") - - -class TestJsonRequest(TestRequest): - request_class = JsonRequest - default_method = "GET" - default_headers = { - b"Content-Type": [b"application/json"], - b"Accept": [b"application/json, text/javascript, */*; q=0.01"], - } - - def setup_method(self): - warnings.simplefilter("always") - - def teardown_method(self): - warnings.resetwarnings() - - def test_data(self): - r1 = self.request_class(url="http://www.example.com/") - assert r1.body == b"" - - body = b"body" - r2 = self.request_class(url="http://www.example.com/", body=body) - assert r2.body == body - - data = { - "name": "value", - } - r3 = self.request_class(url="http://www.example.com/", data=data) - assert r3.body == to_bytes(json.dumps(data)) - - # empty data - r4 = self.request_class(url="http://www.example.com/", data=[]) - assert r4.body == to_bytes(json.dumps([])) - - def test_data_method(self): - # data is not passed - r1 = self.request_class(url="http://www.example.com/") - assert r1.method == "GET" - - body = b"body" - r2 = self.request_class(url="http://www.example.com/", body=body) - assert r2.method == "GET" - - data = { - "name": "value", - } - r3 = self.request_class(url="http://www.example.com/", data=data) - assert r3.method == "POST" - - # method passed explicitly - r4 = self.request_class(url="http://www.example.com/", data=data, method="GET") - assert r4.method == "GET" - - r5 = self.request_class(url="http://www.example.com/", data=[]) - assert r5.method == "POST" - - def test_body_data(self): - """passing both body and data should result a warning""" - body = b"body" - data = { - "name": "value", - } - with warnings.catch_warnings(record=True) as _warnings: - r5 = self.request_class(url="http://www.example.com/", body=body, data=data) - assert r5.body == body - assert r5.method == "GET" - assert len(_warnings) == 1 - assert "data will be ignored" in str(_warnings[0].message) - - def test_empty_body_data(self): - """passing any body value and data should result a warning""" - data = { - "name": "value", - } - with warnings.catch_warnings(record=True) as _warnings: - r6 = self.request_class(url="http://www.example.com/", body=b"", data=data) - assert r6.body == b"" - assert r6.method == "GET" - assert len(_warnings) == 1 - assert "data will be ignored" in str(_warnings[0].message) - - def test_body_none_data(self): - data = { - "name": "value", - } - with warnings.catch_warnings(record=True) as _warnings: - r7 = self.request_class(url="http://www.example.com/", body=None, data=data) - assert r7.body == to_bytes(json.dumps(data)) - assert r7.method == "POST" - assert len(_warnings) == 0 - - def test_body_data_none(self): - with warnings.catch_warnings(record=True) as _warnings: - r8 = self.request_class(url="http://www.example.com/", body=None, data=None) - assert r8.method == "GET" - assert len(_warnings) == 0 - - def test_dumps_sort_keys(self): - """Test that sort_keys=True is passed to json.dumps by default""" - data = { - "name": "value", - } - with mock.patch("json.dumps", return_value=b"") as mock_dumps: - self.request_class(url="http://www.example.com/", data=data) - kwargs = mock_dumps.call_args[1] - assert kwargs["sort_keys"] is True - - def test_dumps_kwargs(self): - """Test that dumps_kwargs are passed to json.dumps""" - data = { - "name": "value", - } - dumps_kwargs = { - "ensure_ascii": True, - "allow_nan": True, - } - with mock.patch("json.dumps", return_value=b"") as mock_dumps: - self.request_class( - url="http://www.example.com/", data=data, dumps_kwargs=dumps_kwargs - ) - kwargs = mock_dumps.call_args[1] - assert kwargs["ensure_ascii"] is True - assert kwargs["allow_nan"] is True - - def test_replace_data(self): - data1 = { - "name1": "value1", - } - data2 = { - "name2": "value2", - } - r1 = self.request_class(url="http://www.example.com/", data=data1) - r2 = r1.replace(data=data2) - assert r2.body == to_bytes(json.dumps(data2)) - - def test_replace_sort_keys(self): - """Test that replace provides sort_keys=True to json.dumps""" - data1 = { - "name1": "value1", - } - data2 = { - "name2": "value2", - } - r1 = self.request_class(url="http://www.example.com/", data=data1) - with mock.patch("json.dumps", return_value=b"") as mock_dumps: - r1.replace(data=data2) - kwargs = mock_dumps.call_args[1] - assert kwargs["sort_keys"] is True - - def test_replace_dumps_kwargs(self): - """Test that dumps_kwargs are provided to json.dumps when replace is called""" - data1 = { - "name1": "value1", - } - data2 = { - "name2": "value2", - } - dumps_kwargs = { - "ensure_ascii": True, - "allow_nan": True, - } - r1 = self.request_class( - url="http://www.example.com/", data=data1, dumps_kwargs=dumps_kwargs - ) - with mock.patch("json.dumps", return_value=b"") as mock_dumps: - r1.replace(data=data2) - kwargs = mock_dumps.call_args[1] - assert kwargs["ensure_ascii"] is True - assert kwargs["allow_nan"] is True - - def test_replacement_both_body_and_data_warns(self): - """Test that we get a warning if both body and data are passed""" - body1 = None - body2 = b"body" - data1 = { - "name1": "value1", - } - data2 = { - "name2": "value2", - } - r1 = self.request_class(url="http://www.example.com/", data=data1, body=body1) - - with warnings.catch_warnings(record=True) as _warnings: - r1.replace(data=data2, body=body2) - assert "Both body and data passed. data will be ignored" in str( - _warnings[0].message - ) diff --git a/tests/test_http_request_form.py b/tests/test_http_request_form.py new file mode 100644 index 000000000..a4f87d50d --- /dev/null +++ b/tests/test_http_request_form.py @@ -0,0 +1,1028 @@ +from __future__ import annotations + +import re +from urllib.parse import parse_qs, unquote_to_bytes + +import pytest + +from scrapy.http import FormRequest, HtmlResponse +from scrapy.utils.httpobj import urlparse_cached +from scrapy.utils.python import to_unicode +from tests.test_http_request import TestRequest + + +def _buildresponse(body, **kwargs): + kwargs.setdefault("body", body) + kwargs.setdefault("url", "http://example.com") + kwargs.setdefault("encoding", "utf-8") + return HtmlResponse(**kwargs) + + +def _qs(req, encoding="utf-8", to_unicode=False): + qs = req.body if req.method == "POST" else req.url.partition("?")[2] + uqs = unquote_to_bytes(qs) + if to_unicode: + uqs = uqs.decode(encoding) + return parse_qs(uqs, True) + + +@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") +class TestFormRequest(TestRequest): + request_class = FormRequest # type: ignore[assignment] + + def assertQueryEqual(self, first, second, msg=None): + first = to_unicode(first).split("&") + second = to_unicode(second).split("&") + assert sorted(first) == sorted(second), msg + + def test_empty_formdata(self): + r1 = self.request_class("http://www.example.com", formdata={}) + assert r1.body == b"" + + def test_formdata_overrides_querystring(self): + data = (("a", "one"), ("a", "two"), ("b", "2")) + url = self.request_class( + "http://www.example.com/?a=0&b=1&c=3#fragment", method="GET", formdata=data + ).url.split("#", maxsplit=1)[0] + fs = _qs(self.request_class(url, method="GET", formdata=data)) + assert set(fs[b"a"]) == {b"one", b"two"} + assert fs[b"b"] == [b"2"] + assert fs.get(b"c") is None + + data = {"a": "1", "b": "2"} + fs = _qs( + self.request_class("http://www.example.com/", method="GET", formdata=data) + ) + assert fs[b"a"] == [b"1"] + assert fs[b"b"] == [b"2"] + + def test_default_encoding_bytes(self): + # using default encoding (utf-8) + data = {b"one": b"two", b"price": b"\xc2\xa3 100"} + r2 = self.request_class("http://www.example.com", formdata=data) + assert r2.method == "POST" + assert r2.encoding == "utf-8" + self.assertQueryEqual(r2.body, b"price=%C2%A3+100&one=two") + assert r2.headers[b"Content-Type"] == b"application/x-www-form-urlencoded" + + def test_default_encoding_textual_data(self): + # using default encoding (utf-8) + data = {"µ one": "two", "price": "£ 100"} + r2 = self.request_class("http://www.example.com", formdata=data) + assert r2.method == "POST" + assert r2.encoding == "utf-8" + self.assertQueryEqual(r2.body, b"price=%C2%A3+100&%C2%B5+one=two") + assert r2.headers[b"Content-Type"] == b"application/x-www-form-urlencoded" + + def test_default_encoding_mixed_data(self): + # using default encoding (utf-8) + data = {"\u00b5one": b"two", b"price\xc2\xa3": "\u00a3 100"} + r2 = self.request_class("http://www.example.com", formdata=data) + assert r2.method == "POST" + assert r2.encoding == "utf-8" + self.assertQueryEqual(r2.body, b"%C2%B5one=two&price%C2%A3=%C2%A3+100") + assert r2.headers[b"Content-Type"] == b"application/x-www-form-urlencoded" + + def test_custom_encoding_bytes(self): + data = {b"\xb5 one": b"two", b"price": b"\xa3 100"} + r2 = self.request_class( + "http://www.example.com", formdata=data, encoding="latin1" + ) + assert r2.method == "POST" + assert r2.encoding == "latin1" + self.assertQueryEqual(r2.body, b"price=%A3+100&%B5+one=two") + assert r2.headers[b"Content-Type"] == b"application/x-www-form-urlencoded" + + def test_custom_encoding_textual_data(self): + data = {"price": "£ 100"} + r3 = self.request_class( + "http://www.example.com", formdata=data, encoding="latin1" + ) + assert r3.encoding == "latin1" + assert r3.body == b"price=%A3+100" + + def test_multi_key_values(self): + # using multiples values for a single key + data = {"price": "\xa3 100", "colours": ["red", "blue", "green"]} + r3 = self.request_class("http://www.example.com", formdata=data) + self.assertQueryEqual( + r3.body, b"colours=red&colours=blue&colours=green&price=%C2%A3+100" + ) + + def test_from_response_post(self): + response = _buildresponse( + b""" + + + +
""", + url="http://www.example.com/this/list.html", + ) + req = self.request_class.from_response( + response, formdata={"one": ["two", "three"], "six": "seven"} + ) + + assert req.method == "POST" + assert req.headers[b"Content-type"] == b"application/x-www-form-urlencoded" + assert req.url == "http://www.example.com/this/post.php" + fs = _qs(req) + assert set(fs[b"test"]) == {b"val1", b"val2"} + assert set(fs[b"one"]) == {b"two", b"three"} + assert fs[b"test2"] == [b"xxx"] + assert fs[b"six"] == [b"seven"] + + def test_from_response_post_nonascii_bytes_utf8(self): + response = _buildresponse( + b"""
+ + + +
""", + url="http://www.example.com/this/list.html", + ) + req = self.request_class.from_response( + response, formdata={"one": ["two", "three"], "six": "seven"} + ) + + assert req.method == "POST" + assert req.headers[b"Content-type"] == b"application/x-www-form-urlencoded" + assert req.url == "http://www.example.com/this/post.php" + fs = _qs(req, to_unicode=True) + assert set(fs["test £"]) == {"val1", "val2"} + assert set(fs["one"]) == {"two", "three"} + assert fs["test2"] == ["xxx µ"] + assert fs["six"] == ["seven"] + + def test_from_response_post_nonascii_bytes_latin1(self): + response = _buildresponse( + b"""
+ + + +
""", + url="http://www.example.com/this/list.html", + encoding="latin1", + ) + req = self.request_class.from_response( + response, formdata={"one": ["two", "three"], "six": "seven"} + ) + + assert req.method == "POST" + assert req.headers[b"Content-type"] == b"application/x-www-form-urlencoded" + assert req.url == "http://www.example.com/this/post.php" + fs = _qs(req, to_unicode=True, encoding="latin1") + assert set(fs["test £"]) == {"val1", "val2"} + assert set(fs["one"]) == {"two", "three"} + assert fs["test2"] == ["xxx µ"] + assert fs["six"] == ["seven"] + + def test_from_response_post_nonascii_unicode(self): + response = _buildresponse( + """
+ + + +
""", + url="http://www.example.com/this/list.html", + ) + req = self.request_class.from_response( + response, formdata={"one": ["two", "three"], "six": "seven"} + ) + + assert req.method == "POST" + assert req.headers[b"Content-type"] == b"application/x-www-form-urlencoded" + assert req.url == "http://www.example.com/this/post.php" + fs = _qs(req, to_unicode=True) + assert set(fs["test £"]) == {"val1", "val2"} + assert set(fs["one"]) == {"two", "three"} + assert fs["test2"] == ["xxx µ"] + assert fs["six"] == ["seven"] + + def test_from_response_duplicate_form_key(self): + response = _buildresponse("
", url="http://www.example.com") + req = self.request_class.from_response( + response=response, + method="GET", + formdata=(("foo", "bar"), ("foo", "baz")), + ) + assert urlparse_cached(req).hostname == "www.example.com" + assert urlparse_cached(req).query == "foo=bar&foo=baz" + + def test_from_response_override_duplicate_form_key(self): + response = _buildresponse( + """
+ + +
""" + ) + req = self.request_class.from_response( + response, formdata=(("two", "2"), ("two", "4")) + ) + fs = _qs(req) + assert fs[b"one"] == [b"1"] + assert fs[b"two"] == [b"2", b"4"] + + def test_from_response_extra_headers(self): + response = _buildresponse( + """
+ + + +
""" + ) + req = self.request_class.from_response( + response=response, + formdata={"one": ["two", "three"], "six": "seven"}, + headers={"Accept-Encoding": "gzip,deflate"}, + ) + assert req.method == "POST" + assert req.headers["Content-type"] == b"application/x-www-form-urlencoded" + assert req.headers["Accept-Encoding"] == b"gzip,deflate" + + def test_from_response_get(self): + response = _buildresponse( + """
+ + + +
""", + url="http://www.example.com/this/list.html", + ) + r1 = self.request_class.from_response( + response, formdata={"one": ["two", "three"], "six": "seven"} + ) + assert r1.method == "GET" + assert urlparse_cached(r1).hostname == "www.example.com" + assert urlparse_cached(r1).path == "/this/get.php" + fs = _qs(r1) + assert set(fs[b"test"]) == {b"val1", b"val2"} + assert set(fs[b"one"]) == {b"two", b"three"} + assert fs[b"test2"] == [b"xxx"] + assert fs[b"six"] == [b"seven"] + + def test_from_response_override_params(self): + response = _buildresponse( + """
+ + +
""" + ) + req = self.request_class.from_response(response, formdata={"two": "2"}) + fs = _qs(req) + assert fs[b"one"] == [b"1"] + assert fs[b"two"] == [b"2"] + + def test_from_response_drop_params(self): + response = _buildresponse( + """
+ + +
""" + ) + req = self.request_class.from_response(response, formdata={"two": None}) + fs = _qs(req) + assert fs[b"one"] == [b"1"] + assert b"two" not in fs + + def test_from_response_override_method(self): + response = _buildresponse( + """ +
+ """ + ) + request = FormRequest.from_response(response) + assert request.method == "GET" + request = FormRequest.from_response(response, method="POST") + assert request.method == "POST" + + def test_from_response_override_url(self): + response = _buildresponse( + """ +
+ """ + ) + request = FormRequest.from_response(response) + assert request.url == "http://example.com/app" + request = FormRequest.from_response(response, url="http://foo.bar/absolute") + assert request.url == "http://foo.bar/absolute" + request = FormRequest.from_response(response, url="/relative") + assert request.url == "http://example.com/relative" + + def test_from_response_case_insensitive(self): + response = _buildresponse( + """
+ + + +
""" + ) + req = self.request_class.from_response(response) + fs = _qs(req) + assert fs[b"clickable1"] == [b"clicked1"] + assert b"i1" not in fs, fs # xpath in _get_inputs() + assert b"clickable2" not in fs, fs # xpath in _get_clickable() + + def test_from_response_submit_first_clickable(self): + response = _buildresponse( + """
+ + + + +
""" + ) + req = self.request_class.from_response(response, formdata={"two": "2"}) + fs = _qs(req) + assert fs[b"clickable1"] == [b"clicked1"] + assert b"clickable2" not in fs, fs + assert fs[b"one"] == [b"1"] + assert fs[b"two"] == [b"2"] + + def test_from_response_submit_not_first_clickable(self): + response = _buildresponse( + """
+ + + + +
""" + ) + req = self.request_class.from_response( + response, formdata={"two": "2"}, clickdata={"name": "clickable2"} + ) + fs = _qs(req) + assert fs[b"clickable2"] == [b"clicked2"] + assert b"clickable1" not in fs, fs + assert fs[b"one"] == [b"1"] + assert fs[b"two"] == [b"2"] + + def test_from_response_dont_submit_image_as_input(self): + response = _buildresponse( + """
+ + + +
""" + ) + req = self.request_class.from_response(response, dont_click=True) + fs = _qs(req) + assert fs == {b"i1": [b"i1v"]} + + def test_from_response_dont_submit_reset_as_input(self): + response = _buildresponse( + """
+ + + + +
""" + ) + req = self.request_class.from_response(response, dont_click=True) + fs = _qs(req) + assert fs == {b"i1": [b"i1v"], b"i2": [b"i2v"]} + + def test_from_response_clickdata_does_not_ignore_image(self): + response = _buildresponse( + """
+ + +
""" + ) + req = self.request_class.from_response(response) + fs = _qs(req) + assert fs == {b"i1": [b"i1v"], b"i2": [b"i2v"]} + + def test_from_response_multiple_clickdata(self): + response = _buildresponse( + """
+ + + + +
""" + ) + req = self.request_class.from_response( + response, clickdata={"name": "clickable", "value": "clicked2"} + ) + fs = _qs(req) + assert fs[b"clickable"] == [b"clicked2"] + assert fs[b"one"] == [b"clicked1"] + assert fs[b"two"] == [b"clicked2"] + + def test_from_response_unicode_clickdata(self): + response = _buildresponse( + """
+ + + + +
""" + ) + req = self.request_class.from_response( + response, clickdata={"name": "price in \u00a3"} + ) + fs = _qs(req, to_unicode=True) + assert fs["price in \u00a3"] + + def test_from_response_unicode_clickdata_latin1(self): + response = _buildresponse( + """
+ + + + +
""", + encoding="latin1", + ) + req = self.request_class.from_response( + response, clickdata={"name": "price in \u00a5"} + ) + fs = _qs(req, to_unicode=True, encoding="latin1") + assert fs["price in \u00a5"] + + def test_from_response_multiple_forms_clickdata(self): + response = _buildresponse( + """
+ + +
+
+ + +
+ """ + ) + req = self.request_class.from_response( + response, formname="form2", clickdata={"name": "clickable"} + ) + fs = _qs(req) + assert fs[b"clickable"] == [b"clicked2"] + assert fs[b"field2"] == [b"value2"] + assert b"field1" not in fs, fs + + def test_from_response_override_clickable(self): + response = _buildresponse( + """
""" + ) + req = self.request_class.from_response( + response, formdata={"clickme": "two"}, clickdata={"name": "clickme"} + ) + fs = _qs(req) + assert fs[b"clickme"] == [b"two"] + + def test_from_response_dont_click(self): + response = _buildresponse( + """
+ + + + +
""" + ) + r1 = self.request_class.from_response(response, dont_click=True) + fs = _qs(r1) + assert b"clickable1" not in fs, fs + assert b"clickable2" not in fs, fs + + def test_from_response_ambiguous_clickdata(self): + response = _buildresponse( + """ +
+ + + + +
""" + ) + with pytest.raises( + ValueError, + match=r"Multiple elements found .* matching the criteria in clickdata", + ): + self.request_class.from_response(response, clickdata={"type": "submit"}) + + def test_from_response_non_matching_clickdata(self): + response = _buildresponse( + """
+ +
""" + ) + with pytest.raises( + ValueError, match="No clickable element matching clickdata:" + ): + self.request_class.from_response( + response, clickdata={"nonexistent": "notme"} + ) + + def test_from_response_nr_index_clickdata(self): + response = _buildresponse( + """
+ + +
+ """ + ) + req = self.request_class.from_response(response, clickdata={"nr": 1}) + fs = _qs(req) + assert b"clickable2" in fs + assert b"clickable1" not in fs + + def test_from_response_invalid_nr_index_clickdata(self): + response = _buildresponse( + """
+ +
+ """ + ) + with pytest.raises( + ValueError, match="No clickable element matching clickdata:" + ): + self.request_class.from_response(response, clickdata={"nr": 1}) + + def test_from_response_errors_noform(self): + response = _buildresponse("""""") + with pytest.raises(ValueError, match="No
element found in"): + self.request_class.from_response(response) + + def test_from_response_invalid_html5(self): + response = _buildresponse( + """""" + """""" + """
""" + ) + req = self.request_class.from_response(response, formdata={"bar": "buz"}) + fs = _qs(req) + assert fs == {b"foo": [b"xxx"], b"bar": [b"buz"]} + + def test_from_response_errors_formnumber(self): + response = _buildresponse( + """
+ + + +
""" + ) + with pytest.raises(IndexError): + self.request_class.from_response(response, formnumber=1) + + def test_from_response_noformname(self): + response = _buildresponse( + """
+ + +
""" + ) + r1 = self.request_class.from_response(response, formdata={"two": "3"}) + assert r1.method == "POST" + assert r1.headers["Content-type"] == b"application/x-www-form-urlencoded" + fs = _qs(r1) + assert fs == {b"one": [b"1"], b"two": [b"3"]} + + def test_from_response_formname_exists(self): + response = _buildresponse( + """
+ + +
+
+ + +
""" + ) + r1 = self.request_class.from_response(response, formname="form2") + assert r1.method == "POST" + fs = _qs(r1) + assert fs == {b"four": [b"4"], b"three": [b"3"]} + + def test_from_response_formname_nonexistent(self): + response = _buildresponse( + """
+ +
+
+ +
""" + ) + r1 = self.request_class.from_response(response, formname="form3") + assert r1.method == "POST" + fs = _qs(r1) + assert fs == {b"one": [b"1"]} + + def test_from_response_formname_errors_formnumber(self): + response = _buildresponse( + """
+ +
+
+ +
""" + ) + with pytest.raises(IndexError): + self.request_class.from_response(response, formname="form3", formnumber=2) + + def test_from_response_formid_exists(self): + response = _buildresponse( + """
+ + +
+
+ + +
""" + ) + r1 = self.request_class.from_response(response, formid="form2") + assert r1.method == "POST" + fs = _qs(r1) + assert fs == {b"four": [b"4"], b"three": [b"3"]} + + def test_from_response_formname_nonexistent_fallback_formid(self): + response = _buildresponse( + """
+ + +
+
+ + +
""" + ) + r1 = self.request_class.from_response( + response, formname="form3", formid="form2" + ) + assert r1.method == "POST" + fs = _qs(r1) + assert fs == {b"four": [b"4"], b"three": [b"3"]} + + def test_from_response_formid_nonexistent(self): + response = _buildresponse( + """
+ +
+
+ +
""" + ) + r1 = self.request_class.from_response(response, formid="form3") + assert r1.method == "POST" + fs = _qs(r1) + assert fs == {b"one": [b"1"]} + + def test_from_response_formid_errors_formnumber(self): + response = _buildresponse( + """
+ +
+
+ +
""" + ) + with pytest.raises(IndexError): + self.request_class.from_response(response, formid="form3", formnumber=2) + + def test_from_response_select(self): + res = _buildresponse( + """
+ + + + + + + + + + + + + + +
""" + ) + req = self.request_class.from_response(res) + fs = _qs(req) + assert fs == {b"i1": [b"iv2"], b"i2": [b"on"]} + + def test_from_response_checkbox(self): + res = _buildresponse( + """
+ + + + + + + + +
""" + ) + req = self.request_class.from_response(res) + fs = _qs(req) + assert fs == {b"i1": [b"iv2"], b"i2": [b"on"]} + + def test_from_response_input_text(self): + res = _buildresponse( + """
+ + + + + +
""" + ) + req = self.request_class.from_response(res) + fs = _qs(req) + assert fs == {b"i1": [b"i1v1"], b"i2": [b""], b"i4": [b"i4v1"]} + + def test_from_response_input_hidden(self): + res = _buildresponse( + """
+ + + + +
""" + ) + req = self.request_class.from_response(res) + fs = _qs(req) + assert fs == {b"i1": [b"i1v1"], b"i2": [b""]} + + def test_from_response_input_textarea(self): + res = _buildresponse( + """
+ + + +
""" + ) + req = self.request_class.from_response(res) + fs = _qs(req) + assert fs == {b"i1": [b"i1v"], b"i2": [b""], b"i3": [b""]} + + def test_from_response_descendants(self): + res = _buildresponse( + """
+
+
+ + +
+ + + + +
+ +
""" + ) + req = self.request_class.from_response(res) + fs = _qs(req) + assert set(fs) == {b"h2", b"i2", b"i1", b"i3", b"h1", b"i5", b"i4"} + + def test_from_response_xpath(self): + response = _buildresponse( + """
+ + +
+
+ + +
""" + ) + r1 = self.request_class.from_response( + response, formxpath="//form[@action='post.php']" + ) + fs = _qs(r1) + assert fs[b"one"] == [b"1"] + + r1 = self.request_class.from_response( + response, formxpath="//form/input[@name='four']" + ) + fs = _qs(r1) + assert fs[b"three"] == [b"3"] + + with pytest.raises(ValueError, match="No
element found with"): + self.request_class.from_response( + response, formxpath="//form/input[@name='abc']" + ) + + def test_from_response_unicode_xpath(self): + response = _buildresponse(b'
') + r = self.request_class.from_response( + response, formxpath="//form[@name='\u044a']" + ) + fs = _qs(r) + assert not fs + + xpath = "//form[@name='\u03b1']" + with pytest.raises(ValueError, match=re.escape(xpath)): + self.request_class.from_response(response, formxpath=xpath) + + def test_from_response_button_submit(self): + response = _buildresponse( + """
+ + + +
""", + url="http://www.example.com/this/list.html", + ) + req = self.request_class.from_response(response) + assert req.method == "POST" + assert req.headers["Content-type"] == b"application/x-www-form-urlencoded" + assert req.url == "http://www.example.com/this/post.php" + fs = _qs(req) + assert fs[b"test1"] == [b"val1"] + assert fs[b"test2"] == [b"val2"] + assert fs[b"button1"] == [b"submit1"] + + def test_from_response_button_notype(self): + response = _buildresponse( + """
+ + + +
""", + url="http://www.example.com/this/list.html", + ) + req = self.request_class.from_response(response) + assert req.method == "POST" + assert req.headers["Content-type"] == b"application/x-www-form-urlencoded" + assert req.url == "http://www.example.com/this/post.php" + fs = _qs(req) + assert fs[b"test1"] == [b"val1"] + assert fs[b"test2"] == [b"val2"] + assert fs[b"button1"] == [b"submit1"] + + def test_from_response_submit_novalue(self): + response = _buildresponse( + """
+ + + Submit +
""", + url="http://www.example.com/this/list.html", + ) + req = self.request_class.from_response(response) + assert req.method == "POST" + assert req.headers["Content-type"] == b"application/x-www-form-urlencoded" + assert req.url == "http://www.example.com/this/post.php" + fs = _qs(req) + assert fs[b"test1"] == [b"val1"] + assert fs[b"test2"] == [b"val2"] + assert fs[b"button1"] == [b""] + + def test_from_response_button_novalue(self): + response = _buildresponse( + """
+ + + +
""", + url="http://www.example.com/this/list.html", + ) + req = self.request_class.from_response(response) + assert req.method == "POST" + assert req.headers["Content-type"] == b"application/x-www-form-urlencoded" + assert req.url == "http://www.example.com/this/post.php" + fs = _qs(req) + assert fs[b"test1"] == [b"val1"] + assert fs[b"test2"] == [b"val2"] + assert fs[b"button1"] == [b""] + + def test_html_base_form_action(self): + response = _buildresponse( + """ + + + + + +
+
+ + + """, + url="http://a.com/", + ) + req = self.request_class.from_response(response) + assert req.url == "http://b.com/test_form" + + def test_spaces_in_action(self): + resp = _buildresponse('
') + req = self.request_class.from_response(resp) + assert req.url == "http://example.com/path" + + def test_from_response_css(self): + response = _buildresponse( + """
+ + +
+
+ + +
""" + ) + r1 = self.request_class.from_response( + response, formcss="form[action='post.php']" + ) + fs = _qs(r1) + assert fs[b"one"] == [b"1"] + + r1 = self.request_class.from_response(response, formcss="input[name='four']") + fs = _qs(r1) + assert fs[b"three"] == [b"3"] + + with pytest.raises(ValueError, match="No
element found with"): + self.request_class.from_response(response, formcss="input[name='abc']") + + def test_from_response_valid_form_methods(self): + form_methods = [ + [method, method] for method in self.request_class.valid_form_methods + ] + form_methods.append(["UNKNOWN", "GET"]) + + for method, expected in form_methods: + response = _buildresponse( + f'' + '' + "
" + ) + r = self.request_class.from_response(response) + assert r.method == expected + + def test_form_response_with_invalid_formdata_type_error(self): + """Test that a ValueError is raised for non-iterable and non-dict formdata input""" + response = _buildresponse( + """ +
+ +
+ """ + ) + with pytest.raises( + ValueError, match="formdata should be a dict or iterable of tuples" + ): + FormRequest.from_response(response, formdata=123) + + def test_form_response_with_custom_invalid_formdata_value_error(self): + """Test that a ValueError is raised for fault-inducing iterable formdata input""" + response = _buildresponse( + """ +
+ +
+ """ + ) + + with pytest.raises( + ValueError, match="formdata should be a dict or iterable of tuples" + ): + FormRequest.from_response(response, formdata=("a",)) + + def test_get_form_with_xpath_no_form_parent(self): + """Test that _get_from raised a ValueError when an XPath selects an element + not nested within a
and no parent is found""" + response = _buildresponse( + """ +
+

This paragraph is not inside a form.

+
+ + +
+ """ + ) + + with pytest.raises(ValueError, match="No
element found with"): + FormRequest.from_response(response, formxpath='//div[@id="outside-form"]/p') diff --git a/tests/test_http_request_json.py b/tests/test_http_request_json.py new file mode 100644 index 000000000..65022afe1 --- /dev/null +++ b/tests/test_http_request_json.py @@ -0,0 +1,189 @@ +from __future__ import annotations + +import json +import warnings +from unittest import mock + +import pytest + +from scrapy.http import JsonRequest +from scrapy.utils.python import to_bytes +from tests.test_http_request import TestRequest + + +class TestJsonRequest(TestRequest): + request_class = JsonRequest + default_method = "GET" + default_headers = { + b"Content-Type": [b"application/json"], + b"Accept": [b"application/json, text/javascript, */*; q=0.01"], + } + + def test_data(self): + r1 = self.request_class(url="http://www.example.com/") + assert r1.body == b"" + + body = b"body" + r2 = self.request_class(url="http://www.example.com/", body=body) + assert r2.body == body + + data = { + "name": "value", + } + r3 = self.request_class(url="http://www.example.com/", data=data) + assert r3.body == to_bytes(json.dumps(data)) + + # empty data + r4 = self.request_class(url="http://www.example.com/", data=[]) + assert r4.body == to_bytes(json.dumps([])) + + def test_data_method(self): + # data is not passed + r1 = self.request_class(url="http://www.example.com/") + assert r1.method == "GET" + + body = b"body" + r2 = self.request_class(url="http://www.example.com/", body=body) + assert r2.method == "GET" + + data = { + "name": "value", + } + r3 = self.request_class(url="http://www.example.com/", data=data) + assert r3.method == "POST" + + # method passed explicitly + r4 = self.request_class(url="http://www.example.com/", data=data, method="GET") + assert r4.method == "GET" + + r5 = self.request_class(url="http://www.example.com/", data=[]) + assert r5.method == "POST" + + def test_body_data(self): + """passing both body and data should result a warning""" + body = b"body" + data = { + "name": "value", + } + with pytest.warns(UserWarning, match="data will be ignored"): + r5 = self.request_class(url="http://www.example.com/", body=body, data=data) + assert r5.body == body + assert r5.method == "GET" + + def test_empty_body_data(self): + """passing any body value and data should result a warning""" + data = { + "name": "value", + } + with pytest.warns(UserWarning, match="data will be ignored"): + r6 = self.request_class(url="http://www.example.com/", body=b"", data=data) + assert r6.body == b"" + assert r6.method == "GET" + + def test_body_none_data(self): + data = { + "name": "value", + } + with warnings.catch_warnings(): + warnings.filterwarnings( + "error", category=UserWarning, message="Both body and data passed" + ) + r7 = self.request_class(url="http://www.example.com/", body=None, data=data) + assert r7.body == to_bytes(json.dumps(data)) + assert r7.method == "POST" + + def test_body_data_none(self): + with warnings.catch_warnings(): + warnings.filterwarnings( + "error", category=UserWarning, message="Both body and data passed" + ) + r8 = self.request_class(url="http://www.example.com/", body=None, data=None) + assert r8.method == "GET" + + def test_dumps_sort_keys(self): + """Test that sort_keys=True is passed to json.dumps by default""" + data = { + "name": "value", + } + with mock.patch("json.dumps", return_value=b"") as mock_dumps: + self.request_class(url="http://www.example.com/", data=data) + kwargs = mock_dumps.call_args[1] + assert kwargs["sort_keys"] is True + + def test_dumps_kwargs(self): + """Test that dumps_kwargs are passed to json.dumps""" + data = { + "name": "value", + } + dumps_kwargs = { + "ensure_ascii": True, + "allow_nan": True, + } + with mock.patch("json.dumps", return_value=b"") as mock_dumps: + self.request_class( + url="http://www.example.com/", data=data, dumps_kwargs=dumps_kwargs + ) + kwargs = mock_dumps.call_args[1] + assert kwargs["ensure_ascii"] is True + assert kwargs["allow_nan"] is True + + def test_replace_data(self): + data1 = { + "name1": "value1", + } + data2 = { + "name2": "value2", + } + r1 = self.request_class(url="http://www.example.com/", data=data1) + r2 = r1.replace(data=data2) + assert r2.body == to_bytes(json.dumps(data2)) + + def test_replace_sort_keys(self): + """Test that replace provides sort_keys=True to json.dumps""" + data1 = { + "name1": "value1", + } + data2 = { + "name2": "value2", + } + r1 = self.request_class(url="http://www.example.com/", data=data1) + with mock.patch("json.dumps", return_value=b"") as mock_dumps: + r1.replace(data=data2) + kwargs = mock_dumps.call_args[1] + assert kwargs["sort_keys"] is True + + def test_replace_dumps_kwargs(self): + """Test that dumps_kwargs are provided to json.dumps when replace is called""" + data1 = { + "name1": "value1", + } + data2 = { + "name2": "value2", + } + dumps_kwargs = { + "ensure_ascii": True, + "allow_nan": True, + } + r1 = self.request_class( + url="http://www.example.com/", data=data1, dumps_kwargs=dumps_kwargs + ) + with mock.patch("json.dumps", return_value=b"") as mock_dumps: + r1.replace(data=data2) + kwargs = mock_dumps.call_args[1] + assert kwargs["ensure_ascii"] is True + assert kwargs["allow_nan"] is True + + def test_replacement_both_body_and_data_warns(self): + """Test that we get a warning if both body and data are passed""" + body1 = None + body2 = b"body" + data1 = { + "name1": "value1", + } + data2 = { + "name2": "value2", + } + r1 = self.request_class(url="http://www.example.com/", data=data1, body=body1) + + with pytest.warns(UserWarning, match="data will be ignored"): + r1.replace(data=data2, body=body2) diff --git a/tests/test_http_response.py b/tests/test_http_response.py index fdef5adea..079c547c7 100644 --- a/tests/test_http_response.py +++ b/tests/test_http_response.py @@ -1,27 +1,21 @@ -import codecs -from unittest import mock +from __future__ import annotations + +from typing import TYPE_CHECKING import pytest -from packaging.version import Version as parse_version -from w3lib import __version__ as w3lib_version from w3lib.encoding import resolve_encoding from scrapy.exceptions import NotSupported -from scrapy.http import ( - Headers, - HtmlResponse, - Request, - Response, - TextResponse, - XmlResponse, -) +from scrapy.http import Headers, Request, Response from scrapy.link import Link -from scrapy.selector import Selector -from scrapy.utils.python import to_unicode +from scrapy.utils._deps_compat import W3LIB_STRIPS_URLS from tests import get_testdata +if TYPE_CHECKING: + from collections.abc import Iterable -class TestResponseBase: + +class TestResponse: response_class = Response def test_init(self): @@ -172,6 +166,53 @@ class TestResponseBase: with pytest.raises(AttributeError): r.body = "xxx" + def test_setter_mutable_lazy_loading(self): + """Mutable attributes are set internally to None only until they are + read, then they always return the same falsy instance of the + corresponding mutable structure. + + Setting them to None causes the next read to return a different object. + """ + + response = self.response_class("http://example.com") + + response.request = Request("http://example.com") + + assert response._flags is None + assert response.flags == [] + assert response.flags is response.flags + assert response._flags == [] + original_flags = response.flags + response.flags = None + assert response._flags is None + assert response.flags == [] + assert response.flags is not original_flags + + assert response._headers is None + assert response.headers == {} + assert response.headers is response.headers + assert isinstance(response.headers, Headers) + assert isinstance(response._headers, Headers) + original_headers = response.headers + response.headers = None + assert response._headers is None + assert response.headers == {} + assert response._headers == {} + assert response.headers is not original_headers + + def test_setters(self): + response = self.response_class("http://example.com") + + response.flags = ["f1"] + assert response.flags == ["f1"] + + headers = Headers({b"X-Test": b"1"}) + response.headers = headers + assert response._headers is headers + response.headers = {b"A": b"b"} + assert isinstance(response.headers, Headers) + assert response._headers[b"A"] == b"b" + def test_urljoin(self): """Test urljoin shortcut (only for existence, since behavior equals urljoin)""" joined = self.response_class("http://www.example.com").urljoin("/test") @@ -214,7 +255,7 @@ class TestResponseBase: r.follow(None) @pytest.mark.xfail( - parse_version(w3lib_version) < parse_version("2.1.1"), + not W3LIB_STRIPS_URLS, reason="https://github.com/scrapy/w3lib/pull/207", strict=True, ) @@ -222,7 +263,7 @@ class TestResponseBase: self._assert_followed_url("foo ", "http://example.com/foo") @pytest.mark.xfail( - parse_version(w3lib_version) < parse_version("2.1.1"), + not W3LIB_STRIPS_URLS, reason="https://github.com/scrapy/w3lib/pull/207", strict=True, ) @@ -290,16 +331,26 @@ class TestResponseBase: with pytest.raises(ValueError, match="url can't be None"): list(r.follow_all(urls=[None])) + @pytest.mark.xfail( + not W3LIB_STRIPS_URLS, + reason="https://github.com/scrapy/w3lib/pull/207", + strict=True, + ) def test_follow_all_whitespace(self): relative = ["foo ", "bar ", "foo/bar ", "bar/foo "] absolute = [ - "http://example.com/foo%20", - "http://example.com/bar%20", - "http://example.com/foo/bar%20", - "http://example.com/bar/foo%20", + "http://example.com/foo", + "http://example.com/bar", + "http://example.com/foo/bar", + "http://example.com/bar/foo", ] self._assert_followed_all_urls(relative, absolute) + @pytest.mark.xfail( + not W3LIB_STRIPS_URLS, + reason="https://github.com/scrapy/w3lib/pull/207", + strict=True, + ) def test_follow_all_whitespace_links(self): absolute = [ "http://example.com/foo ", @@ -307,8 +358,8 @@ class TestResponseBase: "http://example.com/foo/bar ", "http://example.com/bar/foo ", ] - links = map(Link, absolute) - expected = [u.replace(" ", "%20") for u in absolute] + links = [Link(u) for u in absolute] + expected = [u.strip() for u in absolute] self._assert_followed_all_urls(links, expected) def test_follow_all_flags(self): @@ -322,698 +373,36 @@ class TestResponseBase: for req in fol: assert req.flags == ["cached", "allowed"] - def _assert_followed_url(self, follow_obj, target_url, response=None): + def _assert_followed_url( + self, + follow_obj: str | Link, + target_url: str, + response: Response | None = None, + encoding: str | None = None, + ) -> None: if response is None: response = self._links_response() req = response.follow(follow_obj) assert req.url == target_url - return req + if encoding is not None: + assert req.encoding == encoding - def _assert_followed_all_urls(self, follow_obj, target_urls, response=None): + def _assert_followed_all_urls( + self, + follow_obj: Iterable[str | Link], + target_urls: Iterable[str], + response: Response | None = None, + ) -> None: if response is None: response = self._links_response() followed = response.follow_all(follow_obj) - for req, target in zip(followed, target_urls): + for req, target in zip(followed, target_urls, strict=True): assert req.url == target - yield req - def _links_response(self): + def _links_response(self) -> Response: body = get_testdata("link_extractor", "linkextractor.html") return self.response_class("http://example.com/index", body=body) - def _links_response_no_href(self): + def _links_response_no_href(self) -> Response: body = get_testdata("link_extractor", "linkextractor_no_href.html") return self.response_class("http://example.com/index", body=body) - - -class TestTextResponse(TestResponseBase): - response_class = TextResponse - - def test_replace(self): - super().test_replace() - r1 = self.response_class( - "http://www.example.com", body="hello", encoding="cp852" - ) - r2 = r1.replace(url="http://www.example.com/other") - r3 = r1.replace(url="http://www.example.com/other", encoding="latin1") - - assert isinstance(r2, self.response_class) - assert r2.url == "http://www.example.com/other" - self._assert_response_encoding(r2, "cp852") - assert r3.url == "http://www.example.com/other" - assert r3._declared_encoding() == "latin1" - - def test_unicode_url(self): - # instantiate with unicode url without encoding (should set default encoding) - resp = self.response_class("http://www.example.com/") - self._assert_response_encoding(resp, self.response_class._DEFAULT_ENCODING) - - # make sure urls are converted to str - resp = self.response_class(url="http://www.example.com/", encoding="utf-8") - assert isinstance(resp.url, str) - - resp = self.response_class( - url="http://www.example.com/price/\xa3", encoding="utf-8" - ) - assert resp.url == to_unicode(b"http://www.example.com/price/\xc2\xa3") - resp = self.response_class( - url="http://www.example.com/price/\xa3", encoding="latin-1" - ) - assert resp.url == "http://www.example.com/price/\xa3" - resp = self.response_class( - "http://www.example.com/price/\xa3", - headers={"Content-type": ["text/html; charset=utf-8"]}, - ) - assert resp.url == to_unicode(b"http://www.example.com/price/\xc2\xa3") - resp = self.response_class( - "http://www.example.com/price/\xa3", - headers={"Content-type": ["text/html; charset=iso-8859-1"]}, - ) - assert resp.url == "http://www.example.com/price/\xa3" - - def test_unicode_body(self): - unicode_string = ( - "\u043a\u0438\u0440\u0438\u043b\u043b\u0438\u0447\u0435\u0441\u043a\u0438\u0439 " - "\u0442\u0435\u043a\u0441\u0442" - ) - with pytest.raises(TypeError): - self.response_class("http://www.example.com", body="unicode body") - - original_string = unicode_string.encode("cp1251") - r1 = self.response_class( - "http://www.example.com", body=original_string, encoding="cp1251" - ) - - # check response.text - assert isinstance(r1.text, str) - assert r1.text == unicode_string - - def test_encoding(self): - r1 = self.response_class( - "http://www.example.com", - body=b"\xc2\xa3", - headers={"Content-type": ["text/html; charset=utf-8"]}, - ) - r2 = self.response_class( - "http://www.example.com", encoding="utf-8", body="\xa3" - ) - r3 = self.response_class( - "http://www.example.com", - body=b"\xa3", - headers={"Content-type": ["text/html; charset=iso-8859-1"]}, - ) - r4 = self.response_class("http://www.example.com", body=b"\xa2\xa3") - r5 = self.response_class( - "http://www.example.com", - body=b"\xc2\xa3", - headers={"Content-type": ["text/html; charset=None"]}, - ) - r6 = self.response_class( - "http://www.example.com", - body=b"\xa8D", - headers={"Content-type": ["text/html; charset=gb2312"]}, - ) - r7 = self.response_class( - "http://www.example.com", - body=b"\xa8D", - headers={"Content-type": ["text/html; charset=gbk"]}, - ) - r8 = self.response_class( - "http://www.example.com", - body=codecs.BOM_UTF8 + b"\xc2\xa3", - headers={"Content-type": ["text/html; charset=cp1251"]}, - ) - r9 = self.response_class( - "http://www.example.com", - body=b"\x80", - headers={ - "Content-type": [b"application/x-download; filename=\x80dummy.txt"] - }, - ) - - assert r1._headers_encoding() == "utf-8" - assert r2._headers_encoding() is None - assert r2._declared_encoding() == "utf-8" - self._assert_response_encoding(r2, "utf-8") - assert r3._headers_encoding() == "cp1252" - assert r3._declared_encoding() == "cp1252" - assert r4._headers_encoding() is None - assert r5._headers_encoding() is None - assert r8._headers_encoding() == "cp1251" - assert r9._headers_encoding() is None - assert r8._declared_encoding() == "utf-8" - assert r9._declared_encoding() is None - self._assert_response_encoding(r5, "utf-8") - self._assert_response_encoding(r8, "utf-8") - self._assert_response_encoding(r9, "cp1252") - assert r4._body_inferred_encoding() is not None - assert r4._body_inferred_encoding() != "ascii" - self._assert_response_values(r1, "utf-8", "\xa3") - self._assert_response_values(r2, "utf-8", "\xa3") - self._assert_response_values(r3, "iso-8859-1", "\xa3") - self._assert_response_values(r6, "gb18030", "\u2015") - self._assert_response_values(r7, "gb18030", "\u2015") - self._assert_response_values(r9, "cp1252", "€") - - # TextResponse (and subclasses) must be passed a encoding when instantiating with unicode bodies - with pytest.raises(TypeError): - self.response_class("http://www.example.com", body="\xa3") - - def test_declared_encoding_invalid(self): - """Check that unknown declared encodings are ignored""" - r = self.response_class( - "http://www.example.com", - headers={"Content-type": ["text/html; charset=UNKNOWN"]}, - body=b"\xc2\xa3", - ) - assert r._declared_encoding() is None - self._assert_response_values(r, "utf-8", "\xa3") - - def test_utf16(self): - """Test utf-16 because UnicodeDammit is known to have problems with""" - r = self.response_class( - "http://www.example.com", - body=b"\xff\xfeh\x00i\x00", - encoding="utf-16", - ) - self._assert_response_values(r, "utf-16", "hi") - - def test_invalid_utf8_encoded_body_with_valid_utf8_BOM(self): - r6 = self.response_class( - "http://www.example.com", - headers={"Content-type": ["text/html; charset=utf-8"]}, - body=b"\xef\xbb\xbfWORD\xe3\xab", - ) - assert r6.encoding == "utf-8" - assert r6.text in { - "WORD\ufffd\ufffd", # w3lib < 1.19.0 - "WORD\ufffd", # w3lib >= 1.19.0 - } - - def test_bom_is_removed_from_body(self): - # Inferring encoding from body also cache decoded body as sideeffect, - # this test tries to ensure that calling response.encoding and - # response.text in indistinct order doesn't affect final - # response.text in indistinct order doesn't affect final - # values for encoding and decoded body. - url = "http://example.com" - body = b"\xef\xbb\xbfWORD" - headers = {"Content-type": ["text/html; charset=utf-8"]} - - # Test response without content-type and BOM encoding - response = self.response_class(url, body=body) - assert response.encoding == "utf-8" - assert response.text == "WORD" - response = self.response_class(url, body=body) - assert response.text == "WORD" - assert response.encoding == "utf-8" - - # Body caching sideeffect isn't triggered when encoding is declared in - # content-type header but BOM still need to be removed from decoded - # body - response = self.response_class(url, headers=headers, body=body) - assert response.encoding == "utf-8" - assert response.text == "WORD" - response = self.response_class(url, headers=headers, body=body) - assert response.text == "WORD" - assert response.encoding == "utf-8" - - def test_replace_wrong_encoding(self): - """Test invalid chars are replaced properly""" - r = self.response_class( - "http://www.example.com", - encoding="utf-8", - body=b"PREFIX\xe3\xabSUFFIX", - ) - # XXX: Policy for replacing invalid chars may suffer minor variations - # but it should always contain the unicode replacement char ('\ufffd') - assert "\ufffd" in r.text, repr(r.text) - assert "PREFIX" in r.text, repr(r.text) - assert "SUFFIX" in r.text, repr(r.text) - - # Do not destroy html tags due to encoding bugs - r = self.response_class( - "http://example.com", - encoding="utf-8", - body=b"\xf0value", - ) - assert "value" in r.text, repr(r.text) - - # FIXME: This test should pass once we stop using BeautifulSoup's UnicodeDammit in TextResponse - # r = self.response_class("http://www.example.com", body=b'PREFIX\xe3\xabSUFFIX') - # assert '\ufffd' in r.text, repr(r.text) - - def test_selector(self): - body = b"Some page" - response = self.response_class("http://www.example.com", body=body) - - assert isinstance(response.selector, Selector) - assert response.selector.type == "html" - assert response.selector is response.selector # property is cached - assert response.selector.response is response - - assert response.selector.xpath("//title/text()").getall() == ["Some page"] - assert response.selector.css("title::text").getall() == ["Some page"] - assert response.selector.re("Some (.*)") == ["page"] - - def test_selector_shortcuts(self): - body = b"Some page" - response = self.response_class("http://www.example.com", body=body) - - assert ( - response.xpath("//title/text()").getall() - == response.selector.xpath("//title/text()").getall() - ) - assert ( - response.css("title::text").getall() - == response.selector.css("title::text").getall() - ) - - def test_selector_shortcuts_kwargs(self): - body = b'Some page

A nice paragraph.

' - response = self.response_class("http://www.example.com", body=body) - - assert ( - response.xpath( - "normalize-space(//p[@class=$pclass])", pclass="content" - ).getall() - == response.xpath('normalize-space(//p[@class="content"])').getall() - ) - assert ( - response.xpath( - "//title[count(following::p[@class=$pclass])=$pcount]/text()", - pclass="content", - pcount=1, - ).getall() - == response.xpath( - '//title[count(following::p[@class="content"])=1]/text()' - ).getall() - ) - - def test_urljoin_with_base_url(self): - """Test urljoin shortcut which also evaluates base-url through get_base_url().""" - body = b'' - joined = self.response_class("http://www.example.com", body=body).urljoin( - "/test" - ) - absolute = "https://example.net/test" - assert joined == absolute - - body = b'' - joined = self.response_class("http://www.example.com", body=body).urljoin( - "test" - ) - absolute = "http://www.example.com/test" - assert joined == absolute - - body = b'' - joined = self.response_class("http://www.example.com", body=body).urljoin( - "test" - ) - absolute = "http://www.example.com/elsewhere/test" - assert joined == absolute - - def test_follow_selector(self): - resp = self._links_response() - urls = [ - "http://example.com/sample2.html", - "http://example.com/sample3.html", - "http://example.com/sample3.html", - "http://example.com/sample3.html", - "http://example.com/sample3.html#foo", - "http://www.google.com/something", - "http://example.com/innertag.html", - ] - - # select elements - for sellist in [resp.css("a"), resp.xpath("//a")]: - for sel, url in zip(sellist, urls): - self._assert_followed_url(sel, url, response=resp) - - # select elements - self._assert_followed_url( - Selector(text='').css("link")[0], - "http://example.com/foo", - response=resp, - ) - - # href attributes should work - for sellist in [resp.css("a::attr(href)"), resp.xpath("//a/@href")]: - for sel, url in zip(sellist, urls): - self._assert_followed_url(sel, url, response=resp) - - # non-a elements are not supported - with pytest.raises( - ValueError, match="Only and elements are supported" - ): - resp.follow(resp.css("div")[0]) - - def test_follow_selector_list(self): - resp = self._links_response() - with pytest.raises(ValueError, match="SelectorList"): - resp.follow(resp.css("a")) - - def test_follow_selector_invalid(self): - resp = self._links_response() - with pytest.raises(ValueError, match="Unsupported"): - resp.follow(resp.xpath("count(//div)")[0]) - - def test_follow_selector_attribute(self): - resp = self._links_response() - for src in resp.css("img::attr(src)"): - self._assert_followed_url(src, "http://example.com/sample2.jpg") - - def test_follow_selector_no_href(self): - resp = self.response_class( - url="http://example.com", - body=b"click me", - ) - with pytest.raises(ValueError, match="no href"): - resp.follow(resp.css("a")[0]) - - def test_follow_whitespace_selector(self): - resp = self.response_class( - "http://example.com", - body=b"""click me""", - ) - self._assert_followed_url( - resp.css("a")[0], "http://example.com/foo", response=resp - ) - self._assert_followed_url( - resp.css("a::attr(href)")[0], - "http://example.com/foo", - response=resp, - ) - - def test_follow_encoding(self): - resp1 = self.response_class( - "http://example.com", - encoding="utf8", - body='click me'.encode(), - ) - req = self._assert_followed_url( - resp1.css("a")[0], - "http://example.com/foo?%D0%BF%D1%80%D0%B8%D0%B2%D0%B5%D1%82", - response=resp1, - ) - assert req.encoding == "utf8" - - resp2 = self.response_class( - "http://example.com", - encoding="cp1251", - body='click me'.encode( - "cp1251" - ), - ) - req = self._assert_followed_url( - resp2.css("a")[0], - "http://example.com/foo?%EF%F0%E8%E2%E5%F2", - response=resp2, - ) - assert req.encoding == "cp1251" - - def test_follow_flags(self): - res = self.response_class("http://example.com/") - fol = res.follow("http://example.com/", flags=["cached", "allowed"]) - assert fol.flags == ["cached", "allowed"] - - def test_follow_all_flags(self): - re = self.response_class("http://www.example.com/") - urls = [ - "http://www.example.com/", - "http://www.example.com/2", - "http://www.example.com/foo", - ] - fol = re.follow_all(urls, flags=["cached", "allowed"]) - for req in fol: - assert req.flags == ["cached", "allowed"] - - def test_follow_all_css(self): - expected = [ - "http://example.com/sample3.html", - "http://example.com/innertag.html", - ] - response = self._links_response() - extracted = [r.url for r in response.follow_all(css='a[href*="example.com"]')] - assert expected == extracted - - def test_follow_all_css_skip_invalid(self): - expected = [ - "http://example.com/page/1/", - "http://example.com/page/3/", - "http://example.com/page/4/", - ] - response = self._links_response_no_href() - extracted1 = [r.url for r in response.follow_all(css=".pagination a")] - assert expected == extracted1 - extracted2 = [r.url for r in response.follow_all(response.css(".pagination a"))] - assert expected == extracted2 - - def test_follow_all_xpath(self): - expected = [ - "http://example.com/sample3.html", - "http://example.com/innertag.html", - ] - response = self._links_response() - extracted = response.follow_all(xpath='//a[contains(@href, "example.com")]') - assert expected == [r.url for r in extracted] - - def test_follow_all_xpath_skip_invalid(self): - expected = [ - "http://example.com/page/1/", - "http://example.com/page/3/", - "http://example.com/page/4/", - ] - response = self._links_response_no_href() - extracted1 = [ - r.url for r in response.follow_all(xpath='//div[@id="pagination"]/a') - ] - assert expected == extracted1 - extracted2 = [ - r.url - for r in response.follow_all(response.xpath('//div[@id="pagination"]/a')) - ] - assert expected == extracted2 - - def test_follow_all_too_many_arguments(self): - response = self._links_response() - with pytest.raises( - ValueError, match="Please supply exactly one of the following arguments" - ): - response.follow_all( - css='a[href*="example.com"]', - xpath='//a[contains(@href, "example.com")]', - ) - - def test_json_response(self): - json_body = b"""{"ip": "109.187.217.200"}""" - json_response = self.response_class("http://www.example.com", body=json_body) - assert json_response.json() == {"ip": "109.187.217.200"} - - text_body = b"""text""" - text_response = self.response_class("http://www.example.com", body=text_body) - with pytest.raises( - ValueError, match="(Expecting value|Unexpected '<'): line 1" - ): - text_response.json() - - def test_cache_json_response(self): - json_valid_bodies = [b"""{"ip": "109.187.217.200"}""", b"""null"""] - for json_body in json_valid_bodies: - json_response = self.response_class( - "http://www.example.com", body=json_body - ) - - with mock.patch("json.loads") as mock_json: - for _ in range(2): - json_response.json() - mock_json.assert_called_once_with(json_body) - - -class TestHtmlResponse(TestTextResponse): - response_class = HtmlResponse - - def test_html_encoding(self): - body = b"""Some page - - Price: \xa3100' - """ - r1 = self.response_class("http://www.example.com", body=body) - self._assert_response_values(r1, "iso-8859-1", body) - - body = b""" - - Price: \xa3100 - """ - r2 = self.response_class("http://www.example.com", body=body) - self._assert_response_values(r2, "iso-8859-1", body) - - # for conflicting declarations headers must take precedence - body = b"""Some page - - Price: \xa3100' - """ - r3 = self.response_class( - "http://www.example.com", - body=body, - headers={"Content-type": ["text/html; charset=iso-8859-1"]}, - ) - self._assert_response_values(r3, "iso-8859-1", body) - - # make sure replace() preserves the encoding of the original response - body = b"New body \xa3" - r4 = r3.replace(body=body) - self._assert_response_values(r4, "iso-8859-1", body) - - def test_html5_meta_charset(self): - body = b"""Some pagebla bla""" - r1 = self.response_class("http://www.example.com", body=body) - self._assert_response_values(r1, "gb2312", body) - - -class TestXmlResponse(TestTextResponse): - response_class = XmlResponse - - def test_xml_encoding(self): - body = b"" - r1 = self.response_class("http://www.example.com", body=body) - self._assert_response_values(r1, self.response_class._DEFAULT_ENCODING, body) - - body = b"""""" - r2 = self.response_class("http://www.example.com", body=body) - self._assert_response_values(r2, "iso-8859-1", body) - - # make sure replace() preserves the explicit encoding passed in the __init__ method - body = b"""""" - r3 = self.response_class("http://www.example.com", body=body, encoding="utf-8") - body2 = b"New body" - r4 = r3.replace(body=body2) - self._assert_response_values(r4, "utf-8", body2) - - def test_replace_encoding(self): - # make sure replace() keeps the previous encoding unless overridden explicitly - body = b"""""" - body2 = b"""""" - r5 = self.response_class("http://www.example.com", body=body) - r6 = r5.replace(body=body2) - r7 = r5.replace(body=body2, encoding="utf-8") - self._assert_response_values(r5, "iso-8859-1", body) - self._assert_response_values(r6, "iso-8859-1", body2) - self._assert_response_values(r7, "utf-8", body2) - - def test_selector(self): - body = b'value' - response = self.response_class("http://www.example.com", body=body) - - assert isinstance(response.selector, Selector) - assert response.selector.type == "xml" - assert response.selector is response.selector # property is cached - assert response.selector.response is response - - assert response.selector.xpath("//elem/text()").getall() == ["value"] - - def test_selector_shortcuts(self): - body = b'value' - response = self.response_class("http://www.example.com", body=body) - - assert ( - response.xpath("//elem/text()").getall() - == response.selector.xpath("//elem/text()").getall() - ) - - def test_selector_shortcuts_kwargs(self): - body = b""" - - value - """ - response = self.response_class("http://www.example.com", body=body) - - assert ( - response.xpath( - "//s:elem/text()", namespaces={"s": "http://scrapy.org"} - ).getall() - == response.selector.xpath( - "//s:elem/text()", namespaces={"s": "http://scrapy.org"} - ).getall() - ) - - response.selector.register_namespace("s2", "http://scrapy.org") - assert ( - response.xpath( - "//s1:elem/text()", namespaces={"s1": "http://scrapy.org"} - ).getall() - == response.selector.xpath("//s2:elem/text()").getall() - ) - - -class CustomResponse(TextResponse): - attributes = (*TextResponse.attributes, "foo", "bar") - - def __init__(self, *args, **kwargs) -> None: - self.foo = kwargs.pop("foo", None) - self.bar = kwargs.pop("bar", None) - self.lost = kwargs.pop("lost", None) - super().__init__(*args, **kwargs) - - -class TestCustomResponse(TestTextResponse): - response_class = CustomResponse - - def test_copy(self): - super().test_copy() - r1 = self.response_class( - url="https://example.org", - status=200, - foo="foo", - bar="bar", - lost="lost", - ) - r2 = r1.copy() - assert isinstance(r2, self.response_class) - assert r1.foo == r2.foo - assert r1.bar == r2.bar - assert r1.lost == "lost" - assert r2.lost is None - - def test_replace(self): - super().test_replace() - r1 = self.response_class( - url="https://example.org", - status=200, - foo="foo", - bar="bar", - lost="lost", - ) - - r2 = r1.replace(foo="new-foo", bar="new-bar", lost="new-lost") - assert isinstance(r2, self.response_class) - assert r1.foo == "foo" - assert r1.bar == "bar" - assert r1.lost == "lost" - assert r2.foo == "new-foo" - assert r2.bar == "new-bar" - assert r2.lost == "new-lost" - - r3 = r1.replace(foo="new-foo", bar="new-bar") - assert isinstance(r3, self.response_class) - assert r1.foo == "foo" - assert r1.bar == "bar" - assert r1.lost == "lost" - assert r3.foo == "new-foo" - assert r3.bar == "new-bar" - assert r3.lost is None - - r4 = r1.replace(foo="new-foo") - assert isinstance(r4, self.response_class) - assert r1.foo == "foo" - assert r1.bar == "bar" - assert r1.lost == "lost" - assert r4.foo == "new-foo" - assert r4.bar == "bar" - assert r4.lost is None - - with pytest.raises( - TypeError, - match=r"__init__\(\) got an unexpected keyword argument 'unknown'", - ): - r1.replace(unknown="unknown") diff --git a/tests/test_http_response_text.py b/tests/test_http_response_text.py new file mode 100644 index 000000000..4b3fa2302 --- /dev/null +++ b/tests/test_http_response_text.py @@ -0,0 +1,684 @@ +from __future__ import annotations + +import codecs +from unittest import mock + +import pytest + +from scrapy.http import HtmlResponse, TextResponse, XmlResponse +from scrapy.selector import Selector +from scrapy.utils.python import to_unicode +from tests.test_http_response import TestResponse + + +class TestTextResponse(TestResponse): + response_class = TextResponse + + def test_replace(self): + super().test_replace() + r1 = self.response_class( + "http://www.example.com", body="hello", encoding="cp852" + ) + r2 = r1.replace(url="http://www.example.com/other") + r3 = r1.replace(url="http://www.example.com/other", encoding="latin1") + + assert isinstance(r2, self.response_class) + assert r2.url == "http://www.example.com/other" + self._assert_response_encoding(r2, "cp852") + assert r3.url == "http://www.example.com/other" + assert r3._declared_encoding() == "latin1" + + def test_unicode_url(self): + # instantiate with unicode url without encoding (should set default encoding) + resp = self.response_class("http://www.example.com/") + self._assert_response_encoding(resp, self.response_class._DEFAULT_ENCODING) + + # make sure urls are converted to str + resp = self.response_class(url="http://www.example.com/", encoding="utf-8") + assert isinstance(resp.url, str) + + resp = self.response_class( + url="http://www.example.com/price/\xa3", encoding="utf-8" + ) + assert resp.url == to_unicode(b"http://www.example.com/price/\xc2\xa3") + resp = self.response_class( + url="http://www.example.com/price/\xa3", encoding="latin-1" + ) + assert resp.url == "http://www.example.com/price/\xa3" + resp = self.response_class( + "http://www.example.com/price/\xa3", + headers={"Content-type": ["text/html; charset=utf-8"]}, + ) + assert resp.url == to_unicode(b"http://www.example.com/price/\xc2\xa3") + resp = self.response_class( + "http://www.example.com/price/\xa3", + headers={"Content-type": ["text/html; charset=iso-8859-1"]}, + ) + assert resp.url == "http://www.example.com/price/\xa3" + + def test_unicode_body(self): + unicode_string = ( + "\u043a\u0438\u0440\u0438\u043b\u043b\u0438\u0447\u0435\u0441\u043a\u0438\u0439 " + "\u0442\u0435\u043a\u0441\u0442" + ) + with pytest.raises(TypeError): + self.response_class("http://www.example.com", body="unicode body") + + original_string = unicode_string.encode("cp1251") + r1 = self.response_class( + "http://www.example.com", body=original_string, encoding="cp1251" + ) + + # check response.text + assert isinstance(r1.text, str) + assert r1.text == unicode_string + + def test_encoding(self): + r1 = self.response_class( + "http://www.example.com", + body=b"\xc2\xa3", + headers={"Content-type": ["text/html; charset=utf-8"]}, + ) + r2 = self.response_class( + "http://www.example.com", encoding="utf-8", body="\xa3" + ) + r3 = self.response_class( + "http://www.example.com", + body=b"\xa3", + headers={"Content-type": ["text/html; charset=iso-8859-1"]}, + ) + r4 = self.response_class("http://www.example.com", body=b"\xa2\xa3") + r5 = self.response_class( + "http://www.example.com", + body=b"\xc2\xa3", + headers={"Content-type": ["text/html; charset=None"]}, + ) + r6 = self.response_class( + "http://www.example.com", + body=b"\xa8D", + headers={"Content-type": ["text/html; charset=gb2312"]}, + ) + r7 = self.response_class( + "http://www.example.com", + body=b"\xa8D", + headers={"Content-type": ["text/html; charset=gbk"]}, + ) + r8 = self.response_class( + "http://www.example.com", + body=codecs.BOM_UTF8 + b"\xc2\xa3", + headers={"Content-type": ["text/html; charset=cp1251"]}, + ) + r9 = self.response_class( + "http://www.example.com", + body=b"\x80", + headers={ + "Content-type": [b"application/x-download; filename=\x80dummy.txt"] + }, + ) + + assert r1._headers_encoding() == "utf-8" + assert r2._headers_encoding() is None + assert r2._declared_encoding() == "utf-8" + self._assert_response_encoding(r2, "utf-8") + assert r3._headers_encoding() == "cp1252" + assert r3._declared_encoding() == "cp1252" + assert r4._headers_encoding() is None + assert r5._headers_encoding() is None + assert r8._headers_encoding() == "cp1251" + assert r9._headers_encoding() is None + assert r8._declared_encoding() == "utf-8" + assert r9._declared_encoding() is None + self._assert_response_encoding(r5, "utf-8") + self._assert_response_encoding(r8, "utf-8") + self._assert_response_encoding(r9, "cp1252") + assert r4._body_inferred_encoding() is not None + assert r4._body_inferred_encoding() != "ascii" + self._assert_response_values(r1, "utf-8", "\xa3") + self._assert_response_values(r2, "utf-8", "\xa3") + self._assert_response_values(r3, "iso-8859-1", "\xa3") + self._assert_response_values(r6, "gb18030", "\u2015") + self._assert_response_values(r7, "gb18030", "\u2015") + self._assert_response_values(r9, "cp1252", "€") + + # TextResponse (and subclasses) must be passed a encoding when instantiating with unicode bodies + with pytest.raises(TypeError): + self.response_class("http://www.example.com", body="\xa3") + + def test_declared_encoding_invalid(self): + """Check that unknown declared encodings are ignored""" + r = self.response_class( + "http://www.example.com", + headers={"Content-type": ["text/html; charset=UNKNOWN"]}, + body=b"\xc2\xa3", + ) + assert r._declared_encoding() is None + self._assert_response_values(r, "utf-8", "\xa3") + + def test_utf16(self): + """Test utf-16 because UnicodeDammit is known to have problems with""" + r = self.response_class( + "http://www.example.com", + body=b"\xff\xfeh\x00i\x00", + encoding="utf-16", + ) + self._assert_response_values(r, "utf-16", "hi") + + def test_invalid_utf8_encoded_body_with_valid_utf8_BOM(self): + r6 = self.response_class( + "http://www.example.com", + headers={"Content-type": ["text/html; charset=utf-8"]}, + body=b"\xef\xbb\xbfWORD\xe3\xab", + ) + assert r6.encoding == "utf-8" + assert r6.text in { + "WORD\ufffd\ufffd", # w3lib < 1.19.0 + "WORD\ufffd", # w3lib >= 1.19.0 + } + + def test_bom_is_removed_from_body(self): + # Inferring encoding from body also cache decoded body as sideeffect, + # this test tries to ensure that calling response.encoding and + # response.text in indistinct order doesn't affect final + # values for encoding and decoded body. + url = "http://example.com" + body = b"\xef\xbb\xbfWORD" + headers = {"Content-type": ["text/html; charset=utf-8"]} + + # Test response without content-type and BOM encoding + response = self.response_class(url, body=body) + assert response.encoding == "utf-8" + assert response.text == "WORD" + response = self.response_class(url, body=body) + assert response.text == "WORD" + assert response.encoding == "utf-8" + + # Body caching sideeffect isn't triggered when encoding is declared in + # content-type header but BOM still need to be removed from decoded + # body + response = self.response_class(url, headers=headers, body=body) + assert response.encoding == "utf-8" + assert response.text == "WORD" + response = self.response_class(url, headers=headers, body=body) + assert response.text == "WORD" + assert response.encoding == "utf-8" + + def test_replace_wrong_encoding(self): + """Test invalid chars are replaced properly""" + r = self.response_class( + "http://www.example.com", + encoding="utf-8", + body=b"PREFIX\xe3\xabSUFFIX", + ) + # XXX: Policy for replacing invalid chars may suffer minor variations + # but it should always contain the unicode replacement char ('\ufffd') + assert "\ufffd" in r.text, repr(r.text) + assert "PREFIX" in r.text, repr(r.text) + assert "SUFFIX" in r.text, repr(r.text) + + # Do not destroy html tags due to encoding bugs + r = self.response_class( + "http://example.com", + encoding="utf-8", + body=b"\xf0value", + ) + assert "value" in r.text, repr(r.text) + + # FIXME: This test should pass once we stop using BeautifulSoup's UnicodeDammit in TextResponse + # r = self.response_class("http://www.example.com", body=b'PREFIX\xe3\xabSUFFIX') + # assert '\ufffd' in r.text, repr(r.text) + + def test_selector(self): + body = b"Some page" + response = self.response_class("http://www.example.com", body=body) + + assert isinstance(response.selector, Selector) + assert response.selector.type == "html" + assert response.selector is response.selector # property is cached + assert response.selector.response is response + + assert response.selector.xpath("//title/text()").getall() == ["Some page"] + assert response.selector.css("title::text").getall() == ["Some page"] + assert response.selector.re("Some (.*)") == ["page"] + + def test_selector_shortcuts(self): + body = b"Some page" + response = self.response_class("http://www.example.com", body=body) + + assert ( + response.xpath("//title/text()").getall() + == response.selector.xpath("//title/text()").getall() + ) + assert ( + response.css("title::text").getall() + == response.selector.css("title::text").getall() + ) + + def test_selector_shortcuts_kwargs(self): + body = b'Some page

A nice paragraph.

' + response = self.response_class("http://www.example.com", body=body) + + assert ( + response.xpath( + "normalize-space(//p[@class=$pclass])", pclass="content" + ).getall() + == response.xpath('normalize-space(//p[@class="content"])').getall() + ) + assert ( + response.xpath( + "//title[count(following::p[@class=$pclass])=$pcount]/text()", + pclass="content", + pcount=1, + ).getall() + == response.xpath( + '//title[count(following::p[@class="content"])=1]/text()' + ).getall() + ) + + def test_urljoin_with_base_url(self): + """Test urljoin shortcut which also evaluates base-url through get_base_url().""" + body = b'' + joined = self.response_class("http://www.example.com", body=body).urljoin( + "/test" + ) + absolute = "https://example.net/test" + assert joined == absolute + + body = b'' + joined = self.response_class("http://www.example.com", body=body).urljoin( + "test" + ) + absolute = "http://www.example.com/test" + assert joined == absolute + + body = b'' + joined = self.response_class("http://www.example.com", body=body).urljoin( + "test" + ) + absolute = "http://www.example.com/elsewhere/test" + assert joined == absolute + + def test_follow_selector(self): + resp = self._links_response() + urls = [ + "http://example.com/sample2.html", + "http://example.com/sample3.html", + "http://example.com/sample3.html", + "http://example.com/sample3.html", + "http://example.com/sample3.html#foo", + "http://www.google.com/something", + "http://example.com/innertag.html", + "http://example.com/page%204.html", + ] + + # select elements + for sellist in [resp.css("a"), resp.xpath("//a")]: + for sel, url in zip(sellist, urls, strict=True): + self._assert_followed_url(sel, url, response=resp) + + # select elements + self._assert_followed_url( + Selector(text='').css("link")[0], + "http://example.com/foo", + response=resp, + ) + + # href attributes should work + for sellist in [resp.css("a::attr(href)"), resp.xpath("//a/@href")]: + for sel, url in zip(sellist, urls, strict=True): + self._assert_followed_url(sel, url, response=resp) + + # non-a elements are not supported + with pytest.raises( + ValueError, match="Only and elements are supported" + ): + resp.follow(resp.css("div")[0]) + + def test_follow_selector_list(self): + resp = self._links_response() + with pytest.raises(ValueError, match="SelectorList"): + resp.follow(resp.css("a")) + + def test_follow_selector_invalid(self): + resp = self._links_response() + with pytest.raises(ValueError, match="Unsupported"): + resp.follow(resp.xpath("count(//div)")[0]) + + def test_follow_selector_attribute(self): + resp = self._links_response() + for src in resp.css("img::attr(src)"): + self._assert_followed_url(src, "http://example.com/sample2.jpg") + + def test_follow_selector_no_href(self): + resp = self.response_class( + url="http://example.com", + body=b"click me", + ) + with pytest.raises(ValueError, match="no href"): + resp.follow(resp.css("a")[0]) + + def test_follow_whitespace_selector(self): + resp = self.response_class( + "http://example.com", + body=b"""click me""", + ) + self._assert_followed_url( + resp.css("a")[0], "http://example.com/foo", response=resp + ) + self._assert_followed_url( + resp.css("a::attr(href)")[0], + "http://example.com/foo", + response=resp, + ) + + def test_follow_encoding(self): + resp1 = self.response_class( + "http://example.com", + encoding="utf8", + body='click me'.encode(), + ) + self._assert_followed_url( + resp1.css("a")[0], + "http://example.com/foo?%D0%BF%D1%80%D0%B8%D0%B2%D0%B5%D1%82", + response=resp1, + encoding="utf8", + ) + + resp2 = self.response_class( + "http://example.com", + encoding="cp1251", + body='click me'.encode( + "cp1251" + ), + ) + self._assert_followed_url( + resp2.css("a")[0], + "http://example.com/foo?%EF%F0%E8%E2%E5%F2", + response=resp2, + encoding="cp1251", + ) + + def test_follow_flags(self): + res = self.response_class("http://example.com/") + fol = res.follow("http://example.com/", flags=["cached", "allowed"]) + assert fol.flags == ["cached", "allowed"] + + def test_follow_all_flags(self): + re = self.response_class("http://www.example.com/") + urls = [ + "http://www.example.com/", + "http://www.example.com/2", + "http://www.example.com/foo", + ] + fol = re.follow_all(urls, flags=["cached", "allowed"]) + for req in fol: + assert req.flags == ["cached", "allowed"] + + def test_follow_all_css(self): + expected = [ + "http://example.com/sample3.html", + "http://example.com/innertag.html", + ] + response = self._links_response() + extracted = [r.url for r in response.follow_all(css='a[href*="example.com"]')] + assert expected == extracted + + def test_follow_all_css_skip_invalid(self): + expected = [ + "http://example.com/page/1/", + "http://example.com/page/3/", + "http://example.com/page/4/", + ] + response = self._links_response_no_href() + extracted1 = [r.url for r in response.follow_all(css=".pagination a")] + assert expected == extracted1 + extracted2 = [r.url for r in response.follow_all(response.css(".pagination a"))] + assert expected == extracted2 + + def test_follow_all_xpath(self): + expected = [ + "http://example.com/sample3.html", + "http://example.com/innertag.html", + ] + response = self._links_response() + extracted = response.follow_all(xpath='//a[contains(@href, "example.com")]') + assert expected == [r.url for r in extracted] + + def test_follow_all_xpath_skip_invalid(self): + expected = [ + "http://example.com/page/1/", + "http://example.com/page/3/", + "http://example.com/page/4/", + ] + response = self._links_response_no_href() + extracted1 = [ + r.url for r in response.follow_all(xpath='//div[@id="pagination"]/a') + ] + assert expected == extracted1 + extracted2 = [ + r.url + for r in response.follow_all(response.xpath('//div[@id="pagination"]/a')) + ] + assert expected == extracted2 + + def test_follow_all_too_many_arguments(self): + response = self._links_response() + with pytest.raises( + ValueError, match="Please supply exactly one of the following arguments" + ): + response.follow_all( + css='a[href*="example.com"]', + xpath='//a[contains(@href, "example.com")]', + ) + + def test_json_response(self): + json_body = b"""{"ip": "109.187.217.200"}""" + json_response = self.response_class("http://www.example.com", body=json_body) + assert json_response.json() == {"ip": "109.187.217.200"} + + text_body = b"""text""" + text_response = self.response_class("http://www.example.com", body=text_body) + with pytest.raises( + ValueError, match=r"(Expecting value|Unexpected '<'): line 1" + ): + text_response.json() + + def test_cache_json_response(self): + json_valid_bodies = [b"""{"ip": "109.187.217.200"}""", b"""null"""] + for json_body in json_valid_bodies: + json_response = self.response_class( + "http://www.example.com", body=json_body + ) + + with mock.patch("json.loads") as mock_json: + for _ in range(2): + json_response.json() + mock_json.assert_called_once_with(json_body) + + +class TestHtmlResponse(TestTextResponse): + response_class = HtmlResponse + + def test_html_encoding(self): + body = b"""Some page + + Price: \xa3100' + """ + r1 = self.response_class("http://www.example.com", body=body) + self._assert_response_values(r1, "iso-8859-1", body) + + body = b""" + + Price: \xa3100 + """ + r2 = self.response_class("http://www.example.com", body=body) + self._assert_response_values(r2, "iso-8859-1", body) + + # for conflicting declarations headers must take precedence + body = b"""Some page + + Price: \xa3100' + """ + r3 = self.response_class( + "http://www.example.com", + body=body, + headers={"Content-type": ["text/html; charset=iso-8859-1"]}, + ) + self._assert_response_values(r3, "iso-8859-1", body) + + # make sure replace() preserves the encoding of the original response + body = b"New body \xa3" + r4 = r3.replace(body=body) + self._assert_response_values(r4, "iso-8859-1", body) + + def test_html5_meta_charset(self): + body = b"""Some pagebla bla""" + r1 = self.response_class("http://www.example.com", body=body) + self._assert_response_values(r1, "gb2312", body) + + +class TestXmlResponse(TestTextResponse): + response_class = XmlResponse + + def test_xml_encoding(self): + body = b"" + r1 = self.response_class("http://www.example.com", body=body) + self._assert_response_values(r1, self.response_class._DEFAULT_ENCODING, body) + + body = b"""""" + r2 = self.response_class("http://www.example.com", body=body) + self._assert_response_values(r2, "iso-8859-1", body) + + # make sure replace() preserves the explicit encoding passed in the __init__ method + body = b"""""" + r3 = self.response_class("http://www.example.com", body=body, encoding="utf-8") + body2 = b"New body" + r4 = r3.replace(body=body2) + self._assert_response_values(r4, "utf-8", body2) + + def test_replace_encoding(self): + # make sure replace() keeps the previous encoding unless overridden explicitly + body = b"""""" + body2 = b"""""" + r5 = self.response_class("http://www.example.com", body=body) + r6 = r5.replace(body=body2) + r7 = r5.replace(body=body2, encoding="utf-8") + self._assert_response_values(r5, "iso-8859-1", body) + self._assert_response_values(r6, "iso-8859-1", body2) + self._assert_response_values(r7, "utf-8", body2) + + def test_selector(self): + body = b'value' + response = self.response_class("http://www.example.com", body=body) + + assert isinstance(response.selector, Selector) + assert response.selector.type == "xml" + assert response.selector is response.selector # property is cached + assert response.selector.response is response + + assert response.selector.xpath("//elem/text()").getall() == ["value"] + + def test_selector_shortcuts(self): + body = b'value' + response = self.response_class("http://www.example.com", body=body) + + assert ( + response.xpath("//elem/text()").getall() + == response.selector.xpath("//elem/text()").getall() + ) + + def test_selector_shortcuts_kwargs(self): + body = b""" + + value + """ + response = self.response_class("http://www.example.com", body=body) + + assert ( + response.xpath( + "//s:elem/text()", namespaces={"s": "http://scrapy.org"} + ).getall() + == response.selector.xpath( + "//s:elem/text()", namespaces={"s": "http://scrapy.org"} + ).getall() + ) + + response.selector.register_namespace("s2", "http://scrapy.org") + assert ( + response.xpath( + "//s1:elem/text()", namespaces={"s1": "http://scrapy.org"} + ).getall() + == response.selector.xpath("//s2:elem/text()").getall() + ) + + +class CustomResponse(TextResponse): + attributes = (*TextResponse.attributes, "foo", "bar") + + def __init__(self, *args, **kwargs) -> None: + self.foo = kwargs.pop("foo", None) + self.bar = kwargs.pop("bar", None) + self.lost = kwargs.pop("lost", None) + super().__init__(*args, **kwargs) + + +class TestCustomResponse(TestTextResponse): + response_class = CustomResponse + + def test_copy(self): + super().test_copy() + r1 = self.response_class( + url="https://example.org", + status=200, + foo="foo", + bar="bar", + lost="lost", + ) + r2 = r1.copy() + assert isinstance(r2, self.response_class) + assert r1.foo == r2.foo + assert r1.bar == r2.bar + assert r1.lost == "lost" + assert r2.lost is None + + def test_replace(self): + super().test_replace() + r1 = self.response_class( + url="https://example.org", + status=200, + foo="foo", + bar="bar", + lost="lost", + ) + + r2 = r1.replace(foo="new-foo", bar="new-bar", lost="new-lost") + assert isinstance(r2, self.response_class) + assert r1.foo == "foo" + assert r1.bar == "bar" + assert r1.lost == "lost" + assert r2.foo == "new-foo" + assert r2.bar == "new-bar" + assert r2.lost == "new-lost" + + r3 = r1.replace(foo="new-foo", bar="new-bar") + assert isinstance(r3, self.response_class) + assert r1.foo == "foo" + assert r1.bar == "bar" + assert r1.lost == "lost" + assert r3.foo == "new-foo" + assert r3.bar == "new-bar" + assert r3.lost is None + + r4 = r1.replace(foo="new-foo") + assert isinstance(r4, self.response_class) + assert r1.foo == "foo" + assert r1.bar == "bar" + assert r1.lost == "lost" + assert r4.foo == "new-foo" + assert r4.bar == "bar" + assert r4.lost is None + + with pytest.raises( + TypeError, + match=r"__init__\(\) got an unexpected keyword argument 'unknown'", + ): + r1.replace(unknown="unknown") diff --git a/tests/test_item.py b/tests/test_item.py index bf51eb398..34b054e12 100644 --- a/tests/test_item.py +++ b/tests/test_item.py @@ -48,6 +48,18 @@ class TestItem: with pytest.raises(KeyError): i["field"] + def test_delitem(self): + class TestItem(Item): + name = Field() + + i = TestItem(name="John") + del i["name"] + with pytest.raises(KeyError): + i["name"] + + with pytest.raises(KeyError): + del i["name"] + def test_repr(self): class TestItem(Item): name = Field() @@ -60,7 +72,7 @@ class TestItem: assert itemrepr == "{'name': 'John Doe', 'number': 123}" - i2 = eval(itemrepr) # pylint: disable=eval-used + i2 = eval(itemrepr) assert i2["name"] == "John Doe" assert i2["number"] == 123 @@ -284,9 +296,9 @@ class TestItemMeta: (first_call, second_call) = new_mock.call_args_list[-2:] - mcs, class_name, bases, attrs = first_call[0] + *_, attrs = first_call[0] assert "__classcell__" not in attrs - mcs, class_name, bases, attrs = second_call[0] + *_, attrs = second_call[0] assert "__classcell__" in attrs diff --git a/tests/test_link.py b/tests/test_link.py index f96961075..0eeffe12b 100644 --- a/tests/test_link.py +++ b/tests/test_link.py @@ -49,9 +49,13 @@ class TestLink: l1 = Link( "http://www.example.com", text="test", fragment="something", nofollow=True ) - l2 = eval(repr(l1)) # pylint: disable=eval-used + l2 = eval(repr(l1)) self._assert_same_links(l1, l2) def test_bytes_url(self): with pytest.raises(TypeError): Link(b"http://www.example.com/\xc2\xa3") + + def test_eq_non_link(self): + url = "http://example.com" + assert Link(url) != url diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index 15d358d2a..063b92dac 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -9,7 +9,7 @@ from w3lib import __version__ as w3lib_version from scrapy.http import HtmlResponse, XmlResponse from scrapy.link import Link -from scrapy.linkextractors.lxmlhtml import LxmlLinkExtractor +from scrapy.linkextractors.lxmlhtml import LxmlLinkExtractor, LxmlParserLinkExtractor from tests import get_testdata @@ -837,3 +837,36 @@ class TestLxmlLinkExtractor(Base.TestLinkExtractorBase): def test_link_allowed_is_false_with_missing_url_prefix(self): bad_link = Link("should_have_prefix.example") assert not LxmlLinkExtractor()._link_allowed(bad_link) + + +class TestLxmlParserLinkExtractor: + def test_extract_links(self): + html = b'Link' + response = HtmlResponse("http://example.com/", body=html) + lx = LxmlParserLinkExtractor() + assert lx.extract_links(response) == [ + Link(url="http://example.com/page.html", text="Link", nofollow=False), + ] + + def test_strip_false(self): + # With strip=False, trailing whitespace on a relative href survives urljoin + # and is visible to process_value (safe_url_string cleans it up afterward). + # Here process_value rejects URLs that still carry trailing whitespace, + # demonstrating the difference from strip=True. + def reject_trailing_whitespace(url): + return None if url != url.rstrip() else url + + html = b'Link' + response = HtmlResponse("http://example.com/", body=html) + + lx_strip = LxmlParserLinkExtractor( + strip=True, process=reject_trailing_whitespace + ) + assert lx_strip.extract_links(response) == [ + Link(url="http://example.com/page.html", text="Link", nofollow=False), + ] + + lx_no_strip = LxmlParserLinkExtractor( + strip=False, process=reject_trailing_whitespace + ) + assert lx_no_strip.extract_links(response) == [] diff --git a/tests/test_loader.py b/tests/test_loader.py index 224158e7f..c094d25d8 100644 --- a/tests/test_loader.py +++ b/tests/test_loader.py @@ -39,7 +39,7 @@ class AttrsNameItem: @dataclasses.dataclass class NameDataClass: - name: list = dataclasses.field(default_factory=list) + name: list[str] = dataclasses.field(default_factory=list) # test item loaders @@ -55,17 +55,6 @@ class ProcessorItemLoader(NameItemLoader): name_in = MapCompose(lambda v: v.title()) -class DefaultedItemLoader(NameItemLoader): - default_input_processor = MapCompose(lambda v: v[:-1]) - - -# test processors -def processor_with_args(value, other=None, loader_context=None): - if "key" in loader_context: - return loader_context["key"] - return value - - class TestBasicItemLoader: def test_add_value_on_unknown_field(self): il = ProcessorItemLoader() diff --git a/tests/test_logformatter.py b/tests/test_logformatter.py index 047f8c610..360aa613e 100644 --- a/tests/test_logformatter.py +++ b/tests/test_logformatter.py @@ -2,9 +2,7 @@ import logging import pytest from testfixtures import LogCapture -from twisted.internet.defer import inlineCallbacks from twisted.python.failure import Failure -from twisted.trial.unittest import TestCase from scrapy.exceptions import DropItem from scrapy.http import Request, Response @@ -12,8 +10,9 @@ from scrapy.item import Field, Item from scrapy.logformatter import LogFormatter from scrapy.spiders import Spider from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer from tests.spiders import ItemSpider +from tests.utils.decorators import inline_callbacks_test class CustomItem(Item): @@ -29,14 +28,14 @@ class TestLogFormatter: self.spider = Spider("default") self.spider.crawler = get_crawler() - def test_crawled_with_referer(self): + def test_crawled_without_referer(self): req = Request("http://www.example.com") res = Response("http://www.example.com") logkws = self.formatter.crawled(req, res, self.spider) logline = logkws["msg"] % logkws["args"] assert logline == "Crawled (200) (referer: None)" - def test_crawled_without_referer(self): + def test_crawled_with_referer(self): req = Request( "http://www.example.com", headers={"referer": "http://example.com"} ) @@ -110,7 +109,7 @@ class TestLogFormatter: assert logkws["level"] == unsupported_value with pytest.raises(TypeError): - logging.log(logkws["level"], "message") + logging.log(logkws["level"], "message") # noqa: LOG015 def test_dropitem_custom_log_level(self): item = {} @@ -199,7 +198,7 @@ class TestLogformatterSubclass(TestLogFormatter): self.spider = Spider("default") self.spider.crawler = get_crawler(Spider) - def test_crawled_with_referer(self): + def test_crawled_without_referer(self): req = Request("http://www.example.com") res = Response("http://www.example.com") logkws = self.formatter.crawled(req, res, self.spider) @@ -208,7 +207,7 @@ class TestLogformatterSubclass(TestLogFormatter): logline == "Crawled (200) (referer: None) []" ) - def test_crawled_without_referer(self): + def test_crawled_with_referer(self): req = Request( "http://www.example.com", headers={"referer": "http://example.com"}, @@ -247,24 +246,24 @@ class SkipMessagesLogFormatter(LogFormatter): class DropSomeItemsPipeline: drop = True - def process_item(self, item, spider): + def process_item(self, item): if self.drop: self.drop = False raise DropItem("Ignoring item") self.drop = True -class TestShowOrSkipMessages(TestCase): +class TestShowOrSkipMessages: @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) - def setUp(self): + def setup_method(self): self.base_settings = { "LOG_LEVEL": "DEBUG", "ITEM_PIPELINES": { @@ -272,7 +271,7 @@ class TestShowOrSkipMessages(TestCase): }, } - @inlineCallbacks + @inline_callbacks_test def test_show_messages(self): crawler = get_crawler(ItemSpider, self.base_settings) with LogCapture() as lc: @@ -281,7 +280,7 @@ class TestShowOrSkipMessages(TestCase): assert "Crawled (200) Crawler: + return get_crawler(Spider) + + +def test_init(crawler: Crawler) -> None: + m1, m2, m3 = M1(), M2(), M3() + mwman = MyMiddlewareManager(m1, m2, m3, crawler=crawler) + assert list(mwman.methods["open_spider"]) == [m1.open_spider, m2.open_spider] + assert list(mwman.methods["close_spider"]) == [m2.close_spider, m1.close_spider] + assert list(mwman.methods["process"]) == [m1.process, m3.process] + assert mwman.crawler == crawler + + +def test_methods(crawler: Crawler) -> None: + mwman = MyMiddlewareManager(M1(), M2(), M3(), crawler=crawler) + assert [x.__self__.__class__ for x in mwman.methods["open_spider"]] == [M1, M2] # type: ignore[union-attr] + assert [x.__self__.__class__ for x in mwman.methods["close_spider"]] == [M2, M1] # type: ignore[union-attr] + assert [x.__self__.__class__ for x in mwman.methods["process"]] == [M1, M3] # type: ignore[union-attr] + + +def test_enabled(crawler: Crawler) -> None: + m1, m2, m3 = M1(), M2(), M3() + mwman = MyMiddlewareManager(m1, m2, m3, crawler=crawler) + assert mwman.middlewares == (m1, m2, m3) + + +def test_enabled_from_settings(crawler: Crawler) -> None: + crawler = get_crawler() + mwman = MyMiddlewareManager.from_crawler(crawler) + classes = [x.__class__ for x in mwman.middlewares] + assert classes == [M1, M3] + assert mwman.crawler == crawler + + +def test_no_crawler() -> None: + m1, m2, m3 = M1(), M2(), M3() + with pytest.warns( + ScrapyDeprecationWarning, match="was called without the crawler argument" + ): mwman = MyMiddlewareManager(m1, m2, m3) - assert list(mwman.methods["open_spider"]) == [m1.open_spider, m2.open_spider] - assert list(mwman.methods["close_spider"]) == [m2.close_spider, m1.close_spider] - assert list(mwman.methods["process"]) == [m1.process, m3.process] - - def test_methods(self): - mwman = MyMiddlewareManager(M1(), M2(), M3()) - assert [x.__self__.__class__ for x in mwman.methods["open_spider"]] == [M1, M2] - assert [x.__self__.__class__ for x in mwman.methods["close_spider"]] == [M2, M1] - assert [x.__self__.__class__ for x in mwman.methods["process"]] == [M1, M3] - - def test_enabled(self): - m1, m2, m3 = M1(), M2(), M3() - mwman = MiddlewareManager(m1, m2, m3) - assert mwman.middlewares == (m1, m2, m3) - - def test_enabled_from_settings(self): - crawler = get_crawler() - mwman = MyMiddlewareManager.from_crawler(crawler) - classes = [x.__class__ for x in mwman.middlewares] - assert classes == [M1, M3] + assert mwman.middlewares == (m1, m2, m3) + assert mwman.crawler is None diff --git a/tests/test_pipeline_crawl.py b/tests/test_pipeline_crawl.py index cf827e481..0376d27c4 100644 --- a/tests/test_pipeline_crawl.py +++ b/tests/test_pipeline_crawl.py @@ -7,15 +7,14 @@ from typing import TYPE_CHECKING, Any import pytest from testfixtures import LogCapture -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase from w3lib.url import add_or_replace_parameter from scrapy import Spider, signals from scrapy.utils.misc import load_object from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer from tests.spiders import SimpleSpider +from tests.utils.decorators import inline_callbacks_test if TYPE_CHECKING: from scrapy.crawler import Crawler @@ -58,7 +57,7 @@ class RedirectedMediaDownloadSpider(MediaDownloadSpider): ) -class TestFileDownloadCrawl(TestCase): +class TestFileDownloadCrawl: pipeline_class = "scrapy.pipelines.files.FilesPipeline" store_setting_key = "FILES_STORE" media_key = "files" @@ -70,15 +69,15 @@ class TestFileDownloadCrawl(TestCase): } @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) - def setUp(self): + def setup_method(self): # prepare a directory for storing files self.tmpmediastore = Path(mkdtemp()) self.settings = { @@ -87,7 +86,7 @@ class TestFileDownloadCrawl(TestCase): } self.items = [] - def tearDown(self): + def teardown_method(self): shutil.rmtree(self.tmpmediastore) self.items = [] @@ -145,41 +144,41 @@ class TestFileDownloadCrawl(TestCase): # check that no files were written to the media store assert not list(self.tmpmediastore.iterdir()) - @inlineCallbacks + @inline_callbacks_test def test_download_media(self): crawler = self._create_crawler(MediaDownloadSpider) with LogCapture() as log: yield crawler.crawl( - self.mockserver.url("/files/images/"), + self.mockserver.url("/static/files/images/"), media_key=self.media_key, media_urls_key=self.media_urls_key, ) self._assert_files_downloaded(self.items, str(log)) - @inlineCallbacks + @inline_callbacks_test def test_download_media_wrong_urls(self): crawler = self._create_crawler(BrokenLinksMediaDownloadSpider) with LogCapture() as log: yield crawler.crawl( - self.mockserver.url("/files/images/"), + self.mockserver.url("/static/files/images/"), media_key=self.media_key, media_urls_key=self.media_urls_key, ) self._assert_files_download_failure(crawler, self.items, 404, str(log)) - @inlineCallbacks + @inline_callbacks_test def test_download_media_redirected_default_failure(self): crawler = self._create_crawler(RedirectedMediaDownloadSpider) with LogCapture() as log: yield crawler.crawl( - self.mockserver.url("/files/images/"), + self.mockserver.url("/static/files/images/"), media_key=self.media_key, media_urls_key=self.media_urls_key, mockserver=self.mockserver, ) self._assert_files_download_failure(crawler, self.items, 302, str(log)) - @inlineCallbacks + @inline_callbacks_test def test_download_media_redirected_allowed(self): settings = { **self.settings, @@ -188,7 +187,7 @@ class TestFileDownloadCrawl(TestCase): crawler = self._create_crawler(RedirectedMediaDownloadSpider, settings) with LogCapture() as log: yield crawler.crawl( - self.mockserver.url("/files/images/"), + self.mockserver.url("/static/files/images/"), media_key=self.media_key, media_urls_key=self.media_urls_key, mockserver=self.mockserver, @@ -196,7 +195,7 @@ class TestFileDownloadCrawl(TestCase): self._assert_files_downloaded(self.items, str(log)) assert crawler.stats.get_value("downloader/response_status_count/302") == 3 - @inlineCallbacks + @inline_callbacks_test def test_download_media_file_path_error(self): cls = load_object(self.pipeline_class) @@ -211,7 +210,7 @@ class TestFileDownloadCrawl(TestCase): crawler = self._create_crawler(MediaDownloadSpider, settings) with LogCapture() as log: yield crawler.crawl( - self.mockserver.url("/files/images/"), + self.mockserver.url("/static/files/images/"), media_key=self.media_key, media_urls_key=self.media_urls_key, mockserver=self.mockserver, diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index 808fde23d..3829a35f5 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -2,9 +2,9 @@ import dataclasses import os import random import time -import warnings from abc import ABC, abstractmethod from datetime import datetime +from ftplib import FTP from io import BytesIO from pathlib import Path from posixpath import split @@ -12,14 +12,15 @@ from shutil import rmtree from tempfile import mkdtemp from typing import Any from unittest import mock +from unittest.mock import MagicMock from urllib.parse import urlparse import attr import pytest from itemadapter import ItemAdapter -from twisted.internet.defer import inlineCallbacks -from twisted.trial import unittest +from twisted.internet.defer import Deferred +from scrapy.exceptions import NotConfigured from scrapy.http import Request, Response from scrapy.item import Field, Item from scrapy.pipelines.files import ( @@ -29,10 +30,12 @@ from scrapy.pipelines.files import ( GCSFilesStore, S3FilesStore, ) -from scrapy.utils.test import ( - get_crawler, -) -from tests.mockserver import MockFTPServer +from scrapy.settings import Settings +from scrapy.utils.asyncio import call_later +from scrapy.utils.spider import DefaultSpider +from scrapy.utils.test import get_crawler +from tests.mockserver.ftp import MockFTPServer +from tests.utils.decorators import coroutine_test, inline_callbacks_test from .test_pipeline_media import _mocked_download_func @@ -40,7 +43,7 @@ from .test_pipeline_media import _mocked_download_func def get_gcs_content_and_delete( bucket: Any, path: str ) -> tuple[bytes, list[dict[str, str]], Any]: - from google.cloud import storage + from google.cloud import storage # noqa: PLC0415 client = storage.Client(project=os.environ.get("GCS_PROJECT_ID")) bucket = client.get_bucket(bucket) @@ -59,37 +62,61 @@ def get_ftp_content_and_delete( password: str, use_active_mode: bool = False, ) -> bytes: - from ftplib import FTP + with FTP() as ftp: + ftp.connect(host, port) + ftp.login(username, password) + if use_active_mode: + ftp.set_pasv(False) + ftp_data: list[bytes] = [] - ftp = FTP() - ftp.connect(host, port) - ftp.login(username, password) - if use_active_mode: - ftp.set_pasv(False) - ftp_data: list[bytes] = [] + def buffer_data(data: bytes) -> None: + ftp_data.append(data) - def buffer_data(data: bytes) -> None: - ftp_data.append(data) - - ftp.retrbinary(f"RETR {path}", buffer_data) - dirname, filename = split(path) - ftp.cwd(dirname) - ftp.delete(filename) + ftp.retrbinary(f"RETR {path}", buffer_data) + dirname, filename = split(path) + ftp.cwd(dirname) + ftp.delete(filename) return b"".join(ftp_data) -class TestFilesPipeline(unittest.TestCase): - def setUp(self): +class DeferredFSFilesStore(FSFilesStore): + """A simple store with persist_file() returning a deferred.""" + + def persist_file(self, path, buf, info, meta=None, headers=None): + deferred = Deferred() + # short-hand super() doesn't work in nested functions + parent_persist_file = super().persist_file + + def cb(): + parent_persist_file(path, buf, info, meta=meta, headers=headers) + deferred.callback(None) + + call_later(0.5, cb) + return deferred + + +class TestFilesPipeline: + def setup_method(self): self.tempdir = mkdtemp() settings_dict = {"FILES_STORE": self.tempdir} - crawler = get_crawler(spidercls=None, settings_dict=settings_dict) + crawler = get_crawler(DefaultSpider, settings_dict=settings_dict) + crawler.spider = crawler._create_spider() + crawler.engine = MagicMock(download_async=_mocked_download_func) self.pipeline = FilesPipeline.from_crawler(crawler) - self.pipeline.download_func = _mocked_download_func - self.pipeline.open_spider(None) + self.pipeline.open_spider() - def tearDown(self): + def teardown_method(self): rmtree(self.tempdir) + def test_file_path_query_parameters(self): + file_path = self.pipeline.file_path + + req1 = Request("http://foo.bar/baz.txt?fizz") + assert file_path(req1) == "full/a2b4913a62f65445aeae2bac08cd8c3b41d7195e.txt" + + req2 = Request("http://foo.bar/get_img.foo?file=photo.jpg") + assert file_path(req2) == "full/7fc9461c9fd836515bea6983373097203a7d748e.jpg" + def test_file_path(self): file_path = self.pipeline.file_path assert ( @@ -113,10 +140,10 @@ class TestFilesPipeline(unittest.TestCase): assert ( file_path( Request( - "http://www.dfsonline.co.uk/get_prod_image.php?img=status_0907_mdm.jpg" + "http://www.dfsonline.co.uk/get_prod_image?img=status_0907_mdm.jpg" ) ) - == "full/4507be485f38b0da8a0be9eb2e1dfab8a19223f2.jpg" + == "full/c67f916ff9d542e822dedf38f9fcb146d1faba78.jpg" ) assert ( file_path(Request("http://www.dorma.co.uk/images/product_details/2532/")) @@ -137,10 +164,10 @@ class TestFilesPipeline(unittest.TestCase): assert ( file_path( Request( - "http://www.dfsonline.co.uk/get_prod_image.php?img=status_0907_mdm.jpg.bohaha" + "http://www.dfsonline.co.uk/get_prod_image?img=status_0907_mdm.jpg.bohaha" ) ) - == "full/76c00cef2ef669ae65052661f68d451162829507" + == "full/e75f2fa260521b56f6b6a867447b8002d00b5841" ) assert ( file_path( @@ -160,11 +187,11 @@ class TestFilesPipeline(unittest.TestCase): fullpath = Path(self.tempdir, "some", "image", "key.jpg") assert self.pipeline.store._get_filesystem_path(path) == fullpath - @inlineCallbacks - def test_file_not_expired(self): + @coroutine_test + async def test_file_not_expired(self): item_url = "http://example.com/file.pdf" item = _create_item_with_files(item_url) - patchers = [ + with ( mock.patch.object(FilesPipeline, "inc_stats", return_value=True), mock.patch.object( FSFilesStore, @@ -176,22 +203,16 @@ class TestFilesPipeline(unittest.TestCase): "get_media_requests", return_value=[_prepare_request_object(item_url)], ), - ] - for p in patchers: - p.start() - - result = yield self.pipeline.process_item(item, None) + ): + result = await self.pipeline.process_item(item) assert result["files"][0]["checksum"] == "abc" assert result["files"][0]["status"] == "uptodate" - for p in patchers: - p.stop() - - @inlineCallbacks - def test_file_expired(self): + @coroutine_test + async def test_file_expired(self): item_url = "http://example.com/file2.pdf" item = _create_item_with_files(item_url) - patchers = [ + with ( mock.patch.object( FSFilesStore, "stat_file", @@ -207,22 +228,16 @@ class TestFilesPipeline(unittest.TestCase): return_value=[_prepare_request_object(item_url)], ), mock.patch.object(FilesPipeline, "inc_stats", return_value=True), - ] - for p in patchers: - p.start() - - result = yield self.pipeline.process_item(item, None) + ): + result = await self.pipeline.process_item(item) assert result["files"][0]["checksum"] != "abc" assert result["files"][0]["status"] == "downloaded" - for p in patchers: - p.stop() - - @inlineCallbacks - def test_file_cached(self): + @coroutine_test + async def test_file_cached(self): item_url = "http://example.com/file3.pdf" item = _create_item_with_files(item_url) - patchers = [ + with ( mock.patch.object(FilesPipeline, "inc_stats", return_value=True), mock.patch.object( FSFilesStore, @@ -238,16 +253,33 @@ class TestFilesPipeline(unittest.TestCase): "get_media_requests", return_value=[_prepare_request_object(item_url, flags=["cached"])], ), - ] - for p in patchers: - p.start() - - result = yield self.pipeline.process_item(item, None) + ): + result = await self.pipeline.process_item(item) assert result["files"][0]["checksum"] != "abc" assert result["files"][0]["status"] == "cached" - for p in patchers: - p.stop() + @coroutine_test + async def test_async_store(self) -> None: + """Test that async persist_file() works and is awaited.""" + + self.pipeline.store = DeferredFSFilesStore(self.tempdir) + item_url = "http://example.com/file.pdf" + item = _create_item_with_files(item_url) + with ( + mock.patch.object(FilesPipeline, "inc_stats", return_value=True), + mock.patch.object( + FilesPipeline, + "get_media_requests", + return_value=[_prepare_request_object(item_url)], + ), + ): + result = await self.pipeline.process_item(item) + assert result["files"][0]["status"] == "downloaded" + assert result["files"][0]["checksum"] + # check that the file was written by persist_file() + path = Path(self.tempdir) / result["files"][0]["path"] + assert path.exists() + assert path.read_bytes() == b"data" def test_file_path_from_item(self): """ @@ -265,6 +297,26 @@ class TestFilesPipeline(unittest.TestCase): request = Request("http://example.com") assert file_path(request, item=item) == "full/path-to-store-file" + @pytest.mark.parametrize( + "bad_type", + [ + "http://example.com/file.pdf", + ("http://example.com/file.pdf",), + {"url": "http://example.com/file.pdf"}, + 123, + None, + ], + ) + def test_rejects_non_list_file_urls(self, tmp_path, bad_type): + pipeline = FilesPipeline.from_crawler( + get_crawler(None, {"FILES_STORE": str(tmp_path)}) + ) + item = ItemWithFiles() + item["file_urls"] = bad_type + + with pytest.raises(TypeError, match="file_urls must be a list of URLs"): + list(pipeline.get_media_requests(item, None)) + class TestFilesPipelineFieldsMixin(ABC): @property @@ -330,11 +382,11 @@ class TestFilesPipelineFieldsItem(TestFilesPipelineFieldsMixin): class FilesPipelineTestDataClass: name: str # default fields - file_urls: list = dataclasses.field(default_factory=list) - files: list = dataclasses.field(default_factory=list) + file_urls: list[str] = dataclasses.field(default_factory=list) + files: list[dict[str, str]] = dataclasses.field(default_factory=list) # overridden fields - custom_file_urls: list = dataclasses.field(default_factory=list) - custom_files: list = dataclasses.field(default_factory=list) + custom_file_urls: list[str] = dataclasses.field(default_factory=list) + custom_files: list[dict[str, str]] = dataclasses.field(default_factory=list) class TestFilesPipelineFieldsDataClass(TestFilesPipelineFieldsMixin): @@ -417,7 +469,7 @@ class TestFilesPipelineCustomSettings: """ pipe_cls = self._generate_fake_pipeline() pipe = pipe_cls.from_crawler(get_crawler(None, {"FILES_STORE": tmp_path})) - for pipe_attr, settings_attr, pipe_ins_attr in self.file_cls_attr_settings_map: + for pipe_attr, _, pipe_ins_attr in self.file_cls_attr_settings_map: custom_value = getattr(pipe, pipe_ins_attr) assert custom_value != self.default_cls_settings[pipe_attr] assert getattr(pipe, pipe_ins_attr) == getattr(pipe, pipe_attr) @@ -448,7 +500,7 @@ class TestFilesPipelineCustomSettings: user_pipeline = UserDefinedFilesPipeline.from_crawler( get_crawler(None, {"FILES_STORE": tmp_path}) ) - for pipe_attr, settings_attr, pipe_ins_attr in self.file_cls_attr_settings_map: + for pipe_attr, _, pipe_ins_attr in self.file_cls_attr_settings_map: # Values from settings for custom pipeline should be set on pipeline instance. custom_value = self.default_cls_settings.get(pipe_attr.upper()) assert getattr(user_pipeline, pipe_ins_attr) == custom_value @@ -520,7 +572,7 @@ class TestFilesPipelineCustomSettings: pipeline_cls = UserPipe.from_crawler(get_crawler(None, settings)) - for pipe_attr, settings_attr, pipe_inst_attr in self.file_cls_attr_settings_map: + for _, settings_attr, pipe_inst_attr in self.file_cls_attr_settings_map: expected_value = settings.get(settings_attr) assert getattr(pipeline_cls, pipe_inst_attr) == expected_value @@ -541,8 +593,8 @@ class TestFilesPipelineCustomSettings: @pytest.mark.requires_botocore -class TestS3FilesStore(unittest.TestCase): - @inlineCallbacks +class TestS3FilesStore: + @inline_callbacks_test def test_persist(self): bucket = "mybucket" key = "export.csv" @@ -553,7 +605,7 @@ class TestS3FilesStore(unittest.TestCase): content_type = "image/png" store = S3FilesStore(uri) - from botocore.stub import Stubber + from botocore.stub import Stubber # noqa: PLC0415 with Stubber(store.s3_client) as stub: stub.add_response( @@ -582,7 +634,7 @@ class TestS3FilesStore(unittest.TestCase): # The call to read does not happen with Stubber assert buffer.method_calls == [mock.call.seek(0)] - @inlineCallbacks + @inline_callbacks_test def test_stat(self): bucket = "mybucket" key = "export.csv" @@ -591,7 +643,7 @@ class TestS3FilesStore(unittest.TestCase): last_modified = datetime(2019, 12, 1) store = S3FilesStore(uri) - from botocore.stub import Stubber + from botocore.stub import Stubber # noqa: PLC0415 with Stubber(store.s3_client) as stub: stub.add_response( @@ -618,8 +670,8 @@ class TestS3FilesStore(unittest.TestCase): @pytest.mark.skipif( "GCS_PROJECT_ID" not in os.environ, reason="GCS_PROJECT_ID not found" ) -class TestGCSFilesStore(unittest.TestCase): - @inlineCallbacks +class TestGCSFilesStore: + @inline_callbacks_test def test_persist(self): uri = os.environ.get("GCS_TEST_FILE_URI") if not uri: @@ -644,13 +696,13 @@ class TestGCSFilesStore(unittest.TestCase): assert blob.content_type == "application/octet-stream" assert expected_policy in acl - @inlineCallbacks + @inline_callbacks_test def test_blob_path_consistency(self): """Test to make sure that paths used to store files is the same as the one used to get already uploaded files. """ try: - import google.cloud.storage # noqa: F401 + import google.cloud.storage # noqa: F401,PLC0415 except ModuleNotFoundError: pytest.skip("google-cloud-storage is not installed") with ( @@ -670,14 +722,18 @@ class TestGCSFilesStore(unittest.TestCase): store.bucket.get_blob.assert_called_with(expected_blob_path) -class TestFTPFileStore(unittest.TestCase): - @inlineCallbacks +class TestFTPFileStore: + @inline_callbacks_test def test_persist(self): data = b"TestFTPFilesStore: \xe2\x98\x83" buf = BytesIO(data) meta = {"foo": "bar"} path = "full/filename" with MockFTPServer() as ftp_server: + # normally set via FilesPipeline.from_crawler() + FTPFilesStore.FTP_USERNAME = "anonymous" + FTPFilesStore.FTP_PASSWORD = "guest" + store = FTPFilesStore(ftp_server.url("/")) empty_dict = yield store.stat_file(path, info=None) assert empty_dict == {} @@ -703,13 +759,13 @@ class ItemWithFiles(Item): files = Field() -def _create_item_with_files(*files): +def _create_item_with_files(*files: str) -> ItemWithFiles: item = ItemWithFiles() item["file_urls"] = files return item -def _prepare_request_object(item_url, flags=None): +def _prepare_request_object(item_url: str, flags: list[str] | None = None) -> Request: return Request( item_url, meta={"response": Response(item_url, status=200, body=b"data", flags=flags)}, @@ -729,43 +785,10 @@ class TestBuildFromCrawler: class Pipeline(FilesPipeline): pass - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 0 - assert pipe.store - - def test_has_old_init(self): - class Pipeline(FilesPipeline): - def __init__(self, store_uri, download_func=None, settings=None): - super().__init__(store_uri, download_func, settings) - self._init_called = True - - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 2 - assert pipe._init_called - - def test_has_from_settings(self): - class Pipeline(FilesPipeline): - _from_settings_called = False - - @classmethod - def from_settings(cls, settings): - o = super().from_settings(settings) - o._from_settings_called = True - return o - - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 3 - assert pipe.store - assert pipe._from_settings_called + pipe = Pipeline.from_crawler(self.crawler) + assert pipe.crawler == self.crawler + assert pipe._fingerprinter + assert pipe.store def test_has_from_crawler_and_init(self): class Pipeline(FilesPipeline): @@ -779,10 +802,19 @@ class TestBuildFromCrawler: o._from_crawler_called = True return o - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 0 - assert pipe.store - assert pipe._from_crawler_called + pipe = Pipeline.from_crawler(self.crawler) + assert pipe.crawler == self.crawler + assert pipe._fingerprinter + assert pipe.store + assert pipe._from_crawler_called + + +@pytest.mark.parametrize("store", [None, ""]) +def test_files_pipeline_raises_notconfigured_when_files_store_invalid(store): + settings = Settings() + settings.clear() + settings.set("FILES_STORE", store, priority="cmdline") + crawler = get_crawler(settings_dict=settings) + + with pytest.raises(NotConfigured): + FilesPipeline.from_crawler(crawler) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 74b4495ad..1b73dd157 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -14,6 +14,7 @@ from itemadapter import ItemAdapter from scrapy.http import Request, Response from scrapy.item import Field, Item +from scrapy.pipelines.files import GCSFilesStore, S3FilesStore from scrapy.pipelines.images import ImageException, ImagesPipeline from scrapy.utils.test import get_crawler @@ -159,7 +160,7 @@ class TestImagesPipeline: self.pipeline.thumbs = {"small": (20, 20)} orig_im, buf = _create_image("JPEG", "RGB", (50, 50), (0, 0, 0)) - orig_thumb, orig_thumb_buf = _create_image("JPEG", "RGB", (20, 20), (0, 0, 0)) + _, orig_thumb_buf = _create_image("JPEG", "RGB", (20, 20), (0, 0, 0)) resp = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf.getvalue()) req = Request(url="https://dev.mydeco.com/mydeco.gif") @@ -169,13 +170,33 @@ class TestImagesPipeline: path, new_im, new_buf = next(get_images_gen) assert path == "full/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg" - assert orig_im == new_im + assert orig_im.copy() == new_im assert buf.getvalue() == new_buf.getvalue() - thumb_path, thumb_img, thumb_buf = next(get_images_gen) + thumb_path, _, thumb_buf = next(get_images_gen) assert thumb_path == "thumbs/small/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg" assert orig_thumb_buf.getvalue() == thumb_buf.getvalue() + def test_get_transposed_images(self): + orig_im = Image.new("RGB", (2, 2), (0, 0, 0)) + orig_im.putpixel((1, 1), (255, 0, 0)) + exif = orig_im.getexif() + exif[274] = 3 + buf = io.BytesIO() + orig_im.save(buf, "PNG", exif=exif) + buf.seek(0) + + resp = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf.getvalue()) + req = Request(url="https://dev.mydeco.com/mydeco.gif") + + get_images_gen = self.pipeline.get_images( + response=resp, request=req, info=object() + ) + + path, new_im, _ = next(get_images_gen) + assert path == "full/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg" + assert new_im.getpixel((0, 0)) == (255, 0, 0) + def test_convert_image(self): SIZE = (100, 100) # straight forward case: RGB and JPEG @@ -209,6 +230,26 @@ class TestImagesPipeline: assert converted.mode == "RGB" assert converted.getcolors() == [(10000, (205, 230, 255))] + @pytest.mark.parametrize( + "bad_type", + [ + "http://example.com/file.jpg", + ("http://example.com/file.jpg",), + {"url": "http://example.com/file.jpg"}, + 123, + None, + ], + ) + def test_rejects_non_list_image_urls(self, tmp_path, bad_type): + pipeline = ImagesPipeline.from_crawler( + get_crawler(None, {"IMAGES_STORE": str(tmp_path)}) + ) + item = ImagesPipelineTestItem() + item["image_urls"] = bad_type + + with pytest.raises(TypeError, match="image_urls must be a list of URLs"): + list(pipeline.get_media_requests(item, None)) + class TestImagesPipelineFieldsMixin(ABC): @property @@ -274,11 +315,11 @@ class TestImagesPipelineFieldsItem(TestImagesPipelineFieldsMixin): class ImagesPipelineTestDataClass: name: str # default fields - image_urls: list = dataclasses.field(default_factory=list) - images: list = dataclasses.field(default_factory=list) + image_urls: list[str] = dataclasses.field(default_factory=list) + images: list[dict[str, str]] = dataclasses.field(default_factory=list) # overridden fields - custom_image_urls: list = dataclasses.field(default_factory=list) - custom_images: list = dataclasses.field(default_factory=list) + custom_image_urls: list[str] = dataclasses.field(default_factory=list) + custom_images: list[dict[str, str]] = dataclasses.field(default_factory=list) class TestImagesPipelineFieldsDataClass(TestImagesPipelineFieldsMixin): @@ -395,7 +436,7 @@ class TestImagesPipelineCustomSettings: pipeline = pipeline_cls.from_crawler( get_crawler(None, {"IMAGES_STORE": tmp_path}) ) - for pipe_attr, settings_attr in self.img_cls_attribute_names: + for pipe_attr, _ in self.img_cls_attribute_names: # Instance attribute (lowercase) must be equal to class attribute (uppercase). attr_value = getattr(pipeline, pipe_attr.lower()) assert attr_value != self.default_pipeline_settings[pipe_attr] @@ -429,7 +470,7 @@ class TestImagesPipelineCustomSettings: user_pipeline = UserDefinedImagePipeline.from_crawler( get_crawler(None, {"IMAGES_STORE": tmp_path}) ) - for pipe_attr, settings_attr in self.img_cls_attribute_names: + for pipe_attr, _ in self.img_cls_attribute_names: # Values from settings for custom pipeline should be set on pipeline instance. custom_value = self.default_pipeline_settings.get(pipe_attr.upper()) assert getattr(user_pipeline, pipe_attr.lower()) == custom_value @@ -501,9 +542,47 @@ class TestImagesPipelineCustomSettings: expected_value = settings.get(settings_attr) assert getattr(pipeline_cls, pipe_attr.lower()) == expected_value + def test_images_store_s3_acl_setting_used(self, tmp_path): + old_policy = S3FilesStore.POLICY -def _create_image(format, *a, **kw): + try: + crawler = get_crawler( + None, + { + "IMAGES_STORE": tmp_path, + "IMAGES_STORE_S3_ACL": "public-read", + "FILES_STORE_S3_ACL": "private", + }, + ) + + ImagesPipeline.from_crawler(crawler) + + assert S3FilesStore.POLICY == "public-read" + finally: + S3FilesStore.POLICY = old_policy + + def test_images_store_gcs_acl_setting_used(self, tmp_path): + old_policy = GCSFilesStore.POLICY + + try: + crawler = get_crawler( + None, + { + "IMAGES_STORE": tmp_path, + "IMAGES_STORE_GCS_ACL": "authenticatedRead", + "FILES_STORE_GCS_ACL": "", + }, + ) + + ImagesPipeline.from_crawler(crawler) + + assert GCSFilesStore.POLICY == "authenticatedRead" + finally: + GCSFilesStore.POLICY = old_policy + + +def _create_image(format_, *a, **kw): buf = io.BytesIO() - Image.new(*a, **kw).save(buf, format) + Image.new(*a, **kw).save(buf, format_) buf.seek(0) return Image.open(buf), buf diff --git a/tests/test_pipeline_media.py b/tests/test_pipeline_media.py index 40149f184..8ac949da7 100644 --- a/tests/test_pipeline_media.py +++ b/tests/test_pipeline_media.py @@ -1,28 +1,33 @@ from __future__ import annotations -import warnings +from unittest.mock import MagicMock import pytest from testfixtures import LogCapture -from twisted.internet.defer import Deferred, inlineCallbacks from twisted.python.failure import Failure -from twisted.trial import unittest from scrapy import signals +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request, Response from scrapy.http.request import NO_CALLBACK from scrapy.pipelines.files import FileException from scrapy.pipelines.media import MediaPipeline -from scrapy.spiders import Spider +from scrapy.utils.defer import _defer_sleep_async from scrapy.utils.log import failure_to_exc_info from scrapy.utils.signal import disconnect_all +from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler +from tests.utils.decorators import coroutine_test -def _mocked_download_func(request, info): +async def _mocked_download_func(request): assert request.callback is NO_CALLBACK response = request.meta.get("response") - return response() if callable(response) else response + if callable(response): + response = await response() + if isinstance(response, Exception): + raise response + return response class UserDefinedPipeline(MediaPipeline): @@ -36,27 +41,26 @@ class UserDefinedPipeline(MediaPipeline): return {} def media_failed(self, failure, request, info): - return failure + failure.raiseException() def file_path(self, request, response=None, info=None, *, item=None): return "" -class TestBaseMediaPipeline(unittest.TestCase): +class TestBaseMediaPipeline: pipeline_class = UserDefinedPipeline settings = None - def setUp(self): - spider_cls = Spider - self.spider = spider_cls("media.com") - crawler = get_crawler(spider_cls, self.settings) + def setup_method(self): + crawler = get_crawler(DefaultSpider, self.settings) + crawler.spider = crawler._create_spider() + crawler.engine = MagicMock(download_async=_mocked_download_func) self.pipe = self.pipeline_class.from_crawler(crawler) - self.pipe.download_func = _mocked_download_func - self.pipe.open_spider(self.spider) + self.pipe.open_spider() self.info = self.pipe.spiderinfo self.fingerprint = crawler.request_fingerprinter.fingerprint - def tearDown(self): + def teardown_method(self): for name, signal in vars(signals).items(): if not name.startswith("_"): disconnect_all(signal) @@ -158,10 +162,10 @@ class TestBaseMediaPipeline(unittest.TestCase): assert new_item is item assert len(log.records) == 0 - @inlineCallbacks - def test_default_process_item(self): + @coroutine_test + async def test_default_process_item(self): item = {"name": "name"} - new_item = yield self.pipe.process_item(item, self.spider) + new_item = await self.pipe.process_item(item) assert new_item is item @@ -170,10 +174,6 @@ class MockedMediaPipeline(UserDefinedPipeline): super().__init__(*args, crawler=crawler, **kwargs) self._mockcalled = [] - def download(self, request, info): - self._mockcalled.append("download") - return super().download(request, info) - def media_to_download(self, request, info, *, item=None): self._mockcalled.append("media_to_download") if "result" in request.meta: @@ -199,6 +199,11 @@ class MockedMediaPipeline(UserDefinedPipeline): return item +class AsyncMediaDownloadedPipeline(MockedMediaPipeline): + async def media_downloaded(self, response, request, info, *, item=None): + return super().media_downloaded(response, request, info) + + class TestMediaPipeline(TestBaseMediaPipeline): pipeline_class = MockedMediaPipeline @@ -206,8 +211,8 @@ class TestMediaPipeline(TestBaseMediaPipeline): self.pipe._mockcalled.append("request_errback") return result - @inlineCallbacks - def test_result_succeed(self): + @coroutine_test + async def test_result_succeed(self): rsp = Response("http://url1") req = Request( "http://url1", @@ -215,7 +220,7 @@ class TestMediaPipeline(TestBaseMediaPipeline): errback=self._errback, ) item = {"requests": req} - new_item = yield self.pipe.process_item(item, self.spider) + new_item = await self.pipe.process_item(item) assert new_item["results"] == [(True, {})] assert self.pipe._mockcalled == [ "get_media_requests", @@ -224,18 +229,21 @@ class TestMediaPipeline(TestBaseMediaPipeline): "item_completed", ] - @inlineCallbacks - def test_result_failure(self): + @coroutine_test + async def test_result_failure(self): self.pipe.LOG_FAILED_RESULTS = False - fail = Failure(Exception()) + exc = Exception("foo") req = Request( "http://url1", - meta={"response": fail}, + meta={"response": exc}, errback=self._errback, ) item = {"requests": req} - new_item = yield self.pipe.process_item(item, self.spider) - assert new_item["results"] == [(False, fail)] + new_item = await self.pipe.process_item(item) + assert len(new_item["results"]) == 1 + assert new_item["results"][0][0] is False + assert isinstance(new_item["results"][0][1], Failure) + assert new_item["results"][0][1].value == exc assert self.pipe._mockcalled == [ "get_media_requests", "media_to_download", @@ -244,16 +252,20 @@ class TestMediaPipeline(TestBaseMediaPipeline): "item_completed", ] - @inlineCallbacks - def test_mix_of_success_and_failure(self): + @coroutine_test + async def test_mix_of_success_and_failure(self): self.pipe.LOG_FAILED_RESULTS = False rsp1 = Response("http://url1") req1 = Request("http://url1", meta={"response": rsp1}) - fail = Failure(Exception()) - req2 = Request("http://url2", meta={"response": fail}) + exc = Exception("foo") + req2 = Request("http://url2", meta={"response": exc}) item = {"requests": [req1, req2]} - new_item = yield self.pipe.process_item(item, self.spider) - assert new_item["results"] == [(True, {}), (False, fail)] + new_item = await self.pipe.process_item(item) + assert len(new_item["results"]) == 2 + assert new_item["results"][0] == (True, {}) + assert new_item["results"][1][0] is False + assert isinstance(new_item["results"][1][1], Failure) + assert new_item["results"][1][1].value == exc m = self.pipe._mockcalled # only once assert m[0] == "get_media_requests" # first hook called @@ -266,12 +278,12 @@ class TestMediaPipeline(TestBaseMediaPipeline): assert m.count("media_downloaded") == 1 assert m.count("media_failed") == 1 - @inlineCallbacks - def test_get_media_requests(self): + @coroutine_test + async def test_get_media_requests(self): # returns single Request (without callback) req = Request("http://url") item = {"requests": req} # pass a single item - new_item = yield self.pipe.process_item(item, self.spider) + new_item = await self.pipe.process_item(item) assert new_item is item assert self.fingerprint(req) in self.info.downloaded @@ -279,17 +291,17 @@ class TestMediaPipeline(TestBaseMediaPipeline): req1 = Request("http://url1") req2 = Request("http://url2") item = {"requests": iter([req1, req2])} - new_item = yield self.pipe.process_item(item, self.spider) + new_item = await self.pipe.process_item(item) assert new_item is item assert self.fingerprint(req1) in self.info.downloaded assert self.fingerprint(req2) in self.info.downloaded - @inlineCallbacks - def test_results_are_cached_across_multiple_items(self): + @coroutine_test + async def test_results_are_cached_across_multiple_items(self): rsp1 = Response("http://url1") req1 = Request("http://url1", meta={"response": rsp1}) item = {"requests": req1} - new_item = yield self.pipe.process_item(item, self.spider) + new_item = await self.pipe.process_item(item) assert new_item is item assert new_item["results"] == [(True, {})] @@ -298,25 +310,25 @@ class TestMediaPipeline(TestBaseMediaPipeline): req1.url, meta={"response": Response("http://donot.download.me")} ) item = {"requests": req2} - new_item = yield self.pipe.process_item(item, self.spider) + new_item = await self.pipe.process_item(item) assert new_item is item assert self.fingerprint(req1) == self.fingerprint(req2) assert new_item["results"] == [(True, {})] - @inlineCallbacks - def test_results_are_cached_for_requests_of_single_item(self): + @coroutine_test + async def test_results_are_cached_for_requests_of_single_item(self): rsp1 = Response("http://url1") req1 = Request("http://url1", meta={"response": rsp1}) req2 = Request( req1.url, meta={"response": Response("http://donot.download.me")} ) item = {"requests": [req1, req2]} - new_item = yield self.pipe.process_item(item, self.spider) + new_item = await self.pipe.process_item(item) assert new_item is item assert new_item["results"] == [(True, {}), (True, {})] - @inlineCallbacks - def test_wait_if_request_is_downloading(self): + @coroutine_test + async def test_wait_if_request_is_downloading(self): def _check_downloading(response): fp = self.fingerprint(req1) assert fp in self.info.downloading @@ -327,27 +339,24 @@ class TestMediaPipeline(TestBaseMediaPipeline): rsp1 = Response("http://url") - def rsp1_func(): - from twisted.internet import reactor + async def rsp1_func(): + await _defer_sleep_async() + _check_downloading(rsp1) - dfd = Deferred().addCallback(_check_downloading) - reactor.callLater(0.1, dfd.callback, rsp1) - return dfd - - def rsp2_func(): + async def rsp2_func(): pytest.fail("it must cache rsp1 result and must not try to redownload") req1 = Request("http://url", meta={"response": rsp1_func}) req2 = Request(req1.url, meta={"response": rsp2_func}) item = {"requests": [req1, req2]} - new_item = yield self.pipe.process_item(item, self.spider) + new_item = await self.pipe.process_item(item) assert new_item["results"] == [(True, {}), (True, {})] - @inlineCallbacks - def test_use_media_to_download_result(self): + @coroutine_test + async def test_use_media_to_download_result(self): req = Request("http://url", meta={"result": "ITSME"}) item = {"requests": req} - new_item = yield self.pipe.process_item(item, self.spider) + new_item = await self.pipe.process_item(item) assert new_item["results"] == [(True, "ITSME")] assert self.pipe._mockcalled == [ "get_media_requests", @@ -362,6 +371,16 @@ class TestMediaPipeline(TestBaseMediaPipeline): ) +class TestAsyncMediaDownloaded(TestMediaPipeline): + pipeline_class = AsyncMediaDownloadedPipeline + + def test_key_for_pipe(self): + assert ( + self.pipe._key_for_pipe("IMAGES", base_class_name="MediaPipeline") + == "ASYNCMEDIADOWNLOADEDPIPELINE_IMAGES" + ) + + class TestMediaPipelineAllowRedirectSettings: def _assert_request_no3xx(self, pipeline_class, settings): pipe = pipeline_class(crawler=get_crawler(None, settings)) @@ -405,89 +424,9 @@ class TestBuildFromCrawler: class Pipeline(UserDefinedPipeline): pass - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 0 - - def test_has_old_init(self): - class Pipeline(UserDefinedPipeline): - def __init__(self): - super().__init__() - self._init_called = True - - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 2 - assert pipe._init_called - - def test_has_from_settings(self): - class Pipeline(UserDefinedPipeline): - _from_settings_called = False - - @classmethod - def from_settings(cls, settings): - o = cls() - o._from_settings_called = True - return o - - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 2 - assert pipe._from_settings_called - - def test_has_from_settings_and_from_crawler(self): - class Pipeline(UserDefinedPipeline): - _from_settings_called = False - _from_crawler_called = False - - @classmethod - def from_settings(cls, settings): - o = cls() - o._from_settings_called = True - return o - - @classmethod - def from_crawler(cls, crawler): - o = super().from_crawler(crawler) - o._from_crawler_called = True - return o - - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 2 - assert pipe._from_settings_called - assert pipe._from_crawler_called - - def test_has_from_settings_and_init(self): - class Pipeline(UserDefinedPipeline): - _from_settings_called = False - - def __init__(self, store_uri, settings): - super().__init__() - self._init_called = True - - @classmethod - def from_settings(cls, settings): - store_uri = settings["FILES_STORE"] - o = cls(store_uri, settings=settings) - o._from_settings_called = True - return o - - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 2 - assert pipe._from_settings_called - assert pipe._init_called + pipe = Pipeline.from_crawler(self.crawler) + assert pipe.crawler == self.crawler + assert pipe._fingerprinter def test_has_from_crawler_and_init(self): class Pipeline(UserDefinedPipeline): @@ -505,13 +444,11 @@ class TestBuildFromCrawler: o._from_crawler_called = True return o - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 0 - assert pipe._from_crawler_called - assert pipe._init_called + pipe = Pipeline.from_crawler(self.crawler) + assert pipe.crawler == self.crawler + assert pipe._fingerprinter + assert pipe._from_crawler_called + assert pipe._init_called def test_has_from_crawler(self): class Pipeline(UserDefinedPipeline): @@ -525,10 +462,49 @@ class TestBuildFromCrawler: o.store_uri = settings["FILES_STORE"] return o - with warnings.catch_warnings(record=True) as w: - pipe = Pipeline.from_crawler(self.crawler) - # this and the next assert will fail as MediaPipeline.from_crawler() wasn't called - assert pipe.crawler == self.crawler - assert pipe._fingerprinter - assert len(w) == 0 - assert pipe._from_crawler_called + pipe = Pipeline.from_crawler(self.crawler) + assert pipe.crawler == self.crawler + assert pipe._fingerprinter + assert pipe._from_crawler_called + + +class MediaFailedFailurePipeline(MockedMediaPipeline): + def media_failed(self, failure, request, info): + self._mockcalled.append("media_failed") + return failure # deprecated + + +class TestMediaFailedFailure(TestBaseMediaPipeline): + """Test that media_failed() can return a failure instead of raising.""" + + pipeline_class = MediaFailedFailurePipeline + + def _errback(self, result): + self.pipe._mockcalled.append("request_errback") + return result + + @coroutine_test + async def test_result_failure(self): + self.pipe.LOG_FAILED_RESULTS = False + exc = Exception("foo") + req = Request( + "http://url1", + meta={"response": exc}, + errback=self._errback, + ) + item = {"requests": req} + with pytest.warns( + ScrapyDeprecationWarning, match="media_failed returned a Failure instance" + ): + new_item = await self.pipe.process_item(item) + assert len(new_item["results"]) == 1 + assert new_item["results"][0][0] is False + assert isinstance(new_item["results"][0][1], Failure) + assert new_item["results"][0][1].value == exc + assert self.pipe._mockcalled == [ + "get_media_requests", + "media_to_download", + "media_failed", + "request_errback", + "item_completed", + ] diff --git a/tests/test_pipelines.py b/tests/test_pipelines.py index ea85877bf..e65b5bc32 100644 --- a/tests/test_pipelines.py +++ b/tests/test_pipelines.py @@ -1,16 +1,35 @@ import asyncio +from typing import Any import pytest -from twisted.internet.defer import Deferred, inlineCallbacks -from twisted.trial import unittest +from twisted.internet.defer import Deferred, fail, succeed from scrapy import Request, Spider, signals +from scrapy.crawler import Crawler +from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.pipelines import ItemPipelineManager +from scrapy.utils.asyncio import call_later +from scrapy.utils.conf import build_component_list from scrapy.utils.defer import deferred_to_future, maybe_deferred_to_future +from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler, get_from_asyncio_queue -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer +from tests.utils.decorators import coroutine_test class SimplePipeline: + def process_item(self, item): + item["pipeline_passed"] = True + return item + + +class DeprecatedSpiderArgPipeline: + def open_spider(self, spider): + pass + + def close_spider(self, spider): + pass + def process_item(self, item, spider): item["pipeline_passed"] = True return item @@ -21,7 +40,13 @@ class DeferredPipeline: item["pipeline_passed"] = True return item - def process_item(self, item, spider): + def open_spider(self): + return succeed(None) + + def close_spider(self): + return succeed(None) + + def process_item(self, item): d = Deferred() d.addCallback(self.cb) d.callback(item) @@ -29,22 +54,19 @@ class DeferredPipeline: class AsyncDefPipeline: - async def process_item(self, item, spider): + async def process_item(self, item): d = Deferred() - from twisted.internet import reactor - - reactor.callLater(0, d.callback, None) + call_later(0, d.callback, None) await maybe_deferred_to_future(d) item["pipeline_passed"] = True return item class AsyncDefAsyncioPipeline: - async def process_item(self, item, spider): + async def process_item(self, item): d = Deferred() - from twisted.internet import reactor - - reactor.callLater(0, d.callback, None) + loop = asyncio.get_event_loop() + loop.call_later(0, d.callback, None) await deferred_to_future(d) await asyncio.sleep(0.2) item["pipeline_passed"] = await get_from_asyncio_queue(True) @@ -52,7 +74,7 @@ class AsyncDefAsyncioPipeline: class AsyncDefNotAsyncioPipeline: - async def process_item(self, item, spider): + async def process_item(self, item): d1 = Deferred() from twisted.internet import reactor @@ -65,6 +87,36 @@ class AsyncDefNotAsyncioPipeline: return item +class ProcessItemExceptionPipeline: + def process_item(self, item): + raise ValueError("process_item error") + + +class ProcessItemExceptionDeferredPipeline: + def process_item(self, item): + return fail(ValueError("process_item error")) + + +class ProcessItemExceptionAsyncPipeline: + async def process_item(self, item): + raise ValueError("process_item error") + + +class OpenSpiderExceptionPipeline: + def open_spider(self): + raise ValueError("open_spider error") + + +class OpenSpiderExceptionDeferredPipeline: + def open_spider(self): + return fail(ValueError("open_spider error")) + + +class OpenSpiderExceptionAsyncPipeline: + async def open_spider(self): + raise ValueError("open_spider error") + + class ItemSpider(Spider): name = "itemspider" @@ -75,58 +127,427 @@ class ItemSpider(Spider): return {"field": 42} -class TestPipeline(unittest.TestCase): - @classmethod - def setUpClass(cls): - cls.mockserver = MockServer() - cls.mockserver.__enter__() - - @classmethod - def tearDownClass(cls): - cls.mockserver.__exit__(None, None, None) - +class TestPipeline: def _on_item_scraped(self, item): assert isinstance(item, dict) assert item.get("pipeline_passed") self.items.append(item) - def _create_crawler(self, pipeline_class): + def _create_crawler(self, pipeline_class: type) -> Crawler: settings = { "ITEM_PIPELINES": {pipeline_class: 1}, } crawler = get_crawler(ItemSpider, settings) crawler.signals.connect(self._on_item_scraped, signals.item_scraped) - self.items = [] + self.items: list[Any] = [] return crawler - @inlineCallbacks - def test_simple_pipeline(self): - crawler = self._create_crawler(SimplePipeline) - yield crawler.crawl(mockserver=self.mockserver) + @pytest.mark.parametrize( + "pipeline_class", + [ + SimplePipeline, + AsyncDefPipeline, + pytest.param(AsyncDefAsyncioPipeline, marks=pytest.mark.only_asyncio), + pytest.param( + AsyncDefNotAsyncioPipeline, marks=pytest.mark.only_not_asyncio + ), + ], + ) + @coroutine_test + async def test_pipeline(self, mockserver: MockServer, pipeline_class: type) -> None: + crawler = self._create_crawler(pipeline_class) + await crawler.crawl_async(mockserver=mockserver) assert len(self.items) == 1 - @inlineCallbacks - def test_deferred_pipeline(self): + @coroutine_test + async def test_pipeline_deferred(self, mockserver: MockServer) -> None: crawler = self._create_crawler(DeferredPipeline) - yield crawler.crawl(mockserver=self.mockserver) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match="DeferredPipeline.open_spider returned a Deferred", + ), + pytest.warns( + ScrapyDeprecationWarning, + match="DeferredPipeline.close_spider returned a Deferred", + ), + pytest.warns( + ScrapyDeprecationWarning, + match="DeferredPipeline.process_item returned a Deferred", + ), + ): + await crawler.crawl_async(mockserver=mockserver) assert len(self.items) == 1 - @inlineCallbacks - def test_asyncdef_pipeline(self): - crawler = self._create_crawler(AsyncDefPipeline) - yield crawler.crawl(mockserver=self.mockserver) + @coroutine_test + async def test_deprecated_spider_arg(self, mockserver: MockServer) -> None: + crawler = self._create_crawler(DeprecatedSpiderArgPipeline) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"DeprecatedSpiderArgPipeline.open_spider\(\) requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"DeprecatedSpiderArgPipeline.close_spider\(\) requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"DeprecatedSpiderArgPipeline.process_item\(\) requires a spider argument", + ), + ): + await crawler.crawl_async(mockserver=mockserver) + assert len(self.items) == 1 - @pytest.mark.only_asyncio - @inlineCallbacks - def test_asyncdef_asyncio_pipeline(self): - crawler = self._create_crawler(AsyncDefAsyncioPipeline) - yield crawler.crawl(mockserver=self.mockserver) - assert len(self.items) == 1 + @pytest.mark.parametrize( + "pipeline_class", + [ + ProcessItemExceptionPipeline, + pytest.param( + ProcessItemExceptionDeferredPipeline, + marks=pytest.mark.filterwarnings( + "ignore::scrapy.exceptions.ScrapyDeprecationWarning" + ), + ), + ProcessItemExceptionAsyncPipeline, + ], + ) + @coroutine_test + async def test_process_item_exception( + self, + caplog: pytest.LogCaptureFixture, + mockserver: MockServer, + pipeline_class: type, + ) -> None: + crawler = self._create_crawler(pipeline_class) + await crawler.crawl_async(mockserver=mockserver) + assert "Error processing {'field': 42}" in caplog.text + assert "process_item error" in caplog.text - @pytest.mark.only_not_asyncio - @inlineCallbacks - def test_asyncdef_not_asyncio_pipeline(self): - crawler = self._create_crawler(AsyncDefNotAsyncioPipeline) - yield crawler.crawl(mockserver=self.mockserver) - assert len(self.items) == 1 + @pytest.mark.parametrize( + "pipeline_class", + [ + OpenSpiderExceptionPipeline, + pytest.param( + OpenSpiderExceptionDeferredPipeline, + marks=pytest.mark.filterwarnings( + "ignore::scrapy.exceptions.ScrapyDeprecationWarning" + ), + ), + OpenSpiderExceptionAsyncPipeline, + ], + ) + @coroutine_test + async def test_open_spider_exception( + self, mockserver: MockServer, pipeline_class: type + ) -> None: + crawler = self._create_crawler(pipeline_class) + with pytest.raises(ValueError, match="open_spider error"): + await crawler.crawl_async(mockserver=mockserver) + + +class TestCustomPipelineManager: + @coroutine_test + async def test_deprecated_process_item_spider_arg(self) -> None: + class CustomPipelineManager(ItemPipelineManager): + def process_item(self, item: Any, spider: Spider) -> Deferred[Any]: # pylint: disable=useless-parent-delegation + return super().process_item(item, spider) + + crawler = get_crawler(DefaultSpider) + crawler.spider = crawler._create_spider() + itemproc = CustomPipelineManager.from_crawler(crawler) + with pytest.warns( + ScrapyDeprecationWarning, + match=r"CustomPipelineManager.process_item\(\) is deprecated, use process_item_async\(\)", + ): + itemproc.process_item({}, crawler.spider) + + @coroutine_test + async def test_integration_recommended(self, mockserver: MockServer) -> None: + class CustomPipelineManager(ItemPipelineManager): + async def process_item_async(self, item): + return await super().process_item_async(item) + + items = [] + + def _on_item_scraped(item): + assert isinstance(item, dict) + assert item.get("pipeline_passed") + items.append(item) + + crawler = get_crawler( + ItemSpider, + { + "ITEM_PROCESSOR": CustomPipelineManager, + "ITEM_PIPELINES": {SimplePipeline: 1}, + }, + ) + crawler.spider = crawler._create_spider() + crawler.signals.connect(_on_item_scraped, signals.item_scraped) + await crawler.crawl_async(mockserver=mockserver) + + assert len(items) == 1 + + @coroutine_test + async def test_integration_no_async_subclass(self, mockserver: MockServer) -> None: + class CustomPipelineManager(ItemPipelineManager): + def open_spider(self, spider): + with pytest.warns( + ScrapyDeprecationWarning, + match=r"CustomPipelineManager.open_spider\(\) is deprecated, use open_spider_async\(\)", + ): + return super().open_spider(spider) + + def close_spider(self, spider): + with pytest.warns( + ScrapyDeprecationWarning, + match=r"CustomPipelineManager.close_spider\(\) is deprecated, use close_spider_async\(\)", + ): + return super().close_spider(spider) + + def process_item(self, item, spider): + with pytest.warns( + ScrapyDeprecationWarning, + match=r"CustomPipelineManager.process_item\(\) is deprecated, use process_item_async\(\)", + ): + return super().process_item(item, spider) + + items = [] + + def _on_item_scraped(item): + assert isinstance(item, dict) + assert item.get("pipeline_passed") + items.append(item) + + crawler = get_crawler( + ItemSpider, + { + "ITEM_PROCESSOR": CustomPipelineManager, + "ITEM_PIPELINES": {SimplePipeline: 1}, + }, + ) + crawler.spider = crawler._create_spider() + crawler.signals.connect(_on_item_scraped, signals.item_scraped) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"CustomPipelineManager overrides open_spider\(\) but doesn't override open_spider_async\(\)", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"CustomPipelineManager overrides close_spider\(\) but doesn't override close_spider_async\(\)", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"CustomPipelineManager overrides process_item\(\) but doesn't override process_item_async\(\)", + ), + ): + await crawler.crawl_async(mockserver=mockserver) + + assert len(items) == 1 + + @coroutine_test + async def test_integration_no_async_not_subclass( + self, mockserver: MockServer + ) -> None: + class CustomPipelineManager: + def __init__(self, crawler): + self.pipelines = [ + p() + for p in build_component_list( + crawler.settings.getwithbase("ITEM_PIPELINES") + ) + ] + + @classmethod + def from_crawler(cls, crawler): + return cls(crawler) + + def open_spider(self, spider): + return succeed(None) + + def close_spider(self, spider): + return succeed(None) + + def process_item(self, item, spider): + for pipeline in self.pipelines: + item = pipeline.process_item(item) + return succeed(item) + + items = [] + + def _on_item_scraped(item): + assert isinstance(item, dict) + assert item.get("pipeline_passed") + items.append(item) + + crawler = get_crawler( + ItemSpider, + { + "ITEM_PROCESSOR": CustomPipelineManager, + "ITEM_PIPELINES": {SimplePipeline: 1}, + }, + ) + crawler.spider = crawler._create_spider() + crawler.signals.connect(_on_item_scraped, signals.item_scraped) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"CustomPipelineManager doesn't define a open_spider_async\(\) method", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"CustomPipelineManager doesn't define a close_spider_async\(\) method", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"CustomPipelineManager doesn't define a process_item_async\(\) method", + ), + ): + await crawler.crawl_async(mockserver=mockserver) + + assert len(items) == 1 + + +class TestMiddlewareManagerSpider: + """Tests for the deprecated spider arg handling in MiddlewareManager. + + Here because MiddlewareManager doesn't have methods that could take a spider arg.""" + + @pytest.fixture + def crawler(self) -> Crawler: + return get_crawler(Spider) + + @coroutine_test + async def test_deprecated_spider_arg_no_crawler_spider( + self, crawler: Crawler + ) -> None: + """Crawler is provided, but doesn't have a spider, the methods raise an exception. + The instance passed to a deprecated method is ignored.""" + mwman = ItemPipelineManager(crawler=crawler) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"DeprecatedSpiderArgPipeline.open_spider\(\) requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"DeprecatedSpiderArgPipeline.close_spider\(\) requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"DeprecatedSpiderArgPipeline.process_item\(\) requires a spider argument", + ), + ): + mwman._add_middleware(DeprecatedSpiderArgPipeline()) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"ItemPipelineManager.open_spider\(\) is deprecated, use open_spider_async\(\) instead", + ), + pytest.raises( + ValueError, + match=r"ItemPipelineManager needs to access self\.crawler\.spider but it is None", + ), + ): + await maybe_deferred_to_future(mwman.open_spider(DefaultSpider())) + with pytest.raises( + ValueError, + match=r"ItemPipelineManager needs to access self\.crawler\.spider but it is None", + ): + await mwman.open_spider_async() + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"ItemPipelineManager.close_spider\(\) is deprecated, use close_spider_async\(\) instead", + ), + pytest.raises( + ValueError, + match=r"ItemPipelineManager needs to access self\.crawler\.spider but it is None", + ), + ): + await maybe_deferred_to_future(mwman.close_spider(DefaultSpider())) + with pytest.raises( + ValueError, + match=r"ItemPipelineManager needs to access self\.crawler\.spider but it is None", + ): + await mwman.close_spider_async() + + @coroutine_test + async def test_deprecated_spider_arg_with_crawler(self, crawler: Crawler) -> None: + """Crawler is provided and has a spider, works. The instance passed to a deprecated method + is ignored, even if mismatched.""" + mwman = ItemPipelineManager(crawler=crawler) + crawler.spider = crawler._create_spider("foo") + with pytest.warns( + ScrapyDeprecationWarning, + match=r"ItemPipelineManager.open_spider\(\) is deprecated, use open_spider_async\(\) instead", + ): + await maybe_deferred_to_future(mwman.open_spider(DefaultSpider())) + with pytest.warns( + ScrapyDeprecationWarning, + match=r"ItemPipelineManager.close_spider\(\) is deprecated, use close_spider_async\(\) instead", + ): + await maybe_deferred_to_future(mwman.close_spider(DefaultSpider())) + + @coroutine_test + async def test_deprecated_spider_arg_without_crawler(self) -> None: + """The first instance passed to a deprecated method is used. Mismatched ones raise an error.""" + with pytest.warns( + ScrapyDeprecationWarning, + match="was called without the crawler argument", + ): + mwman = ItemPipelineManager() + spider = DefaultSpider() + with pytest.warns( + ScrapyDeprecationWarning, + match=r"ItemPipelineManager.open_spider\(\) is deprecated, use open_spider_async\(\) instead", + ): + await maybe_deferred_to_future(mwman.open_spider(spider)) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"ItemPipelineManager.close_spider\(\) is deprecated, use close_spider_async\(\) instead", + ), + pytest.raises( + RuntimeError, match="Different instances of Spider were passed" + ), + ): + await maybe_deferred_to_future(mwman.close_spider(DefaultSpider())) + with pytest.warns( + ScrapyDeprecationWarning, + match=r"ItemPipelineManager.close_spider\(\) is deprecated, use close_spider_async\(\) instead", + ): + await maybe_deferred_to_future(mwman.close_spider(spider)) + + @coroutine_test + async def test_no_spider_arg_without_crawler(self) -> None: + """If no crawler and no spider arg, raise an error.""" + with pytest.warns( + ScrapyDeprecationWarning, + match="was called without the crawler argument", + ): + mwman = ItemPipelineManager() + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"DeprecatedSpiderArgPipeline.open_spider\(\) requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"DeprecatedSpiderArgPipeline.close_spider\(\) requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"DeprecatedSpiderArgPipeline.process_item\(\) requires a spider argument", + ), + ): + mwman._add_middleware(DeprecatedSpiderArgPipeline()) + with ( + pytest.raises( + ValueError, + match="has no known Spider instance", + ), + ): + await mwman.open_spider_async() diff --git a/tests/test_pqueues.py b/tests/test_pqueues.py index b65f1b7e7..6c6a6584a 100644 --- a/tests/test_pqueues.py +++ b/tests/test_pqueues.py @@ -1,15 +1,17 @@ import tempfile +from unittest.mock import Mock import pytest import queuelib +from scrapy.core.downloader import Downloader from scrapy.http.request import Request from scrapy.pqueues import DownloaderAwarePriorityQueue, ScrapyPriorityQueue from scrapy.spiders import Spider -from scrapy.squeues import FifoMemoryQueue +from scrapy.squeues import FifoMemoryQueue, PickleFifoDiskQueue from scrapy.utils.misc import build_from_crawler, load_object from scrapy.utils.test import get_crawler -from tests.test_scheduler import MockDownloader, MockEngine +from tests.test_scheduler import MockDownloader class TestPriorityQueue: @@ -74,6 +76,29 @@ class TestPriorityQueue: assert queue.pop().url == req3.url assert not queue.close() + def test_init_prios_with_start_queue(self): + temp_dir = tempfile.mkdtemp() + queue = ScrapyPriorityQueue.from_crawler( + self.crawler, + PickleFifoDiskQueue, + temp_dir, + start_queue_cls=PickleFifoDiskQueue, + ) + req = Request("https://example.org/", meta={"is_start_request": True}) + queue.push(req) + startprios = queue.close() + + queue2 = ScrapyPriorityQueue.from_crawler( + self.crawler, + PickleFifoDiskQueue, + temp_dir, + startprios, + start_queue_cls=PickleFifoDiskQueue, + ) + assert len(queue2) == 1 + assert queue2.pop().url == req.url + queue2.close() + def test_queue_push_pop_priorities(self): temp_dir = tempfile.mkdtemp() queue = ScrapyPriorityQueue.from_crawler( @@ -92,13 +117,13 @@ class TestPriorityQueue: assert len(queue) == 2 assert dequeued.url == req3.url assert dequeued.priority == req3.priority - assert queue.close() == [-1, -2] + assert set(queue.close()) == {-1, -2} class TestDownloaderAwarePriorityQueue: def setup_method(self): crawler = get_crawler(Spider) - crawler.engine = MockEngine(downloader=MockDownloader()) + crawler.engine = Mock(downloader=MockDownloader()) self.queue = DownloaderAwarePriorityQueue.from_crawler( crawler=crawler, downstream_queue_cls=FifoMemoryQueue, @@ -157,9 +182,84 @@ class TestDownloaderAwarePriorityQueue: assert self.queue.pop().url == req3.url assert self.queue.peek() is None + def test_tie_breaking_rotates_slots(self): + # No active downloads are tracked in the downloader, so every slot has + # the same score and tie-breaking must not starve a slot. + req_a1 = Request("https://example.org/a1") + req_a1.meta[Downloader.DOWNLOAD_SLOT] = "slot-a" + req_b1 = Request("https://example.org/b1") + req_b1.meta[Downloader.DOWNLOAD_SLOT] = "slot-b" + req_a2 = Request("https://example.org/a2") + req_a2.meta[Downloader.DOWNLOAD_SLOT] = "slot-a" + req_b2 = Request("https://example.org/b2") + req_b2.meta[Downloader.DOWNLOAD_SLOT] = "slot-b" + + for request in (req_a1, req_b1, req_a2, req_b2): + self.queue.push(request) + + slots = [ + self.queue.pop().meta[Downloader.DOWNLOAD_SLOT], + self.queue.pop().meta[Downloader.DOWNLOAD_SLOT], + self.queue.pop().meta[Downloader.DOWNLOAD_SLOT], + self.queue.pop().meta[Downloader.DOWNLOAD_SLOT], + ] + + assert slots == ["slot-a", "slot-b", "slot-a", "slot-b"] + + def test_tie_breaking_keeps_rotation_after_selected_slot_is_deleted(self): + # If the selected slot becomes empty, rotation should continue from + # that slot marker to avoid restarting from the smallest slot. + req_a1 = Request("https://example.org/a1") + req_a1.meta[Downloader.DOWNLOAD_SLOT] = "slot-a" + req_a2 = Request("https://example.org/a2") + req_a2.meta[Downloader.DOWNLOAD_SLOT] = "slot-a" + req_b1 = Request("https://example.org/b1") + req_b1.meta[Downloader.DOWNLOAD_SLOT] = "slot-b" + req_c1 = Request("https://example.org/c1") + req_c1.meta[Downloader.DOWNLOAD_SLOT] = "slot-c" + + for request in (req_a1, req_a2, req_b1, req_c1): + self.queue.push(request) + + slots = [ + self.queue.pop().meta[Downloader.DOWNLOAD_SLOT], + self.queue.pop().meta[Downloader.DOWNLOAD_SLOT], + self.queue.pop().meta[Downloader.DOWNLOAD_SLOT], + self.queue.pop().meta[Downloader.DOWNLOAD_SLOT], + ] + + assert slots == ["slot-a", "slot-b", "slot-c", "slot-a"] + + def test_pop_prefers_slot_with_fewer_active_downloads(self): + downloader = self.queue._downloader_interface.downloader + + req_a = Request("https://example.org/a") + req_a.meta[Downloader.DOWNLOAD_SLOT] = "slot-a" + req_b = Request("https://example.org/b") + req_b.meta[Downloader.DOWNLOAD_SLOT] = "slot-b" + req_c = Request("https://example.org/c") + req_c.meta[Downloader.DOWNLOAD_SLOT] = "slot-c" + + for req in (req_a, req_b, req_c): + self.queue.push(req) + + downloader.increment("slot-a") + downloader.increment("slot-c") + + popped = self.queue.pop() + assert popped.url == req_b.url + + def test_contains(self): + req = Request("https://example.org/") + req.meta[Downloader.DOWNLOAD_SLOT] = "example-slot" + assert "example-slot" not in self.queue + self.queue.push(req) + assert "example-slot" in self.queue + assert "other-slot" not in self.queue + @pytest.mark.parametrize( - ("input", "output"), + ("input_", "output"), [ # By default, start requests are FIFO, other requests are LIFO. ([{}, {}], [2, 1]), @@ -172,7 +272,7 @@ class TestDownloaderAwarePriorityQueue: ([{"start": True}, {}], [2, 1]), ], ) -def test_pop_order(input, output): +def test_pop_order(input_, output): def make_url(index): return f"https://toscrape.com/{index}" @@ -187,7 +287,7 @@ def test_pop_order(input, output): ) input_requests = [ - make_request(index, data) for index, data in enumerate(input, start=1) + make_request(index, data) for index, data in enumerate(input_, start=1) ] expected_output_urls = [make_url(index) for index in output] diff --git a/tests/test_proxy_connect.py b/tests/test_proxy_connect.py deleted file mode 100644 index 801f88b5a..000000000 --- a/tests/test_proxy_connect.py +++ /dev/null @@ -1,125 +0,0 @@ -import json -import os -import re -import sys -from pathlib import Path -from subprocess import PIPE, Popen -from urllib.parse import urlsplit, urlunsplit - -import pytest -from testfixtures import LogCapture -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase - -from scrapy.http import Request -from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer -from tests.spiders import SimpleSpider, SingleRequestSpider - - -class MitmProxy: - auth_user = "scrapy" - auth_pass = "scrapy" - - def start(self): - script = """ -import sys -from mitmproxy.tools.main import mitmdump -sys.argv[0] = "mitmdump" -sys.exit(mitmdump()) - """ - cert_path = Path(__file__).parent.resolve() / "keys" - self.proc = Popen( - [ - sys.executable, - "-u", - "-c", - script, - "--listen-host", - "127.0.0.1", - "--listen-port", - "0", - "--proxyauth", - f"{self.auth_user}:{self.auth_pass}", - "--set", - f"confdir={cert_path}", - "--ssl-insecure", - ], - stdout=PIPE, - ) - line = self.proc.stdout.readline().decode("utf-8") - host_port = re.search(r"listening at (?:http://)?([^:]+:\d+)", line).group(1) - return f"http://{self.auth_user}:{self.auth_pass}@{host_port}" - - def stop(self): - self.proc.kill() - self.proc.communicate() - - -def _wrong_credentials(proxy_url): - bad_auth_proxy = list(urlsplit(proxy_url)) - bad_auth_proxy[1] = bad_auth_proxy[1].replace("scrapy:scrapy@", "wrong:wronger@") - return urlunsplit(bad_auth_proxy) - - -class TestProxyConnect(TestCase): - @classmethod - def setUpClass(cls): - cls.mockserver = MockServer() - cls.mockserver.__enter__() - - @classmethod - def tearDownClass(cls): - cls.mockserver.__exit__(None, None, None) - - def setUp(self): - try: - import mitmproxy # noqa: F401 - except ImportError: - pytest.skip("mitmproxy is not installed") - - self._oldenv = os.environ.copy() - - self._proxy = MitmProxy() - proxy_url = self._proxy.start() - os.environ["https_proxy"] = proxy_url - os.environ["http_proxy"] = proxy_url - - def tearDown(self): - self._proxy.stop() - os.environ = self._oldenv - - @inlineCallbacks - def test_https_connect_tunnel(self): - crawler = get_crawler(SimpleSpider) - with LogCapture() as log: - yield crawler.crawl(self.mockserver.url("/status?n=200", is_secure=True)) - self._assert_got_response_code(200, log) - - @inlineCallbacks - def test_https_tunnel_auth_error(self): - os.environ["https_proxy"] = _wrong_credentials(os.environ["https_proxy"]) - crawler = get_crawler(SimpleSpider) - with LogCapture() as log: - yield crawler.crawl(self.mockserver.url("/status?n=200", is_secure=True)) - # The proxy returns a 407 error code but it does not reach the client; - # he just sees a TunnelError. - self._assert_got_tunnel_error(log) - - @inlineCallbacks - def test_https_tunnel_without_leak_proxy_authorization_header(self): - request = Request(self.mockserver.url("/echo", is_secure=True)) - crawler = get_crawler(SingleRequestSpider) - with LogCapture() as log: - yield crawler.crawl(seed=request) - self._assert_got_response_code(200, log) - echo = json.loads(crawler.spider.meta["responses"][0].text) - assert "Proxy-Authorization" not in echo["headers"] - - def _assert_got_response_code(self, code, log): - print(log) - assert str(log).count(f"Crawled ({code})") == 1 - - def _assert_got_tunnel_error(self, log): - print(log) - assert "TunnelError" in str(log) diff --git a/tests/test_request_attribute_binding.py b/tests/test_request_attribute_binding.py index 9318ee87e..38d56e9bd 100644 --- a/tests/test_request_attribute_binding.py +++ b/tests/test_request_attribute_binding.py @@ -1,29 +1,28 @@ from testfixtures import LogCapture -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase from scrapy import Request, signals from scrapy.http.response import Response from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer from tests.spiders import SingleRequestSpider +from tests.utils.decorators import inline_callbacks_test OVERRIDDEN_URL = "https://example.org" class ProcessResponseMiddleware: - def process_response(self, request, response, spider): + def process_response(self, request, response): return response.replace(request=Request(OVERRIDDEN_URL)) class RaiseExceptionRequestMiddleware: - def process_request(self, request, spider): + def process_request(self, request): 1 / 0 return request class CatchExceptionOverrideRequestMiddleware: - def process_exception(self, request, exception, spider): + def process_exception(self, request, exception): return Response( url="http://localhost/", body=b"Caught " + exception.__class__.__name__.encode("utf-8"), @@ -32,7 +31,7 @@ class CatchExceptionOverrideRequestMiddleware: class CatchExceptionDoNotOverrideRequestMiddleware: - def process_exception(self, request, exception, spider): + def process_exception(self, request, exception): return Response( url="http://localhost/", body=b"Caught " + exception.__class__.__name__.encode("utf-8"), @@ -47,26 +46,33 @@ class AlternativeCallbacksSpider(SingleRequestSpider): class AlternativeCallbacksMiddleware: - def process_response(self, request, response, spider): + def __init__(self, crawler): + self.crawler = crawler + + @classmethod + def from_crawler(cls, crawler): + return cls(crawler) + + def process_response(self, request, response): new_request = request.replace( url=OVERRIDDEN_URL, - callback=spider.alt_callback, + callback=self.crawler.spider.alt_callback, cb_kwargs={"foo": "bar"}, ) return response.replace(request=new_request) -class TestCrawl(TestCase): +class TestCrawl: @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) - @inlineCallbacks + @inline_callbacks_test def test_response_200(self): url = self.mockserver.url("/status?n=200") crawler = get_crawler(SingleRequestSpider) @@ -74,7 +80,7 @@ class TestCrawl(TestCase): response = crawler.spider.meta["responses"][0] assert response.request.url == url - @inlineCallbacks + @inline_callbacks_test def test_response_error(self): for status in ("404", "500"): url = self.mockserver.url(f"/status?n={status}") @@ -85,7 +91,7 @@ class TestCrawl(TestCase): assert failure.request.url == url assert response.request.url == url - @inlineCallbacks + @inline_callbacks_test def test_downloader_middleware_raise_exception(self): url = self.mockserver.url("/status?n=200") crawler = get_crawler( @@ -101,7 +107,7 @@ class TestCrawl(TestCase): assert failure.request.url == url assert isinstance(failure.value, ZeroDivisionError) - @inlineCallbacks + @inline_callbacks_test def test_downloader_middleware_override_request_in_process_response(self): """ Downloader middleware which returns a response with an specific 'request' attribute. @@ -144,7 +150,7 @@ class TestCrawl(TestCase): ), ) - @inlineCallbacks + @inline_callbacks_test def test_downloader_middleware_override_in_process_exception(self): """ An exception is raised but caught by the next middleware, which @@ -167,7 +173,7 @@ class TestCrawl(TestCase): assert response.body == b"Caught ZeroDivisionError" assert response.request.url == OVERRIDDEN_URL - @inlineCallbacks + @inline_callbacks_test def test_downloader_middleware_do_not_override_in_process_exception(self): """ An exception is raised but caught by the next middleware, which @@ -190,7 +196,7 @@ class TestCrawl(TestCase): assert response.body == b"Caught ZeroDivisionError" assert response.request.url == url - @inlineCallbacks + @inline_callbacks_test def test_downloader_middleware_alternative_callback(self): """ Downloader middleware which returns a response with a diff --git a/tests/test_request_cb_kwargs.py b/tests/test_request_cb_kwargs.py index 1714bd4db..ee9d2ed51 100644 --- a/tests/test_request_cb_kwargs.py +++ b/tests/test_request_cb_kwargs.py @@ -1,11 +1,10 @@ from testfixtures import LogCapture -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase from scrapy.http import Request from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer from tests.spiders import MockServerSpider +from tests.utils.decorators import inline_callbacks_test class InjectArgumentsDownloaderMiddleware: @@ -13,11 +12,11 @@ class InjectArgumentsDownloaderMiddleware: Make sure downloader middlewares are able to update the keyword arguments """ - def process_request(self, request, spider): + def process_request(self, request): if request.callback.__name__ == "parse_downloader_mw": request.cb_kwargs["from_process_request"] = True - def process_response(self, request, response, spider): + def process_response(self, request, response): if request.callback.__name__ == "parse_downloader_mw": request.cb_kwargs["from_process_response"] = True return response @@ -34,13 +33,13 @@ class InjectArgumentsSpiderMiddleware: request.cb_kwargs["from_process_start"] = True yield request - def process_spider_input(self, response, spider): + def process_spider_input(self, response): request = response.request if request.callback.__name__ == "parse_spider_mw": request.cb_kwargs["from_process_spider_input"] = True - def process_spider_output(self, response, result, spider): - for element in result: + async def process_spider_output(self, response, result): + async for element in result: if ( isinstance(element, Request) and element.callback.__name__ == "parse_spider_mw_2" @@ -103,9 +102,7 @@ class KeywordArgumentsSpider(MockServerSpider): self.checks.append(kwargs["callback"] == "some_callback") self.crawler.stats.inc_value("boolean_checks", 3) elif response.url.endswith("/general_without"): - self.checks.append( - kwargs == {} # pylint: disable=use-implicit-booleaness-not-comparison - ) + self.checks.append(kwargs == {}) self.crawler.stats.inc_value("boolean_checks") def parse_no_kwargs(self, response): @@ -149,17 +146,17 @@ class KeywordArgumentsSpider(MockServerSpider): self.crawler.stats.inc_value("boolean_checks", 1) -class TestCallbackKeywordArguments(TestCase): +class TestCallbackKeywordArguments: @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) - @inlineCallbacks + @inline_callbacks_test def test_callback_kwargs(self): crawler = get_crawler(KeywordArgumentsSpider) with LogCapture() as log: diff --git a/tests/test_request_dict.py b/tests/test_request_dict.py index ea7018541..78ff18b15 100644 --- a/tests/test_request_dict.py +++ b/tests/test_request_dict.py @@ -1,7 +1,7 @@ import pytest from scrapy import Request, Spider -from scrapy.http import FormRequest, JsonRequest +from scrapy.http import JsonRequest from scrapy.utils.request import request_from_dict @@ -67,12 +67,10 @@ class TestRequestSerialization: assert r1.dumps_kwargs == r2.dumps_kwargs def test_request_class(self): - r1 = FormRequest("http://www.example.com") + r1 = CustomRequest("http://www.example.com") self._assert_serializes_ok(r1, spider=self.spider) - r2 = CustomRequest("http://www.example.com") + r2 = JsonRequest("http://www.example.com", dumps_kwargs={"indent": 4}) self._assert_serializes_ok(r2, spider=self.spider) - r3 = JsonRequest("http://www.example.com", dumps_kwargs={"indent": 4}) - self._assert_serializes_ok(r3, spider=self.spider) def test_callback_serialization(self): r = Request( diff --git a/tests/test_request_left.py b/tests/test_request_left.py index 12ef42610..726e0573a 100644 --- a/tests/test_request_left.py +++ b/tests/test_request_left.py @@ -1,10 +1,8 @@ -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase - from scrapy.signals import request_left_downloader from scrapy.spiders import Spider from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer +from tests.utils.decorators import inline_callbacks_test class SignalCatcherSpider(Spider): @@ -24,35 +22,35 @@ class SignalCatcherSpider(Spider): self.caught_times += 1 -class TestCatching(TestCase): +class TestCatching: @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) - @inlineCallbacks + @inline_callbacks_test def test_success(self): crawler = get_crawler(SignalCatcherSpider) yield crawler.crawl(self.mockserver.url("/status?n=200")) assert crawler.spider.caught_times == 1 - @inlineCallbacks + @inline_callbacks_test def test_timeout(self): crawler = get_crawler(SignalCatcherSpider, {"DOWNLOAD_TIMEOUT": 0.1}) yield crawler.crawl(self.mockserver.url("/delay?n=0.2")) assert crawler.spider.caught_times == 1 - @inlineCallbacks + @inline_callbacks_test def test_disconnect(self): crawler = get_crawler(SignalCatcherSpider) yield crawler.crawl(self.mockserver.url("/drop")) assert crawler.spider.caught_times == 1 - @inlineCallbacks + @inline_callbacks_test def test_noconnect(self): crawler = get_crawler(SignalCatcherSpider) yield crawler.crawl("http://thereisdefinetelynosuchdomain.com") diff --git a/tests/test_resolver.py b/tests/test_resolver.py new file mode 100644 index 000000000..83fc8693b --- /dev/null +++ b/tests/test_resolver.py @@ -0,0 +1,55 @@ +from __future__ import annotations + +from unittest.mock import Mock + +import pytest + +from scrapy.resolver import CachingHostnameResolver, CachingThreadedResolver, dnscache +from scrapy.utils.defer import maybe_deferred_to_future +from scrapy.utils.test import get_crawler +from tests.utils.decorators import coroutine_test + + +@pytest.fixture(autouse=True) +def reset_dnscache(): + original_limit = dnscache.limit + dnscache.clear() + yield + dnscache.clear() + dnscache.limit = original_limit + + +def test_caching_threaded_resolver_dnscache_disabled(): + crawler = get_crawler(settings_dict={"DNSCACHE_ENABLED": False}) + CachingThreadedResolver.from_crawler(crawler, Mock()) + assert dnscache.limit == 0 + + +@coroutine_test +async def test_caching_threaded_resolver_getHostByName_cache_hit(): + resolver = CachingThreadedResolver(Mock(), cache_size=10, timeout=5.0) + dnscache["example.com"] = "1.2.3.4" + + result = await maybe_deferred_to_future(resolver.getHostByName("example.com")) + assert result == "1.2.3.4" + + +def test_caching_hostname_resolver_dnscache_disabled(): + crawler = get_crawler(settings_dict={"DNSCACHE_ENABLED": False}) + CachingHostnameResolver.from_crawler(crawler, Mock()) + assert dnscache.limit == 0 + + +def test_caching_hostname_resolver_no_addresses_not_cached(): + def fake_resolve(receiver, *_): + receiver.resolutionBegan(Mock()) + receiver.resolutionComplete() + return receiver + + reactor = Mock() + reactor.nameResolver.resolveHostName.side_effect = fake_resolve + + resolver = CachingHostnameResolver(reactor, cache_size=10) + resolver.resolveHostName(Mock(), "example.com") + + assert "example.com" not in dnscache diff --git a/tests/test_responsetypes.py b/tests/test_responsetypes.py index 5b04c7436..42ab29267 100644 --- a/tests/test_responsetypes.py +++ b/tests/test_responsetypes.py @@ -40,6 +40,9 @@ class TestResponseTypes: retcls = responsetypes.from_content_disposition(source) assert retcls is cls, f"{source} ==> {retcls} != {cls}" + def test_from_content_disposition_no_filename(self): + assert responsetypes.from_content_disposition(b"attachment") is Response + def test_from_content_type(self): mappings = [ ("text/html; charset=UTF-8", HtmlResponse), diff --git a/tests/test_robotstxt_interface.py b/tests/test_robotstxt_interface.py index 221ccabe6..5249736f2 100644 --- a/tests/test_robotstxt_interface.py +++ b/tests/test_robotstxt_interface.py @@ -1,21 +1,20 @@ import pytest -from scrapy.robotstxt import decode_robotstxt +from scrapy.robotstxt import ( + ProtegoRobotParser, + PythonRobotParser, + RerpRobotParser, + decode_robotstxt, +) +from scrapy.utils._deps_compat import STDLIB_IMPROVED_ROBOTFILEPARSER -def rerp_available(): +def rerp_available() -> bool: # check if robotexclusionrulesparser is installed try: - from robotexclusionrulesparser import RobotExclusionRulesParser # noqa: F401 - except ImportError: - return False - return True - - -def protego_available(): - # check if protego parser is installed - try: - from protego import Protego # noqa: F401 + from robotexclusionrulesparser import ( # noqa: PLC0415 + RobotExclusionRulesParser, # noqa: F401 + ) except ImportError: return False return True @@ -131,38 +130,50 @@ class TestDecodeRobotsTxt: decoded_content = decode_robotstxt(robotstxt_body, spider=None) assert decoded_content == "User-agent: *\nDisallow: /\n" + # UTF-8 BOM at the beginning of the file ignored + def test_decode_utf8_bom(self): + robotstxt_body = b"\xef\xbb\xbfUser-agent: *\nDisallow: /\n" + decoded_content = decode_robotstxt(robotstxt_body, spider=None) + assert decoded_content == "User-agent: *\nDisallow: /\n" + class TestPythonRobotParser(BaseRobotParserTest): def setup_method(self): - from scrapy.robotstxt import PythonRobotParser - super()._setUp(PythonRobotParser) + @pytest.mark.skipif( + not STDLIB_IMPROVED_ROBOTFILEPARSER, + reason="RobotFileParser from this Python version does not support length based directives precedence.", + ) def test_length_based_precedence(self): - pytest.skip( - "RobotFileParser does not support length based directives precedence." - ) + super().test_length_based_precedence() + @pytest.mark.skipif( + STDLIB_IMPROVED_ROBOTFILEPARSER, + reason="RobotFileParser from this Python version does not support order based directives precedence.", + ) + def test_order_based_precedence(self): + super().test_order_based_precedence() + + @pytest.mark.skipif( + not STDLIB_IMPROVED_ROBOTFILEPARSER, + reason="RobotFileParser from this Python version does not support wildcards.", + ) def test_allowed_wildcards(self): - pytest.skip("RobotFileParser does not support wildcards.") + super().test_allowed_wildcards() @pytest.mark.skipif(not rerp_available(), reason="Rerp parser is not installed") class TestRerpRobotParser(BaseRobotParserTest): def setup_method(self): - from scrapy.robotstxt import RerpRobotParser - super()._setUp(RerpRobotParser) def test_length_based_precedence(self): pytest.skip("Rerp does not support length based directives precedence.") -@pytest.mark.skipif(not protego_available(), reason="Protego parser is not installed") class TestProtegoRobotParser(BaseRobotParserTest): def setup_method(self): - from scrapy.robotstxt import ProtegoRobotParser - super()._setUp(ProtegoRobotParser) def test_order_based_precedence(self): diff --git a/tests/test_scheduler.py b/tests/test_scheduler.py index 456c8537f..8637de41e 100644 --- a/tests/test_scheduler.py +++ b/tests/test_scheduler.py @@ -1,32 +1,38 @@ from __future__ import annotations -import shutil -import tempfile +import warnings from abc import ABC, abstractmethod from collections import deque -from typing import Any, NamedTuple +from contextlib import AbstractAsyncContextManager, asynccontextmanager +from typing import TYPE_CHECKING, Any, NamedTuple, cast +from unittest.mock import Mock import pytest -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase from scrapy.core.downloader import Downloader from scrapy.core.scheduler import BaseScheduler, Scheduler from scrapy.crawler import Crawler +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request from scrapy.spiders import Spider +from scrapy.utils.defer import ensure_awaitable from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.misc import load_object from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer +from tests.utils.decorators import coroutine_test, inline_callbacks_test + +if TYPE_CHECKING: + from collections.abc import AsyncGenerator + from pathlib import Path class MemoryScheduler(BaseScheduler): paused = False - def __init__(self, *args, **kwargs): + def __init__(self, *args: Any, **kwargs: Any): super().__init__(*args, **kwargs) - self.queue = deque( + self.queue: deque[Request] = deque( Request(value) if isinstance(value, str) else value for value in getattr(self, "queue", []) ) @@ -53,75 +59,62 @@ class MemoryScheduler(BaseScheduler): self.paused = False -class MockEngine(NamedTuple): - downloader: MockDownloader - - class MockSlot(NamedTuple): active: list[Any] class MockDownloader: - def __init__(self): - self.slots = {} + def __init__(self) -> None: + self.slots: dict[str, MockSlot] = {} - def get_slot_key(self, request): + def get_slot_key(self, request: Request) -> str: if Downloader.DOWNLOAD_SLOT in request.meta: - return request.meta[Downloader.DOWNLOAD_SLOT] + return cast("str", request.meta[Downloader.DOWNLOAD_SLOT]) return urlparse_cached(request).hostname or "" - def increment(self, slot_key): + def increment(self, slot_key: str) -> None: slot = self.slots.setdefault(slot_key, MockSlot(active=[])) slot.active.append(1) - def decrement(self, slot_key): - slot = self.slots.get(slot_key) + def decrement(self, slot_key: str) -> None: + slot = self.slots[slot_key] slot.active.pop() - def close(self): + def close(self) -> None: pass class MockCrawler(Crawler): - def __init__(self, priority_queue_cls, jobdir): + def __init__(self, priority_queue_cls: str, jobdir: Path | None): settings = { "SCHEDULER_DEBUG": False, "SCHEDULER_DISK_QUEUE": "scrapy.squeues.PickleLifoDiskQueue", "SCHEDULER_MEMORY_QUEUE": "scrapy.squeues.LifoMemoryQueue", "SCHEDULER_PRIORITY_QUEUE": priority_queue_cls, - "JOBDIR": jobdir, + "JOBDIR": str(jobdir) if jobdir is not None else None, "DUPEFILTER_CLASS": "scrapy.dupefilters.BaseDupeFilter", } super().__init__(Spider, settings) - self.engine = MockEngine(downloader=MockDownloader()) + self.engine = Mock(downloader=MockDownloader()) self.stats = load_object(self.settings["STATS_CLASS"])(self) -class SchedulerHandler(ABC): - jobdir = None - - @property - @abstractmethod - def priority_queue_cls(self) -> str: - raise NotImplementedError - - def create_scheduler(self): - self.mock_crawler = MockCrawler(self.priority_queue_cls, self.jobdir) - self.scheduler = Scheduler.from_crawler(self.mock_crawler) - self.spider = Spider(name="spider") - self.scheduler.open(self.spider) - - def close_scheduler(self): - self.scheduler.close("finished") - self.mock_crawler.stop() - self.mock_crawler.engine.downloader.close() - - def setup_method(self): - self.create_scheduler() - - def teardown_method(self): - self.close_scheduler() +@asynccontextmanager +async def create_scheduler( + priority_queue_cls: str, jobdir: Path | None +) -> AsyncGenerator[Scheduler]: + mock_crawler = MockCrawler(priority_queue_cls, jobdir) + scheduler = Scheduler.from_crawler(mock_crawler) + spider = Spider(name="spider") + await ensure_awaitable(scheduler.open(spider)) + try: + yield scheduler + finally: + await ensure_awaitable(scheduler.close("finished")) + await mock_crawler.stop_async() + assert mock_crawler.engine + mock_crawler.engine.downloader.close() _PRIORITIES = [ @@ -136,99 +129,118 @@ _PRIORITIES = [ _URLS = {"http://foo.com/a", "http://foo.com/b", "http://foo.com/c"} -class TestSchedulerInMemoryBase(SchedulerHandler): - def test_length(self): - assert not self.scheduler.has_pending_requests() - assert len(self.scheduler) == 0 +class TestSchedulerBase(ABC): + @property + @abstractmethod + def priority_queue_cls(self) -> str: + raise NotImplementedError - for url in _URLS: - self.scheduler.enqueue_request(Request(url)) + @pytest.fixture + def jobdir(self) -> Path | None: + return None - assert self.scheduler.has_pending_requests() - assert len(self.scheduler) == len(_URLS) + def create_scheduler( + self, jobdir: Path | None + ) -> AbstractAsyncContextManager[Scheduler]: + return create_scheduler(self.priority_queue_cls, jobdir) - def test_dequeue(self): - for url in _URLS: - self.scheduler.enqueue_request(Request(url)) + # TODO: unify test methods using "reopen" like in DownloaderAwareSchedulerTestMixin - urls = set() - while self.scheduler.has_pending_requests(): - urls.add(self.scheduler.next_request().url) + +class TestSchedulerInMemoryBase(TestSchedulerBase): + @coroutine_test + async def test_length(self, jobdir: Path | None) -> None: + async with self.create_scheduler(jobdir) as scheduler: + assert not scheduler.has_pending_requests() + assert len(scheduler) == 0 + + for url in _URLS: + scheduler.enqueue_request(Request(url)) + + assert scheduler.has_pending_requests() + assert len(scheduler) == len(_URLS) + + @coroutine_test + async def test_dequeue(self, jobdir: Path | None) -> None: + async with self.create_scheduler(jobdir) as scheduler: + for url in _URLS: + scheduler.enqueue_request(Request(url)) + + urls = set() + while scheduler.has_pending_requests(): + request = scheduler.next_request() + assert request is not None + urls.add(request.url) assert urls == _URLS - def test_dequeue_priorities(self): - for url, priority in _PRIORITIES: - self.scheduler.enqueue_request(Request(url, priority=priority)) + @coroutine_test + async def test_dequeue_priorities(self, jobdir: Path | None) -> None: + async with self.create_scheduler(jobdir) as scheduler: + for url, priority in _PRIORITIES: + scheduler.enqueue_request(Request(url, priority=priority)) - priorities = [] - while self.scheduler.has_pending_requests(): - priorities.append(self.scheduler.next_request().priority) + priorities = [] + while scheduler.has_pending_requests(): + request = scheduler.next_request() + assert request is not None + priorities.append(request.priority) assert priorities == sorted([x[1] for x in _PRIORITIES], key=lambda x: -x) -class TestSchedulerOnDiskBase(SchedulerHandler): - def setup_method(self): - self.jobdir = tempfile.mkdtemp() - self.create_scheduler() +class TestSchedulerOnDiskBase(TestSchedulerBase): + @pytest.fixture + def jobdir(self, tmp_path: Path) -> Path | None: + return tmp_path - def teardown_method(self): - self.close_scheduler() + @coroutine_test + async def test_length(self, jobdir: Path | None) -> None: + async with self.create_scheduler(jobdir) as scheduler: + assert not scheduler.has_pending_requests() + assert len(scheduler) == 0 + for url in _URLS: + scheduler.enqueue_request(Request(url)) - shutil.rmtree(self.jobdir) - self.jobdir = None + async with self.create_scheduler(jobdir) as scheduler: + assert scheduler.has_pending_requests() + assert len(scheduler) == len(_URLS) - def test_length(self): - assert not self.scheduler.has_pending_requests() - assert len(self.scheduler) == 0 - - for url in _URLS: - self.scheduler.enqueue_request(Request(url)) - - self.close_scheduler() - self.create_scheduler() - - assert self.scheduler.has_pending_requests() - assert len(self.scheduler) == len(_URLS) - - def test_dequeue(self): - for url in _URLS: - self.scheduler.enqueue_request(Request(url)) - - self.close_scheduler() - self.create_scheduler() + @coroutine_test + async def test_dequeue(self, jobdir: Path | None) -> None: + async with self.create_scheduler(jobdir) as scheduler: + for url in _URLS: + scheduler.enqueue_request(Request(url)) urls = set() - while self.scheduler.has_pending_requests(): - urls.add(self.scheduler.next_request().url) - + async with self.create_scheduler(jobdir) as scheduler: + while scheduler.has_pending_requests(): + request = scheduler.next_request() + assert request is not None + urls.add(request.url) assert urls == _URLS - def test_dequeue_priorities(self): - for url, priority in _PRIORITIES: - self.scheduler.enqueue_request(Request(url, priority=priority)) - - self.close_scheduler() - self.create_scheduler() + @coroutine_test + async def test_dequeue_priorities(self, jobdir: Path | None) -> None: + async with self.create_scheduler(jobdir) as scheduler: + for url, priority in _PRIORITIES: + scheduler.enqueue_request(Request(url, priority=priority)) priorities = [] - while self.scheduler.has_pending_requests(): - priorities.append(self.scheduler.next_request().priority) - + async with self.create_scheduler(jobdir) as scheduler: + while scheduler.has_pending_requests(): + request = scheduler.next_request() + assert request is not None + priorities.append(request.priority) assert priorities == sorted([x[1] for x in _PRIORITIES], key=lambda x: -x) class TestSchedulerInMemory(TestSchedulerInMemoryBase): - @property - def priority_queue_cls(self) -> str: - return "scrapy.pqueues.ScrapyPriorityQueue" + priority_queue_cls = "scrapy.pqueues.ScrapyPriorityQueue" class TestSchedulerOnDisk(TestSchedulerOnDiskBase): - @property - def priority_queue_cls(self) -> str: - return "scrapy.pqueues.ScrapyPriorityQueue" + priority_queue_cls = "scrapy.pqueues.ScrapyPriorityQueue" _URLS_WITH_SLOTS = [ @@ -242,36 +254,25 @@ _URLS_WITH_SLOTS = [ class TestMigration: - def test_migration(self, tmpdir): - class PrevSchedulerHandler(SchedulerHandler): - jobdir = tmpdir + @coroutine_test + async def test_migration(self, tmp_path: Path) -> None: + async with create_scheduler( + "scrapy.pqueues.ScrapyPriorityQueue", tmp_path + ) as prev_scheduler: + for url in _URLS: + prev_scheduler.enqueue_request(Request(url)) - @property - def priority_queue_cls(self) -> str: - return "scrapy.pqueues.ScrapyPriorityQueue" - - class NextSchedulerHandler(SchedulerHandler): - jobdir = tmpdir - - @property - def priority_queue_cls(self) -> str: - return "scrapy.pqueues.DownloaderAwarePriorityQueue" - - prev_scheduler_handler = PrevSchedulerHandler() - prev_scheduler_handler.create_scheduler() - for url in _URLS: - prev_scheduler_handler.scheduler.enqueue_request(Request(url)) - prev_scheduler_handler.close_scheduler() - - next_scheduler_handler = NextSchedulerHandler() with pytest.raises( ValueError, match="DownloaderAwarePriorityQueue accepts ``slot_startprios`` as a dict", ): - next_scheduler_handler.create_scheduler() + async with create_scheduler( + "scrapy.pqueues.DownloaderAwarePriorityQueue", tmp_path + ): + pass -def _is_scheduling_fair(enqueued_slots, dequeued_slots): +def _is_scheduling_fair(enqueued_slots: list[str], dequeued_slots: list[str]) -> bool: """ We enqueued same number of requests for every slot. Assert correct order, e.g. @@ -296,39 +297,49 @@ def _is_scheduling_fair(enqueued_slots, dequeued_slots): return True -class DownloaderAwareSchedulerTestMixin: +class DownloaderAwareSchedulerTestMixin(TestSchedulerBase): reopen = False + priority_queue_cls = "scrapy.pqueues.DownloaderAwarePriorityQueue" - @property - def priority_queue_cls(self) -> str: - return "scrapy.pqueues.DownloaderAwarePriorityQueue" + @coroutine_test + async def test_logic(self, jobdir: Path | None) -> None: + def _setup(scheduler: Scheduler) -> None: + for url, slot in _URLS_WITH_SLOTS: + request = Request(url) + request.meta[Downloader.DOWNLOAD_SLOT] = slot + scheduler.enqueue_request(request) - def test_logic(self): - for url, slot in _URLS_WITH_SLOTS: - request = Request(url) - request.meta[Downloader.DOWNLOAD_SLOT] = slot - self.scheduler.enqueue_request(request) + def _assert(scheduler: Scheduler) -> None: + dequeued_slots: list[str] = [] + requests: list[Request] = [] + assert scheduler.crawler + assert scheduler.crawler.engine + downloader = scheduler.crawler.engine.downloader + assert isinstance(downloader, MockDownloader) + while scheduler.has_pending_requests(): + request = scheduler.next_request() + assert request is not None + slot = downloader.get_slot_key(request) + dequeued_slots.append(slot) + downloader.increment(slot) + requests.append(request) + + for request in requests: + slot = downloader.get_slot_key(request) + downloader.decrement(slot) + + assert _is_scheduling_fair([s for u, s in _URLS_WITH_SLOTS], dequeued_slots) + assert sum(len(s.active) for s in downloader.slots.values()) == 0 if self.reopen: - self.close_scheduler() - self.create_scheduler() - - dequeued_slots = [] - requests = [] - downloader = self.mock_crawler.engine.downloader - while self.scheduler.has_pending_requests(): - request = self.scheduler.next_request() - slot = downloader.get_slot_key(request) - dequeued_slots.append(slot) - downloader.increment(slot) - requests.append(request) - - for request in requests: - slot = downloader.get_slot_key(request) - downloader.decrement(slot) - - assert _is_scheduling_fair([s for u, s in _URLS_WITH_SLOTS], dequeued_slots) - assert sum(len(s.active) for s in downloader.slots.values()) == 0 + async with self.create_scheduler(jobdir) as scheduler: + _setup(scheduler) + async with self.create_scheduler(jobdir) as scheduler: + _assert(scheduler) + else: + async with self.create_scheduler(jobdir) as scheduler: + _setup(scheduler) + _assert(scheduler) class TestSchedulerWithDownloaderAwareInMemory( @@ -352,8 +363,8 @@ class StartUrlsSpider(Spider): pass -class TestIntegrationWithDownloaderAwareInMemory(TestCase): - def setUp(self): +class TestIntegrationWithDownloaderAwareInMemory: + def setup_method(self): self.crawler = get_crawler( spidercls=StartUrlsSpider, settings_dict={ @@ -362,11 +373,7 @@ class TestIntegrationWithDownloaderAwareInMemory(TestCase): }, ) - @inlineCallbacks - def tearDown(self): - yield self.crawler.stop() - - @inlineCallbacks + @inline_callbacks_test def test_integration_downloader_aware_priority_queue(self): with MockServer() as mockserver: url = mockserver.url("/status?n=200", is_secure=False) @@ -389,7 +396,13 @@ class TestIncompatibility: scheduler.open(spider) def test_incompatibility(self): - with pytest.raises( - ValueError, match="does not support CONCURRENT_REQUESTS_PER_IP" - ): - self._incompatible() + with warnings.catch_warnings(): + warnings.filterwarnings( + "ignore", + category=ScrapyDeprecationWarning, + message="The CONCURRENT_REQUESTS_PER_IP setting is deprecated", + ) + with pytest.raises( + ValueError, match="does not support CONCURRENT_REQUESTS_PER_IP" + ): + self._incompatible() diff --git a/tests/test_scheduler_base.py b/tests/test_scheduler_base.py index 26482fc8d..08acacae7 100644 --- a/tests/test_scheduler_base.py +++ b/tests/test_scheduler_base.py @@ -5,8 +5,6 @@ from urllib.parse import urljoin import pytest from testfixtures import LogCapture from twisted.internet import defer -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase from scrapy.core.scheduler import BaseScheduler from scrapy.http import Request @@ -14,7 +12,8 @@ from scrapy.spiders import Spider from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.request import fingerprint from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer +from tests.utils.decorators import inline_callbacks_test PATHS = ["/a", "/b", "/c"] URLS = [urljoin("https://example.org", p) for p in PATHS] @@ -36,16 +35,16 @@ class MinimalScheduler: def next_request(self) -> Request | None: if self.has_pending_requests(): - fp, request = self.requests.popitem() + _, request = self.requests.popitem() return request return None class SimpleScheduler(MinimalScheduler): - def open(self, spider: Spider) -> defer.Deferred: + def open(self, spider: Spider) -> defer.Deferred[str]: return defer.succeed("open") - def close(self, reason: str) -> defer.Deferred: + def close(self, reason: str) -> defer.Deferred[str]: return defer.succeed("close") def __len__(self) -> int: @@ -105,7 +104,7 @@ class TestMinimalScheduler(InterfaceCheckMixin): for url in URLS: assert self.scheduler.enqueue_request(Request(url)) assert not self.scheduler.enqueue_request(Request(url)) - assert self.scheduler.has_pending_requests + assert self.scheduler.has_pending_requests() dequeued = [] while self.scheduler.has_pending_requests(): @@ -115,11 +114,11 @@ class TestMinimalScheduler(InterfaceCheckMixin): assert not self.scheduler.has_pending_requests() -class TestSimpleScheduler(TestCase, InterfaceCheckMixin): - def setUp(self): +class TestSimpleScheduler(InterfaceCheckMixin): + def setup_method(self): self.scheduler = SimpleScheduler() - @inlineCallbacks + @inline_callbacks_test def test_enqueue_dequeue(self): open_result = yield self.scheduler.open(Spider("foo")) assert open_result == "open" @@ -145,10 +144,10 @@ class TestSimpleScheduler(TestCase, InterfaceCheckMixin): assert close_result == "close" -class TestMinimalSchedulerCrawl(TestCase): +class TestMinimalSchedulerCrawl: scheduler_cls = MinimalScheduler - @inlineCallbacks + @inline_callbacks_test def test_crawl(self): with MockServer() as mockserver: settings = { diff --git a/tests/test_scrapy__getattr__.py b/tests/test_scrapy__getattr__.py index 443e26a3c..4647e1041 100644 --- a/tests/test_scrapy__getattr__.py +++ b/tests/test_scrapy__getattr__.py @@ -1,13 +1,18 @@ -import warnings +from __future__ import annotations + +import pytest + +from scrapy.exceptions import ScrapyDeprecationWarning -def test_deprecated_twisted_version(): - with warnings.catch_warnings(record=True) as warns: - from scrapy import twisted_version # pylint: disable=no-name-in-module - - assert twisted_version is not None - assert isinstance(twisted_version, tuple) - assert ( - "The scrapy.twisted_version attribute is deprecated, use twisted.version instead" - in warns[0].message.args +def test_deprecated_concurrent_requests_per_ip_attribute() -> None: + with pytest.warns( + ScrapyDeprecationWarning, + match=r"scrapy\.settings\.default_settings\.CONCURRENT_REQUESTS_PER_IP attribute is deprecated", + ): + from scrapy.settings.default_settings import ( # noqa: PLC0415 + CONCURRENT_REQUESTS_PER_IP, ) + + assert CONCURRENT_REQUESTS_PER_IP is not None + assert isinstance(CONCURRENT_REQUESTS_PER_IP, int) diff --git a/tests/test_selector.py b/tests/test_selector.py index 5c8eadf0b..98595ac93 100644 --- a/tests/test_selector.py +++ b/tests/test_selector.py @@ -104,10 +104,8 @@ class TestSelector: Selector(TextResponse(url="http://example.com", body=b""), text="") +@pytest.mark.skipif(not PARSEL_18_PLUS, reason="parsel < 1.8 doesn't support jmespath") class TestJMESPath: - @pytest.mark.skipif( - not PARSEL_18_PLUS, reason="parsel < 1.8 doesn't support jmespath" - ) def test_json_has_html(self) -> None: """Sometimes the information is returned in a json wrapper""" @@ -145,9 +143,6 @@ class TestJMESPath: assert resp.jmespath("html").css("div > b").getall() == ["f"] assert resp.jmespath("content").jmespath("name.age").get() == "18" - @pytest.mark.skipif( - not PARSEL_18_PLUS, reason="parsel < 1.8 doesn't support jmespath" - ) def test_html_has_json(self) -> None: body = """
@@ -193,9 +188,6 @@ class TestJMESPath: ] assert resp.xpath("//div/content").jmespath("total").get() == "4" - @pytest.mark.skipif( - not PARSEL_18_PLUS, reason="parsel < 1.8 doesn't support jmespath" - ) def test_jmestpath_with_re(self) -> None: body = """
@@ -248,13 +240,14 @@ class TestJMESPath: r"(\d+)" ) == ["18", "32", "22", "25"] - @pytest.mark.skipif(PARSEL_18_PLUS, reason="parsel >= 1.8 supports jmespath") - def test_jmespath_not_available(self) -> None: - body = """ - { - "website": {"name": "Example"} - } - """ - resp = TextResponse(url="http://example.com", body=body, encoding="utf-8") - with pytest.raises(AttributeError): - resp.jmespath("website.name").get() + +@pytest.mark.skipif(PARSEL_18_PLUS, reason="parsel >= 1.8 supports jmespath") +def test_jmespath_not_available() -> None: + body = """ + { + "website": {"name": "Example"} + } + """ + resp = TextResponse(url="http://example.com", body=body, encoding="utf-8") + with pytest.raises(AttributeError): + resp.jmespath("website.name").get() diff --git a/tests/test_settings/__init__.py b/tests/test_settings/__init__.py index d7d900546..3282b0591 100644 --- a/tests/test_settings/__init__.py +++ b/tests/test_settings/__init__.py @@ -1,10 +1,13 @@ -# pylint: disable=unsubscriptable-object,unsupported-membership-test,use-implicit-booleaness-not-comparison +# pylint: disable=unsubscriptable-object,unsupported-membership-test # (too many false positives) +import logging from unittest import mock import pytest +from scrapy.core.downloader.handlers.file import FileDownloadHandler +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.settings import ( SETTINGS_PRIORITIES, BaseSettings, @@ -12,9 +15,18 @@ from scrapy.settings import ( SettingsAttribute, get_settings_priority, ) +from scrapy.settings import default_settings as scrapy_default_settings +from scrapy.utils.misc import build_from_crawler, load_object +from scrapy.utils.test import get_crawler from . import default_settings +NON_COMPONENT_PRIORITY_DICT_BASE_SETTING_NAMES = { + "DOWNLOAD_HANDLERS_BASE", + "FEED_EXPORTERS_BASE", + "FEED_STORAGES_BASE", +} + class TestSettingsGlobalFuncs: def test_get_settings_priority(self): @@ -307,7 +319,7 @@ class TestBaseSettings: assert settings.getdict("TEST_DICT3", {"key1": 5}) == {"key1": 5} with pytest.raises( ValueError, - match="dictionary update sequence element #0 has length 3; 2 is required|sequence of pairs expected", + match=r"dictionary update sequence element #0 has length 3; 2 is required|sequence of pairs expected", ): settings.getdict("TEST_LIST1") with pytest.raises( @@ -372,15 +384,15 @@ class TestBaseSettings: "TEST_STRING": "a string", "TEST_LIST": [1, 2], "TEST_BOOLEAN": False, - "TEST_BASE": BaseSettings({1: 1, 2: 2}, "project"), - "TEST": BaseSettings({1: 10, 3: 30}, "default"), - "HASNOBASE": BaseSettings({3: 3000}, "default"), + "TEST_BASE": BaseSettings({"foo": 1, "bar": 2}, "project"), + "TEST": BaseSettings({"foo": 10, "baz": 30}, "default"), + "HASNOBASE": BaseSettings({"baz": 3000}, "default"), } ) assert s.copy_to_dict() == { - "HASNOBASE": {3: 3000}, - "TEST": {1: 10, 3: 30}, - "TEST_BASE": {1: 1, 2: 2}, + "HASNOBASE": {"baz": 3000}, + "TEST": {"foo": 10, "baz": 30}, + "TEST_BASE": {"foo": 1, "bar": 2}, "TEST_LIST": [1, 2], "TEST_BOOLEAN": False, "TEST_STRING": "a string", @@ -398,6 +410,199 @@ class TestBaseSettings: assert frozencopy.frozen assert frozencopy is not self.settings + def test_getwithbase_for_dotted_keys(self): + settings = BaseSettings( + { + "FEED_EXPORTERS_BASE": BaseSettings({"json": "foo"}), + "FEED_EXPORTERS": BaseSettings({"csv.gz": "bar"}), + } + ) + value = settings.getwithbase("FEED_EXPORTERS") + assert isinstance(value, BaseSettings) + assert dict(value) == { + "json": "foo", + "csv.gz": "bar", + } + + @pytest.mark.parametrize( + ("key", "exception"), + [ + pytest.param(1, TypeError, id="type-error"), + pytest.param("foo", ValueError, id="value-error"), + pytest.param("csv.gz", NameError, id="name-error"), + ], + ) + def test_get_component_priority_dict_with_base_handles_load_object_exceptions( + self, key, exception + ): + with pytest.raises(exception): + load_object(key) + + settings = BaseSettings( + { + "FOO": BaseSettings({key: 1}), + } + ) + value = settings.get_component_priority_dict_with_base("FOO") + + assert isinstance(value, BaseSettings) + assert dict(value) == {key: 1} + + def test_get_component_priority_dict_with_base_override_none_by_type(self): + settings = BaseSettings() + setting_names = set() + for k, v in scrapy_default_settings.__dict__.items(): + if ( + not k.endswith("_BASE") + or k in NON_COMPONENT_PRIORITY_DICT_BASE_SETTING_NAMES + ): + continue + settings[k] = v + setting_name = k[: -len("_BASE")] + setting_names.add(setting_name) + settings[setting_name] = { + load_object(import_path): None for import_path in v + } + for setting_name in setting_names: + value = settings.get_component_priority_dict_with_base(setting_name) + assert not dict(value) + + def test_get_component_priority_dict_with_base_override_value_by_type(self): + settings = BaseSettings() + setting_names = set() + value = 0 + for k, v in scrapy_default_settings.__dict__.items(): + if ( + not k.endswith("_BASE") + or k in NON_COMPONENT_PRIORITY_DICT_BASE_SETTING_NAMES + ): + continue + settings[k] = v + setting_name = k[: -len("_BASE")] + setting_names.add(setting_name) + settings[setting_name] = { + load_object(import_path): value for import_path in v + } + for setting_name in setting_names: + assert ( + settings.get_component_priority_dict_with_base(setting_name) + == settings[setting_name] + ) + + def test_getwithbase_for_non_component_priority_dicts(self): + settings = BaseSettings() + for base_name in NON_COMPONENT_PRIORITY_DICT_BASE_SETTING_NAMES: + base_value = getattr(scrapy_default_settings, base_name) + settings[base_name] = BaseSettings(base_value) + assert len(base_value) >= 2 + keys = list(base_value) + values = list(base_value.values()) + override = {keys[0]: values[1]} + expected = dict(base_value) + expected[keys[0]] = values[1] + name = base_name[: -len("_BASE")] + settings[name] = BaseSettings(override) + value = settings.getwithbase(name) + assert isinstance(value, BaseSettings) + assert dict(value) == expected + + def test_get_component_priority_dict_with_base_warns_on_duplicate_import_paths( + self, caplog + ): + settings = BaseSettings() + settings["FOO"] = BaseSettings( + { + "scrapy.Request": 1, + "scrapy.http.Request": 2, + } + ) + with caplog.at_level(logging.WARNING): + value = settings.get_component_priority_dict_with_base("FOO") + assert isinstance(value, BaseSettings) + assert dict(value) == {"scrapy.http.Request": 2} + assert caplog.records, "Expected a warning to be logged" + msg = caplog.records[0].message + assert "scrapy.http.request.Request" in msg + + def test_get_component_priority_dict_with_base_warns_on_duplicate_mixed_type_and_path( + self, caplog + ): + settings = BaseSettings() + settings["FOO"] = BaseSettings( + {Component1: 1, "tests.test_settings.Component1": 2} + ) + with caplog.at_level(logging.WARNING): + value = settings.get_component_priority_dict_with_base("FOO") + assert isinstance(value, BaseSettings) + assert dict(value) == {"tests.test_settings.Component1": 2} + assert caplog.records, "Expected a warning to be logged" + msg = caplog.records[0].message + assert "tests.test_settings.Component1" in msg + + def test_getdictorlist(self): + settings = BaseSettings() + + # No value and no default → {} + assert settings.getdictorlist("MISSING") == {} + + # String: valid JSON dict + settings.set("S_DICT_STR", '{"key": "val"}') + assert settings.getdictorlist("S_DICT_STR") == {"key": "val"} + + # String: valid JSON list + settings.set("S_LIST_STR", '["a", "b"]') + assert settings.getdictorlist("S_LIST_STR") == ["a", "b"] + + # String: invalid JSON → comma-split fallback + settings.set("S_CSV", "a,b,c") + assert settings.getdictorlist("S_CSV") == ["a", "b", "c"] + + # String: valid JSON but not dict or list → ValueError caught → comma-split + settings.set("S_JSON_NUMBER", "123") + assert settings.getdictorlist("S_JSON_NUMBER") == ["123"] + + # Tuple → list + settings.set("S_TUPLE", ("x", "y")) + assert settings.getdictorlist("S_TUPLE") == ["x", "y"] + + # Unsupported type → raises ValueError + settings.set("S_INT", 42) + with pytest.raises(ValueError, match="must be a dict, list, tuple, or string"): + settings.getdictorlist("S_INT") + + # Dict value → deepcopy returned + settings.set("S_DICT", {"key": "val"}) + assert settings.getdictorlist("S_DICT") == {"key": "val"} + + # List value → deepcopy returned + settings.set("S_LIST", ["a", "b"]) + assert settings.getdictorlist("S_LIST") == ["a", "b"] + + def test_repr_pretty_(self): + settings = BaseSettings({"key": "value"}) + mock_p = mock.Mock() + + settings._repr_pretty_(mock_p, cycle=False) + assert mock_p.text.call_count == 1 + + mock_p.reset_mock() + settings._repr_pretty_(mock_p, cycle=True) + mock_p.text.assert_called_once_with(repr(settings)) + + def test_getwithbase_invalid_setting_name(self): + settings = BaseSettings() + with pytest.raises( + ValueError, match="Base setting key must be a string, got 123" + ): + settings.getwithbase(123) + + def test_get_component_priority_dict_with_base_invalid_setting_name(self): + settings = BaseSettings() + with pytest.raises( + ValueError, match="Base setting key must be a string, got 123" + ): + settings.get_component_priority_dict_with_base(123) + class TestSettings: def setup_method(self): @@ -446,12 +651,8 @@ class TestSettings: assert mydict["key"] == "val" def test_passing_objects_as_values(self): - from scrapy.core.downloader.handlers.file import FileDownloadHandler - from scrapy.utils.misc import build_from_crawler - from scrapy.utils.test import get_crawler - class TestPipeline: - def process_item(self, i, s): + def process_item(self, i): return i settings = Settings( @@ -471,7 +672,7 @@ class TestSettings: assert priority == 800 assert mypipeline == TestPipeline assert isinstance(mypipeline(), TestPipeline) - assert mypipeline().process_item("item", None) == "item" + assert mypipeline().process_item("item") == "item" myhandler = settings.getdict("DOWNLOAD_HANDLERS").pop("ftp") assert myhandler == FileDownloadHandler @@ -559,6 +760,24 @@ def test_remove_from_list(before, name, item, after): assert settings.getpriority(name) == expected_settings.getpriority(name) +def test_deprecated_dns_resolver_setting(): + settings = Settings() + with pytest.warns( + ScrapyDeprecationWarning, + match="The DNS_RESOLVER setting is deprecated", + ): + settings.get("DNS_RESOLVER") + + +def test_deprecated_concurrent_requests_per_ip_setting(): + settings = Settings({"CONCURRENT_REQUESTS_PER_IP": 1}) + with pytest.warns( + ScrapyDeprecationWarning, + match="The CONCURRENT_REQUESTS_PER_IP setting is deprecated", + ): + settings.get("CONCURRENT_REQUESTS_PER_IP") + + class Component1: pass diff --git a/tests/test_signalmanager.py b/tests/test_signalmanager.py new file mode 100644 index 000000000..ce4d97adb --- /dev/null +++ b/tests/test_signalmanager.py @@ -0,0 +1,21 @@ +from scrapy.signalmanager import SignalManager + + +class TestSignalManager: + def test_disconnect_all(self): + signal = object() + sender = object() + sm = SignalManager(sender) + + calls = [] + + def handler(): + calls.append(1) + + sm.connect(handler, signal) + sm.send_catch_log(signal) + assert calls == [1] + + sm.disconnect_all(signal) + sm.send_catch_log(signal) + assert calls == [1] # handler no longer called after disconnect_all diff --git a/tests/test_signals.py b/tests/test_signals.py index b20a949e8..f5f13b992 100644 --- a/tests/test_signals.py +++ b/tests/test_signals.py @@ -1,11 +1,9 @@ import pytest -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase from scrapy import Request, Spider, signals -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future from scrapy.utils.test import get_crawler, get_from_asyncio_queue -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer +from tests.utils.decorators import coroutine_test, inline_callbacks_test class ItemSpider(Spider): @@ -21,8 +19,8 @@ class ItemSpider(Spider): return {"index": response.meta["index"]} -class TestMain(TestCase): - @deferred_f_from_coro_f +class TestMain: + @coroutine_test async def test_scheduler_empty(self): crawler = get_crawler() calls = [] @@ -31,21 +29,21 @@ class TestMain(TestCase): calls.append(object()) crawler.signals.connect(track_call, signals.scheduler_empty) - await maybe_deferred_to_future(crawler.crawl()) + await crawler.crawl_async() assert len(calls) >= 1 -class TestMockServer(TestCase): +class TestMockServer: @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) - def setUp(self): + def setup_method(self): self.items = [] async def _on_item_scraped(self, item): @@ -53,7 +51,7 @@ class TestMockServer(TestCase): self.items.append(item) @pytest.mark.only_asyncio - @inlineCallbacks + @inline_callbacks_test def test_simple_pipeline(self): crawler = get_crawler(ItemSpider) crawler.signals.connect(self._on_item_scraped, signals.item_scraped) diff --git a/tests/test_spider.py b/tests/test_spider.py index dceb9f91d..526cc8f23 100644 --- a/tests/test_spider.py +++ b/tests/test_spider.py @@ -1,49 +1,28 @@ -import gzip -import warnings -from io import BytesIO -from logging import ERROR, WARNING -from pathlib import Path +from __future__ import annotations + from typing import Any from unittest import mock import pytest from testfixtures import LogCapture -from twisted.internet.defer import inlineCallbacks -from twisted.trial import unittest -from w3lib.url import safe_url_string from scrapy import signals from scrapy.crawler import Crawler -from scrapy.http import HtmlResponse, Request, Response, TextResponse, XmlResponse -from scrapy.linkextractors import LinkExtractor +from scrapy.http import Response, TextResponse, XmlResponse from scrapy.settings import Settings -from scrapy.spiders import ( - CrawlSpider, - CSVFeedSpider, - Rule, - SitemapSpider, - Spider, - XMLFeedSpider, -) -from scrapy.spiders.init import InitSpider -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future +from scrapy.spiders import CSVFeedSpider, Spider, XMLFeedSpider from scrapy.utils.test import get_crawler, get_reactor_settings -from tests import get_testdata, tests_datadir +from tests import get_testdata +from tests.utils.decorators import inline_callbacks_test -class TestSpider(unittest.TestCase): +class TestSpider: spider_class = Spider - def setUp(self): - warnings.simplefilter("always") - - def tearDown(self): - warnings.resetwarnings() - def test_base_spider(self): spider = self.spider_class("example.com") assert spider.name == "example.com" - assert spider.start_urls == [] # pylint: disable=use-implicit-booleaness-not-comparison + assert spider.start_urls == [] def test_spider_args(self): """``__init__`` method arguments are assigned to spider attributes""" @@ -99,7 +78,7 @@ class TestSpider(unittest.TestCase): assert settings.get("TEST2") == "spider" assert settings.get("TEST3") == "project" - @inlineCallbacks + @inline_callbacks_test def test_settings_in_from_crawler(self): spider_settings = {"TEST1": "spider", "TEST2": "spider"} project_settings = { @@ -142,27 +121,6 @@ class TestSpider(unittest.TestCase): mock_logger.log.assert_called_once_with("INFO", "test log msg") -@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") -class TestInitSpider(TestSpider): - spider_class = InitSpider - - @deferred_f_from_coro_f - async def test_start_urls(self): - responses = [] - - class TestSpider(self.spider_class): - name = "test" - start_urls = ["data:,"] - - async def parse(self, response): - responses.append(response) - - crawler = get_crawler(TestSpider) - await maybe_deferred_to_future(crawler.crawl()) - assert len(responses) == 1 - assert responses[0].url == "data:," - - class TestXMLFeedSpider(TestSpider): spider_class = XMLFeedSpider @@ -233,633 +191,6 @@ class TestCSVFeedSpider(TestSpider): assert len(rows) == 4 -class TestCrawlSpider(TestSpider): - test_body = b"""Page title - -

Item 12

-
-

About us

-
- - """ - spider_class = CrawlSpider - - def test_rule_without_link_extractor(self): - response = HtmlResponse( - "http://example.org/somepage/index.html", body=self.test_body - ) - - class _CrawlSpider(self.spider_class): - name = "test" - allowed_domains = ["example.org"] - rules = (Rule(),) - - spider = _CrawlSpider() - output = list(spider._requests_to_follow(response)) - assert len(output) == 3 - assert all(isinstance(r, Request) for r in output) - assert [r.url for r in output] == [ - "http://example.org/somepage/item/12.html", - "http://example.org/about.html", - "http://example.org/nofollow.html", - ] - - def test_process_links(self): - response = HtmlResponse( - "http://example.org/somepage/index.html", body=self.test_body - ) - - class _CrawlSpider(self.spider_class): - name = "test" - allowed_domains = ["example.org"] - rules = (Rule(LinkExtractor(), process_links="dummy_process_links"),) - - def dummy_process_links(self, links): - return links - - spider = _CrawlSpider() - output = list(spider._requests_to_follow(response)) - assert len(output) == 3 - assert all(isinstance(r, Request) for r in output) - assert [r.url for r in output] == [ - "http://example.org/somepage/item/12.html", - "http://example.org/about.html", - "http://example.org/nofollow.html", - ] - - def test_process_links_filter(self): - response = HtmlResponse( - "http://example.org/somepage/index.html", body=self.test_body - ) - - class _CrawlSpider(self.spider_class): - import re - - name = "test" - allowed_domains = ["example.org"] - rules = (Rule(LinkExtractor(), process_links="filter_process_links"),) - _test_regex = re.compile("nofollow") - - def filter_process_links(self, links): - return [link for link in links if not self._test_regex.search(link.url)] - - spider = _CrawlSpider() - output = list(spider._requests_to_follow(response)) - assert len(output) == 2 - assert all(isinstance(r, Request) for r in output) - assert [r.url for r in output] == [ - "http://example.org/somepage/item/12.html", - "http://example.org/about.html", - ] - - def test_process_links_generator(self): - response = HtmlResponse( - "http://example.org/somepage/index.html", body=self.test_body - ) - - class _CrawlSpider(self.spider_class): - name = "test" - allowed_domains = ["example.org"] - rules = (Rule(LinkExtractor(), process_links="dummy_process_links"),) - - def dummy_process_links(self, links): - yield from links - - spider = _CrawlSpider() - output = list(spider._requests_to_follow(response)) - assert len(output) == 3 - assert all(isinstance(r, Request) for r in output) - assert [r.url for r in output] == [ - "http://example.org/somepage/item/12.html", - "http://example.org/about.html", - "http://example.org/nofollow.html", - ] - - def test_process_request(self): - response = HtmlResponse( - "http://example.org/somepage/index.html", body=self.test_body - ) - - def process_request_change_domain(request, response): - return request.replace(url=request.url.replace(".org", ".com")) - - class _CrawlSpider(self.spider_class): - name = "test" - allowed_domains = ["example.org"] - rules = ( - Rule(LinkExtractor(), process_request=process_request_change_domain), - ) - - spider = _CrawlSpider() - output = list(spider._requests_to_follow(response)) - assert len(output) == 3 - assert all(isinstance(r, Request) for r in output) - assert [r.url for r in output] == [ - "http://example.com/somepage/item/12.html", - "http://example.com/about.html", - "http://example.com/nofollow.html", - ] - - def test_process_request_with_response(self): - response = HtmlResponse( - "http://example.org/somepage/index.html", body=self.test_body - ) - - def process_request_meta_response_class(request, response): - request.meta["response_class"] = response.__class__.__name__ - return request - - class _CrawlSpider(self.spider_class): - name = "test" - allowed_domains = ["example.org"] - rules = ( - Rule( - LinkExtractor(), process_request=process_request_meta_response_class - ), - ) - - spider = _CrawlSpider() - output = list(spider._requests_to_follow(response)) - assert len(output) == 3 - assert all(isinstance(r, Request) for r in output) - assert [r.url for r in output] == [ - "http://example.org/somepage/item/12.html", - "http://example.org/about.html", - "http://example.org/nofollow.html", - ] - assert [r.meta["response_class"] for r in output] == [ - "HtmlResponse", - "HtmlResponse", - "HtmlResponse", - ] - - def test_process_request_instance_method(self): - response = HtmlResponse( - "http://example.org/somepage/index.html", body=self.test_body - ) - - class _CrawlSpider(self.spider_class): - name = "test" - allowed_domains = ["example.org"] - rules = (Rule(LinkExtractor(), process_request="process_request_upper"),) - - def process_request_upper(self, request, response): - return request.replace(url=request.url.upper()) - - spider = _CrawlSpider() - output = list(spider._requests_to_follow(response)) - assert len(output) == 3 - assert all(isinstance(r, Request) for r in output) - assert [r.url for r in output] == [ - safe_url_string("http://EXAMPLE.ORG/SOMEPAGE/ITEM/12.HTML"), - safe_url_string("http://EXAMPLE.ORG/ABOUT.HTML"), - safe_url_string("http://EXAMPLE.ORG/NOFOLLOW.HTML"), - ] - - def test_process_request_instance_method_with_response(self): - response = HtmlResponse( - "http://example.org/somepage/index.html", body=self.test_body - ) - - class _CrawlSpider(self.spider_class): - name = "test" - allowed_domains = ["example.org"] - rules = ( - Rule( - LinkExtractor(), - process_request="process_request_meta_response_class", - ), - ) - - def process_request_meta_response_class(self, request, response): - request.meta["response_class"] = response.__class__.__name__ - return request - - spider = _CrawlSpider() - output = list(spider._requests_to_follow(response)) - assert len(output) == 3 - assert all(isinstance(r, Request) for r in output) - assert [r.url for r in output] == [ - "http://example.org/somepage/item/12.html", - "http://example.org/about.html", - "http://example.org/nofollow.html", - ] - assert [r.meta["response_class"] for r in output] == [ - "HtmlResponse", - "HtmlResponse", - "HtmlResponse", - ] - - def test_follow_links_attribute_population(self): - crawler = get_crawler() - spider = self.spider_class.from_crawler(crawler, "example.com") - assert hasattr(spider, "_follow_links") - assert spider._follow_links - - settings_dict = {"CRAWLSPIDER_FOLLOW_LINKS": False} - crawler = get_crawler(settings_dict=settings_dict) - spider = self.spider_class.from_crawler(crawler, "example.com") - assert hasattr(spider, "_follow_links") - assert not spider._follow_links - - @inlineCallbacks - def test_start_url(self): - class TestSpider(self.spider_class): - name = "test" - start_url = "https://www.example.com" - - crawler = get_crawler(TestSpider) - with LogCapture("scrapy.core.engine", propagate=False, level=ERROR) as log: - yield crawler.crawl() - assert "Error while reading start items and requests" in str(log) - assert "did you miss an 's'?" in str(log) - - def test_parse_response_use(self): - class _CrawlSpider(CrawlSpider): - name = "test" - start_urls = "https://www.example.com" - _follow_links = False - - with warnings.catch_warnings(record=True) as w: - spider = _CrawlSpider() - assert len(w) == 0 - spider._parse_response( - TextResponse(spider.start_urls, body=b""), None, None - ) - assert len(w) == 1 - - def test_parse_response_override(self): - class _CrawlSpider(CrawlSpider): - def _parse_response(self, response, callback, cb_kwargs, follow=True): - pass - - name = "test" - start_urls = "https://www.example.com" - _follow_links = False - - with warnings.catch_warnings(record=True) as w: - assert len(w) == 0 - spider = _CrawlSpider() - assert len(w) == 1 - spider._parse_response( - TextResponse(spider.start_urls, body=b""), None, None - ) - assert len(w) == 1 - - def test_parse_with_rules(self): - class _CrawlSpider(CrawlSpider): - name = "test" - start_urls = "https://www.example.com" - - with warnings.catch_warnings(record=True) as w: - spider = _CrawlSpider() - spider.parse_with_rules( - TextResponse(spider.start_urls, body=b""), None, None - ) - assert len(w) == 0 - - -class TestSitemapSpider(TestSpider): - spider_class = SitemapSpider - - BODY = b"SITEMAP" - f = BytesIO() - g = gzip.GzipFile(fileobj=f, mode="w+b") - g.write(BODY) - g.close() - GZBODY = f.getvalue() - - def assertSitemapBody(self, response, body): - crawler = get_crawler() - spider = self.spider_class.from_crawler(crawler, "example.com") - assert spider._get_sitemap_body(response) == body - - def test_get_sitemap_body(self): - r = XmlResponse(url="http://www.example.com/", body=self.BODY) - self.assertSitemapBody(r, self.BODY) - - r = HtmlResponse(url="http://www.example.com/", body=self.BODY) - self.assertSitemapBody(r, None) - - r = Response(url="http://www.example.com/favicon.ico", body=self.BODY) - self.assertSitemapBody(r, None) - - def test_get_sitemap_body_gzip_headers(self): - r = Response( - url="http://www.example.com/sitemap", - body=self.GZBODY, - headers={"content-type": "application/gzip"}, - request=Request("http://www.example.com/sitemap"), - ) - self.assertSitemapBody(r, self.BODY) - - def test_get_sitemap_body_xml_url(self): - r = TextResponse(url="http://www.example.com/sitemap.xml", body=self.BODY) - self.assertSitemapBody(r, self.BODY) - - def test_get_sitemap_body_xml_url_compressed(self): - r = Response( - url="http://www.example.com/sitemap.xml.gz", - body=self.GZBODY, - request=Request("http://www.example.com/sitemap"), - ) - self.assertSitemapBody(r, self.BODY) - - # .xml.gz but body decoded by HttpCompression middleware already - r = Response(url="http://www.example.com/sitemap.xml.gz", body=self.BODY) - self.assertSitemapBody(r, self.BODY) - - def test_get_sitemap_urls_from_robotstxt(self): - robots = b"""# Sitemap files -Sitemap: http://example.com/sitemap.xml -Sitemap: http://example.com/sitemap-product-index.xml -Sitemap: HTTP://example.com/sitemap-uppercase.xml -Sitemap: /sitemap-relative-url.xml -""" - - r = TextResponse(url="http://www.example.com/robots.txt", body=robots) - spider = self.spider_class("example.com") - assert [req.url for req in spider._parse_sitemap(r)] == [ - "http://example.com/sitemap.xml", - "http://example.com/sitemap-product-index.xml", - "http://example.com/sitemap-uppercase.xml", - "http://www.example.com/sitemap-relative-url.xml", - ] - - def test_alternate_url_locs(self): - sitemap = b""" - - - http://www.example.com/english/ - - - - - - """ - r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) - spider = self.spider_class("example.com") - assert [req.url for req in spider._parse_sitemap(r)] == [ - "http://www.example.com/english/" - ] - - spider.sitemap_alternate_links = True - assert [req.url for req in spider._parse_sitemap(r)] == [ - "http://www.example.com/english/", - "http://www.example.com/deutsch/", - "http://www.example.com/schweiz-deutsch/", - "http://www.example.com/italiano/", - ] - - def test_sitemap_filter(self): - sitemap = b""" - - - http://www.example.com/english/ - 2010-01-01 - - - http://www.example.com/portuguese/ - 2005-01-01 - - """ - - class FilteredSitemapSpider(self.spider_class): - def sitemap_filter(self, entries): - from datetime import datetime - - for entry in entries: - date_time = datetime.strptime(entry["lastmod"], "%Y-%m-%d") - if date_time.year > 2008: - yield entry - - r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) - spider = self.spider_class("example.com") - assert [req.url for req in spider._parse_sitemap(r)] == [ - "http://www.example.com/english/", - "http://www.example.com/portuguese/", - ] - - spider = FilteredSitemapSpider("example.com") - assert [req.url for req in spider._parse_sitemap(r)] == [ - "http://www.example.com/english/" - ] - - def test_sitemap_filter_with_alternate_links(self): - sitemap = b""" - - - http://www.example.com/english/article_1/ - 2010-01-01 - - - - http://www.example.com/english/article_2/ - 2015-01-01 - - """ - - class FilteredSitemapSpider(self.spider_class): - def sitemap_filter(self, entries): - for entry in entries: - alternate_links = entry.get("alternate", ()) - for link in alternate_links: - if "/deutsch/" in link: - entry["loc"] = link - yield entry - - r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) - spider = self.spider_class("example.com") - assert [req.url for req in spider._parse_sitemap(r)] == [ - "http://www.example.com/english/article_1/", - "http://www.example.com/english/article_2/", - ] - - spider = FilteredSitemapSpider("example.com") - assert [req.url for req in spider._parse_sitemap(r)] == [ - "http://www.example.com/deutsch/article_1/" - ] - - def test_sitemapindex_filter(self): - sitemap = b""" - - - http://www.example.com/sitemap1.xml - 2004-01-01T20:00:00+00:00 - - - http://www.example.com/sitemap2.xml - 2005-01-01 - - """ - - class FilteredSitemapSpider(self.spider_class): - def sitemap_filter(self, entries): - from datetime import datetime - - for entry in entries: - date_time = datetime.strptime( - entry["lastmod"].split("T")[0], "%Y-%m-%d" - ) - if date_time.year > 2004: - yield entry - - r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) - spider = self.spider_class("example.com") - assert [req.url for req in spider._parse_sitemap(r)] == [ - "http://www.example.com/sitemap1.xml", - "http://www.example.com/sitemap2.xml", - ] - - spider = FilteredSitemapSpider("example.com") - assert [req.url for req in spider._parse_sitemap(r)] == [ - "http://www.example.com/sitemap2.xml" - ] - - def test_compression_bomb_setting(self): - settings = {"DOWNLOAD_MAXSIZE": 10_000_000} - crawler = get_crawler(settings_dict=settings) - spider = self.spider_class.from_crawler(crawler, "example.com") - body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") - body = body_path.read_bytes() - request = Request(url="https://example.com") - response = Response(url="https://example.com", body=body, request=request) - assert spider._get_sitemap_body(response) is None - - def test_compression_bomb_spider_attr(self): - class DownloadMaxSizeSpider(self.spider_class): - download_maxsize = 10_000_000 - - crawler = get_crawler() - spider = DownloadMaxSizeSpider.from_crawler(crawler, "example.com") - body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") - body = body_path.read_bytes() - request = Request(url="https://example.com") - response = Response(url="https://example.com", body=body, request=request) - assert spider._get_sitemap_body(response) is None - - def test_compression_bomb_request_meta(self): - crawler = get_crawler() - spider = self.spider_class.from_crawler(crawler, "example.com") - body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") - body = body_path.read_bytes() - request = Request( - url="https://example.com", meta={"download_maxsize": 10_000_000} - ) - response = Response(url="https://example.com", body=body, request=request) - assert spider._get_sitemap_body(response) is None - - def test_download_warnsize_setting(self): - settings = {"DOWNLOAD_WARNSIZE": 10_000_000} - crawler = get_crawler(settings_dict=settings) - spider = self.spider_class.from_crawler(crawler, "example.com") - body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") - body = body_path.read_bytes() - request = Request(url="https://example.com") - response = Response(url="https://example.com", body=body, request=request) - with LogCapture( - "scrapy.spiders.sitemap", propagate=False, level=WARNING - ) as log: - spider._get_sitemap_body(response) - log.check( - ( - "scrapy.spiders.sitemap", - "WARNING", - ( - "<200 https://example.com> body size after decompression " - "(11511612 B) is larger than the download warning size " - "(10000000 B)." - ), - ), - ) - - def test_download_warnsize_spider_attr(self): - class DownloadWarnSizeSpider(self.spider_class): - download_warnsize = 10_000_000 - - crawler = get_crawler() - spider = DownloadWarnSizeSpider.from_crawler(crawler, "example.com") - body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") - body = body_path.read_bytes() - request = Request( - url="https://example.com", meta={"download_warnsize": 10_000_000} - ) - response = Response(url="https://example.com", body=body, request=request) - with LogCapture( - "scrapy.spiders.sitemap", propagate=False, level=WARNING - ) as log: - spider._get_sitemap_body(response) - log.check( - ( - "scrapy.spiders.sitemap", - "WARNING", - ( - "<200 https://example.com> body size after decompression " - "(11511612 B) is larger than the download warning size " - "(10000000 B)." - ), - ), - ) - - def test_download_warnsize_request_meta(self): - crawler = get_crawler() - spider = self.spider_class.from_crawler(crawler, "example.com") - body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") - body = body_path.read_bytes() - request = Request( - url="https://example.com", meta={"download_warnsize": 10_000_000} - ) - response = Response(url="https://example.com", body=body, request=request) - with LogCapture( - "scrapy.spiders.sitemap", propagate=False, level=WARNING - ) as log: - spider._get_sitemap_body(response) - log.check( - ( - "scrapy.spiders.sitemap", - "WARNING", - ( - "<200 https://example.com> body size after decompression " - "(11511612 B) is larger than the download warning size " - "(10000000 B)." - ), - ), - ) - - @deferred_f_from_coro_f - async def test_sitemap_urls(self): - class TestSpider(self.spider_class): - name = "test" - sitemap_urls = ["https://toscrape.com/sitemap.xml"] - - crawler = get_crawler(TestSpider) - spider = TestSpider.from_crawler(crawler) - with warnings.catch_warnings(): - warnings.simplefilter("error") - requests = [request async for request in spider.start()] - - assert len(requests) == 1 - request = requests[0] - assert request.url == "https://toscrape.com/sitemap.xml" - assert request.dont_filter is False - assert request.callback == spider._parse_sitemap - - -class TestDeprecation: - def test_crawl_spider(self): - assert issubclass(CrawlSpider, Spider) - assert isinstance(CrawlSpider(name="foo"), Spider) - - class TestNoParseMethodSpider: spider_class = Spider diff --git a/tests/test_spider_crawl.py b/tests/test_spider_crawl.py new file mode 100644 index 000000000..63010e195 --- /dev/null +++ b/tests/test_spider_crawl.py @@ -0,0 +1,300 @@ +from __future__ import annotations + +import re +import warnings + +import pytest +from w3lib.url import safe_url_string + +from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.http import HtmlResponse, Request, TextResponse +from scrapy.linkextractors import LinkExtractor +from scrapy.spiders import CrawlSpider, Rule, Spider +from scrapy.utils.test import get_crawler +from tests.test_spider import TestSpider + + +class TestCrawlSpider(TestSpider): + test_body = b"""Page title + +

Item 12

+
+

About us

+
+ + """ + spider_class = CrawlSpider + + def test_rule_without_link_extractor(self): + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) + + class _CrawlSpider(self.spider_class): + name = "test" + allowed_domains = ["example.org"] + rules = (Rule(),) + + spider = _CrawlSpider() + output = list(spider._requests_to_follow(response)) + assert len(output) == 3 + assert all(isinstance(r, Request) for r in output) + assert [r.url for r in output] == [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + "http://example.org/nofollow.html", + ] + + def test_process_links(self): + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) + + class _CrawlSpider(self.spider_class): + name = "test" + allowed_domains = ["example.org"] + rules = (Rule(LinkExtractor(), process_links="dummy_process_links"),) + + def dummy_process_links(self, links): + return links + + spider = _CrawlSpider() + output = list(spider._requests_to_follow(response)) + assert len(output) == 3 + assert all(isinstance(r, Request) for r in output) + assert [r.url for r in output] == [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + "http://example.org/nofollow.html", + ] + + def test_process_links_filter(self): + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) + + class _CrawlSpider(self.spider_class): + name = "test" + allowed_domains = ["example.org"] + rules = (Rule(LinkExtractor(), process_links="filter_process_links"),) + _test_regex = re.compile("nofollow") + + def filter_process_links(self, links): + return [link for link in links if not self._test_regex.search(link.url)] + + spider = _CrawlSpider() + output = list(spider._requests_to_follow(response)) + assert len(output) == 2 + assert all(isinstance(r, Request) for r in output) + assert [r.url for r in output] == [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + ] + + def test_process_links_generator(self): + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) + + class _CrawlSpider(self.spider_class): + name = "test" + allowed_domains = ["example.org"] + rules = (Rule(LinkExtractor(), process_links="dummy_process_links"),) + + def dummy_process_links(self, links): + yield from links + + spider = _CrawlSpider() + output = list(spider._requests_to_follow(response)) + assert len(output) == 3 + assert all(isinstance(r, Request) for r in output) + assert [r.url for r in output] == [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + "http://example.org/nofollow.html", + ] + + def test_process_request(self): + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) + + def process_request_change_domain(request, response): + return request.replace(url=request.url.replace(".org", ".com")) + + class _CrawlSpider(self.spider_class): + name = "test" + allowed_domains = ["example.org"] + rules = ( + Rule(LinkExtractor(), process_request=process_request_change_domain), + ) + + spider = _CrawlSpider() + output = list(spider._requests_to_follow(response)) + assert len(output) == 3 + assert all(isinstance(r, Request) for r in output) + assert [r.url for r in output] == [ + "http://example.com/somepage/item/12.html", + "http://example.com/about.html", + "http://example.com/nofollow.html", + ] + + def test_process_request_with_response(self): + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) + + def process_request_meta_response_class(request, response): + request.meta["response_class"] = response.__class__.__name__ + return request + + class _CrawlSpider(self.spider_class): + name = "test" + allowed_domains = ["example.org"] + rules = ( + Rule( + LinkExtractor(), process_request=process_request_meta_response_class + ), + ) + + spider = _CrawlSpider() + output = list(spider._requests_to_follow(response)) + assert len(output) == 3 + assert all(isinstance(r, Request) for r in output) + assert [r.url for r in output] == [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + "http://example.org/nofollow.html", + ] + assert [r.meta["response_class"] for r in output] == [ + "HtmlResponse", + "HtmlResponse", + "HtmlResponse", + ] + + def test_process_request_instance_method(self): + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) + + class _CrawlSpider(self.spider_class): + name = "test" + allowed_domains = ["example.org"] + rules = (Rule(LinkExtractor(), process_request="process_request_upper"),) + + def process_request_upper(self, request, response): + return request.replace(url=request.url.upper()) + + spider = _CrawlSpider() + output = list(spider._requests_to_follow(response)) + assert len(output) == 3 + assert all(isinstance(r, Request) for r in output) + assert [r.url for r in output] == [ + safe_url_string("http://EXAMPLE.ORG/SOMEPAGE/ITEM/12.HTML"), + safe_url_string("http://EXAMPLE.ORG/ABOUT.HTML"), + safe_url_string("http://EXAMPLE.ORG/NOFOLLOW.HTML"), + ] + + def test_process_request_instance_method_with_response(self): + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) + + class _CrawlSpider(self.spider_class): + name = "test" + allowed_domains = ["example.org"] + rules = ( + Rule( + LinkExtractor(), + process_request="process_request_meta_response_class", + ), + ) + + def process_request_meta_response_class(self, request, response): + request.meta["response_class"] = response.__class__.__name__ + return request + + spider = _CrawlSpider() + output = list(spider._requests_to_follow(response)) + assert len(output) == 3 + assert all(isinstance(r, Request) for r in output) + assert [r.url for r in output] == [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + "http://example.org/nofollow.html", + ] + assert [r.meta["response_class"] for r in output] == [ + "HtmlResponse", + "HtmlResponse", + "HtmlResponse", + ] + + @pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") + def test_follow_links_attribute_population(self): + crawler = get_crawler() + spider = self.spider_class.from_crawler(crawler, "example.com") + assert hasattr(spider, "_follow_links") + assert spider._follow_links + + settings_dict = {"CRAWLSPIDER_FOLLOW_LINKS": False} + crawler = get_crawler(settings_dict=settings_dict) + spider = self.spider_class.from_crawler(crawler, "example.com") + assert hasattr(spider, "_follow_links") + assert not spider._follow_links + + def test_parse_response_use(self): + class _CrawlSpider(CrawlSpider): + name = "test" + start_urls = "https://www.example.com" + _follow_links = False + + with warnings.catch_warnings(): + warnings.simplefilter("error", category=ScrapyDeprecationWarning) + spider = _CrawlSpider() + with pytest.warns( + ScrapyDeprecationWarning, + match=r"CrawlSpider\._parse_response method is deprecated", + ): + spider._parse_response( + TextResponse(spider.start_urls, body=b""), None, None + ) + + def test_parse_response_override(self): + class _CrawlSpider(CrawlSpider): + def _parse_response(self, response, callback, cb_kwargs, follow=True): + pass + + name = "test" + start_urls = "https://www.example.com" + _follow_links = False + + with pytest.warns( + ScrapyDeprecationWarning, + match=r"CrawlSpider\._parse_response method, which the", + ): + spider = _CrawlSpider() + with warnings.catch_warnings(): + warnings.simplefilter("error", category=ScrapyDeprecationWarning) + spider._parse_response( + TextResponse(spider.start_urls, body=b""), None, None + ) + + def test_parse_with_rules(self): + class _CrawlSpider(CrawlSpider): + name = "test" + start_urls = "https://www.example.com" + + with warnings.catch_warnings(): + warnings.simplefilter("error", category=ScrapyDeprecationWarning) + spider = _CrawlSpider() + spider.parse_with_rules( + TextResponse(spider.start_urls, body=b""), None, None + ) + + +class TestDeprecation: + def test_crawl_spider(self): + assert issubclass(CrawlSpider, Spider) + assert isinstance(CrawlSpider(name="foo"), Spider) diff --git a/tests/test_spider_sitemap.py b/tests/test_spider_sitemap.py new file mode 100644 index 000000000..0af99ab6d --- /dev/null +++ b/tests/test_spider_sitemap.py @@ -0,0 +1,437 @@ +from __future__ import annotations + +import gzip +import re +from datetime import datetime +from io import BytesIO +from logging import WARNING +from pathlib import Path + +import pytest +from testfixtures import LogCapture + +from scrapy.http import HtmlResponse, Request, Response, TextResponse, XmlResponse +from scrapy.spiders import SitemapSpider +from scrapy.utils.test import get_crawler +from tests import tests_datadir +from tests.test_spider import TestSpider +from tests.utils.decorators import coroutine_test + + +class TestSitemapSpider(TestSpider): + spider_class = SitemapSpider + + BODY = b"SITEMAP" + f = BytesIO() + g = gzip.GzipFile(fileobj=f, mode="w+b") + g.write(BODY) + g.close() + GZBODY = f.getvalue() + + def assertSitemapBody(self, response: Response, body: bytes | None) -> None: + crawler = get_crawler() + spider = self.spider_class.from_crawler(crawler, "example.com") + assert spider._get_sitemap_body(response) == body + + def test_get_sitemap_body(self): + r = XmlResponse(url="http://www.example.com/", body=self.BODY) + self.assertSitemapBody(r, self.BODY) + + r = HtmlResponse(url="http://www.example.com/", body=self.BODY) + self.assertSitemapBody(r, None) + + r = Response(url="http://www.example.com/favicon.ico", body=self.BODY) + self.assertSitemapBody(r, None) + + r = XmlResponse(url="http://www.example.com/", body=b"") + self.assertSitemapBody(r, b"") + + def test_get_sitemap_body_gzip_headers(self): + r = Response( + url="http://www.example.com/sitemap", + body=self.GZBODY, + headers={"content-type": "application/gzip"}, + request=Request("http://www.example.com/sitemap"), + ) + self.assertSitemapBody(r, self.BODY) + + def test_get_sitemap_body_xml_url(self): + r = TextResponse(url="http://www.example.com/sitemap.xml", body=self.BODY) + self.assertSitemapBody(r, self.BODY) + + def test_get_sitemap_body_xml_url_compressed(self): + r = Response( + url="http://www.example.com/sitemap.xml.gz", + body=self.GZBODY, + request=Request("http://www.example.com/sitemap"), + ) + self.assertSitemapBody(r, self.BODY) + + # .xml.gz but body decoded by HttpCompression middleware already + r = Response(url="http://www.example.com/sitemap.xml.gz", body=self.BODY) + self.assertSitemapBody(r, self.BODY) + + def test_get_sitemap_urls_from_robotstxt(self): + robots = b"""# Sitemap files +Sitemap: http://example.com/sitemap.xml +Sitemap: http://example.com/sitemap-product-index.xml +Sitemap: HTTP://example.com/sitemap-uppercase.xml +Sitemap: /sitemap-relative-url.xml +""" + + r = TextResponse(url="http://www.example.com/robots.txt", body=robots) + spider = self.spider_class("example.com") + assert [req.url for req in spider._parse_sitemap(r)] == [ + "http://example.com/sitemap.xml", + "http://example.com/sitemap-product-index.xml", + "http://example.com/sitemap-uppercase.xml", + "http://www.example.com/sitemap-relative-url.xml", + ] + + def test_get_sitemap_urls_from_robotstxt_skips_invalid_utf8_urls(self): + robots = ( + b"User-agent: *\n" + b"Sitemap: http://example.com/\xff.xml\n" + b"Sitemap: http://example.com/ok.xml\n" + ) + + r = TextResponse(url="http://www.example.com/robots.txt", body=robots) + spider = self.spider_class("example.com") + + assert [req.url for req in spider._parse_sitemap(r)] == [ + "http://example.com/ok.xml", + ] + + def test_alternate_url_locs(self): + sitemap = b""" + + + http://www.example.com/english/ + + + + + + """ + r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) + spider = self.spider_class("example.com") + assert [req.url for req in spider._parse_sitemap(r)] == [ + "http://www.example.com/english/" + ] + + spider.sitemap_alternate_links = True + assert [req.url for req in spider._parse_sitemap(r)] == [ + "http://www.example.com/english/", + "http://www.example.com/deutsch/", + "http://www.example.com/schweiz-deutsch/", + "http://www.example.com/italiano/", + ] + + def test_sitemap_filter(self): + sitemap = b""" + + + http://www.example.com/english/ + 2010-01-01 + + + http://www.example.com/portuguese/ + 2005-01-01 + + """ + + class FilteredSitemapSpider(self.spider_class): + def sitemap_filter(self, entries): + for entry in entries: + date_time = datetime.strptime(entry["lastmod"], "%Y-%m-%d") + if date_time.year > 2008: + yield entry + + r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) + spider = self.spider_class("example.com") + assert [req.url for req in spider._parse_sitemap(r)] == [ + "http://www.example.com/english/", + "http://www.example.com/portuguese/", + ] + + spider = FilteredSitemapSpider("example.com") + assert [req.url for req in spider._parse_sitemap(r)] == [ + "http://www.example.com/english/" + ] + + def test_sitemap_filter_with_alternate_links(self): + sitemap = b""" + + + http://www.example.com/english/article_1/ + 2010-01-01 + + + + http://www.example.com/english/article_2/ + 2015-01-01 + + """ + + class FilteredSitemapSpider(self.spider_class): + def sitemap_filter(self, entries): + for entry in entries: + alternate_links = entry.get("alternate", ()) + for link in alternate_links: + if "/deutsch/" in link: + entry["loc"] = link + yield entry + + r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) + spider = self.spider_class("example.com") + assert [req.url for req in spider._parse_sitemap(r)] == [ + "http://www.example.com/english/article_1/", + "http://www.example.com/english/article_2/", + ] + + spider = FilteredSitemapSpider("example.com") + assert [req.url for req in spider._parse_sitemap(r)] == [ + "http://www.example.com/deutsch/article_1/" + ] + + def test_sitemapindex_filter(self): + sitemap = b""" + + + http://www.example.com/sitemap1.xml + 2004-01-01T20:00:00+00:00 + + + http://www.example.com/sitemap2.xml + 2005-01-01 + + """ + + class FilteredSitemapSpider(self.spider_class): + def sitemap_filter(self, entries): + for entry in entries: + date_time = datetime.strptime( + entry["lastmod"].split("T")[0], "%Y-%m-%d" + ) + if date_time.year > 2004: + yield entry + + r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) + spider = self.spider_class("example.com") + assert [req.url for req in spider._parse_sitemap(r)] == [ + "http://www.example.com/sitemap1.xml", + "http://www.example.com/sitemap2.xml", + ] + + spider = FilteredSitemapSpider("example.com") + assert [req.url for req in spider._parse_sitemap(r)] == [ + "http://www.example.com/sitemap2.xml" + ] + + @pytest.mark.parametrize( + ("rule", "result"), + [(r"english", ["http://www.example.com/english/"]), (r"nonexistent", [])], + ) + def test_sitemap_filter_with_rule(self, rule: str, result: list[str]): + sitemap = b""" + + http://www.example.com/english/ + http://www.example.com/portuguese/ + """ + r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) + + class _RuleSpider(self.spider_class): # type: ignore[name-defined,misc] + sitemap_rules = [(rule, "parse")] + + spider = _RuleSpider("example.com") + urls = [req.url for req in spider._parse_sitemap(r)] + assert urls == result + + def test_parse_sitemap_empty_body(self): + r = XmlResponse(url="http://www.example.com/sitemap.xml", body=b"") + spider = self.spider_class("example.com") + + with LogCapture() as lc: + results = list(spider._parse_sitemap(r)) + + assert not results + + lc.check( + ( + "scrapy.spiders.sitemap", + "WARNING", + "Ignoring invalid sitemap: <200 http://www.example.com/sitemap.xml>", + ) + ) + + def test_parse_sitemap_not_sitemap(self): + body = b""" + + sometext + sometext2 + """ + r = XmlResponse(url="http://www.example.com/random.xml", body=body) + spider = self.spider_class("example.com") + + results = list(spider._parse_sitemap(r)) + + assert not results + + @pytest.mark.parametrize( + ("follow", "result"), + [ + (r"1.xml", ["http://www.example.com/sitemap1.xml"]), + (re.compile(r"sitemap\d"), ["http://www.example.com/sitemap1.xml"]), + (r"nonexistent", []), + ], + ) + def test_sitemap_follow(self, follow, result): + sitemap = b""" + + + http://www.example.com/sitemap1.xml + + """ + r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) + + class _FollowSpider(self.spider_class): + sitemap_follow = [follow] + + spider = _FollowSpider("example.com") + urls = [req.url for req in spider._parse_sitemap(r)] + assert urls == result + + def test_compression_bomb_setting(self): + settings = {"DOWNLOAD_MAXSIZE": 10_000_000} + crawler = get_crawler(settings_dict=settings) + spider = self.spider_class.from_crawler(crawler, "example.com") + body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") + body = body_path.read_bytes() + request = Request(url="https://example.com") + response = Response(url="https://example.com", body=body, request=request) + assert spider._get_sitemap_body(response) is None + + @pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") + def test_compression_bomb_spider_attr(self): + class DownloadMaxSizeSpider(self.spider_class): + download_maxsize = 10_000_000 + + crawler = get_crawler() + spider = DownloadMaxSizeSpider.from_crawler(crawler, "example.com") + body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") + body = body_path.read_bytes() + request = Request(url="https://example.com") + response = Response(url="https://example.com", body=body, request=request) + assert spider._get_sitemap_body(response) is None + + def test_compression_bomb_request_meta(self): + crawler = get_crawler() + spider = self.spider_class.from_crawler(crawler, "example.com") + body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") + body = body_path.read_bytes() + request = Request( + url="https://example.com", meta={"download_maxsize": 10_000_000} + ) + response = Response(url="https://example.com", body=body, request=request) + assert spider._get_sitemap_body(response) is None + + def test_download_warnsize_setting(self): + settings = {"DOWNLOAD_WARNSIZE": 10_000_000} + crawler = get_crawler(settings_dict=settings) + spider = self.spider_class.from_crawler(crawler, "example.com") + body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") + body = body_path.read_bytes() + request = Request(url="https://example.com") + response = Response(url="https://example.com", body=body, request=request) + with LogCapture( + "scrapy.spiders.sitemap", propagate=False, level=WARNING + ) as log: + spider._get_sitemap_body(response) + log.check( + ( + "scrapy.spiders.sitemap", + "WARNING", + ( + "<200 https://example.com> body size after decompression " + "(11511612 B) is larger than the download warning size " + "(10000000 B)." + ), + ), + ) + + @pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") + def test_download_warnsize_spider_attr(self): + class DownloadWarnSizeSpider(self.spider_class): + download_warnsize = 10_000_000 + + crawler = get_crawler() + spider = DownloadWarnSizeSpider.from_crawler(crawler, "example.com") + body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") + body = body_path.read_bytes() + request = Request( + url="https://example.com", meta={"download_warnsize": 10_000_000} + ) + response = Response(url="https://example.com", body=body, request=request) + with LogCapture( + "scrapy.spiders.sitemap", propagate=False, level=WARNING + ) as log: + spider._get_sitemap_body(response) + log.check( + ( + "scrapy.spiders.sitemap", + "WARNING", + ( + "<200 https://example.com> body size after decompression " + "(11511612 B) is larger than the download warning size " + "(10000000 B)." + ), + ), + ) + + def test_download_warnsize_request_meta(self): + crawler = get_crawler() + spider = self.spider_class.from_crawler(crawler, "example.com") + body_path = Path(tests_datadir, "compressed", "bomb-gzip.bin") + body = body_path.read_bytes() + request = Request( + url="https://example.com", meta={"download_warnsize": 10_000_000} + ) + response = Response(url="https://example.com", body=body, request=request) + with LogCapture( + "scrapy.spiders.sitemap", propagate=False, level=WARNING + ) as log: + spider._get_sitemap_body(response) + log.check( + ( + "scrapy.spiders.sitemap", + "WARNING", + ( + "<200 https://example.com> body size after decompression " + "(11511612 B) is larger than the download warning size " + "(10000000 B)." + ), + ), + ) + + @coroutine_test + async def test_sitemap_urls(self): + class TestSpider(self.spider_class): + name = "test" + sitemap_urls = ["https://toscrape.com/sitemap.xml"] + + crawler = get_crawler(TestSpider) + spider = TestSpider.from_crawler(crawler) + requests = [request async for request in spider.start()] + + assert len(requests) == 1 + request = requests[0] + assert request.url == "https://toscrape.com/sitemap.xml" + assert request.dont_filter is False + assert request.callback == spider._parse_sitemap diff --git a/tests/test_spider_start.py b/tests/test_spider_start.py index 3c7fc65d5..9257e0232 100644 --- a/tests/test_spider_start.py +++ b/tests/test_spider_start.py @@ -1,16 +1,16 @@ -import warnings +from __future__ import annotations + from asyncio import sleep +from typing import Any import pytest -from testfixtures import LogCapture -from twisted.trial.unittest import TestCase from scrapy import Spider, signals -from scrapy.exceptions import ScrapyDeprecationWarning -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future +from scrapy.utils.defer import maybe_deferred_to_future from scrapy.utils.test import get_crawler from .utils import twisted_sleep +from .utils.decorators import coroutine_test SLEEP_SECONDS = 0.1 @@ -18,8 +18,10 @@ ITEM_A = {"id": "a"} ITEM_B = {"id": "b"} -class TestMain(TestCase): - async def _test_spider(self, spider, expected_items=None): +class TestMain: + async def _test_spider( + self, spider: type[Spider], expected_items: list[Any] | None = None + ) -> None: actual_items = [] expected_items = [] if expected_items is None else expected_items @@ -28,11 +30,12 @@ class TestMain(TestCase): crawler = get_crawler(spider) crawler.signals.connect(track_item, signals.item_scraped) - await maybe_deferred_to_future(crawler.crawl()) + await crawler.crawl_async() + assert crawler.stats assert crawler.stats.get_value("finish_reason") == "finished" assert actual_items == expected_items - @deferred_f_from_coro_f + @coroutine_test async def test_start_urls(self): class TestSpider(Spider): name = "test" @@ -41,11 +44,9 @@ class TestMain(TestCase): async def parse(self, response): yield ITEM_A - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_spider(TestSpider, [ITEM_A]) + await self._test_spider(TestSpider, [ITEM_A]) - @deferred_f_from_coro_f + @coroutine_test async def test_start(self): class TestSpider(Spider): name = "test" @@ -53,11 +54,9 @@ class TestMain(TestCase): async def start(self): yield ITEM_A - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_spider(TestSpider, [ITEM_A]) + await self._test_spider(TestSpider, [ITEM_A]) - @deferred_f_from_coro_f + @coroutine_test async def test_start_subclass(self): class BaseSpider(Spider): async def start(self): @@ -66,79 +65,7 @@ class TestMain(TestCase): class TestSpider(BaseSpider): name = "test" - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_spider(TestSpider, [ITEM_A]) - - @deferred_f_from_coro_f - async def test_deprecated(self): - class TestSpider(Spider): - name = "test" - - def start_requests(self): - yield ITEM_A - - with pytest.warns(ScrapyDeprecationWarning): - await self._test_spider(TestSpider, [ITEM_A]) - - @deferred_f_from_coro_f - async def test_deprecated_subclass(self): - class BaseSpider(Spider): - def start_requests(self): - yield ITEM_A - - class TestSpider(BaseSpider): - name = "test" - - # The warning must be about the base class and not the subclass. - with pytest.warns(ScrapyDeprecationWarning, match="BaseSpider"): - await self._test_spider(TestSpider, [ITEM_A]) - - @deferred_f_from_coro_f - async def test_universal(self): - class TestSpider(Spider): - name = "test" - - async def start(self): - yield ITEM_A - - def start_requests(self): - yield ITEM_B - - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_spider(TestSpider, [ITEM_A]) - - @deferred_f_from_coro_f - async def test_universal_subclass(self): - class BaseSpider(Spider): - async def start(self): - yield ITEM_A - - def start_requests(self): - yield ITEM_B - - class TestSpider(BaseSpider): - name = "test" - - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_spider(TestSpider, [ITEM_A]) - - @deferred_f_from_coro_f - async def test_start_deprecated_super(self): - class TestSpider(Spider): - name = "test" - - async def start(self): - for item_or_request in super().start_requests(): - yield item_or_request - - with pytest.warns( - ScrapyDeprecationWarning, match=r"use Spider\.start\(\) instead" - ) as messages: - await self._test_spider(TestSpider, []) - assert messages[0].filename.endswith("test_spider_start.py") + await self._test_spider(TestSpider, [ITEM_A]) async def _test_start(self, start_, expected_items=None): class TestSpider(Spider): @@ -148,7 +75,7 @@ class TestMain(TestCase): await self._test_spider(TestSpider, expected_items) @pytest.mark.only_asyncio - @deferred_f_from_coro_f + @coroutine_test async def test_asyncio_delayed(self): async def start(spider): await sleep(SLEEP_SECONDS) @@ -156,31 +83,11 @@ class TestMain(TestCase): await self._test_start(start, [ITEM_A]) - @deferred_f_from_coro_f + @pytest.mark.requires_reactor # needs a reactor for twisted_sleep() + @coroutine_test async def test_twisted_delayed(self): async def start(spider): await maybe_deferred_to_future(twisted_sleep(SLEEP_SECONDS)) yield ITEM_A await self._test_start(start, [ITEM_A]) - - # Exceptions - - @deferred_f_from_coro_f - async def test_deprecated_non_generator_exception(self): - class TestSpider(Spider): - name = "test" - - def start_requests(self): - raise RuntimeError - - with ( - LogCapture() as log, - pytest.warns( - ScrapyDeprecationWarning, - match=r"defines the deprecated start_requests\(\) method", - ), - ): - await self._test_spider(TestSpider, []) - - assert "in start_requests\n raise RuntimeError" in str(log) diff --git a/tests/test_spiderloader/__init__.py b/tests/test_spiderloader/__init__.py index 245507c0b..d85942f90 100644 --- a/tests/test_spiderloader/__init__.py +++ b/tests/test_spiderloader/__init__.py @@ -1,7 +1,6 @@ import contextlib import shutil import sys -import warnings from pathlib import Path from unittest import mock @@ -137,50 +136,38 @@ class TestSpiderLoader: SpiderLoader.from_settings(settings) def test_bad_spider_modules_warning(self): - with warnings.catch_warnings(record=True) as w: - module = "tests.test_spiderloader.test_spiders.doesnotexist" - settings = Settings( - {"SPIDER_MODULES": [module], "SPIDER_LOADER_WARN_ONLY": True} - ) + module = "tests.test_spiderloader.test_spiders.doesnotexist" + settings = Settings( + {"SPIDER_MODULES": [module], "SPIDER_LOADER_WARN_ONLY": True} + ) + with pytest.warns(RuntimeWarning, match="Could not load spiders from module"): spider_loader = SpiderLoader.from_settings(settings) - if str(w[0].message).startswith("_SixMetaPathImporter"): - # needed on 3.10 because of https://github.com/benjaminp/six/issues/349, - # at least until all six versions we can import (including botocore.vendored.six) - # are updated to 1.16.0+ - w.pop(0) - assert "Could not load spiders from module" in str(w[0].message) - spiders = spider_loader.list() - assert not spiders + spiders = spider_loader.list() + assert not spiders def test_syntax_error_exception(self): module = "tests.test_spiderloader.test_spiders.spider1" + settings = Settings({"SPIDER_MODULES": [module]}) with mock.patch.object(SpiderLoader, "_load_spiders") as m: m.side_effect = SyntaxError - settings = Settings({"SPIDER_MODULES": [module]}) with pytest.raises(SyntaxError): SpiderLoader.from_settings(settings) def test_syntax_error_warning(self): - with ( - warnings.catch_warnings(record=True) as w, - mock.patch.object(SpiderLoader, "_load_spiders") as m, - ): + module = "tests.test_spiderloader.test_spiders.spider1" + settings = Settings( + {"SPIDER_MODULES": [module], "SPIDER_LOADER_WARN_ONLY": True} + ) + with mock.patch.object(SpiderLoader, "_load_spiders") as m: m.side_effect = SyntaxError - module = "tests.test_spiderloader.test_spiders.spider1" - settings = Settings( - {"SPIDER_MODULES": [module], "SPIDER_LOADER_WARN_ONLY": True} - ) - spider_loader = SpiderLoader.from_settings(settings) - if str(w[0].message).startswith("_SixMetaPathImporter"): - # needed on 3.10 because of https://github.com/benjaminp/six/issues/349, - # at least until all six versions we can import (including botocore.vendored.six) - # are updated to 1.16.0+ - w.pop(0) - assert "Could not load spiders from module" in str(w[0].message) + with pytest.warns( + RuntimeWarning, match="Could not load spiders from module" + ): + spider_loader = SpiderLoader.from_settings(settings) - spiders = spider_loader.list() - assert not spiders + spiders = spider_loader.list() + assert not spiders class TestDuplicateSpiderNameLoader: @@ -190,21 +177,17 @@ class TestDuplicateSpiderNameLoader: # copy 1 spider module so as to have duplicate spider name shutil.copyfile(spiders_dir / "spider3.py", spiders_dir / "spider3dupe.py") - with warnings.catch_warnings(record=True) as w: + msg = r"""There are several spiders with the same name: + + Spider3 named 'spider3' \(in test_spiders_xxx\.spider3\) + + Spider3 named 'spider3' \(in test_spiders_xxx\.spider3dupe\) + + This can cause unexpected behavior\.""" + with pytest.warns(UserWarning, match=msg): spider_loader = SpiderLoader.from_settings(settings) - - assert len(w) == 1 - msg = str(w[0].message) - assert "several spiders with the same name" in msg - assert "'spider3'" in msg - assert msg.count("'spider3'") == 2 - - assert "'spider1'" not in msg - assert "'spider2'" not in msg - assert "'spider4'" not in msg - - spiders = set(spider_loader.list()) - assert spiders == {"spider1", "spider2", "spider3", "spider4"} + spiders = set(spider_loader.list()) + assert spiders == {"spider1", "spider2", "spider3", "spider4"} def test_multiple_dupename_warning(self, spider_loader_env): settings, spiders_dir = spider_loader_env @@ -213,23 +196,21 @@ class TestDuplicateSpiderNameLoader: shutil.copyfile(spiders_dir / "spider1.py", spiders_dir / "spider1dupe.py") shutil.copyfile(spiders_dir / "spider2.py", spiders_dir / "spider2dupe.py") - with warnings.catch_warnings(record=True) as w: + msg = r"""There are several spiders with the same name: + + Spider1 named 'spider1' \(in test_spiders_xxx\.spider1\) + + Spider1 named 'spider1' \(in test_spiders_xxx\.spider1dupe\) + + Spider2 named 'spider2' \(in test_spiders_xxx\.spider2\) + + Spider2 named 'spider2' \(in test_spiders_xxx\.spider2dupe\) + + This can cause unexpected behavior\.""" + with pytest.warns(UserWarning, match=msg): spider_loader = SpiderLoader.from_settings(settings) - - assert len(w) == 1 - msg = str(w[0].message) - assert "several spiders with the same name" in msg - assert "'spider1'" in msg - assert msg.count("'spider1'") == 2 - - assert "'spider2'" in msg - assert msg.count("'spider2'") == 2 - - assert "'spider3'" not in msg - assert "'spider4'" not in msg - - spiders = set(spider_loader.list()) - assert spiders == {"spider1", "spider2", "spider3", "spider4"} + spiders = set(spider_loader.list()) + assert spiders == {"spider1", "spider2", "spider3", "spider4"} class CustomSpiderLoader(SpiderLoader): @@ -252,3 +233,4 @@ def test_dummy_spider_loader(spider_loader_env): assert not spider_loader.list() with pytest.raises(KeyError): spider_loader.load("spider1") + assert not spider_loader.find_by_request(Request("http://example.com")) diff --git a/tests/test_spidermiddleware.py b/tests/test_spidermiddleware.py index 28ffbe767..e5891474b 100644 --- a/tests/test_spidermiddleware.py +++ b/tests/test_spidermiddleware.py @@ -2,53 +2,59 @@ from __future__ import annotations from collections.abc import AsyncIterator, Iterable from inspect import isasyncgen -from typing import Any +from typing import TYPE_CHECKING, Any, cast from unittest import mock import pytest -from testfixtures import LogCapture from twisted.internet import defer -from twisted.trial.unittest import TestCase from scrapy.core.spidermw import SpiderMiddlewareManager -from scrapy.exceptions import _InvalidOutput +from scrapy.exceptions import ScrapyDeprecationWarning, _InvalidOutput from scrapy.http import Request, Response from scrapy.spiders import Spider from scrapy.utils.asyncgen import collect_asyncgen -from scrapy.utils.defer import ( - deferred_f_from_coro_f, - maybe_deferred_to_future, -) +from scrapy.utils.asyncio import call_later +from scrapy.utils.defer import maybe_deferred_to_future +from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + from twisted.python.failure import Failure + + from scrapy.crawler import Crawler -class TestSpiderMiddleware(TestCase): - def setUp(self): +class TestSpiderMiddleware: + def setup_method(self) -> None: self.request = Request("http://example.com/index.html") self.response = Response(self.request.url, request=self.request) self.crawler = get_crawler(Spider, {"SPIDER_MIDDLEWARES_BASE": {}}) - self.spider = self.crawler._create_spider("foo") + self.crawler.spider = self.crawler._create_spider("foo") self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) async def _scrape_response(self) -> Any: - """Execute spider mw manager's scrape_response method and return the result. + """Execute spider mw manager's scrape_response_async method and return the result. Raise exception in case of failure. """ - scrape_func = mock.MagicMock() - return await maybe_deferred_to_future( - self.mwman.scrape_response( - scrape_func, self.response, self.request, self.spider - ) + + async def scrape_func( + response: Response | Failure, request: Request + ) -> Iterable[Any]: + return mock.MagicMock() + + return await self.mwman.scrape_response_async( + scrape_func, self.response, self.request ) class TestProcessSpiderInputInvalidOutput(TestSpiderMiddleware): """Invalid return value for process_spider_input method""" - @deferred_f_from_coro_f + @coroutine_test async def test_invalid_process_spider_input(self): class InvalidProcessSpiderInputMiddleware: - def process_spider_input(self, response, spider): + def process_spider_input(self, response): return 1 self.mwman._add_middleware(InvalidProcessSpiderInputMiddleware()) @@ -56,56 +62,46 @@ class TestProcessSpiderInputInvalidOutput(TestSpiderMiddleware): await self._scrape_response() -class TestProcessSpiderOutputInvalidOutput(TestSpiderMiddleware): - """Invalid return value for process_spider_output method""" - - @deferred_f_from_coro_f - async def test_invalid_process_spider_output(self): - class InvalidProcessSpiderOutputMiddleware: - def process_spider_output(self, response, result, spider): - return 1 - - self.mwman._add_middleware(InvalidProcessSpiderOutputMiddleware()) - with pytest.raises(_InvalidOutput): - await self._scrape_response() - - class TestProcessSpiderExceptionInvalidOutput(TestSpiderMiddleware): """Invalid return value for process_spider_exception method""" - @deferred_f_from_coro_f + @coroutine_test async def test_invalid_process_spider_exception(self): class InvalidProcessSpiderOutputExceptionMiddleware: - def process_spider_exception(self, response, exception, spider): + def process_spider_exception(self, response, exception): return 1 class RaiseExceptionProcessSpiderOutputMiddleware: - def process_spider_output(self, response, result, spider): + async def process_spider_output(self, response, result): raise RuntimeError + yield # pylint: disable=unreachable self.mwman._add_middleware(InvalidProcessSpiderOutputExceptionMiddleware()) self.mwman._add_middleware(RaiseExceptionProcessSpiderOutputMiddleware()) + it = await self._scrape_response() with pytest.raises(_InvalidOutput): - await self._scrape_response() + await collect_asyncgen(it) class TestProcessSpiderExceptionReRaise(TestSpiderMiddleware): """Re raise the exception by returning None""" - @deferred_f_from_coro_f + @coroutine_test async def test_process_spider_exception_return_none(self): class ProcessSpiderExceptionReturnNoneMiddleware: - def process_spider_exception(self, response, exception, spider): + def process_spider_exception(self, response, exception): return None class RaiseExceptionProcessSpiderOutputMiddleware: - def process_spider_output(self, response, result, spider): + async def process_spider_output(self, response, result): 1 / 0 + yield self.mwman._add_middleware(ProcessSpiderExceptionReturnNoneMiddleware()) self.mwman._add_middleware(RaiseExceptionProcessSpiderOutputMiddleware()) + it = await self._scrape_response() with pytest.raises(ZeroDivisionError): - await self._scrape_response() + await collect_asyncgen(it) class TestBaseAsyncSpiderMiddleware(TestSpiderMiddleware): @@ -114,95 +110,84 @@ class TestBaseAsyncSpiderMiddleware(TestSpiderMiddleware): Should work for process_spider_output and, when it's supported, process_start. """ - ITEM_TYPE: type | tuple + ITEM_TYPE: type | tuple[type, ...] RESULT_COUNT = 3 # to simplify checks, let everything return 3 objects @staticmethod - def _construct_mw_setting(*mw_classes, start_index: int | None = None): + def _construct_mw_setting( + *mw_classes: type[Any], start_index: int | None = None + ) -> dict[type[Any], int]: if start_index is None: start_index = 10 return {i: c for c, i in enumerate(mw_classes, start=start_index)} - def _scrape_func(self, *args, **kwargs): + def _callback(self) -> Any: yield {"foo": 1} yield {"foo": 2} yield {"foo": 3} - async def _get_middleware_result(self, *mw_classes, start_index: int | None = None): + async def _scrape_func( + self, response: Response | Failure, request: Request + ) -> Iterable[Any] | AsyncIterator[Any]: + return cast("Iterable[Any] | AsyncIterator[Any]", self._callback()) + + async def _get_middleware_result( + self, *mw_classes: type[Any], start_index: int | None = None + ) -> Any: setting = self._construct_mw_setting(*mw_classes, start_index=start_index) self.crawler = get_crawler( Spider, {"SPIDER_MIDDLEWARES_BASE": {}, "SPIDER_MIDDLEWARES": setting} ) - self.spider = self.crawler._create_spider("foo") + self.crawler.spider = self.crawler._create_spider("foo") self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) return await self.mwman.scrape_response_async( - self._scrape_func, self.response, self.request, self.spider - ) - - async def _test_simple_base( - self, *mw_classes, downgrade: bool = False, start_index: int | None = None - ): - with LogCapture() as log: - result = await self._get_middleware_result( - *mw_classes, start_index=start_index - ) - assert isinstance(result, Iterable) - result_list = list(result) - assert len(result_list) == self.RESULT_COUNT - assert isinstance(result_list[0], self.ITEM_TYPE) - assert ("downgraded to a non-async" in str(log)) == downgrade - assert ("doesn't support asynchronous spider output" in str(log)) == ( - ProcessSpiderOutputSimpleMiddleware in mw_classes + self._scrape_func, self.response, self.request ) async def _test_asyncgen_base( - self, *mw_classes, downgrade: bool = False, start_index: int | None = None - ): - with LogCapture() as log: - result = await self._get_middleware_result( - *mw_classes, start_index=start_index - ) + self, + *mw_classes: type[Any], + start_index: int | None = None, + ) -> None: + result = await self._get_middleware_result(*mw_classes, start_index=start_index) assert isinstance(result, AsyncIterator) result_list = await collect_asyncgen(result) assert len(result_list) == self.RESULT_COUNT assert isinstance(result_list[0], self.ITEM_TYPE) - assert ("downgraded to a non-async" in str(log)) == downgrade -class ProcessSpiderOutputSimpleMiddleware: - def process_spider_output(self, response, result, spider): +class ProcessSpiderOutputSyncMiddleware: + def process_spider_output(self, response, result): yield from result class ProcessSpiderOutputAsyncGenMiddleware: - async def process_spider_output(self, response, result, spider): + async def process_spider_output(self, response, result): async for r in result: yield r class ProcessSpiderOutputUniversalMiddleware: - def process_spider_output(self, response, result, spider): + def process_spider_output(self, response, result): yield from result - async def process_spider_output_async(self, response, result, spider): + async def process_spider_output_async(self, response, result): async for r in result: yield r class ProcessSpiderExceptionSimpleIterableMiddleware: - def process_spider_exception(self, response, exception, spider): + def process_spider_exception(self, response, exception): yield {"foo": 1} yield {"foo": 2} yield {"foo": 3} class ProcessSpiderExceptionAsyncIteratorMiddleware: - async def process_spider_exception(self, response, exception, spider): + async def process_spider_exception(self, response, exception): yield {"foo": 1} d = defer.Deferred() - from twisted.internet import reactor - - reactor.callLater(0, d.callback, None) + call_later(0, d.callback, None) await maybe_deferred_to_future(d) yield {"foo": 2} yield {"foo": 3} @@ -212,116 +197,46 @@ class TestProcessSpiderOutputSimple(TestBaseAsyncSpiderMiddleware): """process_spider_output tests for simple callbacks""" ITEM_TYPE = dict - MW_SIMPLE = ProcessSpiderOutputSimpleMiddleware + MW_SYNC = ProcessSpiderOutputSyncMiddleware MW_ASYNCGEN = ProcessSpiderOutputAsyncGenMiddleware MW_UNIVERSAL = ProcessSpiderOutputUniversalMiddleware - @deferred_f_from_coro_f - async def test_simple(self): - """Simple mw""" - await self._test_simple_base(self.MW_SIMPLE) + @coroutine_test + async def test_sync(self): + """Unsupported sync mw""" + with pytest.raises( + TypeError, match=r"doesn't support asynchronous spider output" + ): + await self._get_middleware_result(self.MW_SYNC) - @deferred_f_from_coro_f + @coroutine_test async def test_asyncgen(self): - """Asyncgen mw; upgrade""" + """Asyncgen mw""" await self._test_asyncgen_base(self.MW_ASYNCGEN) - @deferred_f_from_coro_f - async def test_simple_asyncgen(self): - """Simple mw -> asyncgen mw; upgrade""" - await self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_SIMPLE) - - @deferred_f_from_coro_f - async def test_asyncgen_simple(self): - """Asyncgen mw -> simple mw; upgrade then downgrade""" - await self._test_simple_base(self.MW_SIMPLE, self.MW_ASYNCGEN, downgrade=True) - - @deferred_f_from_coro_f + @coroutine_test async def test_universal(self): """Universal mw""" - await self._test_simple_base(self.MW_UNIVERSAL) + await self._test_asyncgen_base(self.MW_UNIVERSAL) - @deferred_f_from_coro_f - async def test_universal_simple(self): - """Universal mw -> simple mw""" - await self._test_simple_base(self.MW_SIMPLE, self.MW_UNIVERSAL) - - @deferred_f_from_coro_f - async def test_simple_universal(self): - """Simple mw -> universal mw""" - await self._test_simple_base(self.MW_UNIVERSAL, self.MW_SIMPLE) - - @deferred_f_from_coro_f + @coroutine_test async def test_universal_asyncgen(self): - """Universal mw -> asyncgen mw; upgrade""" + """Universal mw -> asyncgen mw""" await self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_UNIVERSAL) - @deferred_f_from_coro_f + @coroutine_test async def test_asyncgen_universal(self): - """Asyncgen mw -> universal mw; upgrade""" + """Asyncgen mw -> universal mw""" await self._test_asyncgen_base(self.MW_UNIVERSAL, self.MW_ASYNCGEN) class TestProcessSpiderOutputAsyncGen(TestProcessSpiderOutputSimple): """process_spider_output tests for async generator callbacks""" - async def _scrape_func(self, *args, **kwargs): - for item in super()._scrape_func(): + async def _callback(self) -> Any: + for item in super()._callback(): yield item - @deferred_f_from_coro_f - async def test_simple(self): - """Simple mw; downgrade""" - await self._test_simple_base(self.MW_SIMPLE, downgrade=True) - - @deferred_f_from_coro_f - async def test_simple_asyncgen(self): - """Simple mw -> asyncgen mw; downgrade then upgrade""" - await self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_SIMPLE, downgrade=True) - - @deferred_f_from_coro_f - async def test_universal(self): - """Universal mw""" - await self._test_asyncgen_base(self.MW_UNIVERSAL) - - @deferred_f_from_coro_f - async def test_universal_simple(self): - """Universal mw -> simple mw; downgrade""" - await self._test_simple_base(self.MW_SIMPLE, self.MW_UNIVERSAL, downgrade=True) - - @deferred_f_from_coro_f - async def test_simple_universal(self): - """Simple mw -> universal mw; downgrade""" - await self._test_simple_base(self.MW_UNIVERSAL, self.MW_SIMPLE, downgrade=True) - - -class ProcessSpiderOutputNonIterableMiddleware: - def process_spider_output(self, response, result, spider): - return - - -class ProcessSpiderOutputCoroutineMiddleware: - async def process_spider_output(self, response, result, spider): - return result - - -class TestProcessSpiderOutputInvalidResult(TestBaseAsyncSpiderMiddleware): - @deferred_f_from_coro_f - async def test_non_iterable(self): - with pytest.raises( - _InvalidOutput, - match=r"\.process_spider_output must return an iterable, got ", - ): - await self._get_middleware_result(ProcessSpiderOutputNonIterableMiddleware) - - @deferred_f_from_coro_f - async def test_coroutine(self): - with pytest.raises( - _InvalidOutput, - match=r"\.process_spider_output must be an asynchronous generator", - ): - await self._get_middleware_result(ProcessSpiderOutputCoroutineMiddleware) - class ProcessStartSimpleMiddleware: async def process_start(self, start): @@ -335,7 +250,9 @@ class TestProcessStartSimple(TestBaseAsyncSpiderMiddleware): ITEM_TYPE = (Request, dict) MW_SIMPLE = ProcessStartSimpleMiddleware - async def _get_processed_start(self, *mw_classes): + async def _get_processed_start( + self, *mw_classes: type[Any] + ) -> AsyncIterator[Any] | None: class TestSpider(Spider): name = "test" @@ -348,11 +265,11 @@ class TestProcessStartSimple(TestBaseAsyncSpiderMiddleware): self.crawler = get_crawler( TestSpider, {"SPIDER_MIDDLEWARES_BASE": {}, "SPIDER_MIDDLEWARES": setting} ) - self.spider = self.crawler._create_spider() + self.crawler.spider = self.crawler._create_spider() self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) - return await self.mwman.process_start(self.spider) + return await self.mwman.process_start() - @deferred_f_from_coro_f + @coroutine_test async def test_simple(self): """Simple mw""" start = await self._get_processed_start(self.MW_SIMPLE) @@ -363,209 +280,219 @@ class TestProcessStartSimple(TestBaseAsyncSpiderMiddleware): class UniversalMiddlewareNoSync: - async def process_spider_output_async(self, response, result, spider): + async def process_spider_output_async(self, response, result): yield class UniversalMiddlewareBothSync: - def process_spider_output(self, response, result, spider): + def process_spider_output(self, response, result): yield - def process_spider_output_async(self, response, result, spider): + def process_spider_output_async(self, response, result): yield class UniversalMiddlewareBothAsync: - async def process_spider_output(self, response, result, spider): + async def process_spider_output(self, response, result): yield - async def process_spider_output_async(self, response, result, spider): + async def process_spider_output_async(self, response, result): yield class TestUniversalMiddlewareManager: - def setup_method(self): - self.mwman = SpiderMiddlewareManager() + @pytest.fixture + def crawler(self) -> Crawler: + return get_crawler(Spider) - def test_simple_mw(self): - mw = ProcessSpiderOutputSimpleMiddleware() - self.mwman._add_middleware(mw) - assert ( - self.mwman.methods["process_spider_output"][0] == mw.process_spider_output # pylint: disable=comparison-with-callable - ) + @pytest.fixture + def mwman(self, crawler: Crawler) -> SpiderMiddlewareManager: + return SpiderMiddlewareManager.from_crawler(crawler) - def test_async_mw(self): + def test_simple_mw(self, mwman: SpiderMiddlewareManager) -> None: + mw = ProcessSpiderOutputSyncMiddleware() + with pytest.raises( + TypeError, match=r"doesn't support asynchronous spider output" + ): + mwman._add_middleware(mw) + + def test_async_mw(self, mwman: SpiderMiddlewareManager) -> None: mw = ProcessSpiderOutputAsyncGenMiddleware() - self.mwman._add_middleware(mw) + mwman._add_middleware(mw) assert ( - self.mwman.methods["process_spider_output"][0] == mw.process_spider_output # pylint: disable=comparison-with-callable + mwman.methods["process_spider_output"][0] == mw.process_spider_output # pylint: disable=comparison-with-callable ) - def test_universal_mw(self): + def test_universal_mw(self, mwman: SpiderMiddlewareManager) -> None: mw = ProcessSpiderOutputUniversalMiddleware() - self.mwman._add_middleware(mw) - assert self.mwman.methods["process_spider_output"][0] == ( - mw.process_spider_output, - mw.process_spider_output_async, - ) - - def test_universal_mw_no_sync(self): - with LogCapture() as log: - self.mwman._add_middleware(UniversalMiddlewareNoSync()) + mwman._add_middleware(mw) assert ( - "UniversalMiddlewareNoSync has process_spider_output_async" - " without process_spider_output" in str(log) + mwman.methods["process_spider_output"][0] == mw.process_spider_output_async # pylint: disable=comparison-with-callable ) - assert self.mwman.methods["process_spider_output"][0] is None - def test_universal_mw_both_sync(self): + def test_universal_mw_no_sync( + self, mwman: SpiderMiddlewareManager, caplog: pytest.LogCaptureFixture + ) -> None: + mwman._add_middleware(UniversalMiddlewareNoSync()) + assert ( + "UniversalMiddlewareNoSync has process_spider_output_async()" + " without process_spider_output" in caplog.text + ) + assert mwman.methods["process_spider_output"][0] is None + + def test_universal_mw_both_sync( + self, mwman: SpiderMiddlewareManager, caplog: pytest.LogCaptureFixture + ) -> None: mw = UniversalMiddlewareBothSync() - with LogCapture() as log: - self.mwman._add_middleware(mw) + mwman._add_middleware(mw) assert ( "UniversalMiddlewareBothSync.process_spider_output_async " - "is not an async generator function" in str(log) + "is not an async generator function" in caplog.text ) assert ( - self.mwman.methods["process_spider_output"][0] == mw.process_spider_output # pylint: disable=comparison-with-callable + mwman.methods["process_spider_output"][0] == mw.process_spider_output # pylint: disable=comparison-with-callable ) - def test_universal_mw_both_async(self): - with LogCapture() as log: - self.mwman._add_middleware(UniversalMiddlewareBothAsync()) + def test_universal_mw_both_async( + self, mwman: SpiderMiddlewareManager, caplog: pytest.LogCaptureFixture + ) -> None: + mwman._add_middleware(UniversalMiddlewareBothAsync()) assert ( "UniversalMiddlewareBothAsync.process_spider_output " - "is an async generator function while process_spider_output_async exists" - in str(log) + "is an async generator function while process_spider_output_async() exists" + in caplog.text ) - assert self.mwman.methods["process_spider_output"][0] is None + assert mwman.methods["process_spider_output"][0] is None class TestBuiltinMiddlewareSimple(TestBaseAsyncSpiderMiddleware): ITEM_TYPE = dict - MW_SIMPLE = ProcessSpiderOutputSimpleMiddleware MW_ASYNCGEN = ProcessSpiderOutputAsyncGenMiddleware MW_UNIVERSAL = ProcessSpiderOutputUniversalMiddleware - async def _get_middleware_result(self, *mw_classes, start_index: int | None = None): + async def _get_middleware_result( + self, *mw_classes: type[Any], start_index: int | None = None + ) -> Any: setting = self._construct_mw_setting(*mw_classes, start_index=start_index) self.crawler = get_crawler(Spider, {"SPIDER_MIDDLEWARES": setting}) - self.spider = self.crawler._create_spider("foo") + self.crawler.spider = self.crawler._create_spider("foo") self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) return await self.mwman.scrape_response_async( - self._scrape_func, self.response, self.request, self.spider + self._scrape_func, self.response, self.request ) - @deferred_f_from_coro_f - async def test_just_builtin(self): - await self._test_simple_base() - - @deferred_f_from_coro_f - async def test_builtin_simple(self): - await self._test_simple_base(self.MW_SIMPLE, start_index=1000) - - @deferred_f_from_coro_f - async def test_builtin_async(self): - """Upgrade""" - await self._test_asyncgen_base(self.MW_ASYNCGEN, start_index=1000) - - @deferred_f_from_coro_f - async def test_builtin_universal(self): - await self._test_simple_base(self.MW_UNIVERSAL, start_index=1000) - - @deferred_f_from_coro_f - async def test_simple_builtin(self): - await self._test_simple_base(self.MW_SIMPLE) - - @deferred_f_from_coro_f - async def test_async_builtin(self): - """Upgrade""" - await self._test_asyncgen_base(self.MW_ASYNCGEN) - - @deferred_f_from_coro_f - async def test_universal_builtin(self): - await self._test_simple_base(self.MW_UNIVERSAL) - - -class TestBuiltinMiddlewareAsyncGen(TestBuiltinMiddlewareSimple): - async def _scrape_func(self, *args, **kwargs): - for item in super()._scrape_func(): - yield item - - @deferred_f_from_coro_f + @coroutine_test async def test_just_builtin(self): await self._test_asyncgen_base() - @deferred_f_from_coro_f - async def test_builtin_simple(self): - """Downgrade""" - await self._test_simple_base(self.MW_SIMPLE, downgrade=True, start_index=1000) - - @deferred_f_from_coro_f + @coroutine_test async def test_builtin_async(self): + """Upgrade""" await self._test_asyncgen_base(self.MW_ASYNCGEN, start_index=1000) - @deferred_f_from_coro_f + @coroutine_test async def test_builtin_universal(self): await self._test_asyncgen_base(self.MW_UNIVERSAL, start_index=1000) - @deferred_f_from_coro_f - async def test_simple_builtin(self): - """Downgrade""" - await self._test_simple_base(self.MW_SIMPLE, downgrade=True) - - @deferred_f_from_coro_f + @coroutine_test async def test_async_builtin(self): + """Upgrade""" await self._test_asyncgen_base(self.MW_ASYNCGEN) - @deferred_f_from_coro_f + @coroutine_test async def test_universal_builtin(self): await self._test_asyncgen_base(self.MW_UNIVERSAL) +class TestBuiltinMiddlewareAsyncGen(TestBuiltinMiddlewareSimple): + async def _callback(self) -> Any: + for item in super()._callback(): + yield item + + class TestProcessSpiderException(TestBaseAsyncSpiderMiddleware): ITEM_TYPE = dict - MW_SIMPLE = ProcessSpiderOutputSimpleMiddleware MW_ASYNCGEN = ProcessSpiderOutputAsyncGenMiddleware - MW_UNIVERSAL = ProcessSpiderOutputUniversalMiddleware MW_EXC_SIMPLE = ProcessSpiderExceptionSimpleIterableMiddleware MW_EXC_ASYNCGEN = ProcessSpiderExceptionAsyncIteratorMiddleware - def _scrape_func(self, *args, **kwargs): + def _callback(self) -> Any: 1 / 0 - async def _test_asyncgen_nodowngrade(self, *mw_classes): - with pytest.raises( - _InvalidOutput, match="Async iterable returned from .+ cannot be downgraded" - ): - await self._get_middleware_result(*mw_classes) - - @deferred_f_from_coro_f + @coroutine_test async def test_exc_simple(self): """Simple exc mw""" - await self._test_simple_base(self.MW_EXC_SIMPLE) + await self._test_asyncgen_base(self.MW_EXC_SIMPLE) - @deferred_f_from_coro_f + @coroutine_test async def test_exc_async(self): """Async exc mw""" await self._test_asyncgen_base(self.MW_EXC_ASYNCGEN) - @deferred_f_from_coro_f - async def test_exc_simple_simple(self): - """Simple exc mw -> simple output mw""" - await self._test_simple_base(self.MW_SIMPLE, self.MW_EXC_SIMPLE) - - @deferred_f_from_coro_f + @coroutine_test async def test_exc_async_async(self): """Async exc mw -> async output mw""" await self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_EXC_ASYNCGEN) - @deferred_f_from_coro_f + @coroutine_test async def test_exc_simple_async(self): """Simple exc mw -> async output mw; upgrade""" await self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_EXC_SIMPLE) - @deferred_f_from_coro_f - async def test_exc_async_simple(self): - """Async exc mw -> simple output mw; cannot work as downgrading is not supported""" - await self._test_asyncgen_nodowngrade(self.MW_SIMPLE, self.MW_EXC_ASYNCGEN) + +class TestDeprecatedSpiderArg(TestSpiderMiddleware): + @coroutine_test + async def test_deprecated_mw_spider_arg(self): + class DeprecatedSpiderArgMiddleware1: + def process_spider_input(self, response, spider): + return None + + async def process_spider_output(self, response, result, spider): + 1 / 0 + yield + + class DeprecatedSpiderArgMiddleware2: + def process_spider_exception(self, response, exception, spider): + return [] + + with pytest.warns( + ScrapyDeprecationWarning, + match=r"process_spider_exception\(\) requires a spider argument", + ): + self.mwman._add_middleware(DeprecatedSpiderArgMiddleware2()) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"process_spider_input\(\) requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"process_spider_output\(\) requires a spider argument", + ), + ): + self.mwman._add_middleware(DeprecatedSpiderArgMiddleware1()) + it = await self._scrape_response() + await collect_asyncgen(it) + + @coroutine_test + async def test_deprecated_mwman_spider_arg(self): + with pytest.warns( + ScrapyDeprecationWarning, + match=r"Passing a spider argument to SpiderMiddlewareManager.process_start\(\)" + r" is deprecated and the passed value is ignored", + ): + await self.mwman.process_start(DefaultSpider()) + + @coroutine_test + async def test_deprecated_mwman_spider_arg_no_crawler(self): + with pytest.warns( + ScrapyDeprecationWarning, + match=r"MiddlewareManager.__init__\(\) was called without the crawler argument", + ): + mwman = SpiderMiddlewareManager() + with pytest.warns( + ScrapyDeprecationWarning, + match=r"Passing a spider argument to SpiderMiddlewareManager.process_start\(\)" + r" is deprecated, SpiderMiddlewareManager should be instantiated with a Crawler", + ): + await mwman.process_start(DefaultSpider()) diff --git a/tests/test_spidermiddleware_base.py b/tests/test_spidermiddleware_base.py index 77d055d50..70326f3f1 100644 --- a/tests/test_spidermiddleware_base.py +++ b/tests/test_spidermiddleware_base.py @@ -7,7 +7,9 @@ import pytest from scrapy import Request, Spider from scrapy.http import Response from scrapy.spidermiddlewares.base import BaseSpiderMiddleware +from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen from scrapy.utils.test import get_crawler +from tests.utils.decorators import coroutine_test if TYPE_CHECKING: from scrapy.crawler import Crawler @@ -18,7 +20,8 @@ def crawler() -> Crawler: return get_crawler(Spider) -def test_trivial(crawler): +@coroutine_test +async def test_trivial(crawler: Crawler) -> None: class TrivialSpiderMiddleware(BaseSpiderMiddleware): pass @@ -28,15 +31,14 @@ def test_trivial(crawler): test_req = Request("data:,") spider_output = [test_req, {"foo": "bar"}] for processed in [ - list( - mw.process_spider_output(Response("data:,"), spider_output, crawler.spider) - ), - list(mw.process_start_requests(spider_output, crawler.spider)), + list(mw.process_spider_output(Response("data:,"), spider_output)), + await collect_asyncgen(mw.process_start(as_async_generator(spider_output))), ]: assert processed == [test_req, {"foo": "bar"}] -def test_processed_request(crawler): +@coroutine_test +async def test_processed_request(crawler: Crawler) -> None: class ProcessReqSpiderMiddleware(BaseSpiderMiddleware): def get_processed_request( self, request: Request, response: Response | None @@ -53,10 +55,8 @@ def test_processed_request(crawler): test_req3 = Request("data:3,") spider_output = [test_req1, {"foo": "bar"}, test_req2, test_req3] for processed in [ - list( - mw.process_spider_output(Response("data:,"), spider_output, crawler.spider) - ), - list(mw.process_start_requests(spider_output, crawler.spider)), + list(mw.process_spider_output(Response("data:,"), spider_output)), + await collect_asyncgen(mw.process_start(as_async_generator(spider_output))), ]: assert len(processed) == 3 assert isinstance(processed[0], Request) @@ -66,7 +66,8 @@ def test_processed_request(crawler): assert processed[2].url == "data:30," -def test_processed_item(crawler): +@coroutine_test +async def test_processed_item(crawler: Crawler) -> None: class ProcessItemSpiderMiddleware(BaseSpiderMiddleware): def get_processed_item(self, item: Any, response: Response | None) -> Any: if item["foo"] == 2: @@ -79,15 +80,14 @@ def test_processed_item(crawler): test_req = Request("data:,") spider_output = [{"foo": 1}, {"foo": 2}, test_req, {"foo": 3}] for processed in [ - list( - mw.process_spider_output(Response("data:,"), spider_output, crawler.spider) - ), - list(mw.process_start_requests(spider_output, crawler.spider)), + list(mw.process_spider_output(Response("data:,"), spider_output)), + await collect_asyncgen(mw.process_start(as_async_generator(spider_output))), ]: assert processed == [{"foo": 1}, test_req, {"foo": 30}] -def test_processed_both(crawler): +@coroutine_test +async def test_processed_both(crawler: Crawler) -> None: class ProcessBothSpiderMiddleware(BaseSpiderMiddleware): def get_processed_request( self, request: Request, response: Response | None @@ -118,10 +118,8 @@ def test_processed_both(crawler): test_req3, ] for processed in [ - list( - mw.process_spider_output(Response("data:,"), spider_output, crawler.spider) - ), - list(mw.process_start_requests(spider_output, crawler.spider)), + list(mw.process_spider_output(Response("data:,"), spider_output)), + await collect_asyncgen(mw.process_start(as_async_generator(spider_output))), ]: assert len(processed) == 4 assert isinstance(processed[0], Request) diff --git a/tests/test_spidermiddleware_depth.py b/tests/test_spidermiddleware_depth.py index 9b4aa624c..00e547305 100644 --- a/tests/test_spidermiddleware_depth.py +++ b/tests/test_spidermiddleware_depth.py @@ -1,38 +1,57 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import pytest + from scrapy.http import Request, Response from scrapy.spidermiddlewares.depth import DepthMiddleware from scrapy.spiders import Spider from scrapy.utils.test import get_crawler +if TYPE_CHECKING: + from collections.abc import Generator -class TestDepthMiddleware: - def setup_method(self): - crawler = get_crawler(Spider, {"DEPTH_LIMIT": 1, "DEPTH_STATS_VERBOSE": True}) - self.spider = crawler._create_spider("scrapytest.org") + from scrapy.crawler import Crawler + from scrapy.statscollectors import StatsCollector - self.stats = crawler.stats - self.stats.open_spider(self.spider) - self.mw = DepthMiddleware.from_crawler(crawler) +@pytest.fixture +def crawler() -> Crawler: + return get_crawler(Spider, {"DEPTH_LIMIT": 1, "DEPTH_STATS_VERBOSE": True}) - def test_process_spider_output(self): - req = Request("http://scrapytest.org") - resp = Response("http://scrapytest.org") - resp.request = req - result = [Request("http://scrapytest.org")] - out = list(self.mw.process_spider_output(resp, result, self.spider)) - assert out == result +@pytest.fixture +def stats(crawler: Crawler) -> Generator[StatsCollector]: + assert crawler.stats is not None + crawler.stats.open_spider() - rdc = self.stats.get_value("request_depth_count/1", spider=self.spider) - assert rdc == 1 + yield crawler.stats - req.meta["depth"] = 1 + crawler.stats.close_spider() - out2 = list(self.mw.process_spider_output(resp, result, self.spider)) - assert not out2 - rdm = self.stats.get_value("request_depth_max", spider=self.spider) - assert rdm == 1 +@pytest.fixture +def mw(crawler: Crawler) -> DepthMiddleware: + return DepthMiddleware.from_crawler(crawler) - def teardown_method(self): - self.stats.close_spider(self.spider, "") + +def test_process_spider_output(mw: DepthMiddleware, stats: StatsCollector) -> None: + req = Request("http://scrapytest.org") + resp = Response("http://scrapytest.org") + resp.request = req + result = [Request("http://scrapytest.org")] + + out = list(mw.process_spider_output(resp, result)) + assert out == result + + rdc = stats.get_value("request_depth_count/1") + assert rdc == 1 + + req.meta["depth"] = 1 + + out2 = list(mw.process_spider_output(resp, result)) + assert not out2 + + rdm = stats.get_value("request_depth_max") + assert rdm == 1 diff --git a/tests/test_spidermiddleware_httperror.py b/tests/test_spidermiddleware_httperror.py index 12dbaaa96..6a054ded5 100644 --- a/tests/test_spidermiddleware_httperror.py +++ b/tests/test_spidermiddleware_httperror.py @@ -1,17 +1,19 @@ +from __future__ import annotations + import logging +from typing import TYPE_CHECKING import pytest -from testfixtures import LogCapture -from twisted.internet.defer import inlineCallbacks -from twisted.trial.unittest import TestCase from scrapy.http import Request, Response -from scrapy.settings import Settings from scrapy.spidermiddlewares.httperror import HttpError, HttpErrorMiddleware -from scrapy.spiders import Spider +from scrapy.utils.spider import DefaultSpider from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer from tests.spiders import MockServerSpider +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + from tests.mockserver.http import MockServer class _HttpErrorSpider(MockServerSpider): @@ -49,111 +51,132 @@ class _HttpErrorSpider(MockServerSpider): return failure -def _responses(request, status_codes): - responses = [] - for code in status_codes: - response = Response(request.url, status=code) - response.request = request - responses.append(response) - return responses +req = Request("http://scrapytest.org") + + +def _response(request: Request, status_code: int) -> Response: + return Response(request.url, status=status_code, request=request) + + +@pytest.fixture +def res200() -> Response: + return _response(req, 200) + + +@pytest.fixture +def res402() -> Response: + return _response(req, 402) + + +@pytest.fixture +def res404() -> Response: + return _response(req, 404) class TestHttpErrorMiddleware: - def setup_method(self): - crawler = get_crawler(Spider) - self.spider = Spider.from_crawler(crawler, name="foo") - self.mw = HttpErrorMiddleware(Settings({})) - self.req = Request("http://scrapytest.org") - self.res200, self.res404 = _responses(self.req, [200, 404]) + @pytest.fixture + def mw(self) -> HttpErrorMiddleware: + crawler = get_crawler(DefaultSpider) + crawler.spider = crawler._create_spider() + return HttpErrorMiddleware.from_crawler(crawler) - def test_process_spider_input(self): - assert self.mw.process_spider_input(self.res200, self.spider) is None + def test_process_spider_input( + self, mw: HttpErrorMiddleware, res200: Response, res404: Response + ) -> None: + mw.process_spider_input(res200) with pytest.raises(HttpError): - self.mw.process_spider_input(self.res404, self.spider) + mw.process_spider_input(res404) - def test_process_spider_exception(self): - assert ( - self.mw.process_spider_exception( - self.res404, HttpError(self.res404), self.spider - ) - == [] - ) - assert ( - self.mw.process_spider_exception(self.res404, Exception(), self.spider) - is None - ) + def test_process_spider_exception( + self, mw: HttpErrorMiddleware, res404: Response + ) -> None: + assert mw.process_spider_exception(res404, HttpError(res404)) == () + assert mw.process_spider_exception(res404, Exception()) is None - def test_handle_httpstatus_list(self): - res = self.res404.copy() - res.request = Request( + def test_handle_httpstatus_list( + self, mw: HttpErrorMiddleware, res404: Response + ) -> None: + request = Request( "http://scrapytest.org", meta={"handle_httpstatus_list": [404]} ) - assert self.mw.process_spider_input(res, self.spider) is None + res = _response(request, 404) + mw.process_spider_input(res) - self.spider.handle_httpstatus_list = [404] - assert self.mw.process_spider_input(self.res404, self.spider) is None + assert mw.crawler.spider + mw.crawler.spider.handle_httpstatus_list = [404] # type: ignore[attr-defined] + mw.process_spider_input(res404) class TestHttpErrorMiddlewareSettings: """Similar test, but with settings""" - def setup_method(self): - self.spider = Spider("foo") - self.mw = HttpErrorMiddleware(Settings({"HTTPERROR_ALLOWED_CODES": (402,)})) - self.req = Request("http://scrapytest.org") - self.res200, self.res404, self.res402 = _responses(self.req, [200, 404, 402]) + @pytest.fixture + def mw(self) -> HttpErrorMiddleware: + crawler = get_crawler(DefaultSpider, {"HTTPERROR_ALLOWED_CODES": (402,)}) + crawler.spider = crawler._create_spider() + return HttpErrorMiddleware.from_crawler(crawler) - def test_process_spider_input(self): - assert self.mw.process_spider_input(self.res200, self.spider) is None + def test_process_spider_input( + self, + mw: HttpErrorMiddleware, + res200: Response, + res402: Response, + res404: Response, + ) -> None: + mw.process_spider_input(res200) with pytest.raises(HttpError): - self.mw.process_spider_input(self.res404, self.spider) - assert self.mw.process_spider_input(self.res402, self.spider) is None + mw.process_spider_input(res404) + mw.process_spider_input(res402) - def test_meta_overrides_settings(self): + def test_meta_overrides_settings(self, mw: HttpErrorMiddleware) -> None: request = Request( "http://scrapytest.org", meta={"handle_httpstatus_list": [404]} ) - res404 = self.res404.copy() - res404.request = request - res402 = self.res402.copy() - res402.request = request + res404 = _response(request, 404) + res402 = _response(request, 402) - assert self.mw.process_spider_input(res404, self.spider) is None + mw.process_spider_input(res404) with pytest.raises(HttpError): - self.mw.process_spider_input(res402, self.spider) + mw.process_spider_input(res402) - def test_spider_override_settings(self): - self.spider.handle_httpstatus_list = [404] - assert self.mw.process_spider_input(self.res404, self.spider) is None + def test_spider_override_settings( + self, mw: HttpErrorMiddleware, res402: Response, res404: Response + ) -> None: + assert mw.crawler.spider + mw.crawler.spider.handle_httpstatus_list = [404] # type: ignore[attr-defined] + mw.process_spider_input(res404) with pytest.raises(HttpError): - self.mw.process_spider_input(self.res402, self.spider) + mw.process_spider_input(res402) class TestHttpErrorMiddlewareHandleAll: - def setup_method(self): - self.spider = Spider("foo") - self.mw = HttpErrorMiddleware(Settings({"HTTPERROR_ALLOW_ALL": True})) - self.req = Request("http://scrapytest.org") - self.res200, self.res404, self.res402 = _responses(self.req, [200, 404, 402]) + @pytest.fixture + def mw(self) -> HttpErrorMiddleware: + crawler = get_crawler(DefaultSpider, {"HTTPERROR_ALLOW_ALL": True}) + crawler.spider = crawler._create_spider() + return HttpErrorMiddleware.from_crawler(crawler) - def test_process_spider_input(self): - assert self.mw.process_spider_input(self.res200, self.spider) is None - assert self.mw.process_spider_input(self.res404, self.spider) is None + def test_process_spider_input( + self, + mw: HttpErrorMiddleware, + res200: Response, + res404: Response, + ) -> None: + mw.process_spider_input(res200) + mw.process_spider_input(res404) - def test_meta_overrides_settings(self): + def test_meta_overrides_settings(self, mw: HttpErrorMiddleware) -> None: request = Request( "http://scrapytest.org", meta={"handle_httpstatus_list": [404]} ) - res404 = self.res404.copy() - res404.request = request - res402 = self.res402.copy() - res402.request = request + res404 = _response(request, 404) + res402 = _response(request, 402) - assert self.mw.process_spider_input(res404, self.spider) is None + mw.process_spider_input(res404) with pytest.raises(HttpError): - self.mw.process_spider_input(res402, self.spider) + mw.process_spider_input(res402) - def test_httperror_allow_all_false(self): + def test_httperror_allow_all_false(self) -> None: crawler = get_crawler(_HttpErrorSpider) mw = HttpErrorMiddleware.from_crawler(crawler) request_httpstatus_false = Request( @@ -162,76 +185,75 @@ class TestHttpErrorMiddlewareHandleAll: request_httpstatus_true = Request( "http://scrapytest.org", meta={"handle_httpstatus_all": True} ) - res404 = self.res404.copy() - res404.request = request_httpstatus_false - res402 = self.res402.copy() - res402.request = request_httpstatus_true + res404 = _response(request_httpstatus_false, 404) + res402 = _response(request_httpstatus_true, 402) with pytest.raises(HttpError): - mw.process_spider_input(res404, self.spider) - assert mw.process_spider_input(res402, self.spider) is None + mw.process_spider_input(res404) + mw.process_spider_input(res402) -class TestHttpErrorMiddlewareIntegrational(TestCase): - @classmethod - def setUpClass(cls): - cls.mockserver = MockServer() - cls.mockserver.__enter__() - - @classmethod - def tearDownClass(cls): - cls.mockserver.__exit__(None, None, None) - - @inlineCallbacks - def test_middleware_works(self): +class TestHttpErrorMiddlewareIntegrational: + @coroutine_test + async def test_middleware_works(self, mockserver: MockServer) -> None: crawler = get_crawler(_HttpErrorSpider) - yield crawler.crawl(mockserver=self.mockserver) - assert not crawler.spider.skipped, crawler.spider.skipped + await crawler.crawl_async(mockserver=mockserver) + assert isinstance(crawler.spider, _HttpErrorSpider) + assert not crawler.spider.skipped assert crawler.spider.parsed == {"200"} assert crawler.spider.failed == {"404", "402", "500"} + assert crawler.stats get_value = crawler.stats.get_value assert get_value("httperror/response_ignored_count") == 3 assert get_value("httperror/response_ignored_status_count/404") == 1 assert get_value("httperror/response_ignored_status_count/402") == 1 assert get_value("httperror/response_ignored_status_count/500") == 1 - @inlineCallbacks - def test_logging(self): + @coroutine_test + async def test_logging( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: crawler = get_crawler(_HttpErrorSpider) - with LogCapture() as log: - yield crawler.crawl(mockserver=self.mockserver, bypass_status_codes={402}) + with caplog.at_level(logging.INFO): + await crawler.crawl_async(mockserver=mockserver, bypass_status_codes={402}) + assert isinstance(crawler.spider, _HttpErrorSpider) assert crawler.spider.parsed == {"200", "402"} assert crawler.spider.skipped == {"402"} assert crawler.spider.failed == {"404", "500"} - assert "Ignoring response <404" in str(log) - assert "Ignoring response <500" in str(log) - assert "Ignoring response <200" not in str(log) - assert "Ignoring response <402" not in str(log) + assert "Ignoring response <404" in caplog.text + assert "Ignoring response <500" in caplog.text + assert "Ignoring response <200" not in caplog.text + assert "Ignoring response <402" not in caplog.text - @inlineCallbacks - def test_logging_level(self): + @coroutine_test + async def test_logging_level( + self, caplog: pytest.LogCaptureFixture, mockserver: MockServer + ) -> None: # HttpError logs ignored responses with level INFO crawler = get_crawler(_HttpErrorSpider) - with LogCapture(level=logging.INFO) as log: - yield crawler.crawl(mockserver=self.mockserver) + with caplog.at_level(logging.INFO): + await crawler.crawl_async(mockserver=mockserver) + assert isinstance(crawler.spider, _HttpErrorSpider) assert crawler.spider.parsed == {"200"} assert crawler.spider.failed == {"404", "402", "500"} - assert "Ignoring response <402" in str(log) - assert "Ignoring response <404" in str(log) - assert "Ignoring response <500" in str(log) - assert "Ignoring response <200" not in str(log) + assert "Ignoring response <402" in caplog.text + assert "Ignoring response <404" in caplog.text + assert "Ignoring response <500" in caplog.text + assert "Ignoring response <200" not in caplog.text # with level WARNING, we shouldn't capture anything from HttpError + caplog.clear() crawler = get_crawler(_HttpErrorSpider) - with LogCapture(level=logging.WARNING) as log: - yield crawler.crawl(mockserver=self.mockserver) + with caplog.at_level(logging.WARNING): + await crawler.crawl_async(mockserver=mockserver) + assert isinstance(crawler.spider, _HttpErrorSpider) assert crawler.spider.parsed == {"200"} assert crawler.spider.failed == {"404", "402", "500"} - assert "Ignoring response <402" not in str(log) - assert "Ignoring response <404" not in str(log) - assert "Ignoring response <500" not in str(log) - assert "Ignoring response <200" not in str(log) + assert "Ignoring response <402" not in caplog.text + assert "Ignoring response <404" not in caplog.text + assert "Ignoring response <500" not in caplog.text + assert "Ignoring response <200" not in caplog.text diff --git a/tests/test_spidermiddleware_offsite.py b/tests/test_spidermiddleware_offsite.py deleted file mode 100644 index e4f4b8f9b..000000000 --- a/tests/test_spidermiddleware_offsite.py +++ /dev/null @@ -1,105 +0,0 @@ -import warnings -from urllib.parse import urlparse - -from scrapy.http import Request, Response -from scrapy.spidermiddlewares.offsite import OffsiteMiddleware, PortWarning, URLWarning -from scrapy.spiders import Spider -from scrapy.utils.test import get_crawler - - -class TestOffsiteMiddleware: - def setup_method(self): - crawler = get_crawler(Spider) - self.spider = crawler.spider = crawler._create_spider(**self._get_spiderargs()) - self.mw = OffsiteMiddleware.from_crawler(crawler) - self.mw.spider_opened(self.spider) - - def _get_spiderargs(self): - return { - "name": "foo", - "allowed_domains": ["scrapytest.org", "scrapy.org", "scrapy.test.org"], - } - - def test_process_spider_output(self): - res = Response("http://scrapytest.org") - - onsite_reqs = [ - Request("http://scrapytest.org/1"), - Request("http://scrapy.org/1"), - Request("http://sub.scrapy.org/1"), - Request("http://offsite.tld/letmepass", dont_filter=True), - Request("http://offsite-2.tld/allow", meta={"allow_offsite": True}), - Request("http://scrapy.test.org/"), - Request("http://scrapy.test.org:8000/"), - ] - offsite_reqs = [ - Request("http://scrapy2.org"), - Request("http://offsite.tld/"), - Request("http://offsite.tld/scrapytest.org"), - Request("http://offsite.tld/rogue.scrapytest.org"), - Request("http://rogue.scrapytest.org.haha.com"), - Request("http://roguescrapytest.org"), - Request("http://test.org/"), - Request("http://notscrapy.test.org/"), - ] - reqs = onsite_reqs + offsite_reqs - - out = list(self.mw.process_spider_output(res, reqs, self.spider)) - assert out == onsite_reqs - - -class TestOffsiteMiddleware2(TestOffsiteMiddleware): - def _get_spiderargs(self): - return {"name": "foo", "allowed_domains": None} - - def test_process_spider_output(self): - res = Response("http://scrapytest.org") - reqs = [Request("http://a.com/b.html"), Request("http://b.com/1")] - out = list(self.mw.process_spider_output(res, reqs, self.spider)) - assert out == reqs - - -class TestOffsiteMiddleware3(TestOffsiteMiddleware2): - def _get_spiderargs(self): - return {"name": "foo"} - - -class TestOffsiteMiddleware4(TestOffsiteMiddleware3): - def _get_spiderargs(self): - bad_hostname = urlparse("http:////scrapytest.org").hostname - return { - "name": "foo", - "allowed_domains": ["scrapytest.org", None, bad_hostname], - } - - def test_process_spider_output(self): - res = Response("http://scrapytest.org") - reqs = [Request("http://scrapytest.org/1")] - out = list(self.mw.process_spider_output(res, reqs, self.spider)) - assert out == reqs - - -class TestOffsiteMiddleware5(TestOffsiteMiddleware4): - def test_get_host_regex(self): - self.spider.allowed_domains = [ - "http://scrapytest.org", - "scrapy.org", - "scrapy.test.org", - ] - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter("always") - self.mw.get_host_regex(self.spider) - assert issubclass(w[-1].category, URLWarning) - - -class TestOffsiteMiddleware6(TestOffsiteMiddleware4): - def test_get_host_regex(self): - self.spider.allowed_domains = [ - "scrapytest.org:8000", - "scrapy.org", - "scrapy.test.org", - ] - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter("always") - self.mw.get_host_regex(self.spider) - assert issubclass(w[-1].category, PortWarning) diff --git a/tests/test_spidermiddleware_output_chain.py b/tests/test_spidermiddleware_output_chain.py index 60464d696..afdfaa322 100644 --- a/tests/test_spidermiddleware_output_chain.py +++ b/tests/test_spidermiddleware_output_chain.py @@ -1,24 +1,32 @@ from testfixtures import LogCapture -from twisted.trial.unittest import TestCase from scrapy import Request, Spider -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer +from tests.mockserver.http import MockServer +from tests.utils.decorators import coroutine_test -class LogExceptionMiddleware: - def process_spider_exception(self, response, exception, spider): - spider.logger.info( +class _BaseSpiderMiddleware: + def __init__(self, crawler): + self.crawler = crawler + + @classmethod + def from_crawler(cls, crawler): + return cls(crawler) + + +class LogExceptionMiddleware(_BaseSpiderMiddleware): + def process_spider_exception(self, response, exception): + self.crawler.spider.logger.info( "Middleware: %s exception caught", exception.__class__.__name__ ) # ================================================================================ # (0) recover from an exception on a spider callback -class RecoveryMiddleware: - def process_spider_exception(self, response, exception, spider): - spider.logger.info( +class RecoveryMiddleware(_BaseSpiderMiddleware): + def process_spider_exception(self, response, exception): + self.crawler.spider.logger.info( "Middleware: %s exception caught", exception.__class__.__name__ ) return [ @@ -56,9 +64,9 @@ class RecoveryAsyncGenSpider(RecoverySpider): # ================================================================================ # (1) exceptions from a spider middleware's process_spider_input method -class FailProcessSpiderInputMiddleware: - def process_spider_input(self, response, spider): - spider.logger.info("Middleware: will raise IndexError") +class FailProcessSpiderInputMiddleware(_BaseSpiderMiddleware): + def process_spider_input(self, response): + self.crawler.spider.logger.info("Middleware: will raise IndexError") raise IndexError @@ -160,27 +168,31 @@ class NotGeneratorCallbackSpiderMiddlewareRightAfterSpider(NotGeneratorCallbackS # ================================================================================ # (4) exceptions from a middleware process_spider_output method (generator) -class _GeneratorDoNothingMiddleware: - def process_spider_output(self, response, result, spider): - for r in result: +class _GeneratorDoNothingMiddleware(_BaseSpiderMiddleware): + async def process_spider_output(self, response, result): + async for r in result: r["processed"].append(f"{self.__class__.__name__}.process_spider_output") yield r - def process_spider_exception(self, response, exception, spider): + def process_spider_exception(self, response, exception): method = f"{self.__class__.__name__}.process_spider_exception" - spider.logger.info("%s: %s caught", method, exception.__class__.__name__) + self.crawler.spider.logger.info( + "%s: %s caught", method, exception.__class__.__name__ + ) -class GeneratorFailMiddleware: - def process_spider_output(self, response, result, spider): - for r in result: +class GeneratorFailMiddleware(_BaseSpiderMiddleware): + async def process_spider_output(self, response, result): + async for r in result: r["processed"].append(f"{self.__class__.__name__}.process_spider_output") yield r raise LookupError - def process_spider_exception(self, response, exception, spider): + def process_spider_exception(self, response, exception): method = f"{self.__class__.__name__}.process_spider_exception" - spider.logger.info("%s: %s caught", method, exception.__class__.__name__) + self.crawler.spider.logger.info( + "%s: %s caught", method, exception.__class__.__name__ + ) yield {"processed": [method]} @@ -188,15 +200,17 @@ class GeneratorDoNothingAfterFailureMiddleware(_GeneratorDoNothingMiddleware): pass -class GeneratorRecoverMiddleware: - def process_spider_output(self, response, result, spider): - for r in result: +class GeneratorRecoverMiddleware(_BaseSpiderMiddleware): + async def process_spider_output(self, response, result): + async for r in result: r["processed"].append(f"{self.__class__.__name__}.process_spider_output") yield r - def process_spider_exception(self, response, exception, spider): + def process_spider_exception(self, response, exception): method = f"{self.__class__.__name__}.process_spider_exception" - spider.logger.info("%s: %s caught", method, exception.__class__.__name__) + self.crawler.spider.logger.info( + "%s: %s caught", method, exception.__class__.__name__ + ) yield {"processed": [method]} @@ -224,99 +238,25 @@ class GeneratorOutputChainSpider(Spider): # ================================================================================ -# (5) exceptions from a middleware process_spider_output method (not generator) - - -class _NotGeneratorDoNothingMiddleware: - def process_spider_output(self, response, result, spider): - out = [] - for r in result: - r["processed"].append(f"{self.__class__.__name__}.process_spider_output") - out.append(r) - return out - - def process_spider_exception(self, response, exception, spider): - method = f"{self.__class__.__name__}.process_spider_exception" - spider.logger.info("%s: %s caught", method, exception.__class__.__name__) - - -class NotGeneratorFailMiddleware: - def process_spider_output(self, response, result, spider): - out = [] - for r in result: - r["processed"].append(f"{self.__class__.__name__}.process_spider_output") - out.append(r) - raise ReferenceError - - def process_spider_exception(self, response, exception, spider): - method = f"{self.__class__.__name__}.process_spider_exception" - spider.logger.info("%s: %s caught", method, exception.__class__.__name__) - return [{"processed": [method]}] - - -class NotGeneratorDoNothingAfterFailureMiddleware(_NotGeneratorDoNothingMiddleware): - pass - - -class NotGeneratorRecoverMiddleware: - def process_spider_output(self, response, result, spider): - out = [] - for r in result: - r["processed"].append(f"{self.__class__.__name__}.process_spider_output") - out.append(r) - return out - - def process_spider_exception(self, response, exception, spider): - method = f"{self.__class__.__name__}.process_spider_exception" - spider.logger.info("%s: %s caught", method, exception.__class__.__name__) - return [{"processed": [method]}] - - -class NotGeneratorDoNothingAfterRecoveryMiddleware(_NotGeneratorDoNothingMiddleware): - pass - - -class NotGeneratorOutputChainSpider(Spider): - name = "NotGeneratorOutputChainSpider" - custom_settings = { - "SPIDER_MIDDLEWARES": { - NotGeneratorFailMiddleware: 10, - NotGeneratorDoNothingAfterFailureMiddleware: 8, - NotGeneratorRecoverMiddleware: 5, - NotGeneratorDoNothingAfterRecoveryMiddleware: 3, - }, - } - - async def start(self): - yield Request(self.mockserver.url("/status?n=200")) - - def parse(self, response): - return [ - {"processed": ["parse-first-item"]}, - {"processed": ["parse-second-item"]}, - ] - - -# ================================================================================ -class TestSpiderMiddleware(TestCase): +class TestSpiderMiddleware: mockserver: MockServer @classmethod - def setUpClass(cls): + def setup_class(cls): cls.mockserver = MockServer() cls.mockserver.__enter__() @classmethod - def tearDownClass(cls): + def teardown_class(cls): cls.mockserver.__exit__(None, None, None) async def crawl_log(self, spider: type[Spider]) -> LogCapture: crawler = get_crawler(spider) with LogCapture() as log: - await maybe_deferred_to_future(crawler.crawl(mockserver=self.mockserver)) + await crawler.crawl_async(mockserver=self.mockserver) return log - @deferred_f_from_coro_f + @coroutine_test async def test_recovery(self): """ (0) Recover from an exception in a spider callback. The final item count should be 3 @@ -329,7 +269,7 @@ class TestSpiderMiddleware(TestCase): assert str(log).count("Middleware: TabError exception caught") == 1 assert "'item_scraped_count': 3" in str(log) - @deferred_f_from_coro_f + @coroutine_test async def test_recovery_asyncgen(self): """ Same as test_recovery but with an async callback. @@ -339,7 +279,7 @@ class TestSpiderMiddleware(TestCase): assert str(log).count("Middleware: TabError exception caught") == 1 assert "'item_scraped_count': 3" in str(log) - @deferred_f_from_coro_f + @coroutine_test async def test_process_spider_input_without_errback(self): """ (1.1) An exception from the process_spider_input chain should be caught by the @@ -349,7 +289,7 @@ class TestSpiderMiddleware(TestCase): assert "Middleware: will raise IndexError" in str(log1) assert "Middleware: IndexError exception caught" in str(log1) - @deferred_f_from_coro_f + @coroutine_test async def test_process_spider_input_with_errback(self): """ (1.2) An exception from the process_spider_input chain should not be caught by the @@ -363,7 +303,7 @@ class TestSpiderMiddleware(TestCase): assert "{'from': 'callback'}" not in str(log1) assert "'item_scraped_count': 1" in str(log1) - @deferred_f_from_coro_f + @coroutine_test async def test_generator_callback(self): """ (2) An exception from a spider callback (returning a generator) should @@ -374,7 +314,7 @@ class TestSpiderMiddleware(TestCase): assert "Middleware: ImportError exception caught" in str(log2) assert "'item_scraped_count': 2" in str(log2) - @deferred_f_from_coro_f + @coroutine_test async def test_async_generator_callback(self): """ Same as test_generator_callback but with an async callback. @@ -383,7 +323,7 @@ class TestSpiderMiddleware(TestCase): assert "Middleware: ImportError exception caught" in str(log2) assert "'item_scraped_count': 2" in str(log2) - @deferred_f_from_coro_f + @coroutine_test async def test_generator_callback_right_after_callback(self): """ (2.1) Special case of (2): Exceptions should be caught @@ -393,7 +333,7 @@ class TestSpiderMiddleware(TestCase): assert "Middleware: ImportError exception caught" in str(log21) assert "'item_scraped_count': 2" in str(log21) - @deferred_f_from_coro_f + @coroutine_test async def test_not_a_generator_callback(self): """ (3) An exception from a spider callback (returning a list) should @@ -403,7 +343,7 @@ class TestSpiderMiddleware(TestCase): assert "Middleware: ZeroDivisionError exception caught" in str(log3) assert "item_scraped_count" not in str(log3) - @deferred_f_from_coro_f + @coroutine_test async def test_not_a_generator_callback_right_after_callback(self): """ (3.1) Special case of (3): Exceptions should be caught @@ -415,7 +355,7 @@ class TestSpiderMiddleware(TestCase): assert "Middleware: ZeroDivisionError exception caught" in str(log31) assert "item_scraped_count" not in str(log31) - @deferred_f_from_coro_f + @coroutine_test async def test_generator_output_chain(self): """ (4) An exception from a middleware's process_spider_output method should be sent @@ -461,41 +401,3 @@ class TestSpiderMiddleware(TestCase): assert str(item_from_callback) in str(log4) assert str(item_recovered) in str(log4) assert "parse-second-item" not in str(log4) - - @deferred_f_from_coro_f - async def test_not_a_generator_output_chain(self): - """ - (5) An exception from a middleware's process_spider_output method should be sent - to the process_spider_exception method from the next middleware in the chain. - The result of the recovery by the process_spider_exception method should be handled - by the process_spider_output method from the next middleware. - The final item count should be 1 (from the process_spider_exception chain, the items - from the spider callback are lost) - """ - log5 = await self.crawl_log(NotGeneratorOutputChainSpider) - assert "'item_scraped_count': 1" in str(log5) - assert ( - "GeneratorRecoverMiddleware.process_spider_exception: ReferenceError caught" - in str(log5) - ) - assert ( - "GeneratorDoNothingAfterFailureMiddleware.process_spider_exception: ReferenceError caught" - in str(log5) - ) - assert ( - "GeneratorFailMiddleware.process_spider_exception: ReferenceError caught" - not in str(log5) - ) - assert ( - "GeneratorDoNothingAfterRecoveryMiddleware.process_spider_exception: ReferenceError caught" - not in str(log5) - ) - item_recovered = { - "processed": [ - "NotGeneratorRecoverMiddleware.process_spider_exception", - "NotGeneratorDoNothingAfterRecoveryMiddleware.process_spider_output", - ] - } - assert str(item_recovered) in str(log5) - assert "parse-first-item" not in str(log5) - assert "parse-second-item" not in str(log5) diff --git a/tests/test_spidermiddleware_process_start.py b/tests/test_spidermiddleware_process_start.py index e1c8b5fec..67ce3a920 100644 --- a/tests/test_spidermiddleware_process_start.py +++ b/tests/test_spidermiddleware_process_start.py @@ -1,21 +1,18 @@ -import warnings from asyncio import sleep import pytest -from twisted.trial.unittest import TestCase from scrapy import Spider, signals -from scrapy.exceptions import ScrapyDeprecationWarning -from scrapy.utils.defer import deferred_f_from_coro_f, maybe_deferred_to_future +from scrapy.utils.defer import maybe_deferred_to_future from scrapy.utils.test import get_crawler from tests.test_spider_start import SLEEP_SECONDS from .utils import twisted_sleep +from .utils.decorators import coroutine_test ITEM_A = {"id": "a"} ITEM_B = {"id": "b"} ITEM_C = {"id": "c"} -ITEM_D = {"id": "d"} class AsyncioSleepSpiderMiddleware: @@ -38,15 +35,6 @@ class TwistedSleepSpiderMiddleware: yield item_or_request -class UniversalSpiderMiddleware: - async def process_start(self, start): - async for item_or_request in start: - yield item_or_request - - def process_start_requests(self, start_requests, spider): - raise NotImplementedError - - # Spiders and spider middlewares for TestMain._test_wrap @@ -57,27 +45,6 @@ class ModernWrapSpider(Spider): yield ITEM_B -class ModernWrapSpiderSubclass(ModernWrapSpider): - name = "test" - - -class UniversalWrapSpider(Spider): - name = "test" - - async def start(self): - yield ITEM_B - - def start_requests(self): - yield ITEM_D - - -class DeprecatedWrapSpider(Spider): - name = "test" - - def start_requests(self): - yield ITEM_B - - class ModernWrapSpiderMiddleware: async def process_start(self, start): yield ITEM_A @@ -86,27 +53,7 @@ class ModernWrapSpiderMiddleware: yield ITEM_C -class UniversalWrapSpiderMiddleware: - async def process_start(self, start): - yield ITEM_A - async for item_or_request in start: - yield item_or_request - yield ITEM_C - - def process_start_requests(self, start, spider): - yield ITEM_A - yield from start - yield ITEM_C - - -class DeprecatedWrapSpiderMiddleware: - def process_start_requests(self, start, spider): - yield ITEM_A - yield from start - yield ITEM_C - - -class TestMain(TestCase): +class TestMain: async def _test(self, spider_middlewares, spider_cls, expected_items): actual_items = [] @@ -118,7 +65,7 @@ class TestMain(TestCase): } crawler = get_crawler(spider_cls, settings_dict=settings) crawler.signals.connect(track_item, signals.item_scraped) - await maybe_deferred_to_future(crawler.crawl()) + await crawler.crawl_async() assert crawler.stats.get_value("finish_reason") == "finished" assert actual_items == expected_items, f"{actual_items=} != {expected_items=}" @@ -126,199 +73,9 @@ class TestMain(TestCase): expected_items = expected_items or [ITEM_A, ITEM_B, ITEM_C] await self._test([spider_middleware], spider_cls, expected_items) - async def _test_douple_wrap(self, smw1, smw2, spider_cls, expected_items=None): - expected_items = expected_items or [ITEM_A, ITEM_A, ITEM_B, ITEM_C, ITEM_C] - await self._test([smw1, smw2], spider_cls, expected_items) - - @deferred_f_from_coro_f + @coroutine_test async def test_modern_mw_modern_spider(self): - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_wrap(ModernWrapSpiderMiddleware, ModernWrapSpider) - - @deferred_f_from_coro_f - async def test_modern_mw_universal_spider(self): - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_wrap(ModernWrapSpiderMiddleware, UniversalWrapSpider) - - @deferred_f_from_coro_f - async def test_modern_mw_deprecated_spider(self): - with pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated start_requests\(\)" - ): - await self._test_wrap(ModernWrapSpiderMiddleware, DeprecatedWrapSpider) - - @deferred_f_from_coro_f - async def test_universal_mw_modern_spider(self): - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_wrap(UniversalWrapSpiderMiddleware, ModernWrapSpider) - - @deferred_f_from_coro_f - async def test_universal_mw_universal_spider(self): - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_wrap(UniversalWrapSpiderMiddleware, UniversalWrapSpider) - - @deferred_f_from_coro_f - async def test_universal_mw_deprecated_spider(self): - with pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated start_requests\(\)" - ): - await self._test_wrap(UniversalWrapSpiderMiddleware, DeprecatedWrapSpider) - - @deferred_f_from_coro_f - async def test_deprecated_mw_modern_spider(self): - with ( - pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated process_start_requests\(\)" - ), - pytest.raises( - ValueError, match=r"only compatible with \(deprecated\) spiders" - ), - ): - await self._test_wrap(DeprecatedWrapSpiderMiddleware, ModernWrapSpider) - - @deferred_f_from_coro_f - async def test_deprecated_mw_modern_spider_subclass(self): - with ( - pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated process_start_requests\(\)" - ), - pytest.raises( - ValueError, - match=r"^\S+?\.ModernWrapSpider \(inherited by \S+?.ModernWrapSpiderSubclass\) .*? only compatible with \(deprecated\) spiders", - ), - ): - await self._test_wrap( - DeprecatedWrapSpiderMiddleware, ModernWrapSpiderSubclass - ) - - @deferred_f_from_coro_f - async def test_deprecated_mw_universal_spider(self): - with pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated process_start_requests\(\)" - ): - await self._test_wrap( - DeprecatedWrapSpiderMiddleware, - UniversalWrapSpider, - [ITEM_A, ITEM_D, ITEM_C], - ) - - @deferred_f_from_coro_f - async def test_deprecated_mw_deprecated_spider(self): - with ( - pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated process_start_requests\(\)" - ), - pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated start_requests\(\)" - ), - ): - await self._test_wrap(DeprecatedWrapSpiderMiddleware, DeprecatedWrapSpider) - - @deferred_f_from_coro_f - async def test_modern_mw_universal_mw_modern_spider(self): - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_douple_wrap( - ModernWrapSpiderMiddleware, - UniversalWrapSpiderMiddleware, - ModernWrapSpider, - ) - - @deferred_f_from_coro_f - async def test_modern_mw_deprecated_mw_modern_spider(self): - with pytest.raises(ValueError, match=r"trying to combine spider middlewares"): - await self._test_douple_wrap( - ModernWrapSpiderMiddleware, - DeprecatedWrapSpiderMiddleware, - ModernWrapSpider, - ) - - @deferred_f_from_coro_f - async def test_universal_mw_deprecated_mw_modern_spider(self): - with ( - pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated process_start_requests\(\)" - ), - pytest.raises( - ValueError, match=r"only compatible with \(deprecated\) spiders" - ), - ): - await self._test_douple_wrap( - UniversalWrapSpiderMiddleware, - DeprecatedWrapSpiderMiddleware, - ModernWrapSpider, - ) - - @deferred_f_from_coro_f - async def test_modern_mw_universal_mw_universal_spider(self): - with warnings.catch_warnings(): - warnings.simplefilter("error") - await self._test_douple_wrap( - ModernWrapSpiderMiddleware, - UniversalWrapSpiderMiddleware, - UniversalWrapSpider, - ) - - @deferred_f_from_coro_f - async def test_modern_mw_deprecated_mw_universal_spider(self): - with pytest.raises(ValueError, match=r"trying to combine spider middlewares"): - await self._test_douple_wrap( - ModernWrapSpiderMiddleware, - DeprecatedWrapSpiderMiddleware, - UniversalWrapSpider, - ) - - @deferred_f_from_coro_f - async def test_universal_mw_deprecated_mw_universal_spider(self): - with pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated process_start_requests\(\)" - ): - await self._test_douple_wrap( - UniversalWrapSpiderMiddleware, - DeprecatedWrapSpiderMiddleware, - UniversalWrapSpider, - [ITEM_A, ITEM_A, ITEM_D, ITEM_C, ITEM_C], - ) - - @deferred_f_from_coro_f - async def test_modern_mw_universal_mw_deprecated_spider(self): - with pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated start_requests\(\)" - ): - await self._test_douple_wrap( - ModernWrapSpiderMiddleware, - UniversalWrapSpiderMiddleware, - DeprecatedWrapSpider, - ) - - @deferred_f_from_coro_f - async def test_modern_mw_deprecated_mw_deprecated_spider(self): - with pytest.raises(ValueError, match=r"trying to combine spider middlewares"): - await self._test_douple_wrap( - ModernWrapSpiderMiddleware, - DeprecatedWrapSpiderMiddleware, - DeprecatedWrapSpider, - ) - - @deferred_f_from_coro_f - async def test_universal_mw_deprecated_mw_deprecated_spider(self): - with ( - pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated process_start_requests\(\)" - ), - pytest.warns( - ScrapyDeprecationWarning, match=r"deprecated start_requests\(\)" - ), - ): - await self._test_douple_wrap( - UniversalWrapSpiderMiddleware, - DeprecatedWrapSpiderMiddleware, - DeprecatedWrapSpider, - ) + await self._test_wrap(ModernWrapSpiderMiddleware, ModernWrapSpider) async def _test_sleep(self, spider_middlewares): class TestSpider(Spider): @@ -330,22 +87,24 @@ class TestMain(TestCase): await self._test(spider_middlewares, TestSpider, [ITEM_A]) @pytest.mark.only_asyncio - @deferred_f_from_coro_f + @coroutine_test async def test_asyncio_sleep_single(self): await self._test_sleep([AsyncioSleepSpiderMiddleware]) @pytest.mark.only_asyncio - @deferred_f_from_coro_f + @coroutine_test async def test_asyncio_sleep_multiple(self): await self._test_sleep( [NoOpSpiderMiddleware, AsyncioSleepSpiderMiddleware, NoOpSpiderMiddleware] ) - @deferred_f_from_coro_f + @pytest.mark.requires_reactor # needs a reactor for twisted_sleep() + @coroutine_test async def test_twisted_sleep_single(self): await self._test_sleep([TwistedSleepSpiderMiddleware]) - @deferred_f_from_coro_f + @pytest.mark.requires_reactor # needs a reactor for twisted_sleep() + @coroutine_test async def test_twisted_sleep_multiple(self): await self._test_sleep( [NoOpSpiderMiddleware, TwistedSleepSpiderMiddleware, NoOpSpiderMiddleware] diff --git a/tests/test_spidermiddleware_referer.py b/tests/test_spidermiddleware_referer.py index 300a40c13..b3a434c3f 100644 --- a/tests/test_spidermiddleware_referer.py +++ b/tests/test_spidermiddleware_referer.py @@ -6,7 +6,7 @@ from urllib.parse import urlparse import pytest -from scrapy.downloadermiddlewares.redirect import RedirectMiddleware +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request, Response from scrapy.settings import Settings from scrapy.spidermiddlewares.referer import ( @@ -31,7 +31,9 @@ from scrapy.spidermiddlewares.referer import ( StrictOriginWhenCrossOriginPolicy, UnsafeUrlPolicy, ) -from scrapy.spiders import Spider +from scrapy.utils.misc import build_from_crawler +from scrapy.utils.test import get_crawler +from tests.utils.decorators import coroutine_test class TestRefererMiddleware: @@ -42,22 +44,22 @@ class TestRefererMiddleware: ("http://scrapytest.org", "http://scrapytest.org/", b"http://scrapytest.org"), ] - def setup_method(self): - self.spider = Spider("foo") + @pytest.fixture + def mw(self) -> RefererMiddleware: settings = Settings(self.settings) - self.mw = RefererMiddleware(settings) + return RefererMiddleware(settings) - def get_request(self, target): + def get_request(self, target: str) -> Request: return Request(target, meta=self.req_meta) - def get_response(self, origin): + def get_response(self, origin: str) -> Response: return Response(origin, headers=self.resp_headers) - def test(self): + def test(self, mw: RefererMiddleware) -> None: for origin, target, referrer in self.scenarii: response = self.get_response(origin) request = self.get_request(target) - out = list(self.mw.process_spider_output(response, [request], self.spider)) + out = list(mw.process_spider_output(response, [request])) assert out[0].headers.get("Referer") == referrer @@ -835,19 +837,20 @@ class TestRequestMetaSettingFallback: request_meta, policy_class, check_warning, - ) in self.params[3:]: + ) in self.params: mw = RefererMiddleware(Settings(settings)) response = Response(origin, headers=response_headers) request = Request(target, meta=request_meta) - with warnings.catch_warnings(record=True) as w: + if check_warning: + with pytest.warns( + RuntimeWarning, match="Could not load referrer policy" + ): + policy = mw.policy(response, request) + else: policy = mw.policy(response, request) - assert isinstance(policy, policy_class) - - if check_warning: - assert len(w) == 1 - assert w[0].category is RuntimeWarning, w[0].message + assert isinstance(policy, policy_class) class TestSettingsPolicyByName: @@ -964,379 +967,151 @@ class TestPolicyHeaderPrecedence004( resp_headers = {"Referrer-Policy": ""} -class TestReferrerOnRedirect(TestRefererMiddleware): - settings = {"REFERRER_POLICY": "scrapy.spidermiddlewares.referer.UnsafeUrlPolicy"} - scenarii: list[ - tuple[str, str, tuple[tuple[int, str], ...], bytes | None, bytes | None] - ] = [ # type: ignore[assignment] - ( - "http://scrapytest.org/1", # parent - "http://scrapytest.org/2", # target - ( - # redirections: code, URL - (301, "http://scrapytest.org/3"), - (301, "http://scrapytest.org/4"), - ), - b"http://scrapytest.org/1", # expected initial referer - b"http://scrapytest.org/1", # expected referer for the redirection request - ), - ( - "https://scrapytest.org/1", - "https://scrapytest.org/2", - ( - # redirecting to non-secure URL - (301, "http://scrapytest.org/3"), - ), - b"https://scrapytest.org/1", - b"https://scrapytest.org/1", - ), - ( - "https://scrapytest.org/1", - "https://scrapytest.com/2", - ( - # redirecting to non-secure URL: different origin - (301, "http://scrapytest.com/3"), - ), - b"https://scrapytest.org/1", - b"https://scrapytest.org/1", - ), - ] - +class TestPolicyMethodResponseParamRename: def setup_method(self): - self.spider = Spider("foo") - settings = Settings(self.settings) - self.referrermw = RefererMiddleware(settings) - self.redirectmw = RedirectMiddleware(settings) + self.crawler = get_crawler() + self.mw = build_from_crawler(RefererMiddleware, self.crawler) + self.request = Request("http://www.example.com") + self.response = Response("http://www.example.com") - def test(self): - for ( - parent, - target, - redirections, - init_referrer, - final_referrer, - ) in self.scenarii: - response = self.get_response(parent) - request = self.get_request(target) + def test_pos_string(self): + with pytest.warns( + ScrapyDeprecationWarning, + match=r"Passing a response URL to RefererMiddleware\.policy\(\)", + ): + self.mw.policy("http://old.com", self.request) - out = list( - self.referrermw.process_spider_output(response, [request], self.spider) + def test_pos_response(self): + with warnings.catch_warnings(): + warnings.filterwarnings( + "error", + category=ScrapyDeprecationWarning, + message=r"Passing 'resp_or_url' is deprecated", ) - assert out[0].headers.get("Referer") == init_referrer + self.mw.policy(self.response, self.request) - for status, url in redirections: - response = Response( - request.url, headers={"Location": url}, status=status - ) - request = self.redirectmw.process_response( - request, response, self.spider - ) - self.referrermw.request_scheduled(request, self.spider) + def test_key_resp_or_url(self): + with pytest.warns( + ScrapyDeprecationWarning, match=r"Passing 'resp_or_url' is deprecated" + ): + self.mw.policy(resp_or_url=self.response, request=self.request) - assert isinstance(request, Request) - assert request.headers.get("Referer") == final_referrer + def test_key_response(self): + with warnings.catch_warnings(): + warnings.filterwarnings( + "error", + category=ScrapyDeprecationWarning, + message=r"Passing 'resp_or_url' is deprecated", + ) + self.mw.policy(response=self.response, request=self.request) + + def test_key_response_string(self): + with pytest.warns(ScrapyDeprecationWarning, match="Passing a response URL"): + self.mw.policy(response="http://old.com", request=self.request) + + def test_both_resp_or_url_and_response(self): + with pytest.raises( + TypeError, match="Cannot pass both 'response' and 'resp_or_url'" + ): + self.mw.policy( + response=self.response, resp_or_url=self.response, request=self.request + ) -class TestReferrerOnRedirectNoReferrer(TestReferrerOnRedirect): - """ - No Referrer policy never sets the "Referer" header. - HTTP redirections should not change that. - """ +@coroutine_test +async def test_response_policy_only_supports_policy_names(): + crawler = get_crawler(settings_dict={"REFERRER_POLICY": "no-referrer"}) + mw = build_from_crawler(RefererMiddleware, crawler) - settings = {"REFERRER_POLICY": "no-referrer"} - scenarii = [ - ( - "http://scrapytest.org/1", # parent - "http://scrapytest.org/2", # target - ( - # redirections: code, URL - (301, "http://scrapytest.org/3"), - (301, "http://scrapytest.org/4"), - ), - None, # expected initial "Referer" - None, # expected "Referer" for the redirection request - ), - ( - "https://scrapytest.org/1", - "https://scrapytest.org/2", - ((301, "http://scrapytest.org/3"),), - None, - None, - ), - ( - "https://scrapytest.org/1", - "https://example.com/2", # different origin - ((301, "http://scrapytest.com/3"),), - None, - None, - ), + async def input_result(): + yield Request("https://example.com/") + + response = Response( + "https://example.com/", + headers={ + "Referrer-Policy": "scrapy.spidermiddlewares.referer.NoReferrerWhenDowngradePolicy" + }, + ) + with pytest.warns( + RuntimeWarning, + match=r"Could not load referrer policy 'scrapy\.spidermiddlewares\.referer\.NoReferrerWhenDowngradePolicy' \(import paths from the response Referrer-Policy header are not allowed\)", + ): + output = [ + request + async for request in mw.process_spider_output_async( + response, input_result() + ) + ] + assert len(output) == 1 + assert b"Referer" not in output[0].headers + + response = Response( + "https://example.com/", + headers={"Referrer-Policy": "no-referrer-when-downgrade"}, + ) + output = [ + request + async for request in mw.process_spider_output_async(response, input_result()) ] + assert len(output) == 1 + assert output[0].headers == {b"Referer": [b"https://example.com/"]} -class TestReferrerOnRedirectSameOrigin(TestReferrerOnRedirect): - """ - Same Origin policy sends the full URL as "Referer" if the target origin - is the same as the parent response (same protocol, same domain, same port). +@coroutine_test +async def test_referer_policies_setting(): + crawler = get_crawler( + settings_dict={ + "REFERRER_POLICY": "no-referrer", + "REFERRER_POLICIES": { + "no-referrer-when-downgrade": None, + "custom-policy": CustomPythonOrgPolicy, + "": CustomPythonOrgPolicy, + }, + } + ) + mw = build_from_crawler(RefererMiddleware, crawler) - HTTP redirections to a different domain or a lower secure level - should have the "Referer" removed. - """ + async def input_result(): + yield Request("https://example.com/") - settings = {"REFERRER_POLICY": "same-origin"} - scenarii = [ - ( - "http://scrapytest.org/101", # origin - "http://scrapytest.org/102", # target - ( - # redirections: code, URL - (301, "http://scrapytest.org/103"), - (301, "http://scrapytest.org/104"), - ), - b"http://scrapytest.org/101", # expected initial "Referer" - b"http://scrapytest.org/101", # expected referer for the redirection request - ), - ( - "https://scrapytest.org/201", - "https://scrapytest.org/202", - ( - # redirecting from secure to non-secure URL == different origin - (301, "http://scrapytest.org/203"), - ), - b"https://scrapytest.org/201", - None, - ), - ( - "https://scrapytest.org/301", - "https://scrapytest.org/302", - ( - # different domain == different origin - (301, "http://example.com/303"), - ), - b"https://scrapytest.org/301", - None, - ), + # "no-referrer-when-downgrade": None, + response = Response( + "https://example.com/", + headers={"Referrer-Policy": "no-referrer-when-downgrade"}, + ) + with pytest.warns( + RuntimeWarning, + match=r"Could not load referrer policy 'no-referrer-when-downgrade'", + ): + output = [ + request + async for request in mw.process_spider_output_async( + response, input_result() + ) + ] + assert len(output) == 1 + assert b"Referer" not in output[0].headers + + # "custom-policy": CustomPythonOrgPolicy, + response = Response( + "https://example.com/", + headers={"Referrer-Policy": "custom-policy"}, + ) + output = [ + request + async for request in mw.process_spider_output_async(response, input_result()) ] + assert len(output) == 1 + assert output[0].headers == {b"Referer": [b"https://python.org/"]} - -class TestReferrerOnRedirectStrictOrigin(TestReferrerOnRedirect): - """ - Strict Origin policy will always send the "origin" as referrer - (think of it as the parent URL without the path part), - unless the security level is lower and no "Referer" is sent. - - Redirections from secure to non-secure URLs should have the - "Referrer" header removed if necessary. - """ - - settings = {"REFERRER_POLICY": POLICY_STRICT_ORIGIN} - scenarii = [ - ( - "http://scrapytest.org/101", - "http://scrapytest.org/102", - ( - (301, "http://scrapytest.org/103"), - (301, "http://scrapytest.org/104"), - ), - b"http://scrapytest.org/", # send origin - b"http://scrapytest.org/", # redirects to same origin: send origin - ), - ( - "https://scrapytest.org/201", - "https://scrapytest.org/202", - ( - # redirecting to non-secure URL: no referrer - (301, "http://scrapytest.org/203"), - ), - b"https://scrapytest.org/", - None, - ), - ( - "https://scrapytest.org/301", - "https://scrapytest.org/302", - ( - # redirecting to non-secure URL (different domain): no referrer - (301, "http://example.com/303"), - ), - b"https://scrapytest.org/", - None, - ), - ( - "http://scrapy.org/401", - "http://example.com/402", - ((301, "http://scrapytest.org/403"),), - b"http://scrapy.org/", - b"http://scrapy.org/", - ), - ( - "https://scrapy.org/501", - "https://example.com/502", - ( - # HTTPS all along, so origin referrer is kept as-is - (301, "https://google.com/503"), - (301, "https://facebook.com/504"), - ), - b"https://scrapy.org/", - b"https://scrapy.org/", - ), - ( - "https://scrapytest.org/601", - "http://scrapytest.org/602", # TLS to non-TLS: no referrer - ( - ( - 301, - "https://scrapytest.org/603", - ), # TLS URL again: (still) no referrer - ), - None, - None, - ), - ] - - -class TestReferrerOnRedirectOriginWhenCrossOrigin(TestReferrerOnRedirect): - """ - Origin When Cross-Origin policy sends the full URL as "Referer", - unless the target's origin is different (different domain, different protocol) - in which case only the origin is sent. - - Redirections to a different origin should strip the "Referer" - to the parent origin. - """ - - settings = {"REFERRER_POLICY": POLICY_ORIGIN_WHEN_CROSS_ORIGIN} - scenarii = [ - ( - "http://scrapytest.org/101", # origin - "http://scrapytest.org/102", # target + redirection - ( - # redirections: code, URL - (301, "http://scrapytest.org/103"), - (301, "http://scrapytest.org/104"), - ), - b"http://scrapytest.org/101", # expected initial referer - b"http://scrapytest.org/101", # expected referer for the redirection request - ), - ( - "https://scrapytest.org/201", - "https://scrapytest.org/202", - ( - # redirecting to non-secure URL: send origin - (301, "http://scrapytest.org/203"), - ), - b"https://scrapytest.org/201", - b"https://scrapytest.org/", - ), - ( - "https://scrapytest.org/301", - "https://scrapytest.org/302", - ( - # redirecting to non-secure URL (different domain): send origin - (301, "http://example.com/303"), - ), - b"https://scrapytest.org/301", - b"https://scrapytest.org/", - ), - ( - "http://scrapy.org/401", - "http://example.com/402", - ((301, "http://scrapytest.org/403"),), - b"http://scrapy.org/", - b"http://scrapy.org/", - ), - ( - "https://scrapy.org/501", - "https://example.com/502", - ( - # all different domains: send origin - (301, "https://google.com/503"), - (301, "https://facebook.com/504"), - ), - b"https://scrapy.org/", - b"https://scrapy.org/", - ), - ( - "https://scrapytest.org/301", - "http://scrapytest.org/302", # TLS to non-TLS: send origin - ((301, "https://scrapytest.org/303"),), # TLS URL again: send origin (also) - b"https://scrapytest.org/", - b"https://scrapytest.org/", - ), - ] - - -class TestReferrerOnRedirectStrictOriginWhenCrossOrigin(TestReferrerOnRedirect): - """ - Strict Origin When Cross-Origin policy sends the full URL as "Referer", - unless the target's origin is different (different domain, different protocol) - in which case only the origin is sent... - Unless there's also a downgrade in security and then the "Referer" header - is not sent. - - Redirections to a different origin should strip the "Referer" to the parent origin, - and from https:// to http:// will remove the "Referer" header. - """ - - settings = {"REFERRER_POLICY": POLICY_STRICT_ORIGIN_WHEN_CROSS_ORIGIN} - scenarii = [ - ( - "http://scrapytest.org/101", # origin - "http://scrapytest.org/102", # target + redirection - ( - # redirections: code, URL - (301, "http://scrapytest.org/103"), - (301, "http://scrapytest.org/104"), - ), - b"http://scrapytest.org/101", # expected initial referer - b"http://scrapytest.org/101", # expected referer for the redirection request - ), - ( - "https://scrapytest.org/201", - "https://scrapytest.org/202", - ( - # redirecting to non-secure URL: do not send the "Referer" header - (301, "http://scrapytest.org/203"), - ), - b"https://scrapytest.org/201", - None, - ), - ( - "https://scrapytest.org/301", - "https://scrapytest.org/302", - ( - # redirecting to non-secure URL (different domain): send origin - (301, "http://example.com/303"), - ), - b"https://scrapytest.org/301", - None, - ), - ( - "http://scrapy.org/401", - "http://example.com/402", - ((301, "http://scrapytest.org/403"),), - b"http://scrapy.org/", - b"http://scrapy.org/", - ), - ( - "https://scrapy.org/501", - "https://example.com/502", - ( - # all different domains: send origin - (301, "https://google.com/503"), - (301, "https://facebook.com/504"), - ), - b"https://scrapy.org/", - b"https://scrapy.org/", - ), - ( - "https://scrapytest.org/601", - "http://scrapytest.org/602", # TLS to non-TLS: do not send "Referer" - ( - ( - 301, - "https://scrapytest.org/603", - ), # TLS URL again: (still) send nothing - ), - None, - None, - ), + # "": CustomPythonOrgPolicy, + response = Response( + "https://example.com/", + headers={"Referrer-Policy": ""}, + ) + output = [ + request + async for request in mw.process_spider_output_async(response, input_result()) ] + assert len(output) == 1 + assert output[0].headers == {b"Referer": [b"https://python.org/"]} diff --git a/tests/test_spidermiddleware_start.py b/tests/test_spidermiddleware_start.py index 295b10ea8..26397d37c 100644 --- a/tests/test_spidermiddleware_start.py +++ b/tests/test_spidermiddleware_start.py @@ -1,15 +1,13 @@ -from twisted.trial.unittest import TestCase - from scrapy.http import Request from scrapy.spidermiddlewares.start import StartSpiderMiddleware from scrapy.spiders import Spider -from scrapy.utils.defer import deferred_f_from_coro_f from scrapy.utils.misc import build_from_crawler from scrapy.utils.test import get_crawler +from tests.utils.decorators import coroutine_test -class TestMiddleware(TestCase): - @deferred_f_from_coro_f +class TestMiddleware: + @coroutine_test async def test_async(self): crawler = get_crawler(Spider) mw = build_from_crawler(StartSpiderMiddleware, crawler) @@ -25,20 +23,3 @@ class TestMiddleware(TestCase): async for request in mw.process_start(start()) ] assert result == [True, True, False, "foo"] - - @deferred_f_from_coro_f - async def test_sync(self): - crawler = get_crawler(Spider) - mw = build_from_crawler(StartSpiderMiddleware, crawler) - - def start(): - yield Request("data:,1") - yield Request("data:,2", meta={"is_start_request": True}) - yield Request("data:,2", meta={"is_start_request": False}) - yield Request("data:,2", meta={"is_start_request": "foo"}) - - result = [ - request.meta["is_start_request"] - for request in mw.process_start_requests(start(), Spider("test")) - ] - assert result == [True, True, False, "foo"] diff --git a/tests/test_spidermiddleware_urllength.py b/tests/test_spidermiddleware_urllength.py index 5cc3cdc6c..750ae3b07 100644 --- a/tests/test_spidermiddleware_urllength.py +++ b/tests/test_spidermiddleware_urllength.py @@ -1,39 +1,56 @@ -from testfixtures import LogCapture +from __future__ import annotations + +from logging import INFO +from typing import TYPE_CHECKING + +import pytest from scrapy.http import Request, Response from scrapy.spidermiddlewares.urllength import UrlLengthMiddleware from scrapy.spiders import Spider from scrapy.utils.test import get_crawler +if TYPE_CHECKING: + from scrapy.crawler import Crawler + from scrapy.statscollectors import StatsCollector -class TestUrlLengthMiddleware: - def setup_method(self): - self.maxlength = 25 - crawler = get_crawler(Spider, {"URLLENGTH_LIMIT": self.maxlength}) - self.spider = crawler._create_spider("foo") - self.stats = crawler.stats - self.mw = UrlLengthMiddleware.from_crawler(crawler) - self.response = Response("http://scrapytest.org") - self.short_url_req = Request("http://scrapytest.org/") - self.long_url_req = Request("http://scrapytest.org/this_is_a_long_url") - self.reqs = [self.short_url_req, self.long_url_req] +maxlength = 25 +response = Response("http://scrapytest.org") +short_url_req = Request("http://scrapytest.org/") +long_url_req = Request("http://scrapytest.org/this_is_a_long_url") +reqs: list[Request] = [short_url_req, long_url_req] - def process_spider_output(self): - return list( - self.mw.process_spider_output(self.response, self.reqs, self.spider) - ) - def test_middleware_works(self): - assert self.process_spider_output() == [self.short_url_req] +@pytest.fixture +def crawler() -> Crawler: + return get_crawler(Spider, {"URLLENGTH_LIMIT": maxlength}) - def test_logging(self): - with LogCapture() as log: - self.process_spider_output() - ric = self.stats.get_value( - "urllength/request_ignored_count", spider=self.spider - ) - assert ric == 1 +@pytest.fixture +def stats(crawler: Crawler) -> StatsCollector: + assert crawler.stats is not None + return crawler.stats - assert f"Ignoring link (url length > {self.maxlength})" in str(log) + +@pytest.fixture +def mw(crawler: Crawler) -> UrlLengthMiddleware: + return UrlLengthMiddleware.from_crawler(crawler) + + +def process_spider_output(mw: UrlLengthMiddleware) -> list[Request]: + return list(mw.process_spider_output(response, reqs)) + + +def test_middleware_works(mw: UrlLengthMiddleware) -> None: + assert process_spider_output(mw) == [short_url_req] + + +def test_logging( + stats: StatsCollector, mw: UrlLengthMiddleware, caplog: pytest.LogCaptureFixture +) -> None: + with caplog.at_level(INFO): + process_spider_output(mw) + ric = stats.get_value("urllength/request_ignored_count") + assert ric == 1 + assert f"Ignoring link (url length > {maxlength})" in caplog.text diff --git a/tests/test_spiderstate.py b/tests/test_spiderstate.py index cd31891a0..e44cfca90 100644 --- a/tests/test_spiderstate.py +++ b/tests/test_spiderstate.py @@ -1,6 +1,7 @@ -import shutil +from __future__ import annotations + from datetime import datetime, timezone -from tempfile import mkdtemp +from typing import TYPE_CHECKING import pytest @@ -9,38 +10,43 @@ from scrapy.extensions.spiderstate import SpiderState from scrapy.spiders import Spider from scrapy.utils.test import get_crawler +if TYPE_CHECKING: + from pathlib import Path -class TestSpiderState: - def test_store_load(self): - jobdir = mkdtemp() - try: - spider = Spider(name="default") - dt = datetime.now(tz=timezone.utc) - ss = SpiderState(jobdir) - ss.spider_opened(spider) - spider.state["one"] = 1 - spider.state["dt"] = dt - ss.spider_closed(spider) +def test_store_load(tmp_path: Path) -> None: + jobdir = str(tmp_path) - spider2 = Spider(name="default") - ss2 = SpiderState(jobdir) - ss2.spider_opened(spider2) - assert spider.state == {"one": 1, "dt": dt} - ss2.spider_closed(spider2) - finally: - shutil.rmtree(jobdir) + spider = Spider(name="default") + dt = datetime.now(tz=timezone.utc) - def test_state_attribute(self): - # state attribute must be present if jobdir is not set, to provide a - # consistent interface - spider = Spider(name="default") - ss = SpiderState() - ss.spider_opened(spider) - assert spider.state == {} - ss.spider_closed(spider) + ss = SpiderState(jobdir) + ss.spider_opened(spider) + assert hasattr(spider, "state") + spider.state["one"] = 1 + spider.state["dt"] = dt + ss.spider_closed(spider) - def test_not_configured(self): - crawler = get_crawler(Spider) - with pytest.raises(NotConfigured): - SpiderState.from_crawler(crawler) + spider2 = Spider(name="default") + ss2 = SpiderState(jobdir) + ss2.spider_opened(spider2) + assert hasattr(spider2, "state") + assert spider2.state == {"one": 1, "dt": dt} + ss2.spider_closed(spider2) + + +def test_state_attribute() -> None: + # state attribute must be present if jobdir is not set, to provide a + # consistent interface + spider = Spider(name="default") + ss = SpiderState() + ss.spider_opened(spider) + assert hasattr(spider, "state") + assert spider.state == {} + ss.spider_closed(spider) + + +def test_not_configured() -> None: + crawler = get_crawler(Spider) + with pytest.raises(NotConfigured): + SpiderState.from_crawler(crawler) diff --git a/tests/test_squeues.py b/tests/test_squeues.py index 21bbeece2..ddc12766c 100644 --- a/tests/test_squeues.py +++ b/tests/test_squeues.py @@ -33,13 +33,13 @@ def nonserializable_object_test(self): q = self.queue() with pytest.raises( ValueError, - match="unmarshallable object|Can't (get|pickle) local object|Can't pickle .*: it's not found as", + match=r"unmarshallable object|Can't (get|pickle) local object|Can't pickle .*: it's not found as", ): q.push(lambda x: x) # Selectors should fail (lxml.html.HtmlElement objects can't be pickled) sel = Selector(text="

some text

") with pytest.raises( - ValueError, match="unmarshallable object|can't pickle Selector objects" + ValueError, match=r"unmarshallable object|can't pickle Selector objects" ): q.push(sel) @@ -117,10 +117,10 @@ class PickleFifoDiskQueueTest(t.FifoDiskQueueTest, FifoDiskQueueTestMixin): q = self.queue() with pytest.raises( ValueError, - match="Can't (get|pickle) local object|Can't pickle .*: it's not found as", + match=r"Can't (get|pickle) local object|Can't pickle .*: it's not found as", ) as exc_info: q.push(lambda x: x) - if hasattr(sys, "pypy_version_info"): + if sys.version_info >= (3, 14) or hasattr(sys, "pypy_version_info"): assert isinstance(exc_info.value.__context__, pickle.PicklingError) else: assert isinstance(exc_info.value.__context__, AttributeError) diff --git a/tests/test_squeues_request.py b/tests/test_squeues_request.py index 8353ad73c..847a76ab6 100644 --- a/tests/test_squeues_request.py +++ b/tests/test_squeues_request.py @@ -2,7 +2,10 @@ Queues that handle requests """ -from pathlib import Path +from __future__ import annotations + +from abc import ABC, abstractmethod +from typing import TYPE_CHECKING import pytest import queuelib @@ -19,86 +22,65 @@ from scrapy.squeues import ( ) from scrapy.utils.test import get_crawler - -class TestBaseQueue: - def setup_method(self): - self.crawler = get_crawler(Spider) +if TYPE_CHECKING: + from scrapy.crawler import Crawler -class RequestQueueTestMixin: - def queue(self, base_path: Path): +HAVE_PEEK = hasattr(queuelib.queue.FifoMemoryQueue, "peek") + + +@pytest.fixture +def crawler() -> Crawler: + return get_crawler(Spider) + + +class TestRequestQueueBase(ABC): + @property + @abstractmethod + def is_fifo(self) -> bool: raise NotImplementedError - def test_one_element_with_peek(self, tmp_path): - if not hasattr(queuelib.queue.FifoMemoryQueue, "peek"): + @pytest.mark.parametrize("test_peek", [True, False]) + def test_one_element(self, q: queuelib.queue.BaseQueue, test_peek: bool): + if test_peek and not HAVE_PEEK: pytest.skip("The queuelib queues do not define peek") - q = self.queue(tmp_path) + if not test_peek and HAVE_PEEK: + pytest.skip("The queuelib queues define peek") assert len(q) == 0 - assert q.peek() is None + if test_peek: + assert q.peek() is None assert q.pop() is None req = Request("http://www.example.com") q.push(req) assert len(q) == 1 - assert q.peek().url == req.url - assert q.pop().url == req.url + if test_peek: + result = q.peek() + assert result is not None + assert result.url == req.url + else: + with pytest.raises( + NotImplementedError, + match="The underlying queue class does not implement 'peek'", + ): + q.peek() + result = q.pop() + assert result is not None + assert result.url == req.url assert len(q) == 0 - assert q.peek() is None + if test_peek: + assert q.peek() is None assert q.pop() is None q.close() - def test_one_element_without_peek(self, tmp_path): - if hasattr(queuelib.queue.FifoMemoryQueue, "peek"): - pytest.skip("The queuelib queues define peek") - q = self.queue(tmp_path) - assert len(q) == 0 - assert q.pop() is None - req = Request("http://www.example.com") - q.push(req) - assert len(q) == 1 - with pytest.raises( - NotImplementedError, - match="The underlying queue class does not implement 'peek'", - ): - q.peek() - assert q.pop().url == req.url - assert len(q) == 0 - assert q.pop() is None - q.close() - - -class FifoQueueMixin(RequestQueueTestMixin): - def test_fifo_with_peek(self, tmp_path): - if not hasattr(queuelib.queue.FifoMemoryQueue, "peek"): + @pytest.mark.parametrize("test_peek", [True, False]) + def test_order(self, q: queuelib.queue.BaseQueue, test_peek: bool): + if test_peek and not HAVE_PEEK: pytest.skip("The queuelib queues do not define peek") - q = self.queue(tmp_path) - assert len(q) == 0 - assert q.peek() is None - assert q.pop() is None - req1 = Request("http://www.example.com/1") - req2 = Request("http://www.example.com/2") - req3 = Request("http://www.example.com/3") - q.push(req1) - q.push(req2) - q.push(req3) - assert len(q) == 3 - assert q.peek().url == req1.url - assert q.pop().url == req1.url - assert len(q) == 2 - assert q.peek().url == req2.url - assert q.pop().url == req2.url - assert len(q) == 1 - assert q.peek().url == req3.url - assert q.pop().url == req3.url - assert len(q) == 0 - assert q.peek() is None - assert q.pop() is None - q.close() - - def test_fifo_without_peek(self, tmp_path): - if hasattr(queuelib.queue.FifoMemoryQueue, "peek"): + if not test_peek and HAVE_PEEK: pytest.skip("The queuelib queues define peek") - q = self.queue(tmp_path) assert len(q) == 0 + if test_peek: + assert q.peek() is None assert q.pop() is None req1 = Request("http://www.example.com/1") req2 = Request("http://www.example.com/2") @@ -106,111 +88,80 @@ class FifoQueueMixin(RequestQueueTestMixin): q.push(req1) q.push(req2) q.push(req3) - with pytest.raises( - NotImplementedError, - match="The underlying queue class does not implement 'peek'", - ): - q.peek() - assert len(q) == 3 - assert q.pop().url == req1.url - assert len(q) == 2 - assert q.pop().url == req2.url - assert len(q) == 1 - assert q.pop().url == req3.url + if not test_peek: + with pytest.raises( + NotImplementedError, + match="The underlying queue class does not implement 'peek'", + ): + q.peek() + reqs = [req1, req2, req3] if self.is_fifo else [req3, req2, req1] + for i, req in enumerate(reqs): + assert len(q) == 3 - i + if test_peek: + result = q.peek() + assert result is not None + assert result.url == req.url + result = q.pop() + assert result is not None + assert result.url == req.url assert len(q) == 0 + if test_peek: + assert q.peek() is None assert q.pop() is None q.close() -class LifoQueueMixin(RequestQueueTestMixin): - def test_lifo_with_peek(self, tmp_path): - if not hasattr(queuelib.queue.FifoMemoryQueue, "peek"): - pytest.skip("The queuelib queues do not define peek") - q = self.queue(tmp_path) - assert len(q) == 0 - assert q.peek() is None - assert q.pop() is None - req1 = Request("http://www.example.com/1") - req2 = Request("http://www.example.com/2") - req3 = Request("http://www.example.com/3") - q.push(req1) - q.push(req2) - q.push(req3) - assert len(q) == 3 - assert q.peek().url == req3.url - assert q.pop().url == req3.url - assert len(q) == 2 - assert q.peek().url == req2.url - assert q.pop().url == req2.url - assert len(q) == 1 - assert q.peek().url == req1.url - assert q.pop().url == req1.url - assert len(q) == 0 - assert q.peek() is None - assert q.pop() is None - q.close() +class TestPickleFifoDiskQueueRequest(TestRequestQueueBase): + is_fifo = True - def test_lifo_without_peek(self, tmp_path): - if hasattr(queuelib.queue.FifoMemoryQueue, "peek"): - pytest.skip("The queuelib queues define peek") - q = self.queue(tmp_path) - assert len(q) == 0 - assert q.pop() is None - req1 = Request("http://www.example.com/1") - req2 = Request("http://www.example.com/2") - req3 = Request("http://www.example.com/3") - q.push(req1) - q.push(req2) - q.push(req3) - with pytest.raises( - NotImplementedError, - match="The underlying queue class does not implement 'peek'", - ): - q.peek() - assert len(q) == 3 - assert q.pop().url == req3.url - assert len(q) == 2 - assert q.pop().url == req2.url - assert len(q) == 1 - assert q.pop().url == req1.url - assert len(q) == 0 - assert q.pop() is None - q.close() - - -class TestPickleFifoDiskQueueRequest(FifoQueueMixin, TestBaseQueue): - def queue(self, base_path): + @pytest.fixture + def q(self, crawler, tmp_path): return PickleFifoDiskQueue.from_crawler( - crawler=self.crawler, key=str(base_path / "pickle" / "fifo") + crawler=crawler, key=str(tmp_path / "pickle" / "fifo") ) -class TestPickleLifoDiskQueueRequest(LifoQueueMixin, TestBaseQueue): - def queue(self, base_path): +class TestPickleLifoDiskQueueRequest(TestRequestQueueBase): + is_fifo = False + + @pytest.fixture + def q(self, crawler, tmp_path): return PickleLifoDiskQueue.from_crawler( - crawler=self.crawler, key=str(base_path / "pickle" / "lifo") + crawler=crawler, key=str(tmp_path / "pickle" / "lifo") ) -class TestMarshalFifoDiskQueueRequest(FifoQueueMixin, TestBaseQueue): - def queue(self, base_path): +class TestMarshalFifoDiskQueueRequest(TestRequestQueueBase): + is_fifo = True + + @pytest.fixture + def q(self, crawler, tmp_path): return MarshalFifoDiskQueue.from_crawler( - crawler=self.crawler, key=str(base_path / "marshal" / "fifo") + crawler=crawler, key=str(tmp_path / "marshal" / "fifo") ) -class TestMarshalLifoDiskQueueRequest(LifoQueueMixin, TestBaseQueue): - def queue(self, base_path): +class TestMarshalLifoDiskQueueRequest(TestRequestQueueBase): + is_fifo = False + + @pytest.fixture + def q(self, crawler, tmp_path): return MarshalLifoDiskQueue.from_crawler( - crawler=self.crawler, key=str(base_path / "marshal" / "lifo") + crawler=crawler, key=str(tmp_path / "marshal" / "lifo") ) -class TestFifoMemoryQueueRequest(FifoQueueMixin, TestBaseQueue): - def queue(self, base_path): - return FifoMemoryQueue.from_crawler(crawler=self.crawler) +class TestFifoMemoryQueueRequest(TestRequestQueueBase): + is_fifo = True + + @pytest.fixture + def q(self, crawler): + return FifoMemoryQueue.from_crawler(crawler=crawler) -class TestLifoMemoryQueueRequest(LifoQueueMixin, TestBaseQueue): - def queue(self, base_path): - return LifoMemoryQueue.from_crawler(crawler=self.crawler) +class TestLifoMemoryQueueRequest(TestRequestQueueBase): + is_fifo = False + + @pytest.fixture + def q(self, crawler): + return LifoMemoryQueue.from_crawler(crawler=crawler) diff --git a/tests/test_stats.py b/tests/test_stats.py index 537614364..6e6aa0cc4 100644 --- a/tests/test_stats.py +++ b/tests/test_stats.py @@ -1,28 +1,48 @@ +from __future__ import annotations + from datetime import datetime +from typing import TYPE_CHECKING from unittest import mock +import pytest + +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.extensions.corestats import CoreStats from scrapy.spiders import Spider from scrapy.statscollectors import DummyStatsCollector, StatsCollector from scrapy.utils.test import get_crawler +from tests.spiders import SimpleSpider +from tests.utils.decorators import coroutine_test + +if TYPE_CHECKING: + from scrapy.crawler import Crawler + + +@pytest.fixture +def crawler() -> Crawler: + return get_crawler(Spider) + + +@pytest.fixture +def spider(crawler: Crawler) -> Spider: + return crawler._create_spider("foo") class TestCoreStatsExtension: - def setup_method(self): - self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider("foo") - + @mock.patch("scrapy.extensions.corestats.monotonic", return_value=0) @mock.patch("scrapy.extensions.corestats.datetime") - def test_core_stats_default_stats_collector(self, mock_datetime): + def test_core_stats_default_stats_collector( + self, mock_datetime: mock.Mock, crawler: Crawler, spider: Spider + ) -> None: fixed_datetime = datetime(2019, 12, 1, 11, 38) mock_datetime.now = mock.Mock(return_value=fixed_datetime) - self.crawler.stats = StatsCollector(self.crawler) - ext = CoreStats.from_crawler(self.crawler) - ext.spider_opened(self.spider) - ext.item_scraped({}, self.spider) - ext.response_received(self.spider) - ext.item_dropped({}, self.spider, ZeroDivisionError()) - ext.spider_closed(self.spider, "finished") + crawler.stats = StatsCollector(crawler) + ext = CoreStats.from_crawler(crawler) + ext.spider_opened(spider) + ext.item_scraped({}, spider) + ext.response_received(spider) + ext.item_dropped({}, spider, ZeroDivisionError()) + ext.spider_closed(spider, "finished") assert ext.stats._stats == { "start_time": fixed_datetime, "finish_time": fixed_datetime, @@ -34,24 +54,22 @@ class TestCoreStatsExtension: "elapsed_time_seconds": 0.0, } - def test_core_stats_dummy_stats_collector(self): - self.crawler.stats = DummyStatsCollector(self.crawler) - ext = CoreStats.from_crawler(self.crawler) - ext.spider_opened(self.spider) - ext.item_scraped({}, self.spider) - ext.response_received(self.spider) - ext.item_dropped({}, self.spider, ZeroDivisionError()) - ext.spider_closed(self.spider, "finished") + def test_core_stats_dummy_stats_collector( + self, crawler: Crawler, spider: Spider + ) -> None: + crawler.stats = DummyStatsCollector(crawler) + ext = CoreStats.from_crawler(crawler) + ext.spider_opened(spider) + ext.item_scraped({}, spider) + ext.response_received(spider) + ext.item_dropped({}, spider, ZeroDivisionError()) + ext.spider_closed(spider, "finished") assert ext.stats._stats == {} class TestStatsCollector: - def setup_method(self): - self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider("foo") - - def test_collector(self): - stats = StatsCollector(self.crawler) + def test_collector(self, crawler: Crawler) -> None: + stats = StatsCollector(crawler) assert stats.get_stats() == {} assert stats.get_value("anything") is None assert stats.get_value("anything", "default") == "default" @@ -76,9 +94,14 @@ class TestStatsCollector: assert stats.get_value("test2") == 35 stats.min_value("test4", 7) assert stats.get_value("test4") == 7 + stats.set_stats({"replaced": "stats"}) + assert stats.get_stats() == {"replaced": "stats"} + stats.clear_stats() + assert stats.get_stats() == {} - def test_dummy_collector(self): - stats = DummyStatsCollector(self.crawler) + def test_dummy_collector(self) -> None: + crawler = get_crawler(Spider, {"STATS_DUMP": False}) + stats = DummyStatsCollector(crawler) assert stats.get_stats() == {} assert stats.get_value("anything") is None assert stats.get_value("anything", "default") == "default" @@ -86,7 +109,87 @@ class TestStatsCollector: stats.inc_value("v1") stats.max_value("v2", 100) stats.min_value("v3", 100) - stats.open_spider("a") - stats.set_value("test", "value", spider=self.spider) + stats.set_stats({"key": "val"}) + stats.open_spider() + stats.set_value("test", "value") assert stats.get_stats() == {} - assert stats.get_stats("a") == {} + stats.close_spider() + + def test_deprecated_spider_arg(self, crawler: Crawler, spider: Spider) -> None: + stats = StatsCollector(crawler) + with pytest.warns( + ScrapyDeprecationWarning, + match=r"Passing a 'spider' argument to StatsCollector\.set_value\(\) is deprecated", + ): + stats.set_value("test", "value", spider=spider) + assert stats.get_stats() == {"test": "value"} + with pytest.warns( + ScrapyDeprecationWarning, + match=r"Passing a 'spider' argument to StatsCollector\.get_stats\(\) is deprecated", + ): + assert stats.get_stats(spider) == {"test": "value"} + + @coroutine_test + async def test_deprecated_spider_arg_custom_collector(self) -> None: + class CustomStatsCollector: + def __init__(self, crawler): + self._stats = {} + + def open_spider(self, spider): + pass + + def get_stats(self, spider=None): + return self._stats + + def inc_value(self, key, count=1, start=0, spider=None): + d = self._stats + d[key] = d.setdefault(key, start) + count + + def close_spider(self, spider, reason): + pass + + crawler = get_crawler(SimpleSpider, {"STATS_CLASS": CustomStatsCollector}) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"The open_spider\(\) method of .*CustomStatsCollector requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"The close_spider\(\) method of .*CustomStatsCollector requires a spider argument", + ), + ): + await crawler.crawl_async(url="data:,") + + @coroutine_test + async def test_deprecated_spider_arg_custom_collector_subclass(self) -> None: + class CustomStatsCollector(StatsCollector): + def open_spider(self, spider): # pylint: disable=signature-differs + super().open_spider(spider) + + def inc_value(self, key, count=1, start=0, spider=None): # pylint: disable=useless-parent-delegation + super().inc_value(key, count, start, spider) + + def close_spider(self, spider, reason): # pylint: disable=signature-differs + super().close_spider(spider, reason) + + crawler = get_crawler(SimpleSpider, {"STATS_CLASS": CustomStatsCollector}) + with ( + pytest.warns( + ScrapyDeprecationWarning, + match=r"The open_spider\(\) method of .*CustomStatsCollector requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"Passing a 'spider' argument to .*CustomStatsCollector\.open_spider\(\) is deprecated", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"The close_spider\(\) method of .*CustomStatsCollector requires a spider argument", + ), + pytest.warns( + ScrapyDeprecationWarning, + match=r"Passing a 'spider' argument to .*CustomStatsCollector\.close_spider\(\) is deprecated", + ), + ): + await crawler.crawl_async(url="data:,") diff --git a/tests/test_toplevel.py b/tests/test_toplevel.py index 66a6f5318..b7497c608 100644 --- a/tests/test_toplevel.py +++ b/tests/test_toplevel.py @@ -10,26 +10,26 @@ def test_version_info(): def test_request_shortcut(): - from scrapy.http import FormRequest, Request + from scrapy.http import FormRequest, Request # noqa: PLC0415 assert scrapy.Request is Request assert scrapy.FormRequest is FormRequest def test_spider_shortcut(): - from scrapy.spiders import Spider + from scrapy.spiders import Spider # noqa: PLC0415 assert scrapy.Spider is Spider def test_selector_shortcut(): - from scrapy.selector import Selector + from scrapy.selector import Selector # noqa: PLC0415 assert scrapy.Selector is Selector def test_item_shortcut(): - from scrapy.item import Field, Item + from scrapy.item import Field, Item # noqa: PLC0415 assert scrapy.Item is Item assert scrapy.Field is Field diff --git a/tests/test_utils_asyncgen.py b/tests/test_utils_asyncgen.py index 9b5a25b3a..fc4e1c487 100644 --- a/tests/test_utils_asyncgen.py +++ b/tests/test_utils_asyncgen.py @@ -1,17 +1,15 @@ -from twisted.trial import unittest - from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen -from scrapy.utils.defer import deferred_f_from_coro_f +from tests.utils.decorators import coroutine_test -class TestAsyncgenUtils(unittest.TestCase): - @deferred_f_from_coro_f +class TestAsyncgenUtils: + @coroutine_test async def test_as_async_generator(self): ag = as_async_generator(range(42)) results = [i async for i in ag] assert results == list(range(42)) - @deferred_f_from_coro_f + @coroutine_test async def test_collect_asyncgen(self): ag = as_async_generator(range(42)) results = await collect_asyncgen(ag) diff --git a/tests/test_utils_asyncio.py b/tests/test_utils_asyncio.py index a6e52eb26..5532b4a31 100644 --- a/tests/test_utils_asyncio.py +++ b/tests/test_utils_asyncio.py @@ -7,7 +7,6 @@ from unittest import mock import pytest from twisted.internet.defer import Deferred -from twisted.trial import unittest from scrapy.utils.asyncgen import as_async_generator from scrapy.utils.asyncio import ( @@ -15,21 +14,21 @@ from scrapy.utils.asyncio import ( _parallel_asyncio, is_asyncio_available, ) -from scrapy.utils.defer import deferred_f_from_coro_f +from tests.utils.decorators import coroutine_test if TYPE_CHECKING: from collections.abc import AsyncGenerator -@pytest.mark.usefixtures("reactor_pytest") class TestAsyncio: - def test_is_asyncio_available(self): + @coroutine_test + async def test_is_asyncio_available(self, reactor_pytest: str) -> None: # the result should depend only on the pytest --reactor argument - assert is_asyncio_available() == (self.reactor_pytest != "default") + assert is_asyncio_available() == (reactor_pytest != "default") @pytest.mark.only_asyncio -class TestParallelAsyncio(unittest.TestCase): +class TestParallelAsyncio: """Test for scrapy.utils.asyncio.parallel_asyncio(), based on tests.test_utils_defer.TestParallelAsync.""" CONCURRENT_ITEMS = 50 @@ -68,7 +67,7 @@ class TestParallelAsyncio(unittest.TestCase): await asyncio.sleep(random.random() / 20) yield i - @deferred_f_from_coro_f + @coroutine_test async def test_simple(self): for length in [20, 50, 100]: parallel_count = [0] @@ -84,9 +83,10 @@ class TestParallelAsyncio(unittest.TestCase): max_parallel_count, ) assert list(range(length)) == sorted(results) + assert parallel_count[0] == 0 assert max_parallel_count[0] <= self.CONCURRENT_ITEMS - @deferred_f_from_coro_f + @coroutine_test async def test_delays(self): for length in [20, 50, 100]: parallel_count = [0] @@ -102,12 +102,14 @@ class TestParallelAsyncio(unittest.TestCase): max_parallel_count, ) assert list(range(length)) == sorted(results) + assert parallel_count[0] == 0 assert max_parallel_count[0] <= self.CONCURRENT_ITEMS @pytest.mark.only_asyncio class TestAsyncioLoopingCall: - def test_looping_call(self): + @coroutine_test + async def test_looping_call(self): func = mock.MagicMock() looping_call = AsyncioLoopingCall(func) looping_call.start(1, now=False) @@ -116,21 +118,24 @@ class TestAsyncioLoopingCall: assert not looping_call.running assert not func.called - def test_looping_call_now(self): + @coroutine_test + async def test_looping_call_now(self): func = mock.MagicMock() looping_call = AsyncioLoopingCall(func) looping_call.start(1) looping_call.stop() assert func.called - def test_looping_call_already_running(self): + @coroutine_test + async def test_looping_call_already_running(self): looping_call = AsyncioLoopingCall(lambda: None) looping_call.start(1) with pytest.raises(RuntimeError): looping_call.start(1) looping_call.stop() - def test_looping_call_interval(self): + @coroutine_test + async def test_looping_call_interval(self): looping_call = AsyncioLoopingCall(lambda: None) with pytest.raises(ValueError, match="Interval must be greater than 0"): looping_call.start(0) @@ -138,7 +143,8 @@ class TestAsyncioLoopingCall: looping_call.start(-1) assert not looping_call.running - def test_looping_call_bad_function(self): + @coroutine_test + async def test_looping_call_bad_function(self): looping_call = AsyncioLoopingCall(Deferred) with pytest.raises(TypeError): looping_call.start(0.1) diff --git a/tests/test_utils_conf.py b/tests/test_utils_conf.py index ed7dda18d..b6a9d8b06 100644 --- a/tests/test_utils_conf.py +++ b/tests/test_utils_conf.py @@ -31,7 +31,7 @@ class TestBuildComponentList: # Same priority raises ValueError duplicate_bs.set("ONE", duplicate_bs["ONE"], priority=20) with pytest.raises( - ValueError, match="Some paths in .* convert to the same object" + ValueError, match=r"Some paths in .* convert to the same object" ): build_component_list(duplicate_bs, convert=lambda x: x.lower()) diff --git a/tests/test_utils_curl.py b/tests/test_utils_curl.py index 02362693a..0627a4b93 100644 --- a/tests/test_utils_curl.py +++ b/tests/test_utils_curl.py @@ -213,14 +213,16 @@ class TestCurlToRequestKwargs: def test_ignore_unknown_options(self): # case 1: ignore_unknown_options=True: + curl_command = "curl --bar --baz http://www.example.com" + expected_result = {"method": "GET", "url": "http://www.example.com"} with warnings.catch_warnings(): # avoid warning when executing tests - warnings.simplefilter("ignore") - curl_command = "curl --bar --baz http://www.example.com" - expected_result = {"method": "GET", "url": "http://www.example.com"} + warnings.filterwarnings( + "ignore", category=UserWarning, message="Unrecognized options:" + ) assert curl_to_request_kwargs(curl_command) == expected_result # case 2: ignore_unknown_options=False (raise exception): - with pytest.raises(ValueError, match="Unrecognized options:.*--bar.*--baz"): + with pytest.raises(ValueError, match=r"Unrecognized options:.*--bar.*--baz"): curl_to_request_kwargs( "curl --bar --baz http://www.example.com", ignore_unknown_options=False ) diff --git a/tests/test_utils_datatypes.py b/tests/test_utils_datatypes.py index 352e49165..ba6b82503 100644 --- a/tests/test_utils_datatypes.py +++ b/tests/test_utils_datatypes.py @@ -1,7 +1,7 @@ import copy -import warnings from abc import ABC, abstractmethod from collections.abc import Iterator, Mapping, MutableMapping +from typing import Any import pytest @@ -20,7 +20,7 @@ from scrapy.utils.python import garbage_collect class TestCaseInsensitiveDictBase(ABC): @property @abstractmethod - def dict_class(self) -> type[MutableMapping]: + def dict_class(self) -> type[MutableMapping[str, Any]]: raise NotImplementedError def test_init_dict(self): @@ -206,7 +206,7 @@ class TestCaseInsensitiveDictBase(ABC): class TestCaseInsensitiveDict(TestCaseInsensitiveDictBase): - dict_class = CaseInsensitiveDict + dict_class = CaseInsensitiveDict # type: ignore[assignment] def test_repr(self): d1 = self.dict_class({"foo": "bar"}) @@ -226,18 +226,12 @@ class TestCaselessDict(TestCaseInsensitiveDictBase): dict_class = CaselessDict def test_deprecation_message(self): - with warnings.catch_warnings(record=True) as caught: - warnings.filterwarnings("always", category=ScrapyDeprecationWarning) + with pytest.warns( + ScrapyDeprecationWarning, + match=r"scrapy.utils.datatypes.CaselessDict is deprecated", + ): self.dict_class({"foo": "bar"}) - assert len(caught) == 1 - assert issubclass(caught[0].category, ScrapyDeprecationWarning) - assert ( - str(caught[0].message) - == "scrapy.utils.datatypes.CaselessDict is deprecated," - " please use scrapy.utils.datatypes.CaseInsensitiveDict instead" - ) - class TestSequenceExclude: def test_list(self): @@ -353,26 +347,26 @@ class TestLocalWeakReferencedCache: assert len(cache) == 0 def test_cache_without_limit(self): - max = 10**4 + maximum = 10**4 cache = LocalWeakReferencedCache() refs = [] - for x in range(max): + for x in range(maximum): refs.append(Request(f"https://example.org/{x}")) cache[refs[-1]] = x - assert len(cache) == max + assert len(cache) == maximum for i, r in enumerate(refs): assert r in cache assert cache[r] == i del r # delete reference to the last object in the list # pylint: disable=undefined-loop-variable # delete half of the objects, make sure that is reflected in the cache - for _ in range(max // 2): + for _ in range(maximum // 2): refs.pop() # PyPy takes longer to collect dead references garbage_collect() - assert len(cache) == max // 2 + assert len(cache) == maximum // 2 for i, r in enumerate(refs): assert r in cache assert cache[r] == i diff --git a/tests/test_utils_decorators.py b/tests/test_utils_decorators.py new file mode 100644 index 000000000..9743e1a50 --- /dev/null +++ b/tests/test_utils_decorators.py @@ -0,0 +1,107 @@ +from __future__ import annotations + +import warnings + +import pytest +from twisted.internet.defer import Deferred + +from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.utils.decorators import _warn_spider_arg, deprecated, inthread +from scrapy.utils.defer import maybe_deferred_to_future +from tests.utils.decorators import coroutine_test + + +class TestDeprecated: + def test_warns_and_still_calls(self): + @deprecated() + def add(a, b): + return a + b + + with pytest.warns( + ScrapyDeprecationWarning, match=r"Call to deprecated function add\." + ): + result = add(2, 3) + + assert result == 5 + + def test_use_instead_in_message(self): + @deprecated(use_instead="other_function") + def old(): + return None + + with pytest.warns( + ScrapyDeprecationWarning, + match=r"Call to deprecated function old\. Use other_function instead\.", + ): + old() + + def test_applied_without_parentheses(self): + @deprecated + def square(x): + return x * x + + with pytest.warns( + ScrapyDeprecationWarning, match=r"Call to deprecated function square\." + ) as record: + result = square(4) + + assert result == 16 + # No "Use ... instead." part when applied directly to the function. + assert "instead" not in str(record[0].message) + + +class TestInthread: + @coroutine_test + async def test_returns_deferred_with_result(self): + @inthread + def multiply(a, b): + return a * b + + deferred = multiply(6, 7) + assert isinstance(deferred, Deferred) + assert await maybe_deferred_to_future(deferred) == 42 + + +class TestWarnSpiderArg: + def test_sync_warns_with_spider_arg(self): + @_warn_spider_arg + def parse(response, spider=None): + return response + + with pytest.warns( + ScrapyDeprecationWarning, match=r"Passing a 'spider' argument" + ): + assert parse("response", spider="spider") == "response" + + def test_sync_no_warning_without_spider_arg(self): + @_warn_spider_arg + def parse(response, spider=None): + return response + + with warnings.catch_warnings(): + warnings.simplefilter("error", category=ScrapyDeprecationWarning) + assert parse("response") == "response" + + @coroutine_test + async def test_async_warns_with_spider_arg(self): + @_warn_spider_arg + async def parse(response, spider=None): + return response + + with pytest.warns( + ScrapyDeprecationWarning, match=r"Passing a 'spider' argument" + ): + assert await parse("response", spider="spider") == "response" + + @coroutine_test + async def test_asyncgen_warns_with_spider_arg(self): + @_warn_spider_arg + async def parse(response, spider=None): + yield response + + with pytest.warns( + ScrapyDeprecationWarning, match=r"Passing a 'spider' argument" + ): + results = [item async for item in parse("response", spider="spider")] + + assert results == ["response"] diff --git a/tests/test_utils_defer.py b/tests/test_utils_defer.py index 1cfaf70fa..978c24f5a 100644 --- a/tests/test_utils_defer.py +++ b/tests/test_utils_defer.py @@ -6,9 +6,7 @@ from asyncio import Future from typing import TYPE_CHECKING, Any import pytest -from twisted.internet.defer import Deferred, inlineCallbacks, succeed -from twisted.python.failure import Failure -from twisted.trial import unittest +from twisted.internet.defer import Deferred, inlineCallbacks from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen from scrapy.utils.defer import ( @@ -20,28 +18,34 @@ from scrapy.utils.defer import ( maybe_deferred_to_future, mustbe_deferred, parallel_async, - process_chain, - process_parallel, ) +from tests.utils.decorators import coroutine_test, inline_callbacks_test if TYPE_CHECKING: from collections.abc import AsyncGenerator, Awaitable, Callable, Generator -class TestMustbeDeferred(unittest.TestCase): - def test_success_function(self) -> Deferred[list[int]]: +@pytest.mark.requires_reactor # mustbe_deferred() requires a reactor +@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") +class TestMustbeDeferred: + @inline_callbacks_test + def test_success_function(self) -> Generator[Deferred[Any], Any, None]: steps: list[int] = [] def _append(v: int) -> list[int]: steps.append(v) return steps - dfd = mustbe_deferred(_append, 1) - dfd.addCallback(self.assertEqual, [1, 2]) # it is [1] with maybeDeferred - steps.append(2) # add another value, that should be caught by assertEqual - return dfd + def _assert(v: list[int]) -> None: + assert v == [1, 2] # it is [1] with maybeDeferred - def test_unfired_deferred(self) -> Deferred[list[int]]: + dfd = mustbe_deferred(_append, 1) + dfd.addCallback(_assert) + steps.append(2) # add another value, that should be caught by assertEqual + yield dfd + + @inline_callbacks_test + def test_unfired_deferred(self) -> Generator[Deferred[Any], Any, None]: steps: list[int] = [] def _append(v: int) -> Deferred[list[int]]: @@ -52,50 +56,13 @@ class TestMustbeDeferred(unittest.TestCase): reactor.callLater(0, dfd.callback, steps) return dfd + def _assert(v: list[int]) -> None: + assert v == [1, 2] + dfd = mustbe_deferred(_append, 1) - dfd.addCallback(self.assertEqual, [1, 2]) # it is [1] with maybeDeferred + dfd.addCallback(_assert) steps.append(2) # add another value, that should be caught by assertEqual - return dfd - - -def cb1(value, arg1, arg2): - return f"(cb1 {value} {arg1} {arg2})" - - -def cb2(value, arg1, arg2): - return succeed(f"(cb2 {value} {arg1} {arg2})") - - -def cb3(value, arg1, arg2): - return f"(cb3 {value} {arg1} {arg2})" - - -def cb_fail(value, arg1, arg2): - return Failure(TypeError()) - - -def eb1(failure, arg1, arg2): - return f"(eb1 {failure.value.__class__.__name__} {arg1} {arg2})" - - -class TestDeferUtils(unittest.TestCase): - @inlineCallbacks - def test_process_chain(self): - x = yield process_chain([cb1, cb2, cb3], "res", "v1", "v2") - assert x == "(cb3 (cb2 (cb1 res v1 v2) v1 v2) v1 v2)" - - with pytest.raises(TypeError): - yield process_chain([cb1, cb_fail, cb3], "res", "v1", "v2") - - @inlineCallbacks - def test_process_parallel(self): - x = yield process_parallel([cb1, cb2, cb3], "res", "v1", "v2") - assert x == ["(cb1 res v1 v2)", "(cb2 res v1 v2)", "(cb3 res v1 v2)"] - - @inlineCallbacks - def test_process_parallel_failure(self): - with pytest.raises(TypeError): - yield process_parallel([cb1, cb_fail, cb3], "res", "v1", "v2") + yield dfd class TestIterErrback: @@ -122,8 +89,8 @@ class TestIterErrback: assert isinstance(errors[0].value, ZeroDivisionError) -class TestAiterErrback(unittest.TestCase): - @deferred_f_from_coro_f +class TestAiterErrback: + @coroutine_test async def test_aiter_errback_good(self): async def itergood() -> AsyncGenerator[int, None]: for x in range(10): @@ -134,7 +101,7 @@ class TestAiterErrback(unittest.TestCase): assert out == list(range(10)) assert not errors - @deferred_f_from_coro_f + @coroutine_test async def test_iter_errback_bad(self): async def iterbad() -> AsyncGenerator[int, None]: for x in range(10): @@ -149,22 +116,19 @@ class TestAiterErrback(unittest.TestCase): assert isinstance(errors[0].value, ZeroDivisionError) -class TestAsyncDefTestsuite(unittest.TestCase): - @deferred_f_from_coro_f - async def test_deferred_f_from_coro_f(self): +class TestAsyncDefTestsuite: + @coroutine_test + async def test_coroutine_test(self): pass - @deferred_f_from_coro_f - async def test_deferred_f_from_coro_f_generator(self): - yield - @pytest.mark.xfail(reason="Checks that the test is actually executed", strict=True) - @deferred_f_from_coro_f - async def test_deferred_f_from_coro_f_xfail(self): + @coroutine_test + async def test_coroutine_test_xfail(self): raise RuntimeError("This is expected to be raised") -class TestParallelAsync(unittest.TestCase): +@pytest.mark.requires_reactor # parallel_async() requires a reactor +class TestParallelAsync: """This tests _AsyncCooperatorAdapter by testing parallel_async which is its only usage. parallel_async is called with the results of a callback (so an iterable of items, requests and None, @@ -233,7 +197,7 @@ class TestParallelAsync(unittest.TestCase): await maybe_deferred_to_future(dfd) yield i - @inlineCallbacks + @inline_callbacks_test def test_simple(self): for length in [20, 50, 100]: parallel_count = [0] @@ -253,7 +217,7 @@ class TestParallelAsync(unittest.TestCase): assert parallel_count[0] == 0 assert max_parallel_count[0] <= self.CONCURRENT_ITEMS, max_parallel_count[0] - @inlineCallbacks + @inline_callbacks_test def test_delays(self): for length in [20, 50, 100]: parallel_count = [0] @@ -274,7 +238,7 @@ class TestParallelAsync(unittest.TestCase): assert max_parallel_count[0] <= self.CONCURRENT_ITEMS, max_parallel_count[0] -class TestDeferredFromCoro(unittest.TestCase): +class TestDeferredFromCoro: def test_deferred(self): d = Deferred() result = deferred_from_coro(d) @@ -285,7 +249,7 @@ class TestDeferredFromCoro(unittest.TestCase): result = deferred_from_coro(42) assert result == 42 - @inlineCallbacks + @inline_callbacks_test def test_coroutine(self): async def coroutine() -> int: return 42 @@ -296,7 +260,7 @@ class TestDeferredFromCoro(unittest.TestCase): assert coro_result == 42 @pytest.mark.only_asyncio - @inlineCallbacks + @inline_callbacks_test def test_coroutine_asyncio(self): async def coroutine() -> int: await asyncio.sleep(0.01) @@ -308,7 +272,7 @@ class TestDeferredFromCoro(unittest.TestCase): assert coro_result == 42 @pytest.mark.only_asyncio - @inlineCallbacks + @inline_callbacks_test def test_future(self): future = Future() result = deferred_from_coro(future) @@ -318,7 +282,7 @@ class TestDeferredFromCoro(unittest.TestCase): assert future_result == 42 -class TestDeferredFFromCoroF(unittest.TestCase): +class TestDeferredFFromCoroF: @inlineCallbacks def _assert_result( self, c_f: Callable[[], Awaitable[int]] @@ -329,22 +293,24 @@ class TestDeferredFFromCoroF(unittest.TestCase): result = yield d assert result == 42 - @inlineCallbacks + @inline_callbacks_test def test_coroutine(self): async def c_f() -> int: return 42 yield self._assert_result(c_f) - @inlineCallbacks + @pytest.mark.only_asyncio + @inline_callbacks_test def test_coroutine_asyncio(self): async def c_f() -> int: + await asyncio.sleep(0.01) return 42 yield self._assert_result(c_f) @pytest.mark.only_asyncio - @inlineCallbacks + @inline_callbacks_test def test_future(self): def c_f() -> Future[int]: f: Future[int] = Future() @@ -355,8 +321,8 @@ class TestDeferredFFromCoroF(unittest.TestCase): @pytest.mark.only_asyncio -class TestDeferredToFuture(unittest.TestCase): - @deferred_f_from_coro_f +class TestDeferredToFuture: + @coroutine_test async def test_deferred(self): d = Deferred() result = deferred_to_future(d) @@ -365,7 +331,7 @@ class TestDeferredToFuture(unittest.TestCase): future_result = await result assert future_result == 42 - @deferred_f_from_coro_f + @coroutine_test async def test_wrapped_coroutine(self): async def c_f() -> int: return 42 @@ -376,7 +342,7 @@ class TestDeferredToFuture(unittest.TestCase): future_result = await result assert future_result == 42 - @deferred_f_from_coro_f + @coroutine_test async def test_wrapped_coroutine_asyncio(self): async def c_f() -> int: await asyncio.sleep(0.01) @@ -390,8 +356,8 @@ class TestDeferredToFuture(unittest.TestCase): @pytest.mark.only_asyncio -class TestMaybeDeferredToFutureAsyncio(unittest.TestCase): - @deferred_f_from_coro_f +class TestMaybeDeferredToFutureAsyncio: + @coroutine_test async def test_deferred(self): d = Deferred() result = maybe_deferred_to_future(d) @@ -400,7 +366,7 @@ class TestMaybeDeferredToFutureAsyncio(unittest.TestCase): future_result = await result assert future_result == 42 - @deferred_f_from_coro_f + @coroutine_test async def test_wrapped_coroutine(self): async def c_f() -> int: return 42 @@ -411,7 +377,7 @@ class TestMaybeDeferredToFutureAsyncio(unittest.TestCase): future_result = await result assert future_result == 42 - @deferred_f_from_coro_f + @coroutine_test async def test_wrapped_coroutine_asyncio(self): async def c_f() -> int: await asyncio.sleep(0.01) @@ -426,7 +392,8 @@ class TestMaybeDeferredToFutureAsyncio(unittest.TestCase): @pytest.mark.only_not_asyncio class TestMaybeDeferredToFutureNotAsyncio: - def test_deferred(self): + @coroutine_test + async def test_deferred(self): d = Deferred() result = maybe_deferred_to_future(d) assert isinstance(result, Deferred) diff --git a/tests/test_utils_deprecate.py b/tests/test_utils_deprecate.py index a88b5e008..0706fec99 100644 --- a/tests/test_utils_deprecate.py +++ b/tests/test_utils_deprecate.py @@ -1,7 +1,6 @@ import inspect import warnings from unittest import mock -from warnings import WarningMessage import pytest @@ -22,36 +21,26 @@ class NewName(SomeBaseClass): class TestWarnWhenSubclassed: - def _mywarnings( - self, w: list[WarningMessage], category: type[Warning] = MyWarning - ) -> list[WarningMessage]: - return [x for x in w if x.category is MyWarning] - def test_no_warning_on_definition(self): - with warnings.catch_warnings(record=True) as w: + with warnings.catch_warnings(): + warnings.simplefilter("error", category=ScrapyDeprecationWarning) create_deprecated_class("Deprecated", NewName) - w = self._mywarnings(w) - assert w == [] - def test_subclassing_warning_message(self): + msg = ( + r"tests\.test_utils_deprecate\.UserClass inherits from " + r"deprecated class tests\.test_utils_deprecate\.Deprecated, " + r"please inherit from tests\.test_utils_deprecate\.NewName." + r" \(warning only on first subclass, there may be others\)" + ) Deprecated = create_deprecated_class( "Deprecated", NewName, warn_category=MyWarning ) - - with warnings.catch_warnings(record=True) as w: + with pytest.warns(MyWarning, match=msg) as w: class UserClass(Deprecated): pass - w = self._mywarnings(w) - assert len(w) == 1 - assert ( - str(w[0].message) == "tests.test_utils_deprecate.UserClass inherits from " - "deprecated class tests.test_utils_deprecate.Deprecated, " - "please inherit from tests.test_utils_deprecate.NewName." - " (warning only on first subclass, there may be others)" - ) assert w[0].lineno == inspect.getsourcelines(UserClass)[1] def test_custom_class_paths(self): @@ -63,62 +52,77 @@ class TestWarnWhenSubclassed: warn_category=MyWarning, ) - with warnings.catch_warnings(record=True) as w: + with pytest.warns( + MyWarning, + match=r"UserClass inherits from deprecated class bar\.OldClass, please inherit from foo\.NewClass", + ): class UserClass(Deprecated): pass + with pytest.warns( + MyWarning, + match=r"bar\.OldClass is deprecated, instantiate foo\.NewClass instead", + ): _ = Deprecated() - w = self._mywarnings(w) - assert len(w) == 2 - assert "foo.NewClass" in str(w[0].message) - assert "bar.OldClass" in str(w[0].message) - assert "foo.NewClass" in str(w[1].message) - assert "bar.OldClass" in str(w[1].message) - def test_subclassing_warns_only_on_direct_children(self): Deprecated = create_deprecated_class( "Deprecated", NewName, warn_once=False, warn_category=MyWarning ) - with warnings.catch_warnings(record=True) as w: + with pytest.warns( + MyWarning, + match="UserClass inherits from deprecated class", + ): class UserClass(Deprecated): pass + with warnings.catch_warnings(): + warnings.simplefilter("error", MyWarning) + class NoWarnOnMe(UserClass): pass - w = self._mywarnings(w) - assert len(w) == 1 - assert "UserClass" in str(w[0].message) - def test_subclassing_warns_once_by_default(self): Deprecated = create_deprecated_class( "Deprecated", NewName, warn_category=MyWarning ) - with warnings.catch_warnings(record=True) as w: + with pytest.warns( + MyWarning, + match="UserClass inherits from deprecated class", + ): class UserClass(Deprecated): pass + with warnings.catch_warnings(): + warnings.simplefilter("error", MyWarning) + class FooClass(Deprecated): pass class BarClass(Deprecated): pass - w = self._mywarnings(w) - assert len(w) == 1 - assert "UserClass" in str(w[0].message) - def test_warning_on_instance(self): Deprecated = create_deprecated_class( "Deprecated", NewName, warn_category=MyWarning ) + with pytest.warns(MyWarning) as w: + _, lineno = Deprecated(), inspect.getlineno(inspect.currentframe()) + + w = [x for x in w if x.category is MyWarning] + assert len(w) == 1 + assert ( + str(w[0].message) == "tests.test_utils_deprecate.Deprecated is deprecated, " + "instantiate tests.test_utils_deprecate.NewName instead." + ) + assert w[0].lineno == lineno + # ignore subclassing warnings with warnings.catch_warnings(): warnings.simplefilter("ignore", MyWarning) @@ -126,29 +130,20 @@ class TestWarnWhenSubclassed: class UserClass(Deprecated): pass - with warnings.catch_warnings(record=True) as w: - _, lineno = Deprecated(), inspect.getlineno(inspect.currentframe()) - _ = UserClass() # subclass instances don't warn - - w = self._mywarnings(w) - assert len(w) == 1 - assert ( - str(w[0].message) == "tests.test_utils_deprecate.Deprecated is deprecated, " - "instantiate tests.test_utils_deprecate.NewName instead." - ) - assert w[0].lineno == lineno + with warnings.catch_warnings(): + warnings.simplefilter("error", MyWarning) + UserClass() # subclass instances don't warn def test_warning_auto_message(self): - with warnings.catch_warnings(record=True) as w: - Deprecated = create_deprecated_class("Deprecated", NewName) + Deprecated = create_deprecated_class("Deprecated", NewName) + with pytest.warns( + ScrapyDeprecationWarning, + match=r"UserClass2 inherits from deprecated class tests\.test_utils_deprecate\.Deprecated, please inherit from tests\.test_utils_deprecate\.NewName", + ): class UserClass2(Deprecated): pass - msg = str(w[0].message) - assert "tests.test_utils_deprecate.NewName" in msg - assert "tests.test_utils_deprecate.Deprecated" in msg - def test_issubclass(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", ScrapyDeprecationWarning) @@ -169,17 +164,12 @@ class TestWarnWhenSubclassed: class UnrelatedClass: pass - class OldStyleClass: - pass - assert issubclass(UpdatedUserClass1, NewName) assert issubclass(UpdatedUserClass1a, NewName) assert issubclass(UpdatedUserClass1, DeprecatedName) assert issubclass(UpdatedUserClass1a, DeprecatedName) assert issubclass(OutdatedUserClass1, DeprecatedName) assert not issubclass(UnrelatedClass, DeprecatedName) - assert not issubclass(OldStyleClass, DeprecatedName) - assert not issubclass(OldStyleClass, DeprecatedName) assert not issubclass(OutdatedUserClass1, OutdatedUserClass1a) assert not issubclass(OutdatedUserClass1a, OutdatedUserClass1) @@ -206,9 +196,6 @@ class TestWarnWhenSubclassed: class UnrelatedClass: pass - class OldStyleClass: - pass - assert isinstance(UpdatedUserClass2(), NewName) assert isinstance(UpdatedUserClass2a(), NewName) assert isinstance(UpdatedUserClass2(), DeprecatedName) @@ -218,7 +205,6 @@ class TestWarnWhenSubclassed: assert not isinstance(OutdatedUserClass2a(), OutdatedUserClass2) assert not isinstance(OutdatedUserClass2(), OutdatedUserClass2a) assert not isinstance(UnrelatedClass(), DeprecatedName) - assert not isinstance(OldStyleClass(), DeprecatedName) def test_clsdict(self): with warnings.catch_warnings(): @@ -233,8 +219,8 @@ class TestWarnWhenSubclassed: create_deprecated_class("Deprecated", New) def test_deprecate_subclass_of_deprecated_class(self): - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter("always") + with warnings.catch_warnings(): + warnings.simplefilter("error", MyWarning) Deprecated = create_deprecated_class( "Deprecated", NewName, warn_category=MyWarning ) @@ -245,33 +231,26 @@ class TestWarnWhenSubclassed: warn_category=MyWarning, ) - w = self._mywarnings(w) - assert len(w) == 0, [str(warning) for warning in w] - - with warnings.catch_warnings(record=True) as w: + with pytest.warns( + MyWarning, + match=r"AlsoDeprecated is deprecated, instantiate foo\.Bar instead", + ): AlsoDeprecated() + with pytest.warns( + MyWarning, + match=r"UserClass inherits from deprecated class tests\.test_utils_deprecate\.AlsoDeprecated, please inherit from foo\.Bar", + ): + class UserClass(AlsoDeprecated): pass - w = self._mywarnings(w) - assert len(w) == 2 - assert "AlsoDeprecated" in str(w[0].message) - assert "foo.Bar" in str(w[0].message) - assert "AlsoDeprecated" in str(w[1].message) - assert "foo.Bar" in str(w[1].message) - def test_inspect_stack(self): with ( mock.patch("inspect.stack", side_effect=IndexError), - warnings.catch_warnings(record=True) as w, + pytest.warns(UserWarning, match="Error detecting parent module"), ): - DeprecatedName = create_deprecated_class("DeprecatedName", NewName) - - class SubClass(DeprecatedName): - pass - - assert "Error detecting parent module" in str(w[0].message) + create_deprecated_class("DeprecatedName", NewName) @mock.patch( @@ -283,12 +262,12 @@ class TestWarnWhenSubclassed: ) class TestUpdateClassPath: def test_old_path_gets_fixed(self): - with warnings.catch_warnings(record=True) as w: + with pytest.warns( + ScrapyDeprecationWarning, + match="`scrapy.contrib.debug.Debug` class is deprecated, use `scrapy.extensions.debug.Debug` instead", + ): output = update_classpath("scrapy.contrib.debug.Debug") assert output == "scrapy.extensions.debug.Debug" - assert len(w) == 1 - assert "scrapy.contrib.debug.Debug" in str(w[0].message) - assert "scrapy.extensions.debug.Debug" in str(w[0].message) def test_sorted_replacement(self): with warnings.catch_warnings(): @@ -297,10 +276,10 @@ class TestUpdateClassPath: assert output == "scrapy.pipelines.Pipeline" def test_unmatched_path_stays_the_same(self): - with warnings.catch_warnings(record=True) as w: + with warnings.catch_warnings(): + warnings.simplefilter("error", ScrapyDeprecationWarning) output = update_classpath("scrapy.unmatched.Path") assert output == "scrapy.unmatched.Path" - assert len(w) == 0 def test_returns_nonstring(self): for notastring in [None, True, [1, 2, 3], object()]: diff --git a/tests/test_utils_display.py b/tests/test_utils_display.py index 20251ca59..8b02116b8 100644 --- a/tests/test_utils_display.py +++ b/tests/test_utils_display.py @@ -1,3 +1,4 @@ +import builtins from io import StringIO from unittest import mock @@ -74,14 +75,12 @@ def test_pformat_windows(isatty, version, terminal_processing): def test_pformat_no_pygments(isatty): isatty.return_value = True - import builtins - real_import = builtins.__import__ - def mock_import(name, globals, locals, fromlist, level): + def mock_import(name, globals_, locals_, fromlist, level): if "pygments" in name: raise ImportError - return real_import(name, globals, locals, fromlist, level) + return real_import(name, globals_, locals_, fromlist, level) builtins.__import__ = mock_import assert pformat(value) == plain_string diff --git a/tests/test_utils_httpobj.py b/tests/test_utils_httpobj.py index 9bd86f7fb..0eb330461 100644 --- a/tests/test_utils_httpobj.py +++ b/tests/test_utils_httpobj.py @@ -17,4 +17,4 @@ def test_urlparse_cached(): assert req1a == urlp assert req1a is req1b assert req1a is not req2 - assert req1a is not req2 + assert req1b is not req2 diff --git a/tests/test_utils_iterators.py b/tests/test_utils_iterators.py index ac32fff2c..1276c1392 100644 --- a/tests/test_utils_iterators.py +++ b/tests/test_utils_iterators.py @@ -231,11 +231,11 @@ class TestXmliterBase(ABC): "onetwo" ) - iter = self.xmliter(body, "product") - next(iter) - next(iter) + my_iter = self.xmliter(body, "product") + next(my_iter) + next(my_iter) with pytest.raises(StopIteration): - next(iter) + next(my_iter) def test_xmliter_objtype_exception(self): i = self.xmliter(42, "product") @@ -473,13 +473,13 @@ class TestUtilsCsv: body = get_testdata("feeds", "feed-sample3.csv") response = TextResponse(url="http://example.com/", body=body) - iter = csviter(response) - next(iter) - next(iter) - next(iter) - next(iter) + my_iter = csviter(response) + next(my_iter) + next(my_iter) + next(my_iter) + next(my_iter) with pytest.raises(StopIteration): - next(iter) + next(my_iter) def test_csviter_encoding(self): body1 = get_testdata("feeds", "feed-sample4.csv") @@ -527,7 +527,7 @@ class TestBodyOrStr: r3 = _body_or_str(obj, unicode=False) self._assert_type_and_value(r3, self.bbody, obj) assert type(r1) is type(r2) - assert type(r1) is not type(r3) + assert type(r1) is not type(r3) # type: ignore[comparison-overlap] @staticmethod def _assert_type_and_value( diff --git a/tests/test_utils_log.py b/tests/test_utils_log.py index f40e424ff..ee552df64 100644 --- a/tests/test_utils_log.py +++ b/tests/test_utils_log.py @@ -42,33 +42,29 @@ class TestFailureToExcInfo: class TestTopLevelFormatter: - def setup_method(self): - self.handler = LogCapture() - self.handler.addFilter(TopLevelFormatter(["test"])) - - def test_top_level_logger(self): + def test_top_level_logger(self, caplog: pytest.LogCaptureFixture) -> None: + caplog.handler.addFilter(TopLevelFormatter(["test"])) logger = logging.getLogger("test") - with self.handler as log: - logger.warning("test log msg") - log.check(("test", "WARNING", "test log msg")) + logger.warning("test log msg") + assert ("test", logging.WARNING, "test log msg") in caplog.record_tuples - def test_children_logger(self): + def test_children_logger(self, caplog: pytest.LogCaptureFixture) -> None: + caplog.handler.addFilter(TopLevelFormatter(["test"])) logger = logging.getLogger("test.test1") - with self.handler as log: - logger.warning("test log msg") - log.check(("test", "WARNING", "test log msg")) + logger.warning("test log msg") + assert ("test", logging.WARNING, "test log msg") in caplog.record_tuples - def test_overlapping_name_logger(self): + def test_overlapping_name_logger(self, caplog: pytest.LogCaptureFixture) -> None: + caplog.handler.addFilter(TopLevelFormatter(["test"])) logger = logging.getLogger("test2") - with self.handler as log: - logger.warning("test log msg") - log.check(("test2", "WARNING", "test log msg")) + logger.warning("test log msg") + assert ("test2", logging.WARNING, "test log msg") in caplog.record_tuples - def test_different_name_logger(self): + def test_different_name_logger(self, caplog: pytest.LogCaptureFixture) -> None: + caplog.handler.addFilter(TopLevelFormatter(["test"])) logger = logging.getLogger("different") - with self.handler as log: - logger.warning("test log msg") - log.check(("different", "WARNING", "test log msg")) + logger.warning("test log msg") + assert ("different", logging.WARNING, "test log msg") in caplog.record_tuples class TestLogCounterHandler: @@ -80,15 +76,16 @@ class TestLogCounterHandler: @pytest.fixture def logger(self, crawler: Crawler) -> Generator[logging.Logger]: logger = logging.getLogger("test") - logger.setLevel(logging.NOTSET) + logger.setLevel(logging.DEBUG) logger.propagate = False - handler = LogCounterHandler(crawler) + handler = LogCounterHandler(crawler, level=crawler.settings.get("LOG_LEVEL")) logger.addHandler(handler) - - yield logger - - logger.propagate = True - logger.removeHandler(handler) + try: + yield logger + finally: + logger.propagate = True + logger.setLevel(logging.NOTSET) + logger.removeHandler(handler) def test_init(self, crawler: Crawler, logger: logging.Logger) -> None: assert crawler.stats @@ -106,7 +103,7 @@ class TestLogCounterHandler: def test_filtered_out_level(self, crawler: Crawler, logger: logging.Logger) -> None: logger.debug("test log msg") assert crawler.stats - assert crawler.stats.get_value("log_count/INFO") is None + assert crawler.stats.get_value("log_count/DEBUG") is None class TestStreamLogger: @@ -144,7 +141,9 @@ class TestStreamLogger: ], ) def test_spider_logger_adapter_process( - base_extra: Mapping[str, Any], log_extra: MutableMapping, expected_extra: dict + base_extra: Mapping[str, Any], + log_extra: MutableMapping[str, Any], + expected_extra: dict[str, Any], ) -> None: logger = logging.getLogger("test") spider_logger_adapter = SpiderLoggerAdapter(logger, base_extra) diff --git a/tests/test_utils_misc/__init__.py b/tests/test_utils_misc/__init__.py index b330819d9..c4c861404 100644 --- a/tests/test_utils_misc/__init__.py +++ b/tests/test_utils_misc/__init__.py @@ -5,15 +5,16 @@ from unittest import mock import pytest +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.item import Field, Item from scrapy.utils.misc import ( arg_to_iter, build_from_crawler, - create_instance, load_object, rel_has_nofollow, set_environ, walk_modules, + walk_modules_iter, ) @@ -39,7 +40,7 @@ class TestUtilsMisc: load_object({}) def test_walk_modules(self): - mods = walk_modules("tests.test_utils_misc.test_walk_modules") + mods = walk_modules_iter("tests.test_utils_misc.test_walk_modules") expected = [ "tests.test_utils_misc.test_walk_modules", "tests.test_utils_misc.test_walk_modules.mod", @@ -48,27 +49,38 @@ class TestUtilsMisc: ] assert {m.__name__ for m in mods} == set(expected) - mods = walk_modules("tests.test_utils_misc.test_walk_modules.mod") + mods = walk_modules_iter("tests.test_utils_misc.test_walk_modules.mod") expected = [ "tests.test_utils_misc.test_walk_modules.mod", "tests.test_utils_misc.test_walk_modules.mod.mod0", ] assert {m.__name__ for m in mods} == set(expected) - mods = walk_modules("tests.test_utils_misc.test_walk_modules.mod1") + mods = walk_modules_iter("tests.test_utils_misc.test_walk_modules.mod1") expected = [ "tests.test_utils_misc.test_walk_modules.mod1", ] assert {m.__name__ for m in mods} == set(expected) with pytest.raises(ImportError): + for _ in walk_modules_iter("nomodule999"): + pass + with ( + pytest.raises(ImportError), + pytest.warns( + ScrapyDeprecationWarning, + match="The scrapy.utils.misc.walk_modules function is deprecated and will be " + "removed in a future version of Scrapy. " + "Use scrapy.utils.misc.walk_modules_iter instead.", + ), + ): walk_modules("nomodule999") def test_walk_modules_egg(self): egg = str(Path(__file__).parent / "test.egg") sys.path.append(egg) try: - mods = walk_modules("testegg") + mods = walk_modules_iter("testegg") expected = [ "testegg.spiders", "testegg.spiders.a", @@ -97,98 +109,29 @@ class TestUtilsMisc: assert list(arg_to_iter({"a": 1})) == [{"a": 1}] assert list(arg_to_iter(TestItem(name="john"))) == [TestItem(name="john")] - @pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") - def test_create_instance(self): - settings = mock.MagicMock() - crawler = mock.MagicMock(spec_set=["settings"]) - args = (True, 100.0) - kwargs = {"key": "val"} - - def _test_with_settings(mock, settings): - create_instance(mock, settings, None, *args, **kwargs) - if hasattr(mock, "from_crawler"): - assert mock.from_crawler.call_count == 0 - if hasattr(mock, "from_settings"): - mock.from_settings.assert_called_once_with(settings, *args, **kwargs) - assert mock.call_count == 0 - else: - mock.assert_called_once_with(*args, **kwargs) - - def _test_with_crawler(mock, settings, crawler): - create_instance(mock, settings, crawler, *args, **kwargs) - if hasattr(mock, "from_crawler"): - mock.from_crawler.assert_called_once_with(crawler, *args, **kwargs) - if hasattr(mock, "from_settings"): - assert mock.from_settings.call_count == 0 - assert mock.call_count == 0 - elif hasattr(mock, "from_settings"): - mock.from_settings.assert_called_once_with(settings, *args, **kwargs) - assert mock.call_count == 0 - else: - mock.assert_called_once_with(*args, **kwargs) - - # Check usage of correct constructor using four mocks: - # 1. with no alternative constructors - # 2. with from_settings() constructor - # 3. with from_crawler() constructor - # 4. with from_settings() and from_crawler() constructor - spec_sets = ( - ["__qualname__"], - ["__qualname__", "from_settings"], - ["__qualname__", "from_crawler"], - ["__qualname__", "from_settings", "from_crawler"], - ) - for specs in spec_sets: - m = mock.MagicMock(spec_set=specs) - _test_with_settings(m, settings) - m.reset_mock() - _test_with_crawler(m, settings, crawler) - - # Check adoption of crawler settings - m = mock.MagicMock(spec_set=["__qualname__", "from_settings"]) - create_instance(m, None, crawler, *args, **kwargs) - m.from_settings.assert_called_once_with(crawler.settings, *args, **kwargs) - - with pytest.raises( - ValueError, match="Specify at least one of settings and crawler" - ): - create_instance(m, None, None) - - m.from_settings.return_value = None - with pytest.raises(TypeError): - create_instance(m, settings, None) - def test_build_from_crawler(self): - settings = mock.MagicMock() crawler = mock.MagicMock(spec_set=["settings"]) args = (True, 100.0) kwargs = {"key": "val"} - def _test_with_crawler(mock, settings, crawler): + def _test_with_crawler(mock, crawler): build_from_crawler(mock, crawler, *args, **kwargs) if hasattr(mock, "from_crawler"): mock.from_crawler.assert_called_once_with(crawler, *args, **kwargs) - if hasattr(mock, "from_settings"): - assert mock.from_settings.call_count == 0 - assert mock.call_count == 0 - elif hasattr(mock, "from_settings"): - mock.from_settings.assert_called_once_with(settings, *args, **kwargs) assert mock.call_count == 0 else: mock.assert_called_once_with(*args, **kwargs) - # Check usage of correct constructor using three mocks: + # Check usage of correct constructor using 2 mocks: # 1. with no alternative constructors # 2. with from_crawler() constructor - # 3. with from_settings() and from_crawler() constructor spec_sets = ( ["__qualname__"], ["__qualname__", "from_crawler"], - ["__qualname__", "from_settings", "from_crawler"], ) for specs in spec_sets: m = mock.MagicMock(spec_set=specs) - _test_with_crawler(m, settings, crawler) + _test_with_crawler(m, crawler) m.reset_mock() # Check adoption of crawler @@ -217,3 +160,8 @@ class TestUtilsMisc: assert rel_has_nofollow("nofollowfoo") is False assert rel_has_nofollow("foonofollow") is False assert rel_has_nofollow("ugc, , nofollow") is True + # rel attribute values are ASCII case-insensitive per the HTML spec + assert rel_has_nofollow("NoFollow") is True + assert rel_has_nofollow("NOFOLLOW") is True + assert rel_has_nofollow("UGC NoFollow") is True + assert rel_has_nofollow("ugc,NoFollow") is True diff --git a/tests/test_utils_misc/test_return_with_argument_inside_generator.py b/tests/test_utils_misc/test_return_with_argument_inside_generator.py index ad31e5185..1acc3aac2 100644 --- a/tests/test_utils_misc/test_return_with_argument_inside_generator.py +++ b/tests/test_utils_misc/test_return_with_argument_inside_generator.py @@ -93,29 +93,27 @@ https://example.org assert is_generator_with_return_value(h1) assert is_generator_with_return_value(i1) - with warnings.catch_warnings(record=True) as w: + with pytest.warns( + UserWarning, + match='The "MockSpider.top_level_return_something" method is a generator', + ): warn_on_generator_with_return_value(mock_spider, top_level_return_something) - assert len(w) == 1 - assert ( - 'The "MockSpider.top_level_return_something" method is a generator' - in str(w[0].message) - ) - with warnings.catch_warnings(record=True) as w: + with pytest.warns( + UserWarning, match='The "MockSpider.f1" method is a generator' + ): warn_on_generator_with_return_value(mock_spider, f1) - assert len(w) == 1 - assert 'The "MockSpider.f1" method is a generator' in str(w[0].message) - with warnings.catch_warnings(record=True) as w: + with pytest.warns( + UserWarning, match='The "MockSpider.g1" method is a generator' + ): warn_on_generator_with_return_value(mock_spider, g1) - assert len(w) == 1 - assert 'The "MockSpider.g1" method is a generator' in str(w[0].message) - with warnings.catch_warnings(record=True) as w: + with pytest.warns( + UserWarning, match='The "MockSpider.h1" method is a generator' + ): warn_on_generator_with_return_value(mock_spider, h1) - assert len(w) == 1 - assert 'The "MockSpider.h1" method is a generator' in str(w[0].message) - with warnings.catch_warnings(record=True) as w: + with pytest.warns( + UserWarning, match='The "MockSpider.i1" method is a generator' + ): warn_on_generator_with_return_value(mock_spider, i1) - assert len(w) == 1 - assert 'The "MockSpider.i1" method is a generator' in str(w[0].message) def test_generators_return_none(self, mock_spider): def f2(): @@ -160,30 +158,16 @@ https://example.org assert not is_generator_with_return_value(k2) # not recursive assert not is_generator_with_return_value(l2) - with warnings.catch_warnings(record=True) as w: + with warnings.catch_warnings(): + warnings.simplefilter("error", UserWarning) warn_on_generator_with_return_value(mock_spider, top_level_return_none) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, f2) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, g2) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, h2) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, i2) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, j2) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, k2) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, l2) - assert len(w) == 0 def test_generators_return_none_with_decorator(self, mock_spider): def decorator(func): @@ -241,39 +225,23 @@ https://example.org assert not is_generator_with_return_value(k3) # not recursive assert not is_generator_with_return_value(l3) - with warnings.catch_warnings(record=True) as w: + with warnings.catch_warnings(): + warnings.simplefilter("error", UserWarning) warn_on_generator_with_return_value(mock_spider, top_level_return_none) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, f3) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, g3) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, h3) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, i3) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, j3) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, k3) - assert len(w) == 0 - with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(mock_spider, l3) - assert len(w) == 0 @mock.patch( "scrapy.utils.misc.is_generator_with_return_value", new=_indentation_error ) def test_indentation_error(self, mock_spider): - with warnings.catch_warnings(record=True) as w: + with pytest.warns(UserWarning, match="Unable to determine"): warn_on_generator_with_return_value(mock_spider, top_level_return_none) - assert len(w) == 1 - assert "Unable to determine" in str(w[0].message) def test_partial(self): def cb(arg1, arg2): @@ -300,13 +268,11 @@ https://example.org yield 1 return "value" - with warnings.catch_warnings(record=True) as w: + with warnings.catch_warnings(): + warnings.simplefilter("error", UserWarning) warn_on_generator_with_return_value(spider, gen_with_return) - assert len(w) == 0 spider.settings.settings_dict["WARN_ON_GENERATOR_RETURN_VALUE"] = True - with warnings.catch_warnings(record=True) as w: + with pytest.warns(UserWarning, match="is a generator"): warn_on_generator_with_return_value(spider, gen_with_return) - assert len(w) == 1 - assert "is a generator" in str(w[0].message) diff --git a/tests/test_utils_project.py b/tests/test_utils_project.py index 20a3d940c..5333a55cb 100644 --- a/tests/test_utils_project.py +++ b/tests/test_utils_project.py @@ -1,5 +1,4 @@ import os -import warnings from pathlib import Path import pytest @@ -41,11 +40,8 @@ class TestGetProjectSettings: envvars = { "SCRAPY_SETTINGS_MODULE": value, } - with warnings.catch_warnings(): - warnings.simplefilter("error") - with set_environ(**envvars): - settings = get_project_settings() - + with set_environ(**envvars): + settings = get_project_settings() assert settings.get("SETTINGS_MODULE") == value def test_invalid_envvar(self): diff --git a/tests/test_utils_python.py b/tests/test_utils_python.py index c933e0ac9..2e8047e2d 100644 --- a/tests/test_utils_python.py +++ b/tests/test_utils_python.py @@ -7,21 +7,19 @@ import sys from typing import TYPE_CHECKING, TypeVar import pytest -from twisted.trial import unittest from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen -from scrapy.utils.defer import aiter_errback, deferred_f_from_coro_f +from scrapy.utils.defer import aiter_errback from scrapy.utils.python import ( MutableAsyncChain, - MutableChain, binary_is_text, - equal_attributes, get_func_args, memoizemethod_noargs, to_bytes, to_unicode, without_none_values, ) +from tests.utils.decorators import coroutine_test if TYPE_CHECKING: from collections.abc import Iterable, Mapping @@ -31,17 +29,7 @@ _KT = TypeVar("_KT") _VT = TypeVar("_VT") -def test_mutablechain(): - m = MutableChain(range(2), [2, 3], (4, 5)) - m.extend(range(6, 7)) - m.extend([7, 8]) - m.extend([9, 10], (11, 12)) - assert next(m) == 0 - assert m.__next__() == 1 - assert list(m) == list(range(2, 13)) - - -class TestMutableAsyncChain(unittest.TestCase): +class TestMutableAsyncChain: @staticmethod async def g1(): for i in range(3): @@ -65,7 +53,7 @@ class TestMutableAsyncChain(unittest.TestCase): for i in range(5, 7): yield i - @deferred_f_from_coro_f + @coroutine_test async def test_mutableasyncchain(self): m = MutableAsyncChain(self.g1(), as_async_generator(range(3, 7))) m.extend(self.g2()) @@ -75,7 +63,7 @@ class TestMutableAsyncChain(unittest.TestCase): results = await collect_asyncgen(m) assert results == list(range(1, 10)) - @deferred_f_from_coro_f + @coroutine_test async def test_mutableasyncchain_exc(self): m = MutableAsyncChain(self.g1()) m.extend(self.g4()) @@ -151,56 +139,6 @@ def test_binaryistext(value: bytes, expected: bool) -> None: assert binary_is_text(value) is expected -@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") -def test_equal_attributes(): - class Obj: - pass - - a = Obj() - b = Obj() - # no attributes given return False - assert not equal_attributes(a, b, []) - # nonexistent attributes - assert not equal_attributes(a, b, ["x", "y"]) - - a.x = 1 - b.x = 1 - # equal attribute - assert equal_attributes(a, b, ["x"]) - - b.y = 2 - # obj1 has no attribute y - assert not equal_attributes(a, b, ["x", "y"]) - - a.y = 2 - # equal attributes - assert equal_attributes(a, b, ["x", "y"]) - - a.y = 1 - # different attributes - assert not equal_attributes(a, b, ["x", "y"]) - - # test callable - a.meta = {} - b.meta = {} - assert equal_attributes(a, b, ["meta"]) - - # compare ['meta']['a'] - a.meta["z"] = 1 - b.meta["z"] = 1 - - get_z = operator.itemgetter("z") - get_meta = operator.attrgetter("meta") - - def compare_z(obj): - return get_z(get_meta(obj)) - - assert equal_attributes(a, b, [compare_z, "x"]) - # fail z equality - a.meta["z"] = 2 - assert not equal_attributes(a, b, [compare_z, "x"]) - - def test_get_func_args(): def f1(a, b, c): pass diff --git a/tests/test_utils_reactor.py b/tests/test_utils_reactor.py index eb00ab193..7d39a478e 100644 --- a/tests/test_utils_reactor.py +++ b/tests/test_utils_reactor.py @@ -1,36 +1,25 @@ import asyncio -import warnings import pytest -from twisted.trial.unittest import TestCase -from scrapy.utils.defer import deferred_f_from_coro_f from scrapy.utils.reactor import ( _asyncio_reactor_path, install_reactor, is_asyncio_reactor_installed, set_asyncio_event_loop, ) +from tests.utils.decorators import coroutine_test -@pytest.mark.usefixtures("reactor_pytest") -class TestAsyncio(TestCase): - def test_is_asyncio_reactor_installed(self): +class TestAsyncio: + @pytest.mark.requires_reactor # needs a reactor + def test_is_asyncio_reactor_installed(self, reactor_pytest: str) -> None: # the result should depend only on the pytest --reactor argument - assert is_asyncio_reactor_installed() == (self.reactor_pytest != "default") - - def test_install_asyncio_reactor(self): - from twisted.internet import reactor as original_reactor - - with warnings.catch_warnings(record=True) as w: - install_reactor(_asyncio_reactor_path) - assert len(w) == 0, [str(warning) for warning in w] - from twisted.internet import reactor # pylint: disable=reimported - - assert original_reactor == reactor + assert is_asyncio_reactor_installed() == (reactor_pytest == "asyncio") + @pytest.mark.requires_reactor # installs a reactor @pytest.mark.only_asyncio - @deferred_f_from_coro_f + @coroutine_test async def test_set_asyncio_event_loop(self): install_reactor(_asyncio_reactor_path) assert set_asyncio_event_loop(None) is asyncio.get_running_loop() diff --git a/tests/test_utils_request.py b/tests/test_utils_request.py index 9c4cb7159..e4967d4e7 100644 --- a/tests/test_utils_request.py +++ b/tests/test_utils_request.py @@ -1,32 +1,23 @@ from __future__ import annotations import json -import warnings from hashlib import sha1 +from typing import Any from weakref import WeakKeyDictionary import pytest -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request from scrapy.utils.python import to_bytes from scrapy.utils.request import ( _fingerprint_cache, fingerprint, - request_authenticate, request_httprepr, request_to_curl, ) from scrapy.utils.test import get_crawler -@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") -def test_request_authenticate(): - r = Request("http://www.example.com") - request_authenticate(r, "someuser", "somepass") - assert r.headers["Authorization"] == b"Basic c29tZXVzZXI6c29tZXBhc3M=" - - @pytest.mark.parametrize( ("r", "expected"), [ @@ -66,13 +57,17 @@ def test_request_httprepr_for_non_http_request(r: Request) -> None: class TestFingerprint: - function: staticmethod = staticmethod(fingerprint) + function: staticmethod[[Request], bytes] = staticmethod(fingerprint) cache: ( - WeakKeyDictionary[Request, dict[tuple[tuple[bytes, ...] | None, bool], bytes]] - | WeakKeyDictionary[Request, dict[tuple[tuple[bytes, ...] | None, bool], str]] + WeakKeyDictionary[ + Request, dict[tuple[tuple[bytes, ...] | None, bool, bool], bytes] + ] + | WeakKeyDictionary[ + Request, dict[tuple[tuple[bytes, ...] | None, bool, bool], str] + ] ) = _fingerprint_cache - default_cache_key = (None, False) - known_hashes: tuple[tuple[Request, bytes | str, dict], ...] = ( + default_cache_key = (None, False, False) + known_hashes: tuple[tuple[Request, bytes | str, dict[str, Any]], ...] = ( ( Request("http://example.org"), b"xs\xd7\x0c3uj\x15\xfe\xd7d\x9b\xa9\t\xe0d\xbf\x9cXD", @@ -201,6 +196,32 @@ class TestFingerprint: assert self.function(r2) != self.function(r2, keep_fragments=True) assert self.function(r1) != self.function(r2, keep_fragments=True) + def test_verbatim_url(self): + # verbatim_url requests skip URL canonicalization + r1 = Request( + "http://www.example.com/query?a=1&b=2", meta={"verbatim_url": True} + ) + r2 = Request( + "http://www.example.com/query?b=2&a=1", meta={"verbatim_url": True} + ) + assert self.function(r1) != self.function(r2) + + # without verbatim_url, canonicalization makes query-param order irrelevant + r3 = Request("http://www.example.com/query?a=1&b=2") + r4 = Request("http://www.example.com/query?b=2&a=1") + assert self.function(r3) == self.function(r4) + + # with verbatim_url, the fragment is always kept in the fingerprint + r5 = Request( + "http://www.example.com/test#fragment", meta={"verbatim_url": True} + ) + r6 = Request("http://www.example.com/test", meta={"verbatim_url": True}) + assert self.function(r5) != self.function(r6) + + # keep_fragments parameter is ignored for verbatim_url requests + assert self.function(r5) == self.function(r5, keep_fragments=True) + assert self.function(r5) == self.function(r5, keep_fragments=False) + def test_method_and_body(self): r1 = Request("http://www.example.com") r2 = Request("http://www.example.com", method="POST") @@ -237,25 +258,13 @@ class TestFingerprint: class TestRequestFingerprinter: - def test_default_implementation(self): + def test_fingerprint(self): crawler = get_crawler() request = Request("https://example.com") assert crawler.request_fingerprinter.fingerprint(request) == fingerprint( request ) - def test_deprecated_implementation(self): - settings = { - "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", - } - with warnings.catch_warnings(record=True) as logged_warnings: - crawler = get_crawler(settings_dict=settings) - request = Request("https://example.com") - assert crawler.request_fingerprinter.fingerprint(request) == fingerprint( - request - ) - assert logged_warnings - class TestCustomRequestFingerprinter: def test_include_headers(self): @@ -343,57 +352,6 @@ class TestCustomRequestFingerprinter: fingerprint = crawler.request_fingerprinter.fingerprint(request) assert fingerprint == settings["FINGERPRINT"] - def test_from_settings(self): - class RequestFingerprinter: - @classmethod - def from_settings(cls, settings): - return cls(settings) - - def __init__(self, settings): - self._fingerprint = settings["FINGERPRINT"] - - def fingerprint(self, request): - return self._fingerprint - - settings = { - "REQUEST_FINGERPRINTER_CLASS": RequestFingerprinter, - "FINGERPRINT": b"fingerprint", - } - with warnings.catch_warnings(): - warnings.simplefilter("ignore", ScrapyDeprecationWarning) - crawler = get_crawler(settings_dict=settings) - - request = Request("http://www.example.com") - fingerprint = crawler.request_fingerprinter.fingerprint(request) - assert fingerprint == settings["FINGERPRINT"] - - def test_from_crawler_and_settings(self): - class RequestFingerprinter: - # This method is ignored due to the presence of from_crawler - @classmethod - def from_settings(cls, settings): - return cls(settings) - - @classmethod - def from_crawler(cls, crawler): - return cls(crawler) - - def __init__(self, crawler): - self._fingerprint = crawler.settings["FINGERPRINT"] - - def fingerprint(self, request): - return self._fingerprint - - settings = { - "REQUEST_FINGERPRINTER_CLASS": RequestFingerprinter, - "FINGERPRINT": b"fingerprint", - } - crawler = get_crawler(settings_dict=settings) - - request = Request("http://www.example.com") - fingerprint = crawler.request_fingerprinter.fingerprint(request) - assert fingerprint == settings["FINGERPRINT"] - class TestRequestToCurl: def _test_request(self, request_object, expected_curl_command): @@ -455,3 +413,45 @@ class TestRequestToCurl: " --data-raw '{\"foo\": \"bar\"}' --cookie 'foo=bar'" ) self._test_request(request_object, expected_curl_command) + + def test_cookies_list_verbose(self): + request_object = Request( + "https://www.httpbin.org/post", + method="POST", + cookies=[ + { + "name": b"foo", + "value": b"bar", + "domain": "example.com", + "path": "/", + "secure": True, + } + ], + body=json.dumps({"foo": "bar"}), + ) + expected_curl_command = ( + "curl -X POST https://www.httpbin.org/post" + " --data-raw '{\"foo\": \"bar\"}' --cookie 'foo=bar'" + ) + self._test_request(request_object, expected_curl_command) + + def test_cookies_list_verbose_non_string_value(self): + request_object = Request( + "https://www.httpbin.org/post", + method="POST", + cookies=[ + { + "name": "foo", + "value": 1, + "domain": "example.com", + "path": "/", + "secure": True, + } + ], + body=json.dumps({"foo": "bar"}), + ) + expected_curl_command = ( + "curl -X POST https://www.httpbin.org/post" + " --data-raw '{\"foo\": \"bar\"}' --cookie 'foo=1'" + ) + self._test_request(request_object, expected_curl_command) diff --git a/tests/test_utils_response.py b/tests/test_utils_response.py index 179ca49e4..4544cd29e 100644 --- a/tests/test_utils_response.py +++ b/tests/test_utils_response.py @@ -4,7 +4,7 @@ from urllib.parse import urlparse import pytest -from scrapy.http import HtmlResponse, Response +from scrapy.http import HtmlResponse, Response, TextResponse from scrapy.utils.python import to_bytes from scrapy.utils.response import ( _remove_html_comments, @@ -15,17 +15,21 @@ from scrapy.utils.response import ( ) +def _read_browser_output(burl: str): + path = urlparse(burl).path + if not path or not Path(path).exists(): + path = burl.replace("file://", "") + return Path(path).read_bytes() + + def test_open_in_browser(): - url = "http:///www.example.com/some/page.html" + url = "http://www.example.com/some/page.html" body = ( b" test page test body " ) def browser_open(burl: str) -> bool: - path = urlparse(burl).path - if not path or not Path(path).exists(): - path = burl.replace("file://", "") - bbody = Path(path).read_bytes() + bbody = _read_browser_output(burl) assert b'' in bbody return True @@ -67,9 +71,23 @@ if(!checkCookies()){ """, ) + r4 = HtmlResponse( + "http://www.example.com", + body=b""" + + Dummy + + + blahablsdfsal& + """, + ) assert get_meta_refresh(r1) == (5.0, "http://example.org/newpage") assert get_meta_refresh(r2) == (None, None) assert get_meta_refresh(r3) == (None, None) + assert get_meta_refresh(r4) == ( + 5.0, + "http://www.another-domain.com/base/path/target.html", + ) def test_get_base_url(): @@ -97,36 +115,27 @@ def test_response_status_message(): assert response_status_message(573) == "573 Unknown Status" -def test_inject_base_url(): - url = "http://www.example.com" - - def check_base_url(burl): - path = urlparse(burl).path - if not path or not Path(path).exists(): - path = burl.replace("file://", "") - bbody = Path(path).read_bytes() - assert bbody.count(b'') == 1 - return True - - r1 = HtmlResponse( - url, - body=b""" +@pytest.mark.parametrize( + "body", + [ + pytest.param( + b""" Dummy

Hello world.

""", - ) - r2 = HtmlResponse( - url, - body=b""" + id="Simple", + ), + pytest.param( + b""" Dummy Hello world. """, - ) - r3 = HtmlResponse( - url, - body=b""" + id=" with attrs", + ), + pytest.param( + b""" Dummy @@ -134,19 +143,19 @@ def test_inject_base_url():

Hello world.

""", - ) - r4 = HtmlResponse( - url, - body=b""" + id="Misleading tag", + ), + pytest.param( + b""" Dummy

Hello world.

""", - ) - r5 = HtmlResponse( - url, - body=b""" + id="Misleading comment", + ), + pytest.param( + b"""

Hello world.

""", - ) + id="Conditional comment", + ), + ], +) +def test_inject_base_url(body: bytes) -> None: + url = "http://www.example.com" - assert open_in_browser(r1, _openfunc=check_base_url), "Inject base url" - assert open_in_browser(r2, _openfunc=check_base_url), ( - "Inject base url with argumented head" - ) - assert open_in_browser(r3, _openfunc=check_base_url), ( - "Inject unique base url with misleading tag" - ) - assert open_in_browser(r4, _openfunc=check_base_url), ( - "Inject unique base url with misleading comment" - ) - assert open_in_browser(r5, _openfunc=check_base_url), ( - "Inject unique base url with conditional comment" - ) + def check_base_url(burl): + bbody = _read_browser_output(burl) + assert bbody.count(b'>') == 1 + assert b"ccd", b"acd"), (b"ad", b"ad"), + (b"a -->b", b"a -->b"), + (b"real", b"real"), ], ) def test_remove_html_comments(input_body, output_body): assert _remove_html_comments(input_body) == output_body + + +def test_open_in_browser_preserves_html_comments(): + url = "http://www.example.com" + body = ( + b"" + b"" + b"Real" + b"content" + b"" + ) + + def check(burl): + bbody = _read_browser_output(burl) + assert b"" in bbody + return True + + response = HtmlResponse(url, body=body) + assert open_in_browser(response, _openfunc=check) + + +def test_open_in_browser_does_not_inject_base_when_present(): + url = "http://www.example.com" + body = ( + b"" + b'T' + b"hi" + b"" + ) + + def check(burl): + bbody = _read_browser_output(burl) + assert b'' not in bbody + assert b'' in bbody + return True + + response = HtmlResponse(url, body=body) + assert open_in_browser(response, _openfunc=check) + + +def test_open_in_browser_injects_base_when_only_in_comment(): + url = "http://www.example.com" + body = ( + b"" + b"" + b"Real" + b"content" + b"" + ) + + def check(burl): + bbody = _read_browser_output(burl) + assert b'' in bbody + return True + + response = HtmlResponse(url, body=body) + assert open_in_browser(response, _openfunc=check) + + +def test_open_in_browser_injects_base_at_real_head_not_commented_head(): + url = "http://www.example.com" + body = ( + b"" + b"" + b"Actual" + b"hello" + b"" + ) + + def check(burl): + bbody = _read_browser_output(burl) + assert bbody.count(b'') == 1 + base_pos = bbody.find(b'') + title_pos = bbody.find(b"Actual") + assert base_pos < title_pos + return True + + response = HtmlResponse(url, body=body) + assert open_in_browser(response, _openfunc=check) + + +def test_open_in_browser_text_response_uses_txt_extension(): + response = TextResponse("http://www.example.com", body=b"plain text content") + + def check(burl): + assert burl.endswith(".txt") + return True + + assert open_in_browser(response, _openfunc=check) + + +def test_open_in_browser_raises_for_unsupported_response_type(): + response = Response("http://www.example.com", body=b"binary") + with pytest.raises(TypeError): + open_in_browser(response, _openfunc=lambda _: True) diff --git a/tests/test_utils_serialize.py b/tests/test_utils_serialize.py index dcaac7358..2e6a790f8 100644 --- a/tests/test_utils_serialize.py +++ b/tests/test_utils_serialize.py @@ -30,7 +30,7 @@ class TestJsonEncoder: dt_set = {dt} dt_sets = [dts] - for input, output in [ + for input_, output in [ ("foo", "foo"), (d, ds), (t, ts), @@ -40,7 +40,7 @@ class TestJsonEncoder: (s, ss), (dt_set, dt_sets), ]: - assert encoder.encode(input) == json.dumps(output, sort_keys=True) + assert encoder.encode(input_) == json.dumps(output, sort_keys=True) def test_encode_deferred(self, encoder: ScrapyJSONEncoder) -> None: assert "Deferred" in encoder.encode(defer.Deferred()) diff --git a/tests/test_utils_signal.py b/tests/test_utils_signal.py index 79bac8bc5..9ac0fd0c0 100644 --- a/tests/test_utils_signal.py +++ b/tests/test_utils_signal.py @@ -4,10 +4,9 @@ import pytest from pydispatch import dispatcher from testfixtures import LogCapture from twisted.internet import defer -from twisted.internet.defer import inlineCallbacks from twisted.python.failure import Failure -from twisted.trial import unittest +from scrapy.utils.asyncio import call_later from scrapy.utils.defer import deferred_from_coro from scrapy.utils.signal import ( send_catch_log, @@ -15,10 +14,14 @@ from scrapy.utils.signal import ( send_catch_log_deferred, ) from scrapy.utils.test import get_from_asyncio_queue +from tests.utils.decorators import inline_callbacks_test -class TestSendCatchLog(unittest.TestCase): - @inlineCallbacks +class TestSendCatchLog: + # whether the function being tested returns exceptions or failures + returns_exceptions: bool = False + + @inline_callbacks_test def test_send_catch_log(self): test_signal = object() handlers_called = set() @@ -40,7 +43,9 @@ class TestSendCatchLog(unittest.TestCase): assert "error_handler" in record.getMessage() assert record.levelname == "ERROR" assert result[0][0] == self.error_handler # pylint: disable=comparison-with-callable - assert isinstance(result[0][1], Failure) + assert isinstance( + result[0][1], Exception if self.returns_exceptions else Failure + ) assert result[1] == (self.ok_handler, "OK") dispatcher.disconnect(self.error_handler, signal=test_signal) @@ -59,6 +64,7 @@ class TestSendCatchLog(unittest.TestCase): return "OK" +@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") class TestSendCatchLogDeferred(TestSendCatchLog): def _get_result(self, signal, *a, **kw): return send_catch_log_deferred(signal, *a, **kw) @@ -66,16 +72,13 @@ class TestSendCatchLogDeferred(TestSendCatchLog): class TestSendCatchLogDeferred2(TestSendCatchLogDeferred): def ok_handler(self, arg, handlers_called): - from twisted.internet import reactor - handlers_called.add(self.ok_handler) assert arg == "test" d = defer.Deferred() - reactor.callLater(0, d.callback, "OK") + call_later(0, d.callback, "OK") return d -@pytest.mark.usefixtures("reactor_pytest") class TestSendCatchLogDeferredAsyncDef(TestSendCatchLogDeferred): async def ok_handler(self, arg, handlers_called): handlers_called.add(self.ok_handler) @@ -94,22 +97,22 @@ class TestSendCatchLogDeferredAsyncio(TestSendCatchLogDeferred): class TestSendCatchLogAsync(TestSendCatchLog): + returns_exceptions = True + def _get_result(self, signal, *a, **kw): return deferred_from_coro(send_catch_log_async(signal, *a, **kw)) +@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") class TestSendCatchLogAsync2(TestSendCatchLogAsync): def ok_handler(self, arg, handlers_called): - from twisted.internet import reactor - handlers_called.add(self.ok_handler) assert arg == "test" d = defer.Deferred() - reactor.callLater(0, d.callback, "OK") + call_later(0, d.callback, "OK") return d -@pytest.mark.usefixtures("reactor_pytest") class TestSendCatchLogAsyncAsyncDef(TestSendCatchLogAsync): async def ok_handler(self, arg, handlers_called): handlers_called.add(self.ok_handler) diff --git a/tests/test_utils_sitemap.py b/tests/test_utils_sitemap.py index 464a31777..3599c4824 100644 --- a/tests/test_utils_sitemap.py +++ b/tests/test_utils_sitemap.py @@ -1,3 +1,6 @@ +import pytest + +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.sitemap import Sitemap, sitemap_urls_from_robots @@ -156,7 +159,7 @@ def test_sitemap_wrong_ns2(): def test_sitemap_urls_from_robots(): - robots = """User-agent: * + robots = b"""User-agent: * Disallow: /aff/ Disallow: /wl/ @@ -182,6 +185,40 @@ Disallow: /forum/active/ ] +def test_sitemap_urls_from_robots_str_compat(): + robots = """User-agent: * +Disallow: /aff/ +Disallow: /wl/ + +# Search and shopping refining +Disallow: /s*/*facet +Disallow: /s*/*tags + +# Sitemap files +Sitemap: http://example.com/sitemap.xml +Sitemap: http://example.com/sitemap-product-index.xml +Sitemap: HTTP://example.com/sitemap-uppercase.xml +Sitemap: /sitemap-relative-url.xml + +# Forums +Disallow: /forum/search/ +Disallow: /forum/active/ +""" + + with pytest.warns( + ScrapyDeprecationWarning, + match="Passing `str` type as `robots_text` is deprecated", + ): + assert list( + sitemap_urls_from_robots(robots, base_url="http://example.com") + ) == [ + "http://example.com/sitemap.xml", + "http://example.com/sitemap-product-index.xml", + "http://example.com/sitemap-uppercase.xml", + "http://example.com/sitemap-relative-url.xml", + ] + + def test_sitemap_blanklines(): """Assert we can deal with starting blank lines before tag""" s = Sitemap( diff --git a/tests/test_utils_spider.py b/tests/test_utils_spider.py index 8600faa8d..05971f423 100644 --- a/tests/test_utils_spider.py +++ b/tests/test_utils_spider.py @@ -24,7 +24,7 @@ def test_iterate_spider_output(): def test_iter_spider_classes(): - import tests.test_utils_spider # noqa: PLW0406 # pylint: disable=import-self + import tests.test_utils_spider # noqa: PLW0406,PLC0415 it = iter_spider_classes(tests.test_utils_spider) assert set(it) == {MySpider1, MySpider2} diff --git a/tests/test_utils_trackref.py b/tests/test_utils_trackref.py index 3967c3365..7a7a264d3 100644 --- a/tests/test_utils_trackref.py +++ b/tests/test_utils_trackref.py @@ -1,10 +1,11 @@ +import sys from io import StringIO -from time import sleep, time from unittest import mock import pytest from scrapy.utils import trackref +from scrapy.utils.python import garbage_collect class Foo(trackref.object_ref): @@ -63,24 +64,57 @@ Foo 1 oldest: 0s ago\n\n""" ) +_IS_PYPY = "PyPy" in sys.version + + def test_get_oldest(): - o1 = Foo() + """ + Verify that `get_oldest` returns the oldest live instance of a class. - o1_time = time() + The test runs in two passes to expose differences between: + - CPython (reference counting, immediate destruction) + - PyPy (tracing GC, delayed destruction) - o2 = Bar() + Since `trackref` relies on weak references, delayed GC on PyPy can leave + stale entries in `live_refs`, affecting results unless explicitly cleared. + """ - o3_time = time() - if o3_time <= o1_time: - sleep(0.01) - o3_time = time() - if o3_time <= o1_time: - pytest.skip("time.time is not precise enough") + def _delete_o1(): + """Delete `o1` and ensure it is actually collected on PyPy.""" + nonlocal o1 + del o1 - o3 = Foo() # noqa: F841 - assert trackref.get_oldest("Foo") is o1 - assert trackref.get_oldest("Bar") is o2 - assert trackref.get_oldest("XXX") is None + if _IS_PYPY: + # On PyPy, `del` only removes the local reference. The object may + # still exist until the GC runs, so we force a collection cycle. + garbage_collect() + + def _do_asserts(): + assert trackref.get_oldest("Foo") is o1 + assert trackref.get_oldest("Bar") is o2 + # Ensure the newer Foo is not incorrectly considered the oldest + assert trackref.get_oldest("Foo") is not o3 + assert trackref.get_oldest("XXX") is None + + o1, o2, o3 = Foo(), Bar(), Foo() + + _do_asserts() + + # Remove the oldest Foo instance; o3 should now become the oldest + _delete_o1() + assert trackref.get_oldest("Foo") is o3 + + # PyPy-specific behavior where stale references may persist + # unless the registry is explicitly cleared. + if _IS_PYPY: + trackref.live_refs.clear() + + o1, o2, o3 = Foo(), Bar(), Foo() + + _do_asserts() + + _delete_o1() + assert trackref.get_oldest("Foo") is o3 def test_iter_all(): diff --git a/tests/test_utils_url.py b/tests/test_utils_url.py index daf09f945..a74b9a41d 100644 --- a/tests/test_utils_url.py +++ b/tests/test_utils_url.py @@ -1,12 +1,9 @@ -import warnings - import pytest from scrapy.linkextractors import IGNORED_EXTENSIONS from scrapy.spiders import Spider -from scrapy.utils.url import ( # type: ignore[attr-defined] +from scrapy.utils.url import ( _is_filesystem_path, - _public_w3lib_objects, add_http_if_no_scheme, guess_scheme, strip_url, @@ -349,6 +346,18 @@ class TestStripUrl: "ftp://username:password@www.example.com:221/file.txt", "ftp://username:password@www.example.com:221/file.txt", ), + ( + "http://user:80@www.example.com:80/index.html", + "http://user:80@www.example.com/index.html", + ), + ( + "https://user:443@www.example.com:443/index.html", + "https://user:443@www.example.com/index.html", + ), + ( + "ftp://user:21@www.example.com:21/file.txt", + "ftp://user:21@www.example.com/file.txt", + ), ], ) def test_default_ports(self, url: str, expected: str) -> None: @@ -445,25 +454,3 @@ class TestStripUrl: ) def test__is_filesystem_path(path: str, expected: bool) -> None: assert _is_filesystem_path(path) == expected - - -@pytest.mark.parametrize( - "obj_name", - [ - "_unquotepath", - "_safe_chars", - "parse_url", - *_public_w3lib_objects, - ], -) -def test_deprecated_imports_from_w3lib(obj_name: str) -> None: - with warnings.catch_warnings(record=True) as warns: - obj_type = "attribute" if obj_name == "_safe_chars" else "function" - message = f"The scrapy.utils.url.{obj_name} {obj_type} is deprecated, use w3lib.url.{obj_name} instead." - - from importlib import import_module - - getattr(import_module("scrapy.utils.url"), obj_name) - - assert isinstance(warns[0].message, Warning) - assert message in warns[0].message.args diff --git a/tests/test_webclient.py b/tests/test_webclient.py deleted file mode 100644 index 569f4f639..000000000 --- a/tests/test_webclient.py +++ /dev/null @@ -1,384 +0,0 @@ -""" -from twisted.internet import defer -Tests borrowed from the twisted.web.client tests. -""" - -from __future__ import annotations - -import shutil -from pathlib import Path -from tempfile import mkdtemp -from urllib.parse import urlparse - -import OpenSSL.SSL -import pytest -from twisted.internet import defer -from twisted.internet.defer import inlineCallbacks -from twisted.internet.testing import StringTransport -from twisted.protocols.policies import WrappingFactory -from twisted.trial import unittest -from twisted.web import resource, server, static, util - -from scrapy.core.downloader import webclient as client -from scrapy.core.downloader.contextfactory import ( - ScrapyClientContextFactory, -) -from scrapy.http import Headers, Request -from scrapy.utils.misc import build_from_crawler -from scrapy.utils.python import to_bytes, to_unicode -from scrapy.utils.test import get_crawler -from tests.mockserver import ( - BrokenDownloadResource, - ErrorResource, - ForeverTakingResource, - HostHeaderResource, - NoLengthResource, - PayloadResource, - ssl_context_factory, -) -from tests.test_core_downloader import TestContextFactoryBase - - -def getPage(url, contextFactory=None, response_transform=None, *args, **kwargs): - """Adapted version of twisted.web.client.getPage""" - - def _clientfactory(url, *args, **kwargs): - url = to_unicode(url) - timeout = kwargs.pop("timeout", 0) - f = client.ScrapyHTTPClientFactory( - Request(url, *args, **kwargs), timeout=timeout - ) - f.deferred.addCallback(response_transform or (lambda r: r.body)) - return f - - from twisted.web.client import _makeGetterFactory - - return _makeGetterFactory( - to_bytes(url), - _clientfactory, - contextFactory=contextFactory, - *args, - **kwargs, - ).deferred - - -@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") -class TestScrapyHTTPPageGetter: - def test_earlyHeaders(self): - # basic test stolen from twisted HTTPageGetter - factory = client.ScrapyHTTPClientFactory( - Request( - url="http://foo/bar", - body="some data", - headers={ - "Host": "example.net", - "User-Agent": "fooble", - "Cookie": "blah blah", - "Content-Length": "12981", - "Useful": "value", - }, - ) - ) - - self._test( - factory, - b"GET /bar HTTP/1.0\r\n" - b"Content-Length: 9\r\n" - b"Useful: value\r\n" - b"Connection: close\r\n" - b"User-Agent: fooble\r\n" - b"Host: example.net\r\n" - b"Cookie: blah blah\r\n" - b"\r\n" - b"some data", - ) - - # test minimal sent headers - factory = client.ScrapyHTTPClientFactory(Request("http://foo/bar")) - self._test(factory, b"GET /bar HTTP/1.0\r\nHost: foo\r\n\r\n") - - # test a simple POST with body and content-type - factory = client.ScrapyHTTPClientFactory( - Request( - method="POST", - url="http://foo/bar", - body="name=value", - headers={"Content-Type": "application/x-www-form-urlencoded"}, - ) - ) - - self._test( - factory, - b"POST /bar HTTP/1.0\r\n" - b"Host: foo\r\n" - b"Connection: close\r\n" - b"Content-Type: application/x-www-form-urlencoded\r\n" - b"Content-Length: 10\r\n" - b"\r\n" - b"name=value", - ) - - # test a POST method with no body provided - factory = client.ScrapyHTTPClientFactory( - Request(method="POST", url="http://foo/bar") - ) - - self._test( - factory, - b"POST /bar HTTP/1.0\r\nHost: foo\r\nContent-Length: 0\r\n\r\n", - ) - - # test with single and multivalued headers - factory = client.ScrapyHTTPClientFactory( - Request( - url="http://foo/bar", - headers={ - "X-Meta-Single": "single", - "X-Meta-Multivalued": ["value1", "value2"], - }, - ) - ) - - self._test( - factory, - b"GET /bar HTTP/1.0\r\n" - b"Host: foo\r\n" - b"X-Meta-Multivalued: value1\r\n" - b"X-Meta-Multivalued: value2\r\n" - b"X-Meta-Single: single\r\n" - b"\r\n", - ) - - # same test with single and multivalued headers but using Headers class - factory = client.ScrapyHTTPClientFactory( - Request( - url="http://foo/bar", - headers=Headers( - { - "X-Meta-Single": "single", - "X-Meta-Multivalued": ["value1", "value2"], - } - ), - ) - ) - - self._test( - factory, - b"GET /bar HTTP/1.0\r\n" - b"Host: foo\r\n" - b"X-Meta-Multivalued: value1\r\n" - b"X-Meta-Multivalued: value2\r\n" - b"X-Meta-Single: single\r\n" - b"\r\n", - ) - - def _test(self, factory, testvalue): - transport = StringTransport() - protocol = client.ScrapyHTTPPageGetter() - protocol.factory = factory - protocol.makeConnection(transport) - assert set(transport.value().splitlines()) == set(testvalue.splitlines()) - return testvalue - - def test_non_standard_line_endings(self): - # regression test for: http://dev.scrapy.org/ticket/258 - factory = client.ScrapyHTTPClientFactory(Request(url="http://foo/bar")) - protocol = client.ScrapyHTTPPageGetter() - protocol.factory = factory - protocol.headers = Headers() - protocol.dataReceived(b"HTTP/1.0 200 OK\n") - protocol.dataReceived(b"Hello: World\n") - protocol.dataReceived(b"Foo: Bar\n") - protocol.dataReceived(b"\n") - assert protocol.headers == Headers({"Hello": ["World"], "Foo": ["Bar"]}) - - -class EncodingResource(resource.Resource): - out_encoding = "cp1251" - - def render(self, request): - body = to_unicode(request.content.read()) - request.setHeader(b"content-encoding", self.out_encoding) - return body.encode(self.out_encoding) - - -@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") -class TestWebClient(unittest.TestCase): - def _listen(self, site): - from twisted.internet import reactor - - return reactor.listenTCP(0, site, interface="127.0.0.1") - - def setUp(self): - self.tmpname = Path(mkdtemp()) - (self.tmpname / "file").write_bytes(b"0123456789") - r = static.File(str(self.tmpname)) - r.putChild(b"redirect", util.Redirect(b"/file")) - r.putChild(b"wait", ForeverTakingResource()) - r.putChild(b"error", ErrorResource()) - r.putChild(b"nolength", NoLengthResource()) - r.putChild(b"host", HostHeaderResource()) - r.putChild(b"payload", PayloadResource()) - r.putChild(b"broken", BrokenDownloadResource()) - r.putChild(b"encoding", EncodingResource()) - self.site = server.Site(r, timeout=None) - self.wrapper = WrappingFactory(self.site) - self.port = self._listen(self.wrapper) - self.portno = self.port.getHost().port - - @inlineCallbacks - def tearDown(self): - yield self.port.stopListening() - shutil.rmtree(self.tmpname) - - def getURL(self, path): - return f"http://127.0.0.1:{self.portno}/{path}" - - @inlineCallbacks - def testPayload(self): - s = "0123456789" * 10 - body = yield getPage(self.getURL("payload"), body=s) - assert body == to_bytes(s) - - @inlineCallbacks - def testHostHeader(self): - # if we pass Host header explicitly, it should be used, otherwise - # it should extract from url - body = yield getPage(self.getURL("host")) - assert body == to_bytes(f"127.0.0.1:{self.portno}") - body = yield getPage(self.getURL("host"), headers={"Host": "www.example.com"}) - assert body == to_bytes("www.example.com") - - @inlineCallbacks - def test_getPage(self): - """ - L{client.getPage} returns a L{Deferred} which is called back with - the body of the response if the default method B{GET} is used. - """ - body = yield getPage(self.getURL("file")) - assert body == b"0123456789" - - @inlineCallbacks - def test_getPageHead(self): - """ - L{client.getPage} returns a L{Deferred} which is called back with - the empty string if the method is C{HEAD} and there is a successful - response code. - """ - - def _getPage(method): - return getPage(self.getURL("file"), method=method) - - body = yield _getPage("head") - assert body == b"" - body = yield _getPage("HEAD") - assert body == b"" - - @inlineCallbacks - def test_timeoutNotTriggering(self): - """ - When a non-zero timeout is passed to L{getPage} and the page is - retrieved before the timeout period elapses, the L{Deferred} is - called back with the contents of the page. - """ - body = yield getPage(self.getURL("host"), timeout=100) - assert body == to_bytes(f"127.0.0.1:{self.portno}") - - @inlineCallbacks - def test_timeoutTriggering(self): - """ - When a non-zero timeout is passed to L{getPage} and that many - seconds elapse before the server responds to the request. the - L{Deferred} is errbacked with a L{error.TimeoutError}. - """ - with pytest.raises(defer.TimeoutError): - yield getPage(self.getURL("wait"), timeout=0.000001) - # Clean up the server which is hanging around not doing - # anything. - connected = list(self.wrapper.protocols.keys()) - # There might be nothing here if the server managed to already see - # that the connection was lost. - if connected: - connected[0].transport.loseConnection() - - @inlineCallbacks - def testNotFound(self): - body = yield getPage(self.getURL("notsuchfile")) - assert b"404 - No Such Resource" in body - - @inlineCallbacks - def testFactoryInfo(self): - from twisted.internet import reactor - - url = self.getURL("file") - parsed = urlparse(url) - factory = client.ScrapyHTTPClientFactory(Request(url)) - reactor.connectTCP(parsed.hostname, parsed.port, factory) - yield factory.deferred - assert factory.status == b"200" - assert factory.version.startswith(b"HTTP/") - assert factory.message == b"OK" - assert factory.response_headers[b"content-length"] == b"10" - - @inlineCallbacks - def testRedirect(self): - body = yield getPage(self.getURL("redirect")) - assert ( - body - == b'\n\n \n \n' - b' \n \n ' - b'click here\n \n\n' - ) - - @inlineCallbacks - def test_encoding(self): - """Test that non-standart body encoding matches - Content-Encoding header""" - original_body = b"\xd0\x81\xd1\x8e\xd0\xaf" - response = yield getPage( - self.getURL("encoding"), body=original_body, response_transform=lambda r: r - ) - content_encoding = to_unicode(response.headers[b"Content-Encoding"]) - assert content_encoding == EncodingResource.out_encoding - assert response.body.decode(content_encoding) == to_unicode(original_body) - - -@pytest.mark.filterwarnings("ignore::scrapy.exceptions.ScrapyDeprecationWarning") -class TestWebClientSSL(TestContextFactoryBase): - @inlineCallbacks - def testPayload(self): - s = "0123456789" * 10 - body = yield getPage(self.getURL("payload"), body=s) - assert body == to_bytes(s) - - -class TestWebClientCustomCiphersSSL(TestWebClientSSL): - # we try to use a cipher that is not enabled by default in OpenSSL - custom_ciphers = "CAMELLIA256-SHA" - context_factory = ssl_context_factory(cipher_string=custom_ciphers) - - @inlineCallbacks - def testPayload(self): - s = "0123456789" * 10 - crawler = get_crawler( - settings_dict={"DOWNLOADER_CLIENT_TLS_CIPHERS": self.custom_ciphers} - ) - client_context_factory = build_from_crawler(ScrapyClientContextFactory, crawler) - body = yield getPage( - self.getURL("payload"), body=s, contextFactory=client_context_factory - ) - assert body == to_bytes(s) - - @inlineCallbacks - def testPayloadDisabledCipher(self): - s = "0123456789" * 10 - crawler = get_crawler( - settings_dict={ - "DOWNLOADER_CLIENT_TLS_CIPHERS": "ECDHE-RSA-AES256-GCM-SHA384" - } - ) - client_context_factory = build_from_crawler(ScrapyClientContextFactory, crawler) - with pytest.raises(OpenSSL.SSL.Error): - yield getPage( - self.getURL("payload"), body=s, contextFactory=client_context_factory - ) diff --git a/tests/test_zz_resources.py b/tests/test_zz_resources.py new file mode 100644 index 000000000..b2ba013f1 --- /dev/null +++ b/tests/test_zz_resources.py @@ -0,0 +1,60 @@ +"""Test that certain resources are not leaked during earlier tests.""" + +from __future__ import annotations + +import asyncio +import logging + +import pytest + +from scrapy.utils.log import LogCounterHandler +from scrapy.utils.reactor import is_asyncio_reactor_installed, is_reactor_installed +from tests.utils.decorators import coroutine_test + + +def test_counter_handler() -> None: + """Test that ``LogCounterHandler`` is always properly removed. + + It's added in ``LogCount.spider_opened()`` and removed in + ``LogCount.spider_closed()``. + """ + c = sum(1 for h in logging.root.handlers if isinstance(h, LogCounterHandler)) + assert c == 0 + + +def test_stderr_log_handler() -> None: + """Test that the Scrapy root handler is always properly removed. + + It's added in ``configure_logging()``, called by ``{Async,}CrawlerProcess`` + (without ``install_root_handler=False``). It can be removed with + ``_uninstall_scrapy_root_handler()`` if installing it was really needed. + """ + c = sum(1 for h in logging.root.handlers if type(h) is logging.StreamHandler) # pylint: disable=unidiomatic-typecheck + assert c == 0 + + +@pytest.mark.only_asyncio +@coroutine_test +async def test_pending_asyncio_tasks() -> None: + """Test that there are no pending asyncio tasks.""" + # note that pytest-asyncio uses separate loops per function so this isn't as useful there + tasks = [] + for t in asyncio.all_tasks(): + coro = t.get_coro() + if ( + coro is not None + and getattr(coro, "__name__", None) != "test_pending_asyncio_tasks" + ): + tasks.append(t) + assert not tasks + + +def test_installed_reactor(reactor_pytest: str) -> None: + """Test that the correct reactor is installed.""" + match reactor_pytest: + case "asyncio": + assert is_asyncio_reactor_installed() + case "default": + assert not is_asyncio_reactor_installed() + case "none": + assert not is_reactor_installed() diff --git a/tests/upper-constraints.txt b/tests/upper-constraints.txt deleted file mode 100644 index 2a335e533..000000000 --- a/tests/upper-constraints.txt +++ /dev/null @@ -1,17 +0,0 @@ -# Request the latest known version or newer of some dependencies to prevent the -# pip dependency resolver from spending too much time backtracking. -attrs>=20.2.0 -Automat>=0.8.0 -botocore>=1.20.30 -itemadapter>=0.1.1 -itemloaders>=1.0.3 -lxml>=4.6.1 -parsel>=1.5.2 -Pillow>=8.0.1 -pyOpenSSL>=17.5 # mitmproxy 4.0.4 -pytest>=6.2.1 -pytest-twisted>=1.13.1 -service_identity>=17.0.0 -six>=1.14.0 -sybil>=2.0.0 -Twisted>=19.10.0 diff --git a/tests/utils/__init__.py b/tests/utils/__init__.py index e5e56f414..73c0e3776 100644 --- a/tests/utils/__init__.py +++ b/tests/utils/__init__.py @@ -1,9 +1,50 @@ +import asyncio +import os +from collections.abc import Callable +from pathlib import Path + from twisted.internet.defer import Deferred +from scrapy.utils.asyncio import is_asyncio_available +from scrapy.utils.defer import maybe_deferred_to_future -def twisted_sleep(seconds): + +def twisted_sleep(seconds: float): from twisted.internet import reactor - d = Deferred() + d: Deferred[None] = Deferred() reactor.callLater(seconds, d.callback, None) return d + + +async def async_sleep(seconds: float) -> None: + if is_asyncio_available(): + await asyncio.sleep(seconds) + else: + await maybe_deferred_to_future(twisted_sleep(seconds)) + + +def get_script_run_env() -> dict[str, str]: + """Return a OS environment dict suitable to run scripts shipped with tests.""" + + tests_path = Path(__file__).parent.parent + pythonpath = str(tests_path) + os.pathsep + os.environ.get("PYTHONPATH", "") + env = os.environ.copy() + env["PYTHONPATH"] = pythonpath + return env + + +class OneShotLoop: + """Test stub for create_looping_call: run once immediately, no background task.""" + + def __init__(self, func: Callable[[], None]): + self.func = func + self.running = False + + def start(self, _interval: float, now: bool = True) -> None: + self.running = True + if now: + self.func() + + def stop(self) -> None: + self.running = False diff --git a/tests/utils/cmdline.py b/tests/utils/cmdline.py new file mode 100644 index 000000000..122e0236d --- /dev/null +++ b/tests/utils/cmdline.py @@ -0,0 +1,38 @@ +from __future__ import annotations + +import subprocess +import sys +from typing import Any + +import pytest + +from scrapy.utils.test import get_testenv + + +def call(*args: str, **popen_kwargs: Any) -> int: + args = (sys.executable, "-m", "scrapy.cmdline", *args) + return subprocess.call( + args, + stdout=subprocess.DEVNULL, + stderr=subprocess.DEVNULL, + env=get_testenv(), + **popen_kwargs, + ) + + +def proc(*args: str, **popen_kwargs: Any) -> tuple[int, str, str]: + args = (sys.executable, "-m", "scrapy.cmdline", *args) + try: + p = subprocess.run( + args, + check=False, + capture_output=True, + encoding="utf-8", + timeout=15, + env=get_testenv(), + **popen_kwargs, + ) + except subprocess.TimeoutExpired: + pytest.fail("Command took too much time to complete") + + return p.returncode, p.stdout, p.stderr diff --git a/tests/utils/decorators.py b/tests/utils/decorators.py new file mode 100644 index 000000000..0e8988a0a --- /dev/null +++ b/tests/utils/decorators.py @@ -0,0 +1,73 @@ +from __future__ import annotations + +from functools import wraps +from typing import TYPE_CHECKING, Any, ParamSpec + +import pytest +from twisted.internet.defer import Deferred, inlineCallbacks + +from scrapy.utils.defer import deferred_from_coro, deferred_to_future +from scrapy.utils.reactor import is_reactor_installed + +if TYPE_CHECKING: + from collections.abc import Awaitable, Callable, Generator + + +_P = ParamSpec("_P") + + +def inline_callbacks_test( + f: Callable[_P, Generator[Deferred[Any], Any, None]], +) -> Callable[_P, Awaitable[None]]: + """Mark a test function written in a :func:`twisted.internet.defer.inlineCallbacks` style. + + This calls :func:`twisted.internet.defer.inlineCallbacks` and then: + + * with ``pytest-twisted`` this returns the resulting Deferred + * with ``pytest-asyncio`` this converts the resulting Deferred into a + coroutine + """ + + if not is_reactor_installed(): + + @pytest.mark.asyncio + @wraps(f) + async def wrapper_coro(*args: _P.args, **kwargs: _P.kwargs) -> None: + await deferred_to_future(inlineCallbacks(f)(*args, **kwargs)) + + # Likely https://github.com/python/mypy/issues/17171 + return wrapper_coro # type: ignore[no-any-return] + + @wraps(f) + @inlineCallbacks + def wrapper_dfd( + *args: _P.args, **kwargs: _P.kwargs + ) -> Generator[Deferred[Any], Any, None]: + return f(*args, **kwargs) + + return wrapper_dfd + + +def coroutine_test( + coro_f: Callable[_P, Awaitable[None]], +) -> Callable[_P, Awaitable[None]]: + """Mark a test function that returns a coroutine. + + * with ``pytest-twisted`` this converts a coroutine into a + :class:`twisted.internet.defer.Deferred` + * with ``pytest-asyncio`` this is a no-op + + In addition to handling asynchronous test functions this can also be used + to mark "synchronous" test functions (they still need to be made + ``async def``) that call code that needs a reactor or a running event loop, + so that ``pytest-asyncio`` starts a loop for them too. + """ + + if not is_reactor_installed(): + return pytest.mark.asyncio(coro_f) + + @wraps(coro_f) + def f(*coro_args: _P.args, **coro_kwargs: _P.kwargs) -> Deferred[None]: + return deferred_from_coro(coro_f(*coro_args, **coro_kwargs)) + + return f diff --git a/tests_typing/test_http_request.mypy-testing b/tests_typing/test_http_request.mypy-testing index 3926c830f..a431091d5 100644 --- a/tests_typing/test_http_request.mypy-testing +++ b/tests_typing/test_http_request.mypy-testing @@ -15,8 +15,8 @@ class MyRequest2(Request): @pytest.mark.mypy_testing -def mypy_test_headers(): - Request("data:,", headers=1) # E: Argument "headers" to "Request" has incompatible type "int"; expected "Union[Mapping[str, Any], Iterable[tuple[str, Any]], None]" +def mypy_test_headers() -> None: + Request("data:,", headers=1) # E: Argument "headers" to "Request" has incompatible type "int"; expected "Mapping[str, Any] | Iterable[tuple[str, Any]] | None" Request("data:,", headers=None) Request("data:,", headers={}) Request("data:,", headers=[]) @@ -29,7 +29,7 @@ def mypy_test_headers(): @pytest.mark.mypy_testing -def mypy_test_copy(): +def mypy_test_copy() -> None: req = Request("data:,") reveal_type(req) # R: scrapy.http.request.Request req_copy = req.copy() @@ -37,7 +37,7 @@ def mypy_test_copy(): @pytest.mark.mypy_testing -def mypy_test_copy_subclass(): +def mypy_test_copy_subclass() -> None: req = MyRequest("data:,") reveal_type(req) # R: __main__.MyRequest req_copy = req.copy() @@ -45,7 +45,7 @@ def mypy_test_copy_subclass(): @pytest.mark.mypy_testing -def mypy_test_replace(): +def mypy_test_replace() -> None: req = Request("data:,") reveal_type(req) # R: scrapy.http.request.Request req_copy = req.replace(body=b"a") @@ -56,7 +56,7 @@ def mypy_test_replace(): @pytest.mark.mypy_testing -def mypy_test_replace_subclass(): +def mypy_test_replace_subclass() -> None: req = MyRequest("data:,") reveal_type(req) # R: __main__.MyRequest req_copy = req.replace(body=b"a") @@ -69,7 +69,7 @@ def mypy_test_replace_subclass(): @pytest.mark.mypy_testing -def mypy_test_jsonrequest_copy_replace(): +def mypy_test_jsonrequest_copy_replace() -> None: req = JsonRequest("data:,") reveal_type(req) # R: scrapy.http.request.json_request.JsonRequest req_copy = req.copy() diff --git a/tests_typing/test_http_response.mypy-testing b/tests_typing/test_http_response.mypy-testing index 88aedbd3e..d497c2470 100644 --- a/tests_typing/test_http_response.mypy-testing +++ b/tests_typing/test_http_response.mypy-testing @@ -6,8 +6,8 @@ from scrapy.http import HtmlResponse, Response, TextResponse @pytest.mark.mypy_testing -def mypy_test_headers(): - Response("data:,", headers=1) # E: Argument "headers" to "Response" has incompatible type "int"; expected "Union[Mapping[str, Any], Iterable[tuple[str, Any]], None]" +def mypy_test_headers() -> None: + Response("data:,", headers=1) # E: Argument "headers" to "Response" has incompatible type "int"; expected "Mapping[str, Any] | Iterable[tuple[str, Any]] | None" Response("data:,", headers=None) Response("data:,", headers={}) Response("data:,", headers=[]) @@ -20,7 +20,7 @@ def mypy_test_headers(): @pytest.mark.mypy_testing -def mypy_test_copy(): +def mypy_test_copy() -> None: resp = Response("data:,") reveal_type(resp) # R: scrapy.http.response.Response resp_copy = resp.copy() @@ -28,7 +28,7 @@ def mypy_test_copy(): @pytest.mark.mypy_testing -def mypy_test_copy_subclass(): +def mypy_test_copy_subclass() -> None: resp = HtmlResponse("data:,") reveal_type(resp) # R: scrapy.http.response.html.HtmlResponse resp_copy = resp.copy() @@ -36,7 +36,7 @@ def mypy_test_copy_subclass(): @pytest.mark.mypy_testing -def mypy_test_replace(): +def mypy_test_replace() -> None: resp = Response("data:,") reveal_type(resp) # R: scrapy.http.response.Response resp_copy = resp.replace(body=b"a") @@ -47,7 +47,7 @@ def mypy_test_replace(): @pytest.mark.mypy_testing -def mypy_test_replace_subclass(): +def mypy_test_replace_subclass() -> None: resp = HtmlResponse("data:,") reveal_type(resp) # R: scrapy.http.response.html.HtmlResponse resp_copy = resp.replace(body=b"a") diff --git a/tests_typing/test_spiders.mypy-testing b/tests_typing/test_spiders.mypy-testing index 162e31d0c..dfdd2ba4d 100644 --- a/tests_typing/test_spiders.mypy-testing +++ b/tests_typing/test_spiders.mypy-testing @@ -59,7 +59,7 @@ def test_spider_parse_override_no_kwargs() -> None: @pytest.mark.mypy_testing def test_spider_parse_override_specific_kwargs() -> None: spider = SpecificKwargsSpider() - reveal_type(spider.parse) # R: def (response: scrapy.http.response.Response, page: builtins.int) -> Any + reveal_type(spider.parse) # R: def (response: scrapy.http.response.Response, page: int) -> Any @pytest.mark.mypy_testing diff --git a/tox.ini b/tox.ini index 85935b011..2fa7b455d 100644 --- a/tox.ini +++ b/tox.ini @@ -4,32 +4,56 @@ # and then run "tox" from this directory. [tox] -envlist = pre-commit,pylint,typing,py +requires = + sphinx-scrapy[tox] @ git+https://github.com/scrapy/sphinx-scrapy.git@0.8.8 +envlist = + pre-commit + pylint + mypy + mypy-tests + twinecheck + docs + docs-tests + docs-links + docs-coverage + min + min-extra-deps + min-default-reactor + min-no-reactor + min-botocore + min-pypy3 + py{310,311,312,313,314} + extra-deps + default-reactor + no-reactor + no-reactor-extra-deps + botocore + mitmproxy + pypy3 + pypy3-extra-deps minversion = 1.7.0 [test-requirements] deps = attrs - coverage >= 7.4.0 + coverage >= 7.10.6 + httpx pexpect >= 4.8.0 pyftpdlib >= 2.0.1 pygments pytest - pytest-cov >= 4.0.0 + pytest-cov >= 7.0.0 pytest-xdist sybil >= 1.3.0 # https://github.com/cjw296/sybil/issues/20#issuecomment-605433422 testfixtures + pytest-twisted >= 1.14.3 [testenv] deps = {[test-requirements]deps} pytest >= 8.4.1 # https://github.com/pytest-dev/pytest/pull/13502 - - # mitmproxy does not support PyPy - mitmproxy; implementation_name != "pypy" -setenv = - COVERAGE_CORE=sysmon passenv = + PYTEST_ADDOPTS S3_TEST_FILE_URI AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY @@ -39,33 +63,44 @@ passenv = #allow tox virtualenv to upgrade pip/wheel/setuptools download = true commands = - pytest {posargs:--cov-config=pyproject.toml --cov=scrapy --cov-report= --cov-report=term-missing --cov-report=xml --junitxml=testenv.junit.xml -o junit_family=legacy --durations=10 docs scrapy tests --doctest-modules} -install_command = - python -I -m pip install -ctests/upper-constraints.txt {opts} {packages} + pytest {posargs:--cov-config=pyproject.toml --cov=scrapy --cov-report= --cov-report=term-missing --cov-report=xml --junitxml=testenv.junit.xml -o junit_family=legacy --durations=10 scrapy tests --doctest-modules} -[testenv:typing] -basepython = python3.9 +[testenv:mypy] +basepython = python3.10 deps = - mypy==1.14.0 - typing-extensions==4.12.2 - types-lxml==2024.12.13 - types-Pygments==2.18.0.20240506 - botocore-stubs==1.35.90 - boto3-stubs[s3]==1.35.90 - attrs >= 18.2.0 - Pillow >= 10.3.0 - pyOpenSSL >= 24.2.1 - pytest >= 8.2.0 - w3lib >= 2.2.0 + mypy==2.1.0 + typing-extensions==4.15.0 + Pillow==12.2.0 + Protego==0.6.0 + Twisted==26.4.0 + attrs==26.1.0 + boto3-stubs[s3]==1.43.9 + botocore-stubs==1.42.41 + h2==4.3.0 + httpx==0.28.1 + itemadapter==0.13.1 + ptpython==3.0.32 + # newer ones require newer Python + ipython==8.39.0 + pyOpenSSL==26.3.0 + pytest==9.0.3 + socksio==1.0.0 + types-Pygments==2.20.0.20260508 + types-defusedxml==0.7.0.20260504 + types-lxml==2026.2.16 + types-pexpect==4.9.0.20260508 + uvloop==0.22.1 + w3lib==2.4.1 + zstandard==0.25.0 commands = mypy {posargs:scrapy tests} -[testenv:typing-tests] -basepython = python3.9 +[testenv:mypy-tests] +basepython = python3.10 deps = {[test-requirements]deps} - {[testenv:typing]deps} - pytest-mypy-testing==0.1.3 + {[testenv:mypy]deps} + pytest-mypy-testing==0.2.0 commands = pytest {posargs:tests_typing} @@ -80,21 +115,22 @@ commands = basepython = python3 deps = {[testenv:extra-deps]deps} - pylint==3.3.3 + pylint==4.0.2 + pylint-per-file-ignores # https://github.com/pylint-dev/pylint/issues/3767#issuecomment-1319916278 commands = - pylint conftest.py docs extras scrapy tests + pylint {posargs:conftest.py docs extras scrapy tests} [testenv:twinecheck] basepython = python3 deps = - twine==6.0.1 - build==1.2.2.post1 + twine==6.2.0 + build==1.3.0 commands = python -m build --sdist twine check dist/* -[pinned] -basepython = python3.9 +[min] +basepython = python3.10 deps = # pytest 8.4.1 adds support for Twisted 25.5.0 but drops support for Twisted < 24.10.0 pytest==8.4.0 @@ -102,35 +138,29 @@ deps = Twisted==21.7.0 cryptography==37.0.0 cssselect==0.9.1 + httpx==0.27.1 itemadapter==0.1.0 - lxml==4.6.0 + lxml==4.6.4 parsel==1.5.0 pyOpenSSL==22.0.0 queuelib==1.4.2 - service_identity==18.1.0 + service_identity==23.1.0 w3lib==1.17.0 zope.interface==5.1.0 {[test-requirements]deps} - - # mitmproxy 8.0.0 requires upgrading some of the pinned dependencies - # above, hence we do not install it in pinned environments at the moment setenv = - _SCRAPY_PINNED=true -install_command = - python -I -m pip install {opts} {packages} + _SCRAPY_MIN=true commands = - ; tests for docs fail with parsel < 1.8.0 - pytest {posargs:--cov-config=pyproject.toml --cov=scrapy --cov-report=xml --cov-report= --junitxml=pinned.junit.xml -o junit_family=legacy --durations=10 scrapy tests} + pytest {posargs:--cov-config=pyproject.toml --cov=scrapy --cov-report=xml --cov-report= --junitxml=min.junit.xml -o junit_family=legacy --durations=10 scrapy tests} -[testenv:pinned] -basepython = {[pinned]basepython} +[testenv:min] +basepython = {[min]basepython} deps = - {[pinned]deps} + {[min]deps} PyDispatcher==2.0.5 -install_command = {[pinned]install_command} setenv = - {[pinned]setenv} -commands = {[pinned]commands} + {[min]setenv} +commands = {[min]commands} [testenv:extra-deps] basepython = python3 @@ -140,51 +170,74 @@ deps = Twisted[http2] boto3 bpython # optional for shell wrapper tests - brotli; implementation_name != "pypy" # optional for HTTP compress downloader middleware tests - brotlicffi; implementation_name == "pypy" # optional for HTTP compress downloader middleware tests + brotli >= 1.2.0; implementation_name != "pypy" # optional for HTTP compress downloader middleware tests + brotlicffi >= 1.2.0.0; implementation_name == "pypy" # optional for HTTP compress downloader middleware tests google-cloud-storage + httpx[http2,socks] ipython robotexclusionrulesparser uvloop; platform_system != "Windows" and implementation_name != "pypy" zstandard; implementation_name != "pypy" # optional for HTTP compress downloader middleware tests -[testenv:extra-deps-pinned] -basepython = {[pinned]basepython} +[testenv:min-extra-deps] +basepython = {[min]basepython} deps = - {[pinned]deps} - Pillow==8.0.0 + {[min]deps} + Pillow==8.3.2 + Twisted[http2]==21.7.0 boto3==1.20.0 bpython==0.7.1 - brotli==0.5.2; implementation_name != "pypy" - brotlicffi==0.8.0; implementation_name == "pypy" - brotlipy + brotli==1.2.0; implementation_name != "pypy" + brotlicffi==1.2.0.0; implementation_name == "pypy" google-cloud-storage==1.29.0 - ipython==2.0.0 + httpx==0.27.1 + ipython==7.1.0 robotexclusionrulesparser==1.6.2 - uvloop==0.14.0; platform_system != "Windows" and implementation_name != "pypy" - zstandard==0.1; implementation_name != "pypy" -install_command = {[pinned]install_command} + uvloop==0.16.0; platform_system != "Windows" and implementation_name != "pypy" + zstandard==0.16.0; implementation_name != "pypy" setenv = - {[pinned]setenv} -commands = {[pinned]commands} + {[min]setenv} +commands = {[min]commands} [testenv:default-reactor] commands = {[testenv]commands} --reactor=default -[testenv:default-reactor-pinned] -basepython = {[pinned]basepython} -deps = {[testenv:pinned]deps} -commands = {[pinned]commands} --reactor=default -install_command = {[pinned]install_command} +[testenv:min-default-reactor] +basepython = {[min]basepython} +deps = {[testenv:min]deps} +commands = {[min]commands} --reactor=default setenv = - {[pinned]setenv} + {[min]setenv} + +[testenv:no-reactor] +deps = + {[testenv]deps} + pytest-asyncio +commands = + {[testenv]commands} -p no:twisted --reactor=none + +[testenv:no-reactor-extra-deps] +deps = + {[testenv:extra-deps]deps} + pytest-asyncio +commands = + {[testenv]commands} -p no:twisted --reactor=none + +[testenv:min-no-reactor] +basepython = {[min]basepython} +deps = + {[testenv:min]deps} + pytest-asyncio +commands = {[min]commands} -p no:twisted --reactor=none +setenv = + {[min]setenv} [testenv:pypy3] basepython = pypy3 commands = ; not enabling coverage as it significantly increases the run time - pytest {posargs:--durations=10 docs scrapy tests} + pytest {posargs:--durations=10 scrapy tests} [testenv:pypy3-extra-deps] basepython = pypy3 @@ -192,60 +245,55 @@ deps = {[testenv:extra-deps]deps} commands = {[testenv:pypy3]commands} -[testenv:pypy3-pinned] -basepython = pypy3.10 +[testenv:min-pypy3] +basepython = pypy3.11 deps = PyPyDispatcher==2.1.0 {[test-requirements]deps} pytest==8.4.0 Protego==0.1.15 Twisted==21.7.0 - cryptography==41.0.5 + cryptography==44.0.2 cssselect==0.9.1 itemadapter==0.1.0 - lxml==4.6.0 + lxml==5.3.2 parsel==1.5.0 - pyOpenSSL==23.3.0 + pyOpenSSL==24.3.0 queuelib==1.4.2 - service_identity==18.1.0 - w3lib==1.17.0 + service_identity==23.1.0 + # w3lib 1.17 fails to import on PyPy 3.11 because its encoding regex uses + # an inline flag placement that Python 3.11 treats as an error: global + # flags not at the start of the expression. w3lib 1.18 stopped encoding [] + # in URLs until 2.1.0 brought that behavior back. Tests for verbatim_url + # rely on that encoding. + w3lib==2.1.0 zope.interface==5.1.0 commands = - ; disabling both coverage and docs tests + ; disabling coverage pytest {posargs:--durations=10 scrapy tests} -install_command = {[pinned]install_command} setenv = - {[pinned]setenv} + {[min]setenv} -[docs] +[testenv:docs-tests] +changedir = docs +deps = + {[test-requirements]deps} + -rdocs/requirements.txt + form2request +commands = + pytest + +[testenv:docs-coverage] changedir = docs deps = -rdocs/requirements.txt -setenv = - READTHEDOCS_PROJECT=scrapy - READTHEDOCS_VERSION=master - -[testenv:docs] -basepython = python3 -changedir = {[docs]changedir} -deps = {[docs]deps} -setenv = {[docs]setenv} -commands = - sphinx-build -W -b html . {envtmpdir}/html - -[testenv:docs-coverage] -basepython = python3 -changedir = {[docs]changedir} -deps = {[docs]deps} -setenv = {[docs]setenv} commands = sphinx-build -b coverage . {envtmpdir}/coverage [testenv:docs-links] -basepython = python3 -changedir = {[docs]changedir} -deps = {[docs]deps} -setenv = {[docs]setenv} +changedir = docs +deps = + -rdocs/requirements.txt commands = sphinx-build -W -b linkcheck . {envtmpdir}/linkcheck @@ -255,17 +303,32 @@ commands = [testenv:botocore] deps = {[testenv]deps} - botocore>=1.4.87 + botocore>=1.13.45 commands = - pytest {posargs:--cov-config=pyproject.toml --cov=scrapy --cov-report=xml --cov-report= tests --junitxml=botocore.junit.xml -o junit_family=legacy -m requires_botocore} + pytest {posargs:--cov-config=pyproject.toml --cov=scrapy --cov-report=xml --cov-report= tests --junitxml=botocore.junit.xml -o junit_family=legacy} -m requires_botocore -[testenv:botocore-pinned] -basepython = {[pinned]basepython} +[testenv:min-botocore] +basepython = {[min]basepython} deps = - {[pinned]deps} - botocore==1.4.87 -install_command = {[pinned]install_command} + {[min]deps} + botocore==1.13.45 + # botocore 1.13.45 requires urllib3>=1.20,<1.26; requests 2.33.0 requires urllib3>=1.26,<3 + requests<2.33.0 setenv = - {[pinned]setenv} + {[min]setenv} commands = - pytest {posargs:--cov-config=pyproject.toml --cov=scrapy --cov-report=xml --cov-report= tests --junitxml=botocore-pinned.junit.xml -o junit_family=legacy -m requires_botocore} + pytest {posargs:--cov-config=pyproject.toml --cov=scrapy --cov-report=xml --cov-report= tests --junitxml=min-botocore.junit.xml -o junit_family=legacy} -m requires_botocore + + +# Run proxy tests that use mitmproxy in a separate env to avoid installing +# numerous mitmproxy deps in other envs (even in extra-deps), as they can +# conflict with other deps we want, or don't want, to have installed there. + +[testenv:mitmproxy] +deps = + {[testenv]deps} + # mitmproxy does not support PyPy + mitmproxy; implementation_name != "pypy" + httpx[http2,socks] +commands = + pytest {posargs:--cov-config=pyproject.toml --cov=scrapy --cov-report=xml --cov-report= tests --junitxml=mitmproxy.junit.xml -o junit_family=legacy} -m requires_mitmproxy