Icycoide/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng.git synced 2025-07-12 15:59:21 +02:00
Code Issues Projects Releases Packages Wiki Activity

[refactor] typification of SearXNG / EngineResults

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

8
searx/plugins/hash_plugin.py
View file

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