.oO SearXNG Developer Documentation Oo.
|
Functions | |
bool | setup (dict[str, t.Any] engine_settings) |
bool | init (dict[str, t.Any] engine_settings) |
EngineResults | search (str query, "RequestParams" params) |
Variables | |
str | engine_type = "offline" |
list | categories = ["general"] |
bool | disabled = True |
float | timeout = 2.0 |
dict | about |
str | _my_offline_engine = "" |
Within this module we implement a *demo offline engine*. Do not look to close to the implementation, its just a simple example. Configuration ============= To get in use of this *demo* engine add the following entry to your engines list in ``settings.yml``: .. code:: yaml - name: my offline engine engine: demo_offline shortcut: demo disabled: false Implementations ===============
bool searx.engines.demo_offline.init | ( | dict[str, t.Any] | engine_settings | ) |
Initialization of the engine. For more details see :py:obj:`searx.enginelib.Engine.init`.
Definition at line 77 of file demo_offline.py.
EngineResults searx.engines.demo_offline.search | ( | str | query, |
"RequestParams" | params ) |
Query (offline) engine and return results. Assemble the list of results from your local engine. In this demo engine we ignore the 'query' term, usual you would pass the 'query' term to your local engine to filter out the results.
Definition at line 85 of file demo_offline.py.
bool searx.engines.demo_offline.setup | ( | dict[str, t.Any] | engine_settings | ) |
Dynamic setup of the engine settings. The origin of this demo engine is a simple json string which is loaded in this example while the engine is initialized. For more details see :py:obj:`searx.enginelib.Engine.setup`.
Definition at line 54 of file demo_offline.py.
|
protected |
Definition at line 47 of file demo_offline.py.
dict searx.engines.demo_offline.about |
Definition at line 38 of file demo_offline.py.
list searx.engines.demo_offline.categories = ["general"] |
Definition at line 34 of file demo_offline.py.
bool searx.engines.demo_offline.disabled = True |
Definition at line 35 of file demo_offline.py.
str searx.engines.demo_offline.engine_type = "offline" |
Definition at line 33 of file demo_offline.py.
float searx.engines.demo_offline.timeout = 2.0 |
Definition at line 36 of file demo_offline.py.