searx.search.processors.abstract.SuspendedStatus Class Reference

Public Member Functions
	__init__ (self)
	is_suspended (self)
	suspend (self, int|None suspended_time, str suspend_reason)
	resume (self)

Public Attributes
threading.Lock	lock = threading.Lock()
int	continuous_errors = 0
float	suspend_end_time = 0
str	suspend_reason = ""

Detailed Description

Class to handle suspend state.

Definition at line 77 of file abstract.py.

Constructor & Destructor Documentation

__init__()

searx.search.processors.abstract.SuspendedStatus.__init__

(

self

)

Definition at line 80 of file abstract.py.

    def __init__(self):
        self.lock: threading.Lock = threading.Lock()
        self.continuous_errors: int = 0
        self.suspend_end_time: float = 0
        self.suspend_reason: str = ""
 

Member Function Documentation

is_suspended()

searx.search.processors.abstract.SuspendedStatus.is_suspended

(

self

)

Definition at line 87 of file abstract.py.

    def is_suspended(self):
        return self.suspend_end_time >= default_timer()
 

References suspend_end_time.

resume()

searx.search.processors.abstract.SuspendedStatus.resume

(

self

)

Definition at line 103 of file abstract.py.

    def resume(self):
        with self.lock:
            # reset the suspend variables
            self.continuous_errors = 0
            self.suspend_end_time = 0
            self.suspend_reason = ""
 
 

References continuous_errors, searx.metrics.models.CounterStorage.lock, lock, suspend_end_time, and suspend_reason.

suspend()

searx.search.processors.abstract.SuspendedStatus.suspend	(		self,
		int | None	suspended_time,
		str	suspend_reason )

Definition at line 90 of file abstract.py.

    def suspend(self, suspended_time: int | None, suspend_reason: str):
        with self.lock:
            # update continuous_errors / suspend_end_time
            self.continuous_errors += 1
            if suspended_time is None:
                max_ban: int = get_setting("search.max_ban_time_on_fail")
                ban_fail: int = get_setting("search.ban_time_on_fail")
                suspended_time = min(max_ban, ban_fail)
 
            self.suspend_end_time = default_timer() + suspended_time
            self.suspend_reason = suspend_reason
            logger.debug("Suspend for %i seconds", suspended_time)
 

References continuous_errors, searx.get_setting(), searx.metrics.models.CounterStorage.lock, lock, suspend_end_time, and suspend_reason.

Here is the call graph for this function:

Member Data Documentation

continuous_errors

int searx.search.processors.abstract.SuspendedStatus.continuous_errors = 0

Definition at line 82 of file abstract.py.

Referenced by resume(), and suspend().

lock

threading.Lock searx.search.processors.abstract.SuspendedStatus.lock = threading.Lock()

Definition at line 81 of file abstract.py.

Referenced by resume(), and suspend().

suspend_end_time

float searx.search.processors.abstract.SuspendedStatus.suspend_end_time = 0

Definition at line 83 of file abstract.py.

Referenced by is_suspended(), resume(), and suspend().

suspend_reason

str searx.search.processors.abstract.SuspendedStatus.suspend_reason = ""

Definition at line 84 of file abstract.py.

Referenced by resume(), and suspend().

---

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

• /home/andrew/Documents/code/public/searxng/searx/search/processors/abstract.py