|
.oO SearXNG Developer Documentation Oo.
|
::1337x More...
Namespaces | |
| namespace | 1337x |
| namespace | 360search |
| namespace | 360search_videos |
| namespace | 9gag |
| namespace | acfun |
| namespace | adobe_stock |
| namespace | ahmia |
| namespace | alpinelinux |
| namespace | annas_archive |
| namespace | ansa |
| namespace | apkmirror |
| namespace | apple_app_store |
| namespace | apple_maps |
| namespace | archlinux |
| namespace | artic |
| namespace | arxiv |
| namespace | ask |
| namespace | astrophysics_data_system |
| namespace | baidu |
| namespace | bandcamp |
| namespace | base |
| namespace | bilibili |
| namespace | bing |
| namespace | bing_images |
| namespace | bing_news |
| namespace | bing_videos |
| namespace | bitchute |
| namespace | bpb |
| namespace | brave |
| namespace | bt4g |
| namespace | btdigg |
| namespace | ccc_media |
| namespace | chefkoch |
| namespace | chinaso |
| namespace | cloudflareai |
| namespace | command |
| namespace | core |
| namespace | cppreference |
| namespace | crates |
| namespace | crossref |
| namespace | currency_convert |
| namespace | dailymotion |
| namespace | deepl |
| namespace | deezer |
| namespace | demo_offline |
| namespace | demo_online |
| namespace | destatis |
| namespace | deviantart |
| namespace | dictzone |
| namespace | digbt |
| namespace | discourse |
| namespace | docker_hub |
| namespace | doku |
| namespace | duckduckgo |
| namespace | duckduckgo_definitions |
| namespace | duckduckgo_extra |
| namespace | duckduckgo_weather |
| namespace | duden |
| namespace | dummy |
| -offline | |
| namespace | dummy-offline |
| namespace | ebay |
| namespace | elasticsearch |
| namespace | emojipedia |
| namespace | fdroid |
| namespace | findthatmeme |
| namespace | flickr |
| namespace | flickr_noapi |
| namespace | freesound |
| namespace | frinkiac |
| namespace | fyyd |
| namespace | geizhals |
| namespace | genius |
| namespace | gitea |
| namespace | github |
| namespace | github_code |
| namespace | gitlab |
| namespace | goodreads |
| namespace | |
| namespace | google_images |
| namespace | google_news |
| namespace | google_play |
| namespace | google_scholar |
| namespace | google_videos |
| namespace | hackernews |
| namespace | hex |
| namespace | huggingface |
| namespace | il_post |
| namespace | imdb |
| namespace | imgur |
| namespace | ina |
| namespace | invidious |
| namespace | ipernity |
| namespace | iqiyi |
| namespace | jisho |
| namespace | json_engine |
| namespace | kickass |
| namespace | lemmy |
| namespace | lib_rs |
| namespace | libretranslate |
| namespace | lingva |
| namespace | livespace |
| namespace | loc |
| namespace | marginalia |
| namespace | mariadb_server |
| namespace | mastodon |
| namespace | material_icons |
| namespace | mediathekviewweb |
| namespace | mediawiki |
| namespace | meilisearch |
| namespace | metacpan |
| namespace | microsoft_learn |
| namespace | mixcloud |
| namespace | mojeek |
| namespace | mongodb |
| namespace | moviepilot |
| namespace | mozhi |
| namespace | mrs |
| namespace | mullvad_leta |
| namespace | mwmbl |
| namespace | mysql_server |
| namespace | naver |
| namespace | niconico |
| namespace | npm |
| namespace | nyaa |
| namespace | odysee |
| namespace | ollama |
| namespace | open_meteo |
| namespace | openalex |
| namespace | openclipart |
| namespace | openlibrary |
| namespace | opensemantic |
| namespace | openstreetmap |
| namespace | openverse |
| namespace | pdbe |
| namespace | peertube |
| namespace | photon |
| namespace | |
| namespace | piped |
| namespace | piratebay |
| namespace | pixabay |
| namespace | pixiv |
| namespace | pkg_go_dev |
| namespace | podcastindex |
| namespace | postgresql |
| namespace | presearch |
| namespace | public_domain_image_archive |
| namespace | pubmed |
| namespace | pypi |
| namespace | quark |
| namespace | qwant |
| namespace | radio_browser |
| namespace | recoll |
| namespace | |
| namespace | repology |
| namespace | reuters |
| namespace | rottentomatoes |
| namespace | rumble |
| namespace | scanr_structures |
| namespace | searchcode_code |
| namespace | searx_engine |
| namespace | seekr |
| namespace | selfhst |
| namespace | semantic_scholar |
| namespace | senscritique |
| namespace | sepiasearch |
| namespace | seznam |
| namespace | sogou |
| namespace | sogou_images |
| namespace | sogou_videos |
| namespace | sogou_wechat |
| namespace | solidtorrents |
| namespace | solr |
| namespace | soundcloud |
| namespace | spotify |
| namespace | springer |
| namespace | sqlite |
| namespace | stackexchange |
| namespace | startpage |
| namespace | steam |
| namespace | stract |
| namespace | svgrepo |
| namespace | tagesschau |
| namespace | tineye |
| namespace | tokyotoshokan |
| namespace | tootfinder |
| namespace | torznab |
| namespace | translated |
| namespace | tubearchivist |
| namespace | unsplash |
| namespace | uxwing |
| namespace | valkey_server |
| namespace | vimeo |
| namespace | voidlinux |
| namespace | wallhaven |
| namespace | wikicommons |
| namespace | wikidata |
| namespace | wikipedia |
| namespace | wolframalpha_api |
| namespace | wolframalpha_noapi |
| namespace | wordnik |
| namespace | wttr |
| namespace | www1x |
| namespace | xpath |
| namespace | yacy |
| namespace | yahoo |
| namespace | yahoo_news |
| namespace | yandex |
| namespace | yandex_music |
| namespace | yep |
| namespace | youtube_api |
| namespace | youtube_noapi |
| namespace | zlibrary |
Functions | |
| check_engine_module (types.ModuleType module) | |
| "Engine | types.ModuleType | None" | load_engine (dict[str, t.Any] engine_data) |
| set_loggers ("Engine|types.ModuleType" engine, str engine_name) | |
| update_engine_attributes ("Engine | types.ModuleType" engine, dict[str, t.Any] engine_data) | |
| update_attributes_for_tor ("Engine | types.ModuleType" engine) | |
| is_missing_required_attributes ("Engine | types.ModuleType" engine) | |
| using_tor_proxy ("Engine | types.ModuleType" engine) | |
| is_engine_active ("Engine | types.ModuleType" engine) | |
| bool | call_engine_setup ("Engine | types.ModuleType" engine, dict[str, t.Any] engine_data) |
| register_engine ("Engine | types.ModuleType" engine) | |
| load_engines (list[dict[str, t.Any]] engine_list) | |
Variables | |
| logger = logger.getChild('engines') | |
| ENGINE_DIR = dirname(realpath(__file__)) | |
| dict | ENGINE_DEFAULT_ARGS |
| str | DEFAULT_CATEGORY = 'other' |
| dict | categories = {'general': []} |
| dict | engines = {} |
| dict | engine_shortcuts = {} |
::1337x
::9gag
::360search_videos
::360search
1337x
360Search search engine for searxng
360Search-Videos: A search engine for retrieving videos from 360Search.
9GAG (social media)
Load and initialize the ``engines``, see :py:func:`load_engines` and register
:py:obj:`engine_shortcuts`.
usage::
load_engines( settings['engines'] )
| bool searx.engines.call_engine_setup | ( | "Engine | types.ModuleType" | engine, |
| dict[str, t.Any] | engine_data ) |
Definition at line 232 of file __init__.py.
Referenced by load_engine().
| searx.engines.check_engine_module | ( | types.ModuleType | module | ) |
Definition at line 69 of file __init__.py.
Referenced by load_engine().
| searx.engines.is_engine_active | ( | "Engine | types.ModuleType" | engine | ) |
Definition at line 220 of file __init__.py.
References using_tor_proxy().
Referenced by load_engine().
| searx.engines.is_missing_required_attributes | ( | "Engine | types.ModuleType" | engine | ) |
An attribute is required when its name doesn't start with ``_`` (underline). Required attributes must not be ``None``.
Definition at line 202 of file __init__.py.
Referenced by load_engine().
| "Engine | types.ModuleType | None" searx.engines.load_engine | ( | dict[str, t.Any] | engine_data | ) |
Load engine from ``engine_data``. :param dict engine_data: Attributes from YAML ``settings:engines/<engine>`` :return: initialized namespace of the ``<engine>``. 1. create a namespace and load module of the ``<engine>`` 2. update namespace with the defaults from :py:obj:`ENGINE_DEFAULT_ARGS` 3. update namespace with values from ``engine_data`` If engine *is active*, return namespace of the engine, otherwise return ``None``. This function also returns ``None`` if initialization of the namespace fails for one of the following reasons: - engine name contains underscore - engine name is not lowercase - required attribute is not set :py:func:`is_missing_required_attributes`
Definition at line 81 of file __init__.py.
References call_engine_setup(), check_engine_module(), is_engine_active(), is_missing_required_attributes(), set_loggers(), update_attributes_for_tor(), and update_engine_attributes().
Referenced by load_engines().
| searx.engines.load_engines | ( | list[dict[str, t.Any]] | engine_list | ) |
usage: ``engine_list = settings['engines']``
Definition at line 266 of file __init__.py.
References load_engine(), and register_engine().
| searx.engines.register_engine | ( | "Engine | types.ModuleType" | engine | ) |
Definition at line 251 of file __init__.py.
Referenced by load_engines().
| searx.engines.set_loggers | ( | "Engine|types.ModuleType" | engine, |
| str | engine_name ) |
Definition at line 159 of file __init__.py.
Referenced by load_engine().
| searx.engines.update_attributes_for_tor | ( | "Engine | types.ModuleType" | engine | ) |
Definition at line 196 of file __init__.py.
References using_tor_proxy().
Referenced by load_engine().
| searx.engines.update_engine_attributes | ( | "Engine | types.ModuleType" | engine, |
| dict[str, t.Any] | engine_data ) |
Definition at line 178 of file __init__.py.
Referenced by load_engine().
| searx.engines.using_tor_proxy | ( | "Engine | types.ModuleType" | engine | ) |
Return True if the engine configuration declares to use Tor.
Definition at line 215 of file __init__.py.
Referenced by is_engine_active(), and update_attributes_for_tor().
| dict searx.engines.categories = {'general': []} |
Definition at line 53 of file __init__.py.
| str searx.engines.DEFAULT_CATEGORY = 'other' |
Definition at line 51 of file __init__.py.
| dict searx.engines.ENGINE_DEFAULT_ARGS |
Definition at line 30 of file __init__.py.
| searx.engines.ENGINE_DIR = dirname(realpath(__file__)) |
Definition at line 27 of file __init__.py.
| dict searx.engines.engine_shortcuts = {} |
Definition at line 58 of file __init__.py.
| dict searx.engines.engines = {} |
Definition at line 55 of file __init__.py.
| searx.engines.logger = logger.getChild('engines') |
Definition at line 26 of file __init__.py.