Source code for scrapy.exceptions

"""
Scrapy core exceptions

These exceptions are documented in docs/topics/exceptions.rst. Please don't add
new exceptions here without documenting them there.
"""

from __future__ import annotations

from typing import TYPE_CHECKING, Any

if TYPE_CHECKING:
    from scrapy.http import Response

# Internal




class NotConfigured(Exception):
    """Indicates a missing configuration situation"""



class _InvalidOutput(TypeError):
    """
    Indicates an invalid value has been returned by a middleware's processing method.
    Internal and undocumented, it should not be raised or caught by user code.
    """


# HTTP and crawling




class IgnoreRequest(Exception):
    """Indicates a decision was made not to process a request"""





class DontCloseSpider(Exception):
    """Request the spider not to be closed yet"""





class CloseSpider(Exception):
    """Raise this from callbacks to request the spider to be closed"""

    def __init__(self, reason: str = "cancelled"):
        super().__init__()
        self.reason = reason





class StopDownload(Exception):
    """
    Stop the download of the body for a given response.
    The 'fail' boolean parameter indicates whether or not the resulting partial response
    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




class DropItem(Exception):
    """Drop item from the item pipeline"""

    def __init__(self, message: str, log_level: str | None = None):
        super().__init__(message)
        self.log_level = log_level





class NotSupported(Exception):
    """Indicates a feature or method is not supported"""



# Commands


class UsageError(Exception):
    """To indicate a command-line usage error"""

    def __init__(self, *a: Any, **kw: Any):
        self.print_help = kw.pop("print_help", True)
        super().__init__(*a, **kw)


class ScrapyDeprecationWarning(Warning):
    """Warning category for deprecated features, since the default
    DeprecationWarning is silenced on Python 2.7+
    """




class ContractFail(AssertionError):
    """Error raised in case of a failing contract"""