searxng/docs/dev/engines
Markus Heiser 36a1ef1239 [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>
2025-01-28 07:07:08 +01:00
..
demo [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
offline [doc] slightly improve documentation of SQL engines 2024-10-03 13:04:06 +02:00
online [feat] engine: add adobe stock video and audio engines 2024-11-24 11:56:12 +01:00
online_url_search [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
engine_overview.rst [refactor] typification of SearXNG (initial) / result items (part 1) 2025-01-28 07:07:08 +01:00
enginelib.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
engines.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
index.rst [refactor] typification of SearXNG / EngineResults 2025-01-28 07:07:08 +01:00
json_engine.rst [json_engine] document existing options 2025-01-14 14:07:35 +01:00
mediawiki.rst [mod] engine: wikimedia - improve results, add addition settings & doc 2023-08-04 19:06:50 +02:00
offline_concept.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00
xpath.rst [doc] rearranges Settings & Engines docs for better readability 2023-07-01 22:45:19 +02:00