From 36a1ef12399d529f210ceb4f8b28f497fabd0834 Mon Sep 17 00:00:00 2001
From: Markus Heiser <markus.heiser@darmarit.de>
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 <markus.heiser@darmarit.de>
---
 searx/engines/lingva.py | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

(limited to 'searx/engines/lingva.py')

diff --git a/searx/engines/lingva.py b/searx/engines/lingva.py
index 1cf70f636..156e37d89 100644
--- a/searx/engines/lingva.py
+++ b/searx/engines/lingva.py
@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 """Lingva (alternative Google Translate frontend)"""
 
-from searx.result_types import Translations
+from searx.result_types import EngineResults
 
 about = {
     "website": 'https://lingva.ml',
@@ -23,8 +23,8 @@ def request(_query, params):
     return params
 
 
-def response(resp):
-    results = []
+def response(resp) -> EngineResults:
+    results = EngineResults()
 
     result = resp.json()
     info = result["info"]
@@ -44,7 +44,7 @@ def response(resp):
     for definition in info['definitions']:
         for translation in definition['list']:
             data.append(
-                Translations.Item(
+                results.types.Translations.Item(
                     text=result['translation'],
                     definitions=[translation['definition']] if translation['definition'] else [],
                     examples=[translation['example']] if translation['example'] else [],
@@ -55,19 +55,20 @@ def response(resp):
     for translation in info["extraTranslations"]:
         for word in translation["list"]:
             data.append(
-                Translations.Item(
+                results.types.Translations.Item(
                     text=word['word'],
                     definitions=word['meanings'],
                 )
             )
 
     if not data and result['translation']:
-        data.append(Translations.Item(text=result['translation']))
+        data.append(results.types.Translations.Item(text=result['translation']))
 
     params = resp.search_params
-    Translations(
-        results=results,
-        translations=data,
-        url=f"{url}/{params['from_lang'][1]}/{params['to_lang'][1]}/{params['query']}",
+    results.add(
+        results.types.Translations(
+            translations=data,
+            url=f"{url}/{params['from_lang'][1]}/{params['to_lang'][1]}/{params['query']}",
+        )
     )
     return results
-- 
cgit v1.2.3