.oO SearXNG Developer Documentation Oo.
Loading...
Searching...
No Matches
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

int suspended_time = suspended_time
str message = message

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.

66 def __init__(self, suspended_time: int | None = None, message: str = 'Access denied'):
67 """Generic exception to raise when an engine denies access to the results.
68
69 :param suspended_time: How long the engine is going to be suspended in
70 second. Defaults to None.
71 :type suspended_time: int, None
72 :param message: Internal message. Defaults to ``Access denied``
73 :type message: str
74 """
75 if suspended_time is None:
76 suspended_time = self._get_default_suspended_time()
77 super().__init__(message + ', suspended_time=' + str(suspended_time))
78 self.suspended_time: int = suspended_time
79 self.message: str = message
80

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.

81 def _get_default_suspended_time(self) -> int:
82 from searx import get_setting # pylint: disable=C0415
83
84 return get_setting(self.SUSPEND_TIME_SETTING)
85
86

Member Data Documentation

◆ message

str searx.exceptions.SearxEngineAccessDeniedException.message = message

Definition at line 79 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: