From 36a1ef12399d529f210ceb4f8b28f497fabd0834 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 27 Jan 2025 16:43:43 +0100 Subject: [refactor] typification of SearXNG / EngineResults In [1] and [2] we discussed the need of a Result.results property and how we can avoid unclear code. This patch implements a class for the reslut-lists of engines:: searx.result_types.EngineResults A simple example for the usage in engine development:: from searx.result_types import EngineResults ... def response(resp) -> EngineResults: res = EngineResults() ... res.add( res.types.Answer(answer="lorem ipsum ..", url="https://example.org") ) ... return res [1] https://github.com/searxng/searxng/pull/4183#pullrequestreview-257400034 [2] https://github.com/searxng/searxng/pull/4183#issuecomment-2614301580 Signed-off-by: Markus Heiser --- searx/engines/dictzone.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'searx/engines/dictzone.py') diff --git a/searx/engines/dictzone.py b/searx/engines/dictzone.py index 7f562c716..83ab28ff2 100644 --- a/searx/engines/dictzone.py +++ b/searx/engines/dictzone.py @@ -7,7 +7,7 @@ import urllib.parse from lxml import html from searx.utils import eval_xpath, extract_text -from searx.result_types import Translations +from searx.result_types import EngineResults from searx.network import get as http_get # https://github.com/searxng/searxng/issues/762 # about @@ -43,9 +43,9 @@ def _clean_up_node(node): n.getparent().remove(n) -def response(resp): +def response(resp) -> EngineResults: + results = EngineResults() - results = [] item_list = [] if not resp.ok: @@ -85,7 +85,7 @@ def response(resp): synonyms.append(p_text) - item = Translations.Item(text=text, synonyms=synonyms) + item = results.types.Translations.Item(text=text, synonyms=synonyms) item_list.append(item) # the "autotranslate" of dictzone is loaded by the JS from URL: @@ -98,7 +98,7 @@ def response(resp): # works only sometimes? autotranslate = http_get(f"{base_url}/trans/{query}/{from_lang}_{to_lang}", timeout=1.0) if autotranslate.ok and autotranslate.text: - item_list.insert(0, Translations.Item(text=autotranslate.text)) + item_list.insert(0, results.types.Translations.Item(text=autotranslate.text)) - Translations(results=results, translations=item_list, url=resp.search_params["url"]) + results.add(results.types.Translations(translations=item_list, url=resp.search_params["url"])) return results -- cgit v1.2.3