[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 <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2025-01-27 16:43:43 +01:00 committed by Markus Heiser
parent edfbf1e118
commit 36a1ef1239
26 changed files with 195 additions and 140 deletions

View file

@ -5,7 +5,7 @@
import urllib.parse
from searx.result_types import Translations
from searx.result_types import EngineResults
# about
about = {
@ -37,8 +37,8 @@ def request(query, params): # pylint: disable=unused-argument
return params
def response(resp):
results = []
def response(resp) -> EngineResults:
results = EngineResults()
data = resp.json()
args = {
@ -53,7 +53,7 @@ def response(resp):
examples = [f"{m['segment']} : {m['translation']}" for m in data['matches'] if m['translation'] != text]
item = Translations.Item(text=text, examples=examples)
Translations(results=results, translations=[item], url=link)
item = results.types.Translations.Item(text=text, examples=examples)
results.add(results.types.Translations(translations=[item], url=link))
return results