Functions
None	update_kwargs (**kwargs)
"SXNG_Response"	get (args, *kwargs)
"SXNG_Response"	post (args, *kwargs)
list[str]	baidu (str query, str _sxng_locale)
list[str]	brave (str query, str _sxng_locale)
list[str]	dbpedia (str query, str _sxng_locale)
list[str]	duckduckgo (str query, str sxng_locale)
list[str]	google_complete (str query, str sxng_locale)
list[str]	mwmbl (str query, str _sxng_locale)
list[str]	naver (str query, str _sxng_locale)
list[str]	qihu360search (str query, str _sxng_locale)
list[str]	quark (str query, str _sxng_locale)
list[str]	seznam (str query, str _sxng_locale)
list[str]	sogou (str query, str _sxng_locale)
list[str]	startpage (str query, str sxng_locale)
list[str]	stract (str query, str _sxng_locale)
list[str]	swisscows (str query, str _sxng_locale)
list[str]	qwant (str query, str sxng_locale)
list[str]	wikipedia (str query, str sxng_locale)
list[str]	yandex (str query, str _sxng_locale)
list[str]	search_autocomplete (str backend_name, str query, str sxng_locale)

Variables
dict	backends

Detailed Description

This module implements functions needed for the autocompleter.

Function Documentation

◆ baidu()

list[str] searx.autocomplete.baidu	(	str	query,
		str	_sxng_locale )

Definition at line 45 of file autocomplete.py.

def baidu(query: str, _sxng_locale: str) -> list[str]:
    # baidu search autocompleter
    base_url = "https://www.baidu.com/sugrec?"
    response = get(base_url + urlencode({'ie': 'utf-8', 'json': 1, 'prod': 'pc', 'wd': query}))
    results: list[str] = []
 
    if response.ok:
        data: dict[str, t.Any] = response.json()
        if 'g' in data:
            for item in data['g']:
                results.append(item['q'])
    return results
 
 

References get().

Here is the call graph for this function:

◆ brave()

list[str] searx.autocomplete.brave	(	str	query,
		str	_sxng_locale )

Definition at line 59 of file autocomplete.py.

def brave(query: str, _sxng_locale: str) -> list[str]:
    # brave search autocompleter
    url = 'https://search.brave.com/api/suggest?'
    url += urlencode({'q': query})
    country = 'all'
    kwargs = {'cookies': {'country': country}}
    resp = get(url, **kwargs)
    results: list[str] = []
 
    if resp.ok:
        data: list[list[str]] = resp.json()
        for item in data[1]:
            results.append(item)
    return results
 
 

References get().

Here is the call graph for this function:

◆ dbpedia()

list[str] searx.autocomplete.dbpedia	(	str	query,
		str	_sxng_locale )

Definition at line 75 of file autocomplete.py.

def dbpedia(query: str, _sxng_locale: str) -> list[str]:
    autocomplete_url = 'https://lookup.dbpedia.org/api/search.asmx/KeywordSearch?'
    resp = get(autocomplete_url + urlencode(dict(QueryString=query)))
    results: list[str] = []
 
    if resp.ok:
        dom = lxml.etree.fromstring(resp.content)
        results = [str(x) for x in dom.xpath('//Result/Label//text()')]
 
    return results
 
 

References get().

Here is the call graph for this function:

◆ duckduckgo()

list[str] searx.autocomplete.duckduckgo	(	str	query,
		str	sxng_locale )

Autocomplete from DuckDuckGo. Supports DuckDuckGo's languages

Definition at line 87 of file autocomplete.py.

def duckduckgo(query: str, sxng_locale: str) -> list[str]:
    """Autocomplete from DuckDuckGo. Supports DuckDuckGo's languages"""
 
    traits = engines['duckduckgo'].traits
    args: dict[str, str] = {
        'q': query,
        'kl': traits.get_region(sxng_locale, traits.all_locale),
    }
 
    url = 'https://duckduckgo.com/ac/?type=list&' + urlencode(args)
    resp = get(url)
    results: list[str] = []
 
    if resp.ok:
        j = resp.json()
        if len(j) > 1:
            results = j[1]
    return results
 
 

References get().

Here is the call graph for this function:

◆ get()

"SXNG_Response" searx.autocomplete.get	(	*	args,
		**	kwargs )

Definition at line 35 of file autocomplete.py.

def get(*args, **kwargs) -> "SXNG_Response":  # type: ignore
    update_kwargs(**kwargs)  # pyright: ignore[reportUnknownArgumentType]
    return http_get(*args, **kwargs)  # pyright: ignore[reportUnknownArgumentType]
 
 

References update_kwargs().

Referenced by baidu(), brave(), dbpedia(), duckduckgo(), google_complete(), mwmbl(), naver(), qihu360search(), quark(), qwant(), seznam(), sogou(), startpage(), swisscows(), wikipedia(), and yandex().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ google_complete()

list[str] searx.autocomplete.google_complete	(	str	query,
		str	sxng_locale )

Autocomplete from Google.  Supports Google's languages and subdomains
(:py:obj:`searx.engines.google.get_google_info`) by using the async REST
API::

    https://{subdomain}/complete/search?{args}

Definition at line 107 of file autocomplete.py.

def google_complete(query: str, sxng_locale: str) -> list[str]:
    """Autocomplete from Google.  Supports Google's languages and subdomains
    (:py:obj:`searx.engines.google.get_google_info`) by using the async REST
    API::
 
        https://{subdomain}/complete/search?{args}
 
    """
 
    google_info: dict[str, t.Any] = google.get_google_info({'searxng_locale': sxng_locale}, engines['google'].traits)
    url = 'https://{subdomain}/complete/search?{args}'
    args = urlencode(
        {
            'q': query,
            'client': 'gws-wiz',
            'hl': google_info['params']['hl'],
        }
    )
    results: list[str] = []
 
    resp = get(url.format(subdomain=google_info['subdomain'], args=args))
    if resp and resp.ok:
        json_txt = resp.text[resp.text.find('[') : resp.text.find(']', -3) + 1]
        data = json.loads(json_txt)
        for item in data[0]:
            results.append(lxml.html.fromstring(item[0]).text_content())
    return results
 
 

References get().

Here is the call graph for this function:

◆ mwmbl()

list[str] searx.autocomplete.mwmbl	(	str	query,
		str	_sxng_locale )

Autocomplete from Mwmbl_.

Definition at line 136 of file autocomplete.py.

def mwmbl(query: str, _sxng_locale: str) -> list[str]:
    """Autocomplete from Mwmbl_."""
 
    # mwmbl autocompleter
    url = 'https://api.mwmbl.org/search/complete?{query}'
 
    results: list[str] = get(url.format(query=urlencode({'q': query}))).json()[1]
 
    # results starting with `go:` are direct urls and not useful for auto completion
    return [result for result in results if not result.startswith("go: ") and not result.startswith("search: ")]

References get().

Here is the call graph for this function:

◆ naver()

list[str] searx.autocomplete.naver	(	str	query,
		str	_sxng_locale )

Definition at line 148 of file autocomplete.py.

def naver(query: str, _sxng_locale: str) -> list[str]:
    # Naver search autocompleter
    url = f"https://ac.search.naver.com/nx/ac?{urlencode({'q': query, 'r_format': 'json', 'st': 0})}"
    response = get(url)
    results: list[str] = []
 
    if response.ok:
        data: dict[str, t.Any] = response.json()
        if data.get('items'):
            for item in data['items'][0]:
                results.append(item[0])
    return results
 
 

References get().

Here is the call graph for this function:

◆ post()

"SXNG_Response" searx.autocomplete.post	(	*	args,
		**	kwargs )

Definition at line 40 of file autocomplete.py.

def post(*args, **kwargs) -> "SXNG_Response":  # type: ignore
    update_kwargs(**kwargs)  # pyright: ignore[reportUnknownArgumentType]
    return http_post(*args, **kwargs)  # pyright: ignore[reportUnknownArgumentType]
 
 

References update_kwargs().

Referenced by stract().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ qihu360search()

list[str] searx.autocomplete.qihu360search	(	str	query,
		str	_sxng_locale )

Definition at line 162 of file autocomplete.py.

def qihu360search(query: str, _sxng_locale: str) -> list[str]:
    # 360Search search autocompleter
    url = f"https://sug.so.360.cn/suggest?{urlencode({'format': 'json', 'word': query})}"
    response = get(url)
    results: list[str] = []
 
    if response.ok:
        data: dict[str, t.Any] = response.json()
        if 'result' in data:
            for item in data['result']:
                results.append(item['word'])
    return results
 
 

References get().

Here is the call graph for this function:

◆ quark()

list[str] searx.autocomplete.quark	(	str	query,
		str	_sxng_locale )

Definition at line 176 of file autocomplete.py.

def quark(query: str, _sxng_locale: str) -> list[str]:
    # Quark search autocompleter
    url = f"https://sugs.m.sm.cn/web?{urlencode({'q': query})}"
    response = get(url)
    results: list[str] = []
 
    if response.ok:
        data = response.json()
        for item in data.get('r', []):
            results.append(item['w'])
    return results
 
 

References get().

Here is the call graph for this function:

◆ qwant()

list[str] searx.autocomplete.qwant	(	str	query,
		str	sxng_locale )

Autocomplete from Qwant. Supports Qwant's regions.

Definition at line 292 of file autocomplete.py.

def qwant(query: str, sxng_locale: str) -> list[str]:
    """Autocomplete from Qwant. Supports Qwant's regions."""
    locale = engines['qwant'].traits.get_region(sxng_locale, 'en_US')
    url = 'https://api.qwant.com/v3/suggest?{query}'
    resp = get(url.format(query=urlencode({'q': query, 'locale': locale, 'version': '2'})))
    results: list[str] = []
 
    if resp.ok:
        data = resp.json()
        if data['status'] == 'success':
            for item in data['data']['items']:
                results.append(item['value'])
 
    return results
 
 

References get().

Here is the call graph for this function:

◆ search_autocomplete()

list[str] searx.autocomplete.search_autocomplete	(	str	backend_name,
		str	query,
		str	sxng_locale )

Definition at line 367 of file autocomplete.py.

def search_autocomplete(backend_name: str, query: str, sxng_locale: str) -> list[str]:
    backend = backends.get(backend_name)
    if backend is None:
        return []
    try:
        return backend(query, sxng_locale)
    except (HTTPError, SearxEngineResponseException):
        return []

◆ seznam()

list[str] searx.autocomplete.seznam	(	str	query,
		str	_sxng_locale )

Definition at line 189 of file autocomplete.py.

def seznam(query: str, _sxng_locale: str) -> list[str]:
    # seznam search autocompleter
    url = 'https://suggest.seznam.cz/fulltext/cs?{query}'
    resp = get(
        url.format(
            query=urlencode(
                {'phrase': query, 'cursorPosition': len(query), 'format': 'json-2', 'highlight': '1', 'count': '6'}
            )
        )
    )
    results: list[str] = []
 
    if resp.ok:
        data = resp.json()
        results = [
            ''.join([part.get('text', '') for part in item.get('text', [])])
            for item in data.get('result', [])
            if item.get('itemType', None) == 'ItemType.TEXT'
        ]
    return results
 
 

References get().

Here is the call graph for this function:

◆ sogou()

list[str] searx.autocomplete.sogou	(	str	query,
		str	_sxng_locale )

Definition at line 211 of file autocomplete.py.

def sogou(query: str, _sxng_locale: str) -> list[str]:
    # Sogou search autocompleter
    base_url = "https://sor.html5.qq.com/api/getsug?"
    resp = get(base_url + urlencode({'m': 'searxng', 'key': query}))
    results: list[str] = []
 
    if resp.ok:
        raw_json = extr(resp.text, "[", "]", default="")
        try:
            data = json.loads(f"[{raw_json}]]")
            results = data[1]
        except json.JSONDecodeError:
            pass
    return results
 
 

References get().

Here is the call graph for this function:

◆ startpage()

list[str] searx.autocomplete.startpage	(	str	query,
		str	sxng_locale )

Autocomplete from Startpage's Firefox extension.
Supports the languages specified in lang_map.

Definition at line 227 of file autocomplete.py.

def startpage(query: str, sxng_locale: str) -> list[str]:
    """Autocomplete from Startpage's Firefox extension.
    Supports the languages specified in lang_map.
    """
 
    lang_map = {
        'da': 'dansk',
        'de': 'deutsch',
        'en': 'english',
        'es': 'espanol',
        'fr': 'francais',
        'nb': 'norsk',
        'nl': 'nederlands',
        'pl': 'polski',
        'pt': 'portugues',
        'sv': 'svenska',
    }
 
    base_lang = sxng_locale.split('-')[0]
    lui = lang_map.get(base_lang, 'english')
 
    url_params = {
        'q': query,
        'format': 'opensearch',
        'segment': 'startpage.defaultffx',
        'lui': lui,
    }
    url = f'https://www.startpage.com/suggestions?{urlencode(url_params)}'
 
    # Needs user agent, returns a 204 otherwise
    h = {'User-Agent': gen_useragent()}
 
    resp = get(url, headers=h)
    results: list[str] = []
 
    if resp.ok:
        try:
            data = resp.json()
            if len(data) >= 2 and isinstance(data[1], list):
                results = data[1]
        except json.JSONDecodeError:
            pass
 
    return results
 
 

References get().

Here is the call graph for this function:

◆ stract()

list[str] searx.autocomplete.stract	(	str	query,
		str	_sxng_locale )

Definition at line 273 of file autocomplete.py.

def stract(query: str, _sxng_locale: str) -> list[str]:
    # stract autocompleter (beta)
    url = f"https://stract.com/beta/api/autosuggest?q={quote_plus(query)}"
    resp = post(url)
    results: list[str] = []
 
    if resp.ok:
        results = [html.unescape(suggestion['raw']) for suggestion in resp.json()]
 
    return results
 
 

References post().

Here is the call graph for this function:

◆ swisscows()

list[str] searx.autocomplete.swisscows	(	str	query,
		str	_sxng_locale )

Definition at line 285 of file autocomplete.py.

def swisscows(query: str, _sxng_locale: str) -> list[str]:
    # swisscows autocompleter
    url = 'https://swisscows.ch/api/suggest?{query}&itemsCount=5'
    results: list[str] = json.loads(get(url.format(query=urlencode({'query': query}))).text)
    return results
 
 

References get().

Here is the call graph for this function:

◆ update_kwargs()

None searx.autocomplete.update_kwargs ( ** kwargs )

Definition at line 29 of file autocomplete.py.

def update_kwargs(**kwargs) -> None:  # type: ignore
    if 'timeout' not in kwargs:
        kwargs['timeout'] = settings['outgoing']['request_timeout']
    kwargs['raise_for_httperror'] = True
 
 

Referenced by get(), and post().

Here is the caller graph for this function:

◆ wikipedia()

list[str] searx.autocomplete.wikipedia	(	str	query,
		str	sxng_locale )

Autocomplete from Wikipedia. Supports Wikipedia's languages (aka netloc).

Definition at line 308 of file autocomplete.py.

def wikipedia(query: str, sxng_locale: str) -> list[str]:
    """Autocomplete from Wikipedia. Supports Wikipedia's languages (aka netloc)."""
    eng_traits = engines['wikipedia'].traits
    wiki_lang = eng_traits.get_language(sxng_locale, 'en')
    wiki_netloc: str = eng_traits.custom['wiki_netloc'].get(wiki_lang, 'en.wikipedia.org')  # type: ignore
 
    args = urlencode(
        {
            'action': 'opensearch',
            'format': 'json',
            'formatversion': '2',
            'search': query,
            'namespace': '0',
            'limit': '10',
        }
    )
    resp = get(f'https://{wiki_netloc}/w/api.php?{args}')
    results: list[str] = []
 
    if resp.ok:
        data = resp.json()
        if len(data) > 1:
            results = data[1]
 
    return results
 
 

References get().

Here is the call graph for this function:

◆ yandex()

list[str] searx.autocomplete.yandex	(	str	query,
		str	_sxng_locale )

Definition at line 335 of file autocomplete.py.

def yandex(query: str, _sxng_locale: str) -> list[str]:
    # yandex autocompleter
    url = "https://suggest.yandex.com/suggest-ff.cgi?{0}"
    resp = json.loads(get(url.format(urlencode(dict(part=query)))).text)
    results: list[str] = []
 
    if len(resp) > 1:
        results = resp[1]
    return results
 
 

References get().

Here is the call graph for this function:

Variable Documentation

◆ backends

dict searx.autocomplete.backends

Initial value:

=  {
    '360search': qihu360search,
    'baidu': baidu,
    'brave': brave,
    'dbpedia': dbpedia,
    'duckduckgo': duckduckgo,
    'google': google_complete,
    'mwmbl': mwmbl,
    'naver': naver,
    'quark': quark,
    'qwant': qwant,
    'seznam': seznam,
    'sogou': sogou,
    'startpage': startpage,
    'stract': stract,
    'swisscows': swisscows,
    'wikipedia': wikipedia,
    'yandex': yandex,
}

Definition at line 346 of file autocomplete.py.

Functions

Variables

Detailed Description

Function Documentation

◆ baidu()

◆ brave()

◆ dbpedia()

◆ duckduckgo()

◆ get()

◆ google_complete()

◆ mwmbl()

◆ naver()

◆ post()

◆ qihu360search()

◆ quark()

◆ qwant()

◆ search_autocomplete()

◆ seznam()

◆ sogou()

◆ startpage()

◆ stract()

◆ swisscows()

◆ update_kwargs()

◆ wikipedia()

◆ yandex()

Variable Documentation

◆ backends