kamp/searxng
1
0
Fork 0
mirror of https://github.com/searxng/searxng.git synced 2024-11-22 12:10:11 +01:00
Code

[doc] Add doc-strings to searx.exceptions

Browse Source 
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2023-01-29 18:51:13 +01:00
parent 37addec69e
commit feccee01c0
2 changed files with 30 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/src/searx.exceptions.rst Normal file
View File

@ -0,0 +1,8 @@
.. _searx.exceptions:
==================
SearXNG Exceptions
==================
.. automodule:: searx.exceptions
:members:

50
searx/exceptions.py
View File

@ -1,29 +1,19 @@
''' # -*- coding: utf-8 -*-
searx is free software: you can redistribute it and/or modify # SPDX-License-Identifier: AGPL-3.0-or-later
it under the terms of the GNU Affero General Public License as published by # lint: pylint
the Free Software Foundation, either version 3 of the License, or """Exception types raised by SearXNG modules.
(at your option) any later version. """
searx is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with searx. If not, see < http://www.gnu.org/licenses/ >.
(C) 2017- by Alexandre Flament, <alex@al-f.net>
'''
from typing import Optional, Union from typing import Optional, Union
class SearxException(Exception): class SearxException(Exception):
pass """Base SearXNG exception."""
class SearxParameterException(SearxException): class SearxParameterException(SearxException):
"""Raised when query miss a required paramater"""
def __init__(self, name, value): def __init__(self, name, value):
if value == '' or value is None: if value == '' or value is None:
message = 'Empty ' + name + ' parameter' message = 'Empty ' + name + ' parameter'
@ -70,14 +60,17 @@ class SearxEngineAccessDeniedException(SearxEngineResponseException):
"""The website is blocking the access""" """The website is blocking the access"""
SUSPEND_TIME_SETTING = "search.suspended_times.SearxEngineAccessDenied" SUSPEND_TIME_SETTING = "search.suspended_times.SearxEngineAccessDenied"
"""This settings contains the default suspended time""" """This settings contains the default suspended time (default 86400 sec / 1
day)."""
def __init__(self, suspended_time: int = None, message: str = 'Access denied'): def __init__(self, suspended_time: int = None, message: str = 'Access denied'):
"""Generic exception to raise when an engine denies access to the results """Generic exception to raise when an engine denies access to the results.
Args: :param suspended_time: How long the engine is going to be suspended in
suspended_time (int, optional): How long the engine is going to be suspended in second. Defaults to None. second. Defaults to None.
message (str, optional): Internal message. Defaults to 'Access denied'. :type suspended_time: int, None
:param message: Internal message. Defaults to ``Access denied``
:type message: str
""" """
suspended_time = suspended_time or self._get_default_suspended_time() suspended_time = suspended_time or self._get_default_suspended_time()
super().__init__(message + ', suspended_time=' + str(suspended_time)) super().__init__(message + ', suspended_time=' + str(suspended_time))
@ -85,18 +78,17 @@ class SearxEngineAccessDeniedException(SearxEngineResponseException):
self.message = message self.message = message
def _get_default_suspended_time(self): def _get_default_suspended_time(self):
from searx import get_setting from searx import get_setting # pylint: disable=C0415
return get_setting(self.SUSPEND_TIME_SETTING) return get_setting(self.SUSPEND_TIME_SETTING)
class SearxEngineCaptchaException(SearxEngineAccessDeniedException): class SearxEngineCaptchaException(SearxEngineAccessDeniedException):
"""The website has returned a CAPTCHA """The website has returned a CAPTCHA."""
By default, searx stops sending requests to this engine for 1 day.
"""
SUSPEND_TIME_SETTING = "search.suspended_times.SearxEngineCaptcha" SUSPEND_TIME_SETTING = "search.suspended_times.SearxEngineCaptcha"
"""This settings contains the default suspended time (default 86400 sec / 1
day)."""
def __init__(self, suspended_time=None, message='CAPTCHA'): def __init__(self, suspended_time=None, message='CAPTCHA'):
super().__init__(message=message, suspended_time=suspended_time) super().__init__(message=message, suspended_time=suspended_time)
@ -109,6 +101,8 @@ class SearxEngineTooManyRequestsException(SearxEngineAccessDeniedException):
""" """
SUSPEND_TIME_SETTING = "search.suspended_times.SearxEngineTooManyRequests" SUSPEND_TIME_SETTING = "search.suspended_times.SearxEngineTooManyRequests"
"""This settings contains the default suspended time (default 3660 sec / 1
hour)."""
def __init__(self, suspended_time=None, message='Too many request'): def __init__(self, suspended_time=None, message='Too many request'):
super().__init__(message=message, suspended_time=suspended_time) super().__init__(message=message, suspended_time=suspended_time)