.oO SearXNG Developer Documentation Oo.
Loading...
Searching...
No Matches
searx.search.Search Class Reference
+ Inheritance diagram for searx.search.Search:

Public Member Functions

 __init__ (self, SearchQuery search_query)
 
 search_external_bang (self)
 
 search_answerers (self)
 
 search_multiple_requests (self, requests)
 
 search_standard (self)
 
ResultContainer search (self)
 

Public Attributes

 search_query
 
 result_container
 
 start_time
 
 actual_timeout
 

Protected Member Functions

 _get_requests (self)
 

Static Private Attributes

str __slots__ = "search_query", "result_container", "start_time", "actual_timeout"
 

Detailed Description

Search information container

Definition at line 42 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

searx.search.Search.__init__ ( self,
SearchQuery search_query )
Initialize the Search

Reimplemented in searx.search.SearchWithPlugins.

Definition at line 47 of file __init__.py.

47 def __init__(self, search_query: SearchQuery):
48 """Initialize the Search"""
49 # init vars
50 super().__init__()
51 self.search_query = search_query
52 self.result_container = ResultContainer()
53 self.start_time = None
54 self.actual_timeout = None
55

Member Function Documentation

◆ _get_requests()

searx.search.Search._get_requests ( self)
protected

Definition at line 84 of file __init__.py.

84 def _get_requests(self):
85 # init vars
86 requests = []
87
88 # max of all selected engine timeout
89 default_timeout = 0
90
91 # start search-request for all selected engines
92 for engineref in self.search_query.engineref_list:
93 processor = PROCESSORS[engineref.name]
94
95 # stop the request now if the engine is suspend
96 if processor.extend_container_if_suspended(self.result_container):
97 continue
98
99 # set default request parameters
100 request_params = processor.get_params(self.search_query, engineref.category)
101 if request_params is None:
102 continue
103
104 counter_inc('engine', engineref.name, 'search', 'count', 'sent')
105
106 # append request to list
107 requests.append((engineref.name, self.search_query.query, request_params))
108
109 # update default_timeout
110 default_timeout = max(default_timeout, processor.engine.timeout)
111
112 # adjust timeout
113 max_request_timeout = settings['outgoing']['max_request_timeout']
114 actual_timeout = default_timeout
115 query_timeout = self.search_query.timeout_limit
116
117 if max_request_timeout is None and query_timeout is None:
118 # No max, no user query: default_timeout
119 pass
120 elif max_request_timeout is None and query_timeout is not None:
121 # No max, but user query: From user query except if above default
122 actual_timeout = min(default_timeout, query_timeout)
123 elif max_request_timeout is not None and query_timeout is None:
124 # Max, no user query: Default except if above max
125 actual_timeout = min(default_timeout, max_request_timeout)
126 elif max_request_timeout is not None and query_timeout is not None:
127 # Max & user query: From user query except if above max
128 actual_timeout = min(query_timeout, max_request_timeout)
129
130 logger.debug(
131 "actual_timeout={0} (default_timeout={1}, ?timeout_limit={2}, max_request_timeout={3})".format(
132 actual_timeout, default_timeout, query_timeout, max_request_timeout
133 )
134 )
135
136 return requests, actual_timeout
137

◆ search()

ResultContainer searx.search.Search.search ( self)

Reimplemented in searx.search.SearchWithPlugins.

Definition at line 176 of file __init__.py.

176 def search(self) -> ResultContainer:
177 self.start_time = default_timer()
178 if not self.search_external_bang():
179 if not self.search_answerers():
180 self.search_standard()
181 return self.result_container
182
183

◆ search_answerers()

searx.search.Search.search_answerers ( self)
Check if an answer return a result.
If yes, update self.result_container and return True

Definition at line 70 of file __init__.py.

70 def search_answerers(self):
71 """
72 Check if an answer return a result.
73 If yes, update self.result_container and return True
74 """
75 answerers_results = ask(self.search_query)
76
77 if answerers_results:
78 for results in answerers_results:
79 self.result_container.extend('answer', results)
80 return True
81 return False
82

◆ search_external_bang()

searx.search.Search.search_external_bang ( self)
Check if there is a external bang.
If yes, update self.result_container and return True

Definition at line 56 of file __init__.py.

56 def search_external_bang(self):
57 """
58 Check if there is a external bang.
59 If yes, update self.result_container and return True
60 """
61 if self.search_query.external_bang:
62 self.result_container.redirect_url = get_bang_url(self.search_query)
63
64 # This means there was a valid bang and the
65 # rest of the search does not need to be continued
66 if isinstance(self.result_container.redirect_url, str):
67 return True
68 return False
69

◆ search_multiple_requests()

searx.search.Search.search_multiple_requests ( self,
requests )

Definition at line 138 of file __init__.py.

138 def search_multiple_requests(self, requests):
139 # pylint: disable=protected-access
140 search_id = str(uuid4())
141
142 for engine_name, query, request_params in requests:
143 _search = copy_current_request_context(PROCESSORS[engine_name].search)
144 th = threading.Thread( # pylint: disable=invalid-name
145 target=_search,
146 args=(query, request_params, self.result_container, self.start_time, self.actual_timeout),
147 name=search_id,
148 )
149 th._timeout = False
150 th._engine_name = engine_name
151 th.start()
152
153 for th in threading.enumerate(): # pylint: disable=invalid-name
154 if th.name == search_id:
155 remaining_time = max(0.0, self.actual_timeout - (default_timer() - self.start_time))
156 th.join(remaining_time)
157 if th.is_alive():
158 th._timeout = True
159 self.result_container.add_unresponsive_engine(th._engine_name, 'timeout')
160 PROCESSORS[th._engine_name].logger.error('engine timeout')
161

◆ search_standard()

searx.search.Search.search_standard ( self)
Update self.result_container, self.actual_timeout

Definition at line 162 of file __init__.py.

162 def search_standard(self):
163 """
164 Update self.result_container, self.actual_timeout
165 """
166 requests, self.actual_timeout = self._get_requests()
167
168 # send all search-request
169 if requests:
170 self.search_multiple_requests(requests)
171
172 # return results, suggestions, answers and infoboxes
173 return True
174

Member Data Documentation

◆ __slots__

str searx.search.Search.__slots__ = "search_query", "result_container", "start_time", "actual_timeout"
staticprivate

Definition at line 45 of file __init__.py.

◆ actual_timeout

searx.search.Search.actual_timeout

Definition at line 54 of file __init__.py.

◆ result_container

◆ search_query

searx.search.Search.search_query

◆ start_time

searx.search.Search.start_time

Definition at line 53 of file __init__.py.


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