mirror of
https://github.com/searxng/searxng.git
synced 2025-11-03 19:17:07 -05:00
36a1ef1239
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>
117 lines
1.9 KiB
ReStructuredText
117 lines
1.9 KiB
ReStructuredText
.. _engine implementations:
|
|
|
|
======================
|
|
Engine Implementations
|
|
======================
|
|
|
|
.. contents::
|
|
:depth: 2
|
|
:local:
|
|
:backlinks: entry
|
|
|
|
|
|
.. toctree::
|
|
:caption: Framework Components
|
|
:maxdepth: 2
|
|
|
|
enginelib
|
|
engines
|
|
engine_overview
|
|
|
|
|
|
ResultList and engines
|
|
======================
|
|
|
|
.. autoclass:: searx.result_types.ResultList
|
|
|
|
.. autoclass:: searx.result_types.EngineResults
|
|
|
|
|
|
Engine Types
|
|
============
|
|
|
|
The :py:obj:`engine_type <searx.enginelib.Engine.engine_type>` of an engine
|
|
determines which :ref:`search processor <searx.search.processors>` is used by
|
|
the engine.
|
|
|
|
In this section a list of the engines that are documented is given, a complete
|
|
list of the engines can be found in the source under: :origin:`searx/engines`.
|
|
|
|
.. _online engines:
|
|
|
|
Online Engines
|
|
--------------
|
|
|
|
.. sidebar:: info
|
|
|
|
- :py:obj:`processors.online <searx.search.processors.online>`
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
demo/demo_online
|
|
xpath
|
|
mediawiki
|
|
json_engine
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
online/*
|
|
|
|
.. _offline engines:
|
|
|
|
Offline Engines
|
|
---------------
|
|
|
|
.. sidebar:: info
|
|
|
|
- :py:obj:`processors.offline <searx.search.processors.offline>`
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
offline_concept
|
|
demo/demo_offline
|
|
offline/*
|
|
|
|
.. _online url search:
|
|
|
|
Online URL Search
|
|
-----------------
|
|
|
|
.. sidebar:: info
|
|
|
|
- :py:obj:`processors.online_url_search <searx.search.processors.online_url_search>`
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
online_url_search/*
|
|
|
|
.. _online currency:
|
|
|
|
Online Currency
|
|
---------------
|
|
|
|
.. sidebar:: info
|
|
|
|
- :py:obj:`processors.online_currency <searx.search.processors.online_currency>`
|
|
|
|
*no engine of this type is documented yet / coming soon*
|
|
|
|
.. _online dictionary:
|
|
|
|
Online Dictionary
|
|
-----------------
|
|
|
|
.. sidebar:: info
|
|
|
|
- :py:obj:`processors.online_dictionary <searx.search.processors.online_dictionary>`
|
|
|
|
*no engine of this type is documented yet / coming soon*
|