Inheritance diagram for searx.search.SearchWithPlugins:

Collaboration diagram for searx.search.SearchWithPlugins:

Public Member Functions
	__init__ (self, SearchQuery search_query, ordered_plugin_list, flask.Request request)

ResultContainer	search (self)

Public Member Functions inherited from searx.search.Search
	search_external_bang (self)

	search_answerers (self)

	search_multiple_requests (self, requests)

	search_standard (self)

Public Attributes
	ordered_plugin_list = ordered_plugin_list

	request = request._get_current_object()

Public Attributes inherited from searx.search.Search
	search_query = search_query

	result_container = ResultContainer()

	start_time = None

	actual_timeout = None

Protected Member Functions
	_on_result (self, result)

Protected Member Functions inherited from searx.search.Search
	_get_requests (self)

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

Detailed Description

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

Definition at line 184 of file __init__.py.

Constructor & Destructor Documentation

◆ init()

searx.search.SearchWithPlugins.__init__	(		self,
		SearchQuery	search_query,
			ordered_plugin_list,
		flask.Request	request )

Initialize the Search

Reimplemented from searx.search.Search.

Definition at line 189 of file __init__.py.

    def __init__(self, search_query: SearchQuery, ordered_plugin_list, request: flask.Request):
        super().__init__(search_query)
        self.ordered_plugin_list = ordered_plugin_list
        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 202 of file __init__.py.

    def _on_result(self, result):
        return plugins.call(self.ordered_plugin_list, 'on_result', self.request, self, result)
 

◆ search()

ResultContainer searx.search.SearchWithPlugins.search ( self )

Reimplemented from searx.search.Search.

Definition at line 205 of file __init__.py.

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

Member Data Documentation

◆ slots

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

staticprivate

Definition at line 187 of file __init__.py.

◆ ordered_plugin_list

searx.search.SearchWithPlugins.ordered_plugin_list = ordered_plugin_list

Definition at line 191 of file __init__.py.

◆ request

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

Definition at line 200 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

Public Member Functions

Public Attributes

Protected Member Functions

Static Private Attributes