searx.enginelib.Engine Class Reference

Inheritance diagram for searx.enginelib.Engine:

Collaboration diagram for searx.enginelib.Engine:

Public Member Functions
None	init (self, dict[str, t.Any] engine_settings)
None	request (self, str query, dict[str, t.Any] params)
"EngineResults"	response (self, "SXNG_Response" resp)

Static Public Attributes
logging	logger .Logger
str	fetch_traits : "Callable[[EngineTraits, bool], None]"
str	traits : "traits.EngineTraits"
list	categories [str]
dict	proxies [str, dict[str, str]]
dict	about [str, dict[str, str]]
list	tokens [str]

Detailed Description

Class of engine instances build from YAML settings.

Further documentation see :ref:`general engine configuration`.

.. hint::

   This class is currently never initialized and only used for type hinting.

Definition at line 178 of file __init__.py.

Member Function Documentation

init()

None searx.enginelib.Engine.init	(		self,
		dict[str, t.Any]	engine_settings )

Initialization of the engine. If no initialization is needed, drop
this init function.

Definition at line 307 of file __init__.py.

    def init(self, engine_settings: dict[str, t.Any]) -> None:  # pyright: ignore[reportUnusedParameter]
        """Initialization of the engine. If no initialization is needed, drop
        this init function."""
 

Referenced by searx.sqlitedb.SQLiteAppl.connect(), and searx.sqlitedb.SQLiteAppl.DB().

Here is the caller graph for this function:

request()

None searx.enginelib.Engine.request	(		self,
		str	query,
		dict[str, t.Any]	params )

Build up the params for the online request.

Definition at line 312 of file __init__.py.

    def request(self, query: str, params: dict[str, t.Any]) -> None:
        """Build up the params for the online request."""
 

response()

"EngineResults" searx.enginelib.Engine.response	(		self,
		"SXNG_Response"	resp )

Parse out the result items from the response.

Definition at line 316 of file __init__.py.

    def response(self, resp: "SXNG_Response") -> "EngineResults":
        """Parse out the result items from the response."""

Member Data Documentation

about

dict searx.enginelib.Engine.about [str, dict[str, str]]

static

Definition at line 278 of file __init__.py.

categories

list searx.enginelib.Engine.categories [str]

static

Definition at line 237 of file __init__.py.

fetch_traits

str searx.enginelib.Engine.fetch_traits : "Callable[[EngineTraits, bool], None]"

static

Definition at line 229 of file __init__.py.

logger

logging searx.enginelib.Engine.logger .Logger

static

Definition at line 188 of file __init__.py.

Referenced by searx.search.processors.online.OnlineProcessor.get_params(), searx.search.processors.abstract.EngineProcessor.initialize(), and searx.search.processors.online.OnlineProcessor.search().

proxies

dict searx.enginelib.Engine.proxies [str, dict[str, str]]

static

Definition at line 261 of file __init__.py.

Referenced by searx.network.network.Network.check_parameters(), and searx.network.network.Network.iter_proxies().

tokens

list searx.enginelib.Engine.tokens [str]

static

Definition at line 300 of file __init__.py.

Referenced by searx.preferences.Preferences.get_as_url_params(), searx.preferences.Preferences.parse_dict(), searx.preferences.Preferences.parse_form(), searx.preferences.Preferences.save(), and searx.preferences.Preferences.validate_token().

traits

str searx.enginelib.Engine.traits : "traits.EngineTraits"

static

Definition at line 232 of file __init__.py.

---

The documentation for this class was generated from the following file:

• /home/andrew/Documents/code/public/searxng/searx/enginelib/__init__.py