summaryrefslogtreecommitdiff
path: root/docs/dev
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 /docs/dev
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 'docs/dev')
-rw-r--r--docs/dev/engines/index.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/dev/engines/index.rst b/docs/dev/engines/index.rst
index d0a31ab67..8491681cb 100644
--- a/docs/dev/engines/index.rst
+++ b/docs/dev/engines/index.rst
@@ -19,6 +19,14 @@ Engine Implementations
engine_overview
+ResultList and engines
+======================
+
+.. autoclass:: searx.result_types.ResultList
+
+.. autoclass:: searx.result_types.EngineResults
+
+
Engine Types
============