git.iko.soy/searx
on master help sign in
Merge pull request #2398 from dalf/mod-search-query
04447f8Alexandre Flament
searx/query.py+2−2
compare with master
unifiedsplit
@@ -125,12 +125,12 @@ class RawTextQuery:
125 searx_query_part = True
125 searx_query_part = True
126 engine_name = engine_shortcuts[prefix]
126 engine_name = engine_shortcuts[prefix]
127 if engine_name in engines:
127 if engine_name in engines:
128− self.enginerefs.append(EngineRef(engine_name, 'none', True))
128+ self.enginerefs.append(EngineRef(engine_name, 'none'))
129
129
130 # check if prefix is equal with engine name
130 # check if prefix is equal with engine name
131 elif prefix in engines:
131 elif prefix in engines:
132 searx_query_part = True
132 searx_query_part = True
133− self.enginerefs.append(EngineRef(prefix, 'none', True))
133+ self.enginerefs.append(EngineRef(prefix, 'none'))
134
134
135 # check if prefix is equal with categorie name
135 # check if prefix is equal with categorie name
136 elif prefix in categories:
136 elif prefix in categories:
searx/search/__init__.py+15−15
@@ -52,39 +52,36 @@ def initialize(settings_engines=None):
52
52
53class EngineRef:
53class EngineRef:
54
54
55− __slots__ = 'name', 'category', 'from_bang'
55+ __slots__ = 'name', 'category'
56
56
57− def __init__(self, name: str, category: str, from_bang: bool=False):
57+ def __init__(self, name: str, category: str):
58 self.name = name
58 self.name = name
59 self.category = category
59 self.category = category
60− self.from_bang = from_bang
61
60
62 def __repr__(self):
61 def __repr__(self):
63− return "EngineRef({!r}, {!r}, {!r})".format(self.name, self.category, self.from_bang)
62+ return "EngineRef({!r}, {!r})".format(self.name, self.category)
64
63
65 def __eq__(self, other):
64 def __eq__(self, other):
66− return self.name == other.name and self.category == other.category and self.from_bang == other.from_bang
65+ return self.name == other.name and self.category == other.category
67
66
68
67
69class SearchQuery:
68class SearchQuery:
70 """container for all the search parameters (query, language, etc...)"""
69 """container for all the search parameters (query, language, etc...)"""
71
70
72− __slots__ = 'query', 'engineref_list', 'categories', 'lang', 'safesearch', 'pageno', 'time_range',\
71+ __slots__ = 'query', 'engineref_list', 'lang', 'safesearch', 'pageno', 'time_range',\
73 'timeout_limit', 'external_bang'
72 'timeout_limit', 'external_bang'
74
73
75 def __init__(self,
74 def __init__(self,
76 query: str,
75 query: str,
77 engineref_list: typing.List[EngineRef],
76 engineref_list: typing.List[EngineRef],
78− categories: typing.List[str],
79− lang: str,
77+ lang: str='all',
80− safesearch: int,
78+ safesearch: int=0,
81− pageno: int,
79+ pageno: int=1,
82− time_range: typing.Optional[str],
80+ time_range: typing.Optional[str]=None,
83 timeout_limit: typing.Optional[float]=None,
81 timeout_limit: typing.Optional[float]=None,
84 external_bang: typing.Optional[str]=None):
82 external_bang: typing.Optional[str]=None):
85 self.query = query
83 self.query = query
86 self.engineref_list = engineref_list
84 self.engineref_list = engineref_list
87− self.categories = categories
88 self.lang = lang
85 self.lang = lang
89 self.safesearch = safesearch
86 self.safesearch = safesearch
90 self.pageno = pageno
87 self.pageno = pageno
@@ -92,15 +89,18 @@ class SearchQuery:
92 self.timeout_limit = timeout_limit
89 self.timeout_limit = timeout_limit
93 self.external_bang = external_bang
90 self.external_bang = external_bang
94
91
92+ @property
93+ def categories(self):
94+ return list(set(map(lambda engineref: engineref.category, self.engineref_list)))
95+
95 def __repr__(self):
96 def __repr__(self):
96− return "SearchQuery({!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r})".\
97+ return "SearchQuery({!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r})".\
97− format(self.query, self.engineref_list, self.categories, self.lang, self.safesearch,
98+ format(self.query, self.engineref_list, self.lang, self.safesearch,
98 self.pageno, self.time_range, self.timeout_limit, self.external_bang)
99 self.pageno, self.time_range, self.timeout_limit, self.external_bang)
99
100
100 def __eq__(self, other):
101 def __eq__(self, other):
101 return self.query == other.query\
102 return self.query == other.query\
102 and self.engineref_list == other.engineref_list\
103 and self.engineref_list == other.engineref_list\
103− and self.categories == self.categories\
104 and self.lang == other.lang\
104 and self.lang == other.lang\
105 and self.safesearch == other.safesearch\
105 and self.safesearch == other.safesearch\
106 and self.pageno == other.pageno\
106 and self.pageno == other.pageno\
searx/webadapter.py+6−23
@@ -109,18 +109,6 @@ def parse_timeout(form: Dict[str, str], raw_text_query: RawTextQuery) -> Optiona
109 raise SearxParameterException('timeout_limit', timeout_limit)
109 raise SearxParameterException('timeout_limit', timeout_limit)
110
110
111
111
112−def parse_specific(raw_text_query: RawTextQuery) -> Tuple[List[EngineRef], List[str]]:
113− query_engineref_list = raw_text_query.enginerefs
114− additional_categories = set()
115− for engineref in raw_text_query.enginerefs:
116− if engineref.from_bang:
117− additional_categories.add('none')
118− else:
119− additional_categories.add(engineref.category)
120− query_categories = list(additional_categories)
121− return query_engineref_list, query_categories
122−
123−
124def parse_category_form(query_categories: List[str], name: str, value: str) -> None:
112def parse_category_form(query_categories: List[str], name: str, value: str) -> None:
125 if name == 'categories':
113 if name == 'categories':
126 query_categories.extend(categ for categ in map(str.strip, value.split(',')) if categ in categories)
114 query_categories.extend(categ for categ in map(str.strip, value.split(',')) if categ in categories)
@@ -171,8 +159,7 @@ def get_engineref_from_category_list(category_list: List[str], disabled_engines:
171 return result
159 return result
172
160
173
161
174−def parse_generic(preferences: Preferences, form: Dict[str, str], disabled_engines: List[str])\
162+def parse_generic(preferences: Preferences, form: Dict[str, str], disabled_engines: List[str]) -> List[EngineRef]:
175− -> Tuple[List[EngineRef], List[str]]:
176 query_engineref_list = []
163 query_engineref_list = []
177 query_categories = []
164 query_categories = []
178
165
@@ -195,8 +182,6 @@ def parse_generic(preferences: Preferences, form: Dict[str, str], disabled_engin
195 if query_categories:
182 if query_categories:
196 # add engines from referenced by the "categories" parameter and the "category_*"" parameters
183 # add engines from referenced by the "categories" parameter and the "category_*"" parameters
197 query_engineref_list.extend(get_engineref_from_category_list(query_categories, disabled_engines))
184 query_engineref_list.extend(get_engineref_from_category_list(query_categories, disabled_engines))
198− # get categories from the query_engineref_list
199− query_categories = list(set(engine.category for engine in query_engineref_list))
200 else:
185 else:
201 # no "engines" parameters in the form
186 # no "engines" parameters in the form
202 if not query_categories:
187 if not query_categories:
@@ -208,7 +193,7 @@ def parse_generic(preferences: Preferences, form: Dict[str, str], disabled_engin
208 # declared under the specific categories
193 # declared under the specific categories
209 query_engineref_list.extend(get_engineref_from_category_list(query_categories, disabled_engines))
194 query_engineref_list.extend(get_engineref_from_category_list(query_categories, disabled_engines))
210
195
211− return query_engineref_list, query_categories
196+ return query_engineref_list
212
197
213
198
214def get_search_query_from_webapp(preferences: Preferences, form: Dict[str, str])\
199def get_search_query_from_webapp(preferences: Preferences, form: Dict[str, str])\
@@ -236,20 +221,18 @@ def get_search_query_from_webapp(preferences: Preferences, form: Dict[str, str])
236 if not is_locked('categories') and raw_text_query.enginerefs and raw_text_query.specific:
221 if not is_locked('categories') and raw_text_query.enginerefs and raw_text_query.specific:
237 # if engines are calculated from query,
222 # if engines are calculated from query,
238 # set categories by using that informations
223 # set categories by using that informations
239− query_engineref_list, query_categories = parse_specific(raw_text_query)
224+ query_engineref_list = raw_text_query.enginerefs
240 else:
225 else:
241 # otherwise, using defined categories to
226 # otherwise, using defined categories to
242 # calculate which engines should be used
227 # calculate which engines should be used
243− query_engineref_list, query_categories = parse_generic(preferences, form, disabled_engines)
228+ query_engineref_list = parse_generic(preferences, form, disabled_engines)
244
229
245 query_engineref_list = deduplicate_engineref_list(query_engineref_list)
230 query_engineref_list = deduplicate_engineref_list(query_engineref_list)
246 query_engineref_list, query_engineref_list_unknown, query_engineref_list_notoken =\
231 query_engineref_list, query_engineref_list_unknown, query_engineref_list_notoken =\
247 validate_engineref_list(query_engineref_list, preferences)
232 validate_engineref_list(query_engineref_list, preferences)
248
233
249− return (SearchQuery(query, query_engineref_list, query_categories,
250− query_lang, query_safesearch, query_pageno,
234+ return (SearchQuery(query, query_engineref_list, query_lang, query_safesearch, query_pageno,
251− query_time_range, query_timeout,
235+ query_time_range, query_timeout, external_bang=external_bang),
252− external_bang=external_bang),
253 raw_text_query,
236 raw_text_query,
254 query_engineref_list_unknown,
237 query_engineref_list_unknown,
255 query_engineref_list_notoken)
238 query_engineref_list_notoken)
tests/unit/test_search.py+11−11
@@ -23,13 +23,13 @@ TEST_ENGINES = [
23class SearchQueryTestCase(SearxTestCase):
23class SearchQueryTestCase(SearxTestCase):
24
24
25 def test_repr(self):
25 def test_repr(self):
26− s = SearchQuery('test', [EngineRef('bing', 'general', False)], ['general'], 'all', 0, 1, '1', 5.0, 'g')
26+ s = SearchQuery('test', [EngineRef('bing', 'general')], 'all', 0, 1, '1', 5.0, 'g')
27 self.assertEqual(repr(s),
27 self.assertEqual(repr(s),
28− "SearchQuery('test', [EngineRef('bing', 'general', False)], ['general'], 'all', 0, 1, '1', 5.0, 'g')") # noqa
28+ "SearchQuery('test', [EngineRef('bing', 'general')], 'all', 0, 1, '1', 5.0, 'g')") # noqa
29
29
30 def test_eq(self):
30 def test_eq(self):
31− s = SearchQuery('test', [EngineRef('bing', 'general', False)], ['general'], 'all', 0, 1, None, None, None)
31+ s = SearchQuery('test', [EngineRef('bing', 'general')], 'all', 0, 1, None, None, None)
32− t = SearchQuery('test', [EngineRef('google', 'general', False)], ['general'], 'all', 0, 1, None, None, None)
32+ t = SearchQuery('test', [EngineRef('google', 'general')], 'all', 0, 1, None, None, None)
33 self.assertEqual(s, s)
33 self.assertEqual(s, s)
34 self.assertNotEqual(s, t)
34 self.assertNotEqual(s, t)
35
35
@@ -43,7 +43,7 @@ class SearchTestCase(SearxTestCase):
43 def test_timeout_simple(self):
43 def test_timeout_simple(self):
44 searx.search.max_request_timeout = None
44 searx.search.max_request_timeout = None
45 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
45 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
46− ['general'], 'en-US', SAFESEARCH, PAGENO, None, None)
46+ 'en-US', SAFESEARCH, PAGENO, None, None)
47 search = searx.search.Search(search_query)
47 search = searx.search.Search(search_query)
48 search.search()
48 search.search()
49 self.assertEqual(search.actual_timeout, 3.0)
49 self.assertEqual(search.actual_timeout, 3.0)
@@ -51,7 +51,7 @@ class SearchTestCase(SearxTestCase):
51 def test_timeout_query_above_default_nomax(self):
51 def test_timeout_query_above_default_nomax(self):
52 searx.search.max_request_timeout = None
52 searx.search.max_request_timeout = None
53 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
53 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
54− ['general'], 'en-US', SAFESEARCH, PAGENO, None, 5.0)
54+ 'en-US', SAFESEARCH, PAGENO, None, 5.0)
55 search = searx.search.Search(search_query)
55 search = searx.search.Search(search_query)
56 search.search()
56 search.search()
57 self.assertEqual(search.actual_timeout, 3.0)
57 self.assertEqual(search.actual_timeout, 3.0)
@@ -59,7 +59,7 @@ class SearchTestCase(SearxTestCase):
59 def test_timeout_query_below_default_nomax(self):
59 def test_timeout_query_below_default_nomax(self):
60 searx.search.max_request_timeout = None
60 searx.search.max_request_timeout = None
61 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
61 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
62− ['general'], 'en-US', SAFESEARCH, PAGENO, None, 1.0)
62+ 'en-US', SAFESEARCH, PAGENO, None, 1.0)
63 search = searx.search.Search(search_query)
63 search = searx.search.Search(search_query)
64 search.search()
64 search.search()
65 self.assertEqual(search.actual_timeout, 1.0)
65 self.assertEqual(search.actual_timeout, 1.0)
@@ -67,7 +67,7 @@ class SearchTestCase(SearxTestCase):
67 def test_timeout_query_below_max(self):
67 def test_timeout_query_below_max(self):
68 searx.search.max_request_timeout = 10.0
68 searx.search.max_request_timeout = 10.0
69 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
69 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
70− ['general'], 'en-US', SAFESEARCH, PAGENO, None, 5.0)
70+ 'en-US', SAFESEARCH, PAGENO, None, 5.0)
71 search = searx.search.Search(search_query)
71 search = searx.search.Search(search_query)
72 search.search()
72 search.search()
73 self.assertEqual(search.actual_timeout, 5.0)
73 self.assertEqual(search.actual_timeout, 5.0)
@@ -75,7 +75,7 @@ class SearchTestCase(SearxTestCase):
75 def test_timeout_query_above_max(self):
75 def test_timeout_query_above_max(self):
76 searx.search.max_request_timeout = 10.0
76 searx.search.max_request_timeout = 10.0
77 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
77 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
78− ['general'], 'en-US', SAFESEARCH, PAGENO, None, 15.0)
78+ 'en-US', SAFESEARCH, PAGENO, None, 15.0)
79 search = searx.search.Search(search_query)
79 search = searx.search.Search(search_query)
80 search.search()
80 search.search()
81 self.assertEqual(search.actual_timeout, 10.0)
81 self.assertEqual(search.actual_timeout, 10.0)
@@ -83,7 +83,7 @@ class SearchTestCase(SearxTestCase):
83 def test_external_bang(self):
83 def test_external_bang(self):
84 search_query = SearchQuery('yes yes',
84 search_query = SearchQuery('yes yes',
85 [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
85 [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
86− ['general'], 'en-US', SAFESEARCH, PAGENO, None, None,
86+ 'en-US', SAFESEARCH, PAGENO, None, None,
87 external_bang="yt")
87 external_bang="yt")
88 search = searx.search.Search(search_query)
88 search = searx.search.Search(search_query)
89 results = search.search()
89 results = search.search()
@@ -92,7 +92,7 @@ class SearchTestCase(SearxTestCase):
92
92
93 search_query = SearchQuery('youtube never gonna give you up',
93 search_query = SearchQuery('youtube never gonna give you up',
94 [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
94 [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
95− ['general'], 'en-US', SAFESEARCH, PAGENO, None, None)
95+ 'en-US', SAFESEARCH, PAGENO, None, None)
96
96
97 search = searx.search.Search(search_query)
97 search = searx.search.Search(search_query)
98 results = search.search()
98 results = search.search()
tests/unit/test_standalone_searx.py+2−2
@@ -101,8 +101,8 @@ class StandaloneSearx(SearxTestCase):
101 args = sas.parse_argument(['rain', ])
101 args = sas.parse_argument(['rain', ])
102 search_q = sas.get_search_query(args)
102 search_q = sas.get_search_query(args)
103 self.assertTrue(search_q)
103 self.assertTrue(search_q)
104− self.assertEqual(search_q, SearchQuery('rain', [EngineRef('engine1', 'general', False)],
104+ self.assertEqual(search_q, SearchQuery('rain', [EngineRef('engine1', 'general')],
105− ['general'], 'all', 0, 1, None, None, None))
105+ 'all', 0, 1, None, None, None))
106
106
107 def test_no_parsed_url(self):
107 def test_no_parsed_url(self):
108 """test no_parsed_url func"""
108 """test no_parsed_url func"""