git.iko.soy/searx
on master help sign in
[mod] searx.search.SearchQuery: remove categories parameter

The categories parameter is useless in the constructor: it is always the categories from the EngineRef. The categories becomes a property.

commit995ba2f40643bd01134902eca91cacf0bab1ebdc authorAlexandre Flament <alex@al-f.net> dateThu 17 Dec 2020, 13:51 (6 years ago) parent14c7cc0
4 files changed+30−35
compare with master
unifiedsplit
searx/search/__init__.py+11−10 searx/webadapter.py+7−13 tests/unit/test_search.py+11−11 tests/unit/test_standalone_searx.py+1−1
searx/search/__init__.py+11−10
@@ -69,22 +69,20 @@ class EngineRef:
6969class SearchQuery:
7070 """container for all the search parameters (query, language, etc...)"""
7171
72− __slots__ = 'query', 'engineref_list', 'categories', 'lang', 'safesearch', 'pageno', 'time_range',\
72+ __slots__ = 'query', 'engineref_list', 'lang', 'safesearch', 'pageno', 'time_range',\
7373 'timeout_limit', 'external_bang'
7474
7575 def __init__(self,
7676 query: str,
7777 engineref_list: typing.List[EngineRef],
78− categories: typing.List[str],
79− lang: str,
80− safesearch: int,
81− pageno: int,
82− time_range: typing.Optional[str],
78+ lang: str='all',
79+ safesearch: int=0,
80+ pageno: int=1,
81+ time_range: typing.Optional[str]=None,
8382 timeout_limit: typing.Optional[float]=None,
8483 external_bang: typing.Optional[str]=None):
8584 self.query = query
8685 self.engineref_list = engineref_list
87− self.categories = categories
8886 self.lang = lang
8987 self.safesearch = safesearch
9088 self.pageno = pageno
@@ -92,15 +90,18 @@ class SearchQuery:
9290 self.timeout_limit = timeout_limit
9391 self.external_bang = external_bang
9492
93+ @property
94+ def categories(self):
95+ return list(set(map(lambda engineref: engineref.category, self.engineref_list)))
96+
9597 def __repr__(self):
96− return "SearchQuery({!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r})".\
97− format(self.query, self.engineref_list, self.categories, self.lang, self.safesearch,
98+ return "SearchQuery({!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r})".\
99+ format(self.query, self.engineref_list, self.lang, self.safesearch,
98100 self.pageno, self.time_range, self.timeout_limit, self.external_bang)
99101
100102 def __eq__(self, other):
101103 return self.query == other.query\
102104 and self.engineref_list == other.engineref_list\
103− and self.categories == self.categories\
104105 and self.lang == other.lang\
105106 and self.safesearch == other.safesearch\
106107 and self.pageno == other.pageno\
searx/webadapter.py+7−13
@@ -117,8 +117,7 @@ def parse_specific(raw_text_query: RawTextQuery) -> Tuple[List[EngineRef], List[
117117 additional_categories.add('none')
118118 else:
119119 additional_categories.add(engineref.category)
120− query_categories = list(additional_categories)
121− return query_engineref_list, query_categories
120+ return query_engineref_list
122121
123122
124123def parse_category_form(query_categories: List[str], name: str, value: str) -> None:
@@ -171,8 +170,7 @@ def get_engineref_from_category_list(category_list: List[str], disabled_engines:
171170 return result
172171
173172
174−def parse_generic(preferences: Preferences, form: Dict[str, str], disabled_engines: List[str])\
175− -> Tuple[List[EngineRef], List[str]]:
173+def parse_generic(preferences: Preferences, form: Dict[str, str], disabled_engines: List[str]) -> List[EngineRef]:
176174 query_engineref_list = []
177175 query_categories = []
178176
@@ -195,8 +193,6 @@ def parse_generic(preferences: Preferences, form: Dict[str, str], disabled_engin
195193 if query_categories:
196194 # add engines from referenced by the "categories" parameter and the "category_*"" parameters
197195 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))
200196 else:
201197 # no "engines" parameters in the form
202198 if not query_categories:
@@ -208,7 +204,7 @@ def parse_generic(preferences: Preferences, form: Dict[str, str], disabled_engin
208204 # declared under the specific categories
209205 query_engineref_list.extend(get_engineref_from_category_list(query_categories, disabled_engines))
210206
211− return query_engineref_list, query_categories
207+ return query_engineref_list
212208
213209
214210def get_search_query_from_webapp(preferences: Preferences, form: Dict[str, str])\
@@ -236,20 +232,18 @@ def get_search_query_from_webapp(preferences: Preferences, form: Dict[str, str])
236232 if not is_locked('categories') and raw_text_query.enginerefs and raw_text_query.specific:
237233 # if engines are calculated from query,
238234 # set categories by using that informations
239− query_engineref_list, query_categories = parse_specific(raw_text_query)
235+ query_engineref_list = parse_specific(raw_text_query)
240236 else:
241237 # otherwise, using defined categories to
242238 # calculate which engines should be used
243− query_engineref_list, query_categories = parse_generic(preferences, form, disabled_engines)
239+ query_engineref_list = parse_generic(preferences, form, disabled_engines)
244240
245241 query_engineref_list = deduplicate_engineref_list(query_engineref_list)
246242 query_engineref_list, query_engineref_list_unknown, query_engineref_list_notoken =\
247243 validate_engineref_list(query_engineref_list, preferences)
248244
249− return (SearchQuery(query, query_engineref_list, query_categories,
250− query_lang, query_safesearch, query_pageno,
251− query_time_range, query_timeout,
252− external_bang=external_bang),
245+ return (SearchQuery(query, query_engineref_list, query_lang, query_safesearch, query_pageno,
246+ query_time_range, query_timeout, external_bang=external_bang),
253247 raw_text_query,
254248 query_engineref_list_unknown,
255249 query_engineref_list_notoken)
tests/unit/test_search.py+11−11
@@ -23,13 +23,13 @@ TEST_ENGINES = [
2323class SearchQueryTestCase(SearxTestCase):
2424
2525 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', False)], 'all', 0, 1, '1', 5.0, 'g')
2727 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', False)], 'all', 0, 1, '1', 5.0, 'g')") # noqa
2929
3030 def test_eq(self):
31− s = SearchQuery('test', [EngineRef('bing', 'general', False)], ['general'], 'all', 0, 1, None, None, None)
32− t = SearchQuery('test', [EngineRef('google', 'general', False)], ['general'], 'all', 0, 1, None, None, None)
31+ s = SearchQuery('test', [EngineRef('bing', 'general', False)], 'all', 0, 1, None, None, None)
32+ t = SearchQuery('test', [EngineRef('google', 'general', False)], 'all', 0, 1, None, None, None)
3333 self.assertEqual(s, s)
3434 self.assertNotEqual(s, t)
3535
@@ -43,7 +43,7 @@ class SearchTestCase(SearxTestCase):
4343 def test_timeout_simple(self):
4444 searx.search.max_request_timeout = None
4545 search_query = SearchQuery('test', [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
46− ['general'], 'en-US', SAFESEARCH, PAGENO, None, None)
46+ 'en-US', SAFESEARCH, PAGENO, None, None)
4747 search = searx.search.Search(search_query)
4848 search.search()
4949 self.assertEqual(search.actual_timeout, 3.0)
@@ -51,7 +51,7 @@ class SearchTestCase(SearxTestCase):
5151 def test_timeout_query_above_default_nomax(self):
5252 searx.search.max_request_timeout = None
5353 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)
5555 search = searx.search.Search(search_query)
5656 search.search()
5757 self.assertEqual(search.actual_timeout, 3.0)
@@ -59,7 +59,7 @@ class SearchTestCase(SearxTestCase):
5959 def test_timeout_query_below_default_nomax(self):
6060 searx.search.max_request_timeout = None
6161 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)
6363 search = searx.search.Search(search_query)
6464 search.search()
6565 self.assertEqual(search.actual_timeout, 1.0)
@@ -67,7 +67,7 @@ class SearchTestCase(SearxTestCase):
6767 def test_timeout_query_below_max(self):
6868 searx.search.max_request_timeout = 10.0
6969 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)
7171 search = searx.search.Search(search_query)
7272 search.search()
7373 self.assertEqual(search.actual_timeout, 5.0)
@@ -75,7 +75,7 @@ class SearchTestCase(SearxTestCase):
7575 def test_timeout_query_above_max(self):
7676 searx.search.max_request_timeout = 10.0
7777 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)
7979 search = searx.search.Search(search_query)
8080 search.search()
8181 self.assertEqual(search.actual_timeout, 10.0)
@@ -83,7 +83,7 @@ class SearchTestCase(SearxTestCase):
8383 def test_external_bang(self):
8484 search_query = SearchQuery('yes yes',
8585 [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
86− ['general'], 'en-US', SAFESEARCH, PAGENO, None, None,
86+ 'en-US', SAFESEARCH, PAGENO, None, None,
8787 external_bang="yt")
8888 search = searx.search.Search(search_query)
8989 results = search.search()
@@ -92,7 +92,7 @@ class SearchTestCase(SearxTestCase):
9292
9393 search_query = SearchQuery('youtube never gonna give you up',
9494 [EngineRef(PUBLIC_ENGINE_NAME, 'general')],
95− ['general'], 'en-US', SAFESEARCH, PAGENO, None, None)
95+ 'en-US', SAFESEARCH, PAGENO, None, None)
9696
9797 search = searx.search.Search(search_query)
9898 results = search.search()
tests/unit/test_standalone_searx.py+1−1
@@ -102,7 +102,7 @@ class StandaloneSearx(SearxTestCase):
102102 search_q = sas.get_search_query(args)
103103 self.assertTrue(search_q)
104104 self.assertEqual(search_q, SearchQuery('rain', [EngineRef('engine1', 'general', False)],
105− ['general'], 'all', 0, 1, None, None, None))
105+ 'all', 0, 1, None, None, None))
106106
107107 def test_no_parsed_url(self):
108108 """test no_parsed_url func"""