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

Public Member Functions

 __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)
ResultContainer search (self)

Public Attributes

 search_query = search_query
ResultContainer result_container = ResultContainer()
float|None start_time = None
float|None actual_timeout = None

Protected Member Functions

tuple[list[tuple[str, str, dict[str, t.Any]]], int] _get_requests (self)

Static Private Attributes

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

Detailed Description

Search information container

Definition at line 52 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 57 of file __init__.py.

57 def __init__(self, search_query: "SearchQuery"):
58 """Initialize the Search"""
59 # init vars
60 super().__init__()
61 self.search_query: "SearchQuery" = search_query
62 self.result_container: ResultContainer = ResultContainer()
63 self.start_time: float | None = None
64 self.actual_timeout: float | None = None
65

Member Function Documentation

◆ _get_requests()

tuple[list[tuple[str, str, dict[str, t.Any]]], int] searx.search.Search._get_requests ( self)
protected

Definition at line 85 of file __init__.py.

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

◆ search()

ResultContainer searx.search.Search.search ( self)

Reimplemented in searx.search.SearchWithPlugins.

Definition at line 177 of file __init__.py.

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

◆ search_answerers()

searx.search.Search.search_answerers ( self)

Definition at line 78 of file __init__.py.

78 def search_answerers(self):
79
80 results = searx.answerers.STORAGE.ask(self.search_query.query)
81 self.result_container.extend(None, results) # pyright: ignore[reportArgumentType]
82 return bool(results)
83

◆ search_external_bang()

bool 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 66 of file __init__.py.

66 def search_external_bang(self) -> bool:
67 """Check if there is a external bang. If yes, update
68 self.result_container and return True."""
69 if self.search_query.external_bang:
70 self.result_container.redirect_url = get_bang_url(self.search_query)
71
72 # This means there was a valid bang and the rest of the search does
73 # not need to be continued
74 if isinstance(self.result_container.redirect_url, str):
75 return True
76 return False
77

◆ search_multiple_requests()

searx.search.Search.search_multiple_requests ( self,
list[tuple[str, str, dict[str, t.Any]]] requests )

Definition at line 139 of file __init__.py.

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

◆ search_standard()

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

Definition at line 163 of file __init__.py.

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

Member Data Documentation

◆ __slots__

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

Definition at line 55 of file __init__.py.

◆ actual_timeout

float | None searx.search.Search.actual_timeout = None

Definition at line 64 of file __init__.py.

◆ result_container

◆ search_query

searx.search.Search.search_query = search_query

◆ start_time

float | None searx.search.Search.start_time = None

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