searx.exceptions.SearxEngineAccessDeniedException Class Reference

Inheritance diagram for searx.exceptions.SearxEngineAccessDeniedException:

Collaboration diagram for searx.exceptions.SearxEngineAccessDeniedException:

Public Member Functions
	__init__ (self, int|None suspended_time=None, str message='Access denied')

Public Attributes
str	message = f"{message} (suspended_time={suspended_time})"
int	suspended_time = suspended_time

Static Public Attributes
str	SUSPEND_TIME_SETTING = "search.suspended_times.SearxEngineAccessDenied"

Protected Member Functions
int	_get_default_suspended_time (self)

Detailed Description

The website is blocking the access

Definition at line 59 of file exceptions.py.

Constructor & Destructor Documentation

__init__()

searx.exceptions.SearxEngineAccessDeniedException.__init__	(		self,
		int | None	suspended_time = None,
		str	message = 'Access denied' )

Generic exception to raise when an engine denies access to the results.

:param suspended_time: How long the engine is going to be suspended in
    second. Defaults to None.
:type suspended_time: int, None
:param message: Internal message.  Defaults to ``Access denied``
:type message: str

Definition at line 66 of file exceptions.py.

    def __init__(self, suspended_time: int | None = None, message: str = 'Access denied'):
        """Generic exception to raise when an engine denies access to the results.
 
        :param suspended_time: How long the engine is going to be suspended in
            second. Defaults to None.
        :type suspended_time: int, None
        :param message: Internal message.  Defaults to ``Access denied``
        :type message: str
        """
        if suspended_time is None:
            suspended_time = self._get_default_suspended_time()
        self.message: str = f"{message} (suspended_time={suspended_time})"
        self.suspended_time: int = suspended_time
        super().__init__(self.message)
 

Member Function Documentation

_get_default_suspended_time()

int searx.exceptions.SearxEngineAccessDeniedException._get_default_suspended_time ( self )

protected

Definition at line 81 of file exceptions.py.

    def _get_default_suspended_time(self) -> int:
        from searx import get_setting  # pylint: disable=C0415
 
        return get_setting(self.SUSPEND_TIME_SETTING)
 
 

Member Data Documentation

message

searx.exceptions.SearxEngineAccessDeniedException.message = f"{message} (suspended_time={suspended_time})"

Definition at line 77 of file exceptions.py.

SUSPEND_TIME_SETTING

searx.exceptions.SearxEngineAccessDeniedException.SUSPEND_TIME_SETTING = "search.suspended_times.SearxEngineAccessDenied"

static

Definition at line 62 of file exceptions.py.

suspended_time

int searx.exceptions.SearxEngineAccessDeniedException.suspended_time = suspended_time

Definition at line 78 of file exceptions.py.

---

The documentation for this class was generated from the following file:

• /home/andrew/Documents/code/public/searxng/searx/exceptions.py