Functions
None	init (dict[str, t.Any] engine_settings)
EngineResults	search (str query, dict[str, t.Any] params)

Variables
str	engine_type = "offline"
list	categories = ["general"]
bool	disabled = True
float	timeout = 2.0
dict	about
str	_my_offline_engine = ""

Detailed Description

Within this module we implement a *demo offline engine*.  Do not look to
close to the implementation, its just a simple example.  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

Function Documentation

◆ init()

None searx.engines.demo_offline.init ( dict[str, t.Any] engine_settings )

Initialization of the (offline) engine.  The origin of this demo engine is a
simple json string which is loaded in this example while the engine is
initialized.

Definition at line 42 of file demo_offline.py.

def init(engine_settings: dict[str, t.Any]) -> None:
    """Initialization of the (offline) engine.  The origin of this demo engine is a
    simple json string which is loaded in this example while the engine is
    initialized."""
    global _my_offline_engine, CACHE  # pylint: disable=global-statement
 
    CACHE = EngineCache(engine_settings["name"])
 
    _my_offline_engine = (
        '[ {"value": "%s"}'
        ', {"value":"first item"}'
        ', {"value":"second item"}'
        ', {"value":"third item"}'
        ']' % engine_settings.get('name')
    )
 
 

◆ search()

EngineResults searx.engines.demo_offline.search	(	str	query,
		dict[str, t.Any]	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 59 of file demo_offline.py.

def search(query: str, params: dict[str, t.Any]) -> EngineResults:
    """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.
    """
    res = EngineResults()
 
    count: int = CACHE.get("count", 0)
    data_rows: list[dict[str, str]] = json.loads(_my_offline_engine)
 
    for row in data_rows:
        count += 1
        kvmap = {
            'query': query,
            'language': params['searxng_locale'],
            'value': row.get("value"),
        }
        res.add(
            res.types.KeyValue(
                caption=f"Demo Offline Engine Result #{count}",
                key_title="Name",
                value_title="Value",
                kvmap=kvmap,
            )
        )
    res.add(res.types.LegacyResult(number_of_results=count))
 
    # cache counter value for 20sec
    CACHE.set("count", count, expire=20)
    return res

Variable Documentation

◆ _my_offline_engine

str searx.engines.demo_offline._my_offline_engine = ""

protected

Definition at line 35 of file demo_offline.py.

◆ about

dict searx.engines.demo_offline.about

Initial value:

=  {
    "wikidata_id": None,
    "official_api_documentation": None,
    "use_official_api": False,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 26 of file demo_offline.py.

◆ categories

list searx.engines.demo_offline.categories = ["general"]

Definition at line 22 of file demo_offline.py.

◆ disabled

bool searx.engines.demo_offline.disabled = True

Definition at line 23 of file demo_offline.py.

◆ engine_type

str searx.engines.demo_offline.engine_type = "offline"

Definition at line 21 of file demo_offline.py.

◆ timeout

float searx.engines.demo_offline.timeout = 2.0

Definition at line 24 of file demo_offline.py.

Functions

Variables