Result list that should be used by engine developers. For convenience, engine developers don't need to import types / see :py:obj:`ResultList.typ

Check and update a setting value

The website has returned an application error

parse raw text query (the value from the html input)

Persistent (SQLite) key/value cache that deletes its values again after ``expire`` seconds (default/max: :py:obj:`MAXHOLD_TIME <searx.cache.Ex

Reference by names to an engine and category

container for all the search parameters (query, language, etc...)

The website has returned a CAPTCHA.

Setting of a value which can only come from the given choices

Object that holds information about a *plugin*, these infos are shown to the user in the Preferences menu. To be able to translate the inform

Simple table view which maps *key* names (first col) to *values* (second col).

Base class of all result types displayed in :ref:`area main results`.

Additional fields describing the engine. .. code:: yaml about: website: https://example.com wikidata_id: Q306656

The website is blocking the access

Request description for the multi_requests function

Raised when query miss a required parameter

The class is intended to be instantiated for each engine.

Setting of values which can only come from the given choices

A family of metrics. - The ``key`` parameter is the metric name that should be used (snake case). - The ``type_hint`` parameter must be one o

Simple answer type where the *answer* is a simple string with an optional :py:obj:`url field <Result.url>` field to link a resource (article, map,

Setting of a boolean value that has to be translated in order to be storable

Setting of a value that has to be translated in order to be storable

Validates and saves preferences to cookies

In the result container, the results are collected, sorted and duplicates will be merged.

Exception to store and/or raise a message from a schema issue.

Available choices may change, so user's value may not be in choices anymore

Exption from ``cls.__init__`` when configuration value is invalid.

A wrapper around a legacy result item. The SearXNG core uses this class for untyped dictionaries / to be downward compatible. This class is

Error while getting the result of an XPath expression

Object that holds information about an answerer, these infos are shown to the user in the Preferences menu. To be able to translate the infor

Class to represent date & time. Essentially, it is a wrapper that conveniently combines :py:obj:`datetime.datetime` and :py:obj:`babel.dates.

Configuration of a :py:obj:`ExpireCache` cache.

Dataclass which provides information on the status of the cache.

Plugin settings

Internal class to extract text from HTML

Reference to an (alternative) image format

The website has returned a Too Many Request status code By default, SearXNG stops sending requests to this engine for 1 hour.

Error while loading the settings

Base class of user settings

Check and update a setting value that is a directory path

Answer type for weather data.

Aggregator for :py:obj:`BaseAnswer` items in a result container.

A storage for managing the *answerers* of SearXNG. With the :py:obj:`AnswerStorage.ask`” method, a caller can ask questions to all *answerers

Block HTTP request The constructor is blank because httpx.AsyncHTTPTransport.__init__ creates an SSLContext unconditionally: https://github.c

Fix httpx_socks.AsyncProxyTransport Map python_socks exceptions to httpx.ProxyError exceptions

Container to assemble client prefferences and settings.

Engine settings

Cache that manages key/value pairs in a SQLite DB. The DB model in the SQLite DB is implemented in abstract class :py:obj:`SQLiteAppl <searx.

Dataclass which provides information on the status of the cache.

Class of ``False`` singleton

Favicon cache in process' memory. Its just a POC that stores the favicons in the memory of the process. .. attention:: Don't use it

A dummy favicon cache that caches nothing / a fallback solution. The NullCache is used when more efficient caches such as the :py:obj:`Favicon

Favicon cache that manages the favicon BLOBs in a SQLite DB. The DB model in the SQLite DB is implemented using the abstract class :py:obj:`s

Cached rendering of the online documentation a SearXNG instance has. :param page_class: render online documentation by :py:obj:`InfoPage` parser.

A wrapper class for legacy *answerers* where the names (keywords, answer, info) are implemented on the module level (not in a class). .. note

Settings of a plugin. .. code:: yaml mypackage.mymodule.MyPlugin: active: true

A storage for managing the *plugins* of SearXNG.

Class to manage :py:obj:`EngineProcessor` instances in a key/value map (instances stored by *engine-name*).

A middleware like the ProxyFix_ class, where the ``x_for`` argument is replaced by a method that determines the number of trusted proxies via the

Base class of all result types :ref:`result types`.

Wrap the application in this middleware and configure the front-end server to add these headers, to let you quietly bind this to a URL other t

Simple class to manage properties of a DB application in the DB. The object has its own DB connection and transaction area. .. code:: sql

Error inside an engine

Base SearXNG exception.

Searx Robot Test Layer

Syntax error in a XPATH

Setting of values of type ``set`` (comma separated string)

Check the value is a sublist of type definition.

Class to handle suspend state.

Escape unicode string in :py:obj:`pprint.pformat`

Internal class for this module, do not create instance of this class. Replace the None value, allow explicitly pass None as a function argument