[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 random
import re
import urllib.parse
from searx.result_types import Translations
from searx.result_types import EngineResults
about = {
"website": 'https://codeberg.org/aryak/mozhi',
@ -33,11 +33,11 @@ def request(_query, params):
return params
def response(resp):
results = []
def response(resp) -> EngineResults:
res = EngineResults()
translation = resp.json()
item = Translations.Item(text=translation['translated-text'])
item = res.types.Translations.Item(text=translation['translated-text'])
if translation['target_transliteration'] and not re.match(
re_transliteration_unsupported, translation['target_transliteration']
@ -57,5 +57,5 @@ def response(resp):
url = urllib.parse.urlparse(resp.search_params["url"])
# remove the api path
url = url._replace(path="", fragment="").geturl()
Translations(results=results, translations=[item], url=url)
return results
res.add(res.types.Translations(translations=[item], url=url))
return res