[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>

3 files changed, 13 insertions, 13 deletions

diff --git a/searx/plugins/calculator.py b/searx/plugins/calculator.py
index 162f3c3c6..11caa272f 100644
--- a/searx/plugins/calculator.py
+++ b/searx/plugins/calculator.py
@@ -14,7 +14,7 @@ import babel
 import babel.numbers
 from flask_babel import gettext
 
-from searx.result_types import Answer
+from searx.result_types import EngineResults
 
 name = "Basic Calculator"
 description = gettext("Calculate mathematical expressions via the search bar")
@@ -94,8 +94,8 @@ def timeout_func(timeout, func, *args, **kwargs):
     return ret_val
 
 
-def post_search(request, search) -> list[Answer]:
-    results = []
+def post_search(request, search) -> EngineResults:
+    results = EngineResults()
 
     # only show the result of the expression on the first page
     if search.search_query.pageno > 1:
@@ -135,6 +135,6 @@ def post_search(request, search) -> list[Answer]:
         return results
 
     res = babel.numbers.format_decimal(res, locale=ui_locale)
-    Answer(results=results, answer=f"{search.search_query.query} = {res}")
+    results.add(results.types.Answer(answer=f"{search.search_query.query} = {res}"))
 
     return results
diff --git a/searx/plugins/hash_plugin.py b/searx/plugins/hash_plugin.py
index 9db3748b3..940c895a1 100644
--- a/searx/plugins/hash_plugin.py
+++ b/searx/plugins/hash_plugin.py
@@ -9,7 +9,7 @@ import hashlib
 from flask_babel import gettext
 
 from searx.plugins import Plugin, PluginInfo
-from searx.result_types import Answer
+from searx.result_types import EngineResults
 
 if typing.TYPE_CHECKING:
     from searx.search import SearchWithPlugins
@@ -37,9 +37,9 @@ class SXNGPlugin(Plugin):
             preference_section="query",
         )
 
-    def post_search(self, request: "SXNG_Request", search: "SearchWithPlugins") -> list[Answer]:
+    def post_search(self, request: "SXNG_Request", search: "SearchWithPlugins") -> EngineResults:
         """Returns a result list only for the first page."""
-        results = []
+        results = EngineResults()
 
         if search.search_query.pageno > 1:
             return results
@@ -61,6 +61,6 @@ class SXNGPlugin(Plugin):
         f.update(string.encode("utf-8").strip())
         answer = function + " " + gettext("hash digest") + ": " + f.hexdigest()
 
-        Answer(results=results, answer=answer)
+        results.add(results.types.Answer(answer=answer))
 
         return results
diff --git a/searx/plugins/self_info.py b/searx/plugins/self_info.py
index d1d7f12b9..f5498e480 100644
--- a/searx/plugins/self_info.py
+++ b/searx/plugins/self_info.py
@@ -7,7 +7,7 @@ import re
 from flask_babel import gettext
 
 from searx.botdetection._helpers import get_real_ip
-from searx.result_types import Answer
+from searx.result_types import EngineResults
 
 from . import Plugin, PluginInfo
 
@@ -41,17 +41,17 @@ class SXNGPlugin(Plugin):
             preference_section="query",
         )
 
-    def post_search(self, request: "SXNG_Request", search: "SearchWithPlugins") -> list[Answer]:
+    def post_search(self, request: "SXNG_Request", search: "SearchWithPlugins") -> EngineResults:
         """Returns a result list only for the first page."""
-        results = []
+        results = EngineResults()
 
         if search.search_query.pageno > 1:
             return results
 
         if self.ip_regex.search(search.search_query.query):
-            Answer(results=results, answer=gettext("Your IP is: ") + get_real_ip(request))
+            results.add(results.types.Answer(answer=gettext("Your IP is: ") + get_real_ip(request)))
 
         if self.ua_regex.match(search.search_query.query):
-            Answer(results=results, answer=gettext("Your user-agent is: ") + str(request.user_agent))
+            results.add(results.types.Answer(answer=gettext("Your user-agent is: ") + str(request.user_agent)))
 
         return results