.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 suspended_time=None, str message='Access denied')
 

Public Attributes

 suspended_time
 
 message
 
 SUSPEND_TIME_SETTING
 

Static Public Attributes

str SUSPEND_TIME_SETTING = "search.suspended_times.SearxEngineAccessDenied"
 

Protected Member Functions

 _get_default_suspended_time (self)
 

Detailed Description

The website is blocking the access

Definition at line 57 of file exceptions.py.

Constructor & Destructor Documentation

◆ __init__()

searx.exceptions.SearxEngineAccessDeniedException.__init__ ( self,
int 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

Reimplemented in searx.exceptions.SearxEngineCaptchaException, and searx.exceptions.SearxEngineTooManyRequestsException.

Definition at line 64 of file exceptions.py.

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

Member Function Documentation

◆ _get_default_suspended_time()

searx.exceptions.SearxEngineAccessDeniedException._get_default_suspended_time ( self)
protected

Definition at line 78 of file exceptions.py.

78 def _get_default_suspended_time(self):
79 from searx import get_setting # pylint: disable=C0415
80
81 return get_setting(self.SUSPEND_TIME_SETTING)
82
83

Member Data Documentation

◆ message

searx.exceptions.SearxEngineAccessDeniedException.message

Definition at line 76 of file exceptions.py.

◆ SUSPEND_TIME_SETTING [1/2]

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

Definition at line 60 of file exceptions.py.

◆ SUSPEND_TIME_SETTING [2/2]

searx.exceptions.SearxEngineAccessDeniedException.SUSPEND_TIME_SETTING

Definition at line 81 of file exceptions.py.

◆ suspended_time

searx.exceptions.SearxEngineAccessDeniedException.suspended_time

Definition at line 75 of file exceptions.py.


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