.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)

Detailed Description

Search information container

Definition at line 51 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 54 of file __init__.py.

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

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

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

◆ search()

ResultContainer searx.search.Search.search ( self)

Reimplemented in searx.search.SearchWithPlugins.

Definition at line 174 of file __init__.py.

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

◆ search_answerers()

searx.search.Search.search_answerers ( self)

Definition at line 75 of file __init__.py.

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

◆ 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 63 of file __init__.py.

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

◆ search_multiple_requests()

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

Definition at line 136 of file __init__.py.

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

◆ search_standard()

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

Definition at line 160 of file __init__.py.

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

Member Data Documentation

◆ actual_timeout

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

Definition at line 61 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 60 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