searx.search.SearchWithPlugins Class Reference

Inheritance diagram for searx.search.SearchWithPlugins:

Collaboration diagram for searx.search.SearchWithPlugins:

Public Member Functions
	__init__ (self, "SearchQuery" search_query, "SXNG_Request" request, list[str] user_plugins)
ResultContainer	search (self)
Public Member Functions inherited from searx.search.Search
	__init__ (self, "SearchQuery" search_query)
bool	search_external_bang (self)
	search_answerers (self)
	search_multiple_requests (self, list[tuple[str, str, dict[str, t.Any]]] requests)
	search_standard (self)

Public Attributes
	user_plugins = user_plugins
	request = request._get_current_object()
Public Attributes inherited from searx.search.Search
	search_query = search_query
ResultContainer	result_container = ResultContainer()
float|None	start_time = None
float|None	actual_timeout = None

Protected Member Functions
	_on_result (self, result)
Protected Member Functions inherited from searx.search.Search
tuple[list[tuple[str, str, dict[str, t.Any]]], int]	_get_requests (self)

Static Private Attributes
str	__slots__ = 'user_plugins', 'request'

Detailed Description

Inherit from the Search class, add calls to the plugins.

Definition at line 185 of file __init__.py.

Constructor & Destructor Documentation

__init__()

searx.search.SearchWithPlugins.__init__	(		self,
		"SearchQuery"	search_query,
		"SXNG_Request"	request,
		list[str]	user_plugins )

Definition at line 190 of file __init__.py.

    def __init__(self, search_query: "SearchQuery", request: "SXNG_Request", user_plugins: list[str]):
        super().__init__(search_query)
        self.user_plugins = user_plugins
        self.result_container.on_result = self._on_result
        # pylint: disable=line-too-long
        # get the "real" request to use it outside the Flask context.
        # see
        # * https://github.com/pallets/flask/blob/d01d26e5210e3ee4cbbdef12f05c886e08e92852/src/flask/globals.py#L55
        # * https://github.com/pallets/werkzeug/blob/3c5d3c9bd0d9ce64590f0af8997a38f3823b368d/src/werkzeug/local.py#L548-L559
        # * https://werkzeug.palletsprojects.com/en/2.0.x/local/#werkzeug.local.LocalProxy._get_current_object
        # pylint: enable=line-too-long
        self.request = request._get_current_object()
 

Member Function Documentation

_on_result()

searx.search.SearchWithPlugins._on_result ( self, result )

protected

Definition at line 203 of file __init__.py.

    def _on_result(self, result):
        return searx.plugins.STORAGE.on_result(self.request, self, result)
 

search()

ResultContainer searx.search.SearchWithPlugins.search

(

self

)

Reimplemented from searx.search.Search.

Definition at line 206 of file __init__.py.

    def search(self) -> ResultContainer:
 
        if searx.plugins.STORAGE.pre_search(self.request, self):
            super().search()
 
        searx.plugins.STORAGE.post_search(self.request, self)
        self.result_container.close()
 
        return self.result_container

Member Data Documentation

__slots__

str searx.search.SearchWithPlugins.__slots__ = 'user_plugins', 'request'

staticprivate

Definition at line 188 of file __init__.py.

request

searx.search.SearchWithPlugins.request = request._get_current_object()

Definition at line 201 of file __init__.py.

user_plugins

searx.search.SearchWithPlugins.user_plugins = user_plugins

Definition at line 192 of file __init__.py.

---

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

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