.oO SearXNG Developer Documentation Oo.
Loading...
Searching...
No Matches
Static Public Attributes | List of all members
searx.enginelib.Engine Class Reference
+ Collaboration diagram for searx.enginelib.Engine:

Static Public Attributes

str engine_type
 
bool paging
 
bool time_range_support
 
bool safesearch
 
bool language_support
 
str language
 
str region
 
Callable fetch_traits
 
traits traits .EngineTraits
 
List categories [str]
 
str name
 
str engine
 
bool enable_http
 
str shortcut
 
float timeout
 
bool display_error_messages
 
dict proxies
 
bool disabled
 
bool inactive
 
dict about
 
bool using_tor_proxy
 
bool send_accept_language_header
 
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 22 of file __init__.py.

Member Data Documentation

◆ about

dict searx.enginelib.Engine.about
static

Definition at line 120 of file __init__.py.

◆ categories

List searx.enginelib.Engine.categories [str]
static

Definition at line 79 of file __init__.py.

◆ disabled

bool searx.enginelib.Engine.disabled
static

Definition at line 113 of file __init__.py.

Referenced by searx.preferences.BooleanChoices.save().

◆ display_error_messages

bool searx.enginelib.Engine.display_error_messages
static

Definition at line 100 of file __init__.py.

◆ enable_http

bool searx.enginelib.Engine.enable_http
static

Definition at line 91 of file __init__.py.

Referenced by searx.network.network.Network.get_client().

◆ engine

str searx.enginelib.Engine.engine
static

Definition at line 86 of file __init__.py.

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

◆ engine_type

str searx.enginelib.Engine.engine_type
static

Definition at line 34 of file __init__.py.

◆ fetch_traits

Callable searx.enginelib.Engine.fetch_traits
static

Definition at line 71 of file __init__.py.

◆ inactive

bool searx.enginelib.Engine.inactive
static

Definition at line 117 of file __init__.py.

◆ language

str searx.enginelib.Engine.language
static

Definition at line 49 of file __init__.py.

Referenced by searx.engines.wikidata.WDArticle.get_label(), searx.engines.wikidata.WDArticle.get_select(), searx.engines.wikidata.WDArticle.get_str(), and searx.engines.wikidata.WDArticle.get_where().

◆ language_support

bool searx.enginelib.Engine.language_support
static

Definition at line 46 of file __init__.py.

◆ name

str searx.enginelib.Engine.name
static

Definition at line 82 of file __init__.py.

Referenced by searx.search.models.EngineRef.__eq__(), searx.search.models.EngineRef.__hash__(), searx.engines.wikidata.WDAttribute.__repr__(), searx.search.models.EngineRef.__repr__(), searx.engines.wikidata.WDGeoAttribute.get_geo_url(), searx.engines.wikidata.WDAttribute.get_label(), searx.engines.wikidata.WDAttribute.get_select(), searx.engines.wikidata.WDAttribute.get_str(), searx.engines.wikidata.WDAmountAttribute.get_str(), searx.engines.wikidata.WDLabelAttribute.get_str(), searx.engines.wikidata.WDURLAttribute.get_str(), searx.engines.wikidata.WDGeoAttribute.get_str(), searx.engines.wikidata.WDDateAttribute.get_str(), searx.engines.wikidata.WDAttribute.get_where(), searx.engines.wikidata.WDAmountAttribute.get_where(), searx.engines.wikidata.WDLabelAttribute.get_where(), searx.engines.wikidata.WDGeoAttribute.get_where(), searx.engines.wikidata.WDDateAttribute.get_where(), searx.engines.wikidata.WDLabelAttribute.get_wikibase_label(), and searx.preferences.BooleanChoices.save().

◆ paging

bool searx.enginelib.Engine.paging
static

Definition at line 37 of file __init__.py.

◆ proxies

dict searx.enginelib.Engine.proxies
static

Definition at line 103 of file __init__.py.

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

◆ region

str searx.enginelib.Engine.region
static

Definition at line 60 of file __init__.py.

◆ safesearch

bool searx.enginelib.Engine.safesearch
static

Definition at line 43 of file __init__.py.

Referenced by searx.search.models.SearchQuery.__copy__(), searx.search.models.SearchQuery.__eq__(), searx.search.models.SearchQuery.__hash__(), and searx.search.models.SearchQuery.__repr__().

◆ send_accept_language_header

bool searx.enginelib.Engine.send_accept_language_header
static

Definition at line 137 of file __init__.py.

◆ shortcut

str searx.enginelib.Engine.shortcut
static

Definition at line 94 of file __init__.py.

◆ time_range_support

bool searx.enginelib.Engine.time_range_support
static

Definition at line 40 of file __init__.py.

◆ timeout

float searx.enginelib.Engine.timeout
static

Definition at line 97 of file __init__.py.

◆ tokens

List searx.enginelib.Engine.tokens [str]
static

Definition at line 142 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

traits searx.enginelib.Engine.traits .EngineTraits
static

Definition at line 74 of file __init__.py.

◆ using_tor_proxy

bool searx.enginelib.Engine.using_tor_proxy
static

Definition at line 134 of file __init__.py.

Referenced by searx.network.network.Network.get_client().

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