@@ -1,4 +1,4 @@
1−import typing
1+from typing import Dict, List, Optional, Tuple
22from searx.exceptions import SearxParameterException
33from searx.query import RawTextQuery, VALID_LANGUAGE_CODE
44from searx.engines import categories, engines
@@ -8,19 +8,19 @@ from searx.preferences import Preferences
88
99# remove duplicate queries.
1010# FIXME: does not fix "!music !soundcloud", because the categories are 'none' and 'music'
11−def deduplicate_engineref_list(engineref_list: typing.List[EngineRef]) -> typing.List[EngineRef]:
11+def deduplicate_engineref_list(engineref_list: List[EngineRef]) -> List[EngineRef]:
1212 engineref_dict = {q.category + '|' + q.name: q for q in engineref_list}
1313 return engineref_dict.values()
1414
1515
16−def validate_engineref_list(engineref_list: typing.List[EngineRef], preferences: Preferences):
17− """
18− Validate query_engines according to the preferences
16+def validate_engineref_list(engineref_list: List[EngineRef], preferences: Preferences)\
17+ -> Tuple[List[EngineRef], List[EngineRef], List[EngineRef]]:
18+ """Validate query_engines according to the preferences
1919
20− Returns:
21− list of existing engines with a validated token
22− list of unknown engine
23− list of engine with invalid token according to the preferences
20+ Returns:
21+ List[EngineRef]: list of existing engines with a validated token
22+ List[EngineRef]: list of unknown engine
23+ List[EngineRef]: list of engine with invalid token according to the preferences
2424 """
2525 valid = []
2626 unknown = []
@@ -39,14 +39,14 @@ def validate_engineref_list(engineref_list: typing.List[EngineRef], preferences:
3939 return valid, unknown, no_token
4040
4141
42−def parse_pageno(form: typing.Dict[str, str]) -> int:
42+def parse_pageno(form: Dict[str, str]) -> int:
4343 pageno_param = form.get('pageno', '1')
4444 if not pageno_param.isdigit() or int(pageno_param) < 1:
4545 raise SearxParameterException('pageno', pageno_param)
4646 return int(pageno_param)
4747
4848
49−def parse_lang(raw_text_query: RawTextQuery, form: typing.Dict[str, str], preferences: Preferences) -> str:
49+def parse_lang(preferences: Preferences, form: Dict[str, str], raw_text_query: RawTextQuery) -> str:
5050 # get language
5151 # set specific language if set on request, query or preferences
5252 # TODO support search with multible languages
@@ -64,7 +64,7 @@ def parse_lang(raw_text_query: RawTextQuery, form: typing.Dict[str, str], prefer
6464 return query_lang
6565
6666
67−def parse_safesearch(form: typing.Dict[str, str], preferences: Preferences) -> int:
67+def parse_safesearch(preferences: Preferences, form: Dict[str, str]) -> int:
6868 if 'safesearch' in form:
6969 query_safesearch = form.get('safesearch')
7070 # first check safesearch
@@ -81,7 +81,7 @@ def parse_safesearch(form: typing.Dict[str, str], preferences: Preferences) -> i
8181 return query_safesearch
8282
8383
84−def parse_time_range(form: typing.Dict[str, str]) -> str:
84+def parse_time_range(form: Dict[str, str]) -> str:
8585 query_time_range = form.get('time_range')
8686 # check time_range
8787 query_time_range = None if query_time_range in ('', 'None') else query_time_range
@@ -90,7 +90,7 @@ def parse_time_range(form: typing.Dict[str, str]) -> str:
9090 return query_time_range
9191
9292
93−def parse_timeout(raw_text_query: RawTextQuery, form: typing.Dict[str, str]) -> typing.Optional[float]:
93+def parse_timeout(form: Dict[str, str], raw_text_query: RawTextQuery) -> Optional[float]:
9494 query_timeout = raw_text_query.timeout_limit
9595 if query_timeout is None and 'timeout_limit' in form:
9696 raw_time_limit = form.get('timeout_limit')
@@ -103,7 +103,7 @@ def parse_timeout(raw_text_query: RawTextQuery, form: typing.Dict[str, str]) ->
103103 raise SearxParameterException('timeout_limit', raw_time_limit)
104104
105105
106−def parse_specific(raw_text_query: RawTextQuery):
106+def parse_specific(raw_text_query: RawTextQuery) -> Tuple[List[EngineRef], List[str]]:
107107 query_engineref_list = raw_text_query.enginerefs
108108 additional_categories = set()
109109 for engineref in raw_text_query.enginerefs:
@@ -115,7 +115,7 @@ def parse_specific(raw_text_query: RawTextQuery):
115115 return query_engineref_list, query_categories
116116
117117
118−def parse_category_form(query_categories, name, value):
118+def parse_category_form(query_categories: List[str], name: str, value: str) -> None:
119119 if name == 'categories':
120120 query_categories.extend(categ for categ in map(str.strip, value.split(',')) if categ in categories)
121121 elif name.startswith('category_'):
@@ -133,7 +133,7 @@ def parse_category_form(query_categories, name, value):
133133 query_categories.remove(category)
134134
135135
136−def get_selected_categories(form, preferences):
136+def get_selected_categories(preferences: Preferences, form: Dict[str, str]) -> List[str]:
137137 selected_categories = []
138138
139139 if form is not None:
@@ -156,7 +156,8 @@ def get_selected_categories(form, preferences):
156156 return selected_categories
157157
158158
159−def parse_generic(form, preferences, disabled_engines):
159+def parse_generic(preferences: Preferences, form: Dict[str, str], disabled_engines: List[str])\
160+ -> Tuple[List[EngineRef], List[str]]:
160161 query_engineref_list = []
161162 query_categories = []
162163
@@ -178,7 +179,7 @@ def parse_generic(form, preferences, disabled_engines):
178179 for engine in query_engineref_list))
179180 else:
180181 if not query_categories:
181− query_categories = get_selected_categories(None, preferences)
182+ query_categories = get_selected_categories(preferences, None)
182183
183184 # using all engines for that search, which are
184185 # declared under the specific categories
@@ -190,8 +191,8 @@ def parse_generic(form, preferences, disabled_engines):
190191 return query_engineref_list, query_categories
191192
192193
193−def get_search_query_from_webapp(preferences: Preferences, form: typing.Dict[str, str])\
194− -> typing.Tuple[SearchQuery, RawTextQuery, typing.List[EngineRef], typing.List[EngineRef]]:
194+def get_search_query_from_webapp(preferences: Preferences, form: Dict[str, str])\
195+ -> Tuple[SearchQuery, RawTextQuery, List[EngineRef], List[EngineRef]]:
195196 # no text for the query ?
196197 if not form.get('q'):
197198 raise SearxParameterException('q', '')
@@ -206,10 +207,10 @@ def get_search_query_from_webapp(preferences: Preferences, form: typing.Dict[str
206207 # set query
207208 query = raw_text_query.getQuery()
208209 query_pageno = parse_pageno(form)
209− query_lang = parse_lang(raw_text_query, form, preferences)
210− query_safesearch = parse_safesearch(form, preferences)
210+ query_lang = parse_lang(preferences, form, raw_text_query)
211+ query_safesearch = parse_safesearch(preferences, form)
211212 query_time_range = parse_time_range(form)
212− query_timeout = parse_timeout(raw_text_query, form)
213+ query_timeout = parse_timeout(form, raw_text_query)
213214 external_bang = raw_text_query.external_bang
214215
215216 if raw_text_query.enginerefs and raw_text_query.specific:
@@ -219,7 +220,7 @@ def get_search_query_from_webapp(preferences: Preferences, form: typing.Dict[str
219220 else:
220221 # otherwise, using defined categories to
221222 # calculate which engines should be used
222− query_engineref_list, query_categories = parse_generic(form, preferences, disabled_engines)
223+ query_engineref_list, query_categories = parse_generic(preferences, form, disabled_engines)
223224
224225 query_engineref_list = deduplicate_engineref_list(query_engineref_list)
225226 query_engineref_list, query_engineref_list_unknown, query_engineref_list_notoken =\