summaryrefslogtreecommitdiff
path: root/searx/engines/demo_online.py
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2025-01-27 16:43:43 +0100
committerMarkus Heiser <markus.heiser@darmarIT.de>2025-01-28 07:07:08 +0100
commit36a1ef12399d529f210ceb4f8b28f497fabd0834 (patch)
tree4015a316c6505c3e52d43eea7137338331cbd4eb /searx/engines/demo_online.py
parentedfbf1e1183815cea3b723f3b66260bc55679f32 (diff)
[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>
Diffstat (limited to 'searx/engines/demo_online.py')
-rw-r--r--searx/engines/demo_online.py16
1 files changed, 12 insertions, 4 deletions
diff --git a/searx/engines/demo_online.py b/searx/engines/demo_online.py
index 6accc0033..ee06c3b31 100644
--- a/searx/engines/demo_online.py
+++ b/searx/engines/demo_online.py
@@ -17,6 +17,7 @@ list in ``settings.yml``:
from json import loads
from urllib.parse import urlencode
+from searx.result_types import EngineResults
engine_type = 'online'
send_accept_language_header = True
@@ -70,21 +71,28 @@ def request(query, params):
return params
-def response(resp):
+def response(resp) -> EngineResults:
"""Parse out the result items from the response. In this example we parse the
response from `api.artic.edu <https://artic.edu>`__ and filter out all
images.
"""
- results = []
+ res = EngineResults()
json_data = loads(resp.text)
+ res.add(
+ res.types.Answer(
+ answer="this is a dummy answer ..",
+ url="https://example.org",
+ )
+ )
+
for result in json_data['data']:
if not result['image_id']:
continue
- results.append(
+ res.append(
{
'url': 'https://artic.edu/artworks/%(id)s' % result,
'title': result['title'] + " (%(date_display)s) // %(artist_display)s" % result,
@@ -95,4 +103,4 @@ def response(resp):
}
)
- return results
+ return res