Functions
	iterate (iterable)
	is_iterable (obj)
	parse (query)
	do_query (data, q)
	query (data, query_string)
	request (query, params)
	identity (arg)
	extract_response_info (result)
	response (resp)

Variables
	search_url = None
str	lang_all = 'en'
list	no_result_for_http_status = []
int	soft_max_redirects = 0
str	method = 'GET'
str	request_body = ''
dict	cookies = {}
dict	headers = {}
bool	paging = False
int	page_size = 1
int	first_page_num = 1
str	results_query = ''
	url_query = None
str	url_prefix = ""
	title_query = None
	content_query = None
bool	thumbnail_query = False
str	thumbnail_prefix = ''
str	suggestion_query = ''
bool	title_html_to_text = False
bool	content_html_to_text = False
bool	time_range_support = False
str	time_range_url = '&hours={time_range_val}'
dict	time_range_map
bool	safe_search_support = False
dict	safe_search_map = {0: '&filter=none', 1: '&filter=moderate', 2: '&filter=strict'}

Detailed Description

The JSON engine is a *generic* engine with which it is possible to configure
engines in the settings.

Configuration
=============

Request:

- :py:obj:`search_url`
- :py:obj:`lang_all`
- :py:obj:`soft_max_redirects`
- :py:obj:`method`
- :py:obj:`request_body`
- :py:obj:`cookies`
- :py:obj:`headers`

Paging:

- :py:obj:`paging`
- :py:obj:`page_size`
- :py:obj:`first_page_num`

Time Range:

- :py:obj:`time_range_support`
- :py:obj:`time_range_url`
- :py:obj:`time_range_map`

Safe-Search:

- :py:obj:`safe_search_support`
- :py:obj:`safe_search_map`

Response:

- :py:obj:`title_html_to_text`
- :py:obj:`content_html_to_text`
- :py:obj:`no_result_for_http_status`

JSON query:

- :py:obj:`results_query`
- :py:obj:`url_query`
- :py:obj:`url_prefix`
- :py:obj:`title_query`
- :py:obj:`content_query`
- :py:obj:`thumbnail_query`
- :py:obj:`thumbnail_prefix`
- :py:obj:`suggestion_query`


Example
=======

Here is a simple example of a JSON engine configure in the :ref:`settings
engines` section, further read :ref:`engines-dev`.

.. code:: yaml

  - name : mdn
    engine : json_engine
    paging : True
    search_url : https://developer.mozilla.org/api/v1/search?q={query}&page={pageno}
    results_query : documents
    url_query : mdn_url
    url_prefix : https://developer.mozilla.org
    title_query : title
    content_query : summary

Implementations
===============

Function Documentation

◆ do_query()

searx.engines.json_engine.do_query	(		data,
			q )

Definition at line 281 of file json_engine.py.

def do_query(data, q):  # pylint: disable=invalid-name
    ret = []
    if not q:
        return ret
 
    qkey = q[0]
 
    for key, value in iterate(data):
 
        if len(q) == 1:
            if key == qkey:
                ret.append(value)
            elif is_iterable(value):
                ret.extend(do_query(value, q))
        else:
            if not is_iterable(value):
                continue
            if key == qkey:
                ret.extend(do_query(value, q[1:]))
            else:
                ret.extend(do_query(value, q))
    return ret
 
 

References do_query(), is_iterable(), and iterate().

Referenced by do_query(), and query().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ extract_response_info()

searx.engines.json_engine.extract_response_info ( result )

Definition at line 355 of file json_engine.py.

def extract_response_info(result):
    title_filter = html_to_text if title_html_to_text else identity
    content_filter = html_to_text if content_html_to_text else identity
 
    tmp_result = {}
 
    try:
        url = query(result, url_query)[0]
        tmp_result['url'] = url_prefix + to_string(url)
 
        title = query(result, title_query)[0]
        tmp_result['title'] = title_filter(to_string(title))
    except:  # pylint: disable=bare-except
        return None
 
    try:
        content = query(result, content_query)[0]
        tmp_result['content'] = content_filter(to_string(content))
    except:  # pylint: disable=bare-except
        tmp_result['content'] = ""
 
    try:
        if thumbnail_query:
            thumbnail_query_result = query(result, thumbnail_query)[0]
            tmp_result['thumbnail'] = thumbnail_prefix + to_string(thumbnail_query_result)
    except:  # pylint: disable=bare-except
        pass
 
    return tmp_result
 
 

Referenced by response().

Here is the caller graph for this function:

◆ identity()

searx.engines.json_engine.identity ( arg )

Definition at line 351 of file json_engine.py.

def identity(arg):
    return arg

◆ is_iterable()

searx.engines.json_engine.is_iterable ( obj )

Definition at line 266 of file json_engine.py.

def is_iterable(obj):
    if isinstance(obj, str):
        return False
    return isinstance(obj, Iterable)
 
 

Referenced by do_query().

Here is the caller graph for this function:

◆ iterate()

searx.engines.json_engine.iterate ( iterable )

Definition at line 256 of file json_engine.py.

def iterate(iterable):
    if isinstance(iterable, dict):
        items = iterable.items()
 
    else:
        items = enumerate(iterable)
    for index, value in items:
        yield str(index), value
 
 

Referenced by do_query().

Here is the caller graph for this function:

◆ parse()

searx.engines.json_engine.parse ( query )

Definition at line 272 of file json_engine.py.

def parse(query):  # pylint: disable=redefined-outer-name
    q = []  # pylint: disable=invalid-name
    for part in query.split('/'):
        if part == '':
            continue
        q.append(part)
    return q
 
 

Referenced by query().

Here is the caller graph for this function:

◆ query()

searx.engines.json_engine.query	(		data,
			query_string )

Definition at line 305 of file json_engine.py.

def query(data, query_string):
    q = parse(query_string)
 
    return do_query(data, q)

References do_query(), and parse().

Here is the call graph for this function:

◆ request()

searx.engines.json_engine.request	(		query,
			params )

Build request parameters (see :ref:`engine request`).

Definition at line 311 of file json_engine.py.

def request(query, params):  # pylint: disable=redefined-outer-name
    '''Build request parameters (see :ref:`engine request`).'''
    lang = lang_all
    if params['language'] != 'all':
        lang = params['language'][:2]
 
    time_range = ''
    if params.get('time_range'):
        time_range_val = time_range_map.get(params.get('time_range'))
        time_range = time_range_url.format(time_range_val=time_range_val)
 
    safe_search = ''
    if params['safesearch']:
        safe_search = safe_search_map[params['safesearch']]
 
    fp = {  # pylint: disable=invalid-name
        'query': urlencode({'q': query})[2:],
        'lang': lang,
        'pageno': (params['pageno'] - 1) * page_size + first_page_num,
        'time_range': time_range,
        'safe_search': safe_search,
    }
 
    params['cookies'].update(cookies)
    params['headers'].update(headers)
 
    params['url'] = search_url.format(**fp)
    params['method'] = method
 
    if request_body:
        # don't url-encode the query if it's in the request body
        fp['query'] = query
        params['data'] = request_body.format(**fp)
 
    params['soft_max_redirects'] = soft_max_redirects
    params['raise_for_httperror'] = False
 
    return params
 
 

◆ response()

searx.engines.json_engine.response ( resp )

Scrap *results* from the response (see :ref:`result types`).

Definition at line 386 of file json_engine.py.

def response(resp):
    '''Scrap *results* from the response (see :ref:`result types`).'''
    results = []
 
    if no_result_for_http_status and resp.status_code in no_result_for_http_status:
        return results
 
    raise_for_httperror(resp)
 
    if not resp.text:
        return results
 
    json = loads(resp.text)
    is_onion = 'onions' in categories
 
    if results_query:
        rs = query(json, results_query)  # pylint: disable=invalid-name
        if not rs:
            return results
        rs = rs[0]  # pylint: disable=invalid-name
    else:
        rs = json  # pylint: disable=invalid-name
 
    for result in rs:
        tmp_result = extract_response_info(result)
        if not tmp_result:
            continue
 
        if is_onion:
            tmp_result['is_onion'] = True
 
        results.append(tmp_result)
 
    if not suggestion_query:
        return results
    for suggestion in query(json, suggestion_query):
        results.append({'suggestion': suggestion})
    return results

References extract_response_info().

Here is the call graph for this function:

Variable Documentation

◆ content_html_to_text

bool searx.engines.json_engine.content_html_to_text = False

Definition at line 205 of file json_engine.py.

◆ content_query

searx.engines.json_engine.content_query = None

Definition at line 190 of file json_engine.py.

◆ cookies

dict searx.engines.json_engine.cookies = {}

Definition at line 154 of file json_engine.py.

◆ first_page_num

int searx.engines.json_engine.first_page_num = 1

Definition at line 169 of file json_engine.py.

◆ headers

dict searx.engines.json_engine.headers = {}

Definition at line 158 of file json_engine.py.

◆ lang_all

str searx.engines.json_engine.lang_all = 'en'

Definition at line 115 of file json_engine.py.

◆ method

str searx.engines.json_engine.method = 'GET'

Definition at line 131 of file json_engine.py.

◆ no_result_for_http_status

list searx.engines.json_engine.no_result_for_http_status = []

Definition at line 120 of file json_engine.py.

◆ page_size

int searx.engines.json_engine.page_size = 1

Definition at line 165 of file json_engine.py.

◆ paging

bool searx.engines.json_engine.paging = False

Definition at line 162 of file json_engine.py.

◆ request_body

str searx.engines.json_engine.request_body = ''

Definition at line 134 of file json_engine.py.

◆ results_query

str searx.engines.json_engine.results_query = ''

Definition at line 172 of file json_engine.py.

◆ safe_search_map

dict searx.engines.json_engine.safe_search_map = {0: '&filter=none', 1: '&filter=moderate', 2: '&filter=strict'}

Definition at line 242 of file json_engine.py.

◆ safe_search_support

bool searx.engines.json_engine.safe_search_support = False

Definition at line 239 of file json_engine.py.

◆ search_url

searx.engines.json_engine.search_url = None

Definition at line 82 of file json_engine.py.

◆ soft_max_redirects

int searx.engines.json_engine.soft_max_redirects = 0

Definition at line 128 of file json_engine.py.

◆ suggestion_query

str searx.engines.json_engine.suggestion_query = ''

Definition at line 199 of file json_engine.py.

◆ thumbnail_prefix

str searx.engines.json_engine.thumbnail_prefix = ''

Definition at line 196 of file json_engine.py.

◆ thumbnail_query

bool searx.engines.json_engine.thumbnail_query = False

Definition at line 193 of file json_engine.py.

◆ time_range_map

dict searx.engines.json_engine.time_range_map

Initial value:

=  {
    'day': 24,
    'week': 24 * 7,
    'month': 24 * 30,
    'year': 24 * 365,
}

Definition at line 221 of file json_engine.py.

◆ time_range_support

bool searx.engines.json_engine.time_range_support = False

Definition at line 208 of file json_engine.py.

◆ time_range_url

str searx.engines.json_engine.time_range_url = '&hours={time_range_val}'

Definition at line 211 of file json_engine.py.

◆ title_html_to_text

bool searx.engines.json_engine.title_html_to_text = False

Definition at line 202 of file json_engine.py.

◆ title_query

searx.engines.json_engine.title_query = None

Definition at line 187 of file json_engine.py.

◆ url_prefix

str searx.engines.json_engine.url_prefix = ""

Definition at line 184 of file json_engine.py.

◆ url_query

searx.engines.json_engine.url_query = None

Definition at line 181 of file json_engine.py.

Functions

Variables

Detailed Description

Function Documentation

◆ do_query()

◆ extract_response_info()

◆ identity()

◆ is_iterable()

◆ iterate()

◆ parse()

◆ query()

◆ request()

◆ response()

Variable Documentation

◆ content_html_to_text

◆ content_query

◆ cookies

◆ first_page_num

◆ headers

◆ lang_all

◆ method

◆ no_result_for_http_status

◆ page_size

◆ paging

◆ request_body

◆ results_query

◆ safe_search_map

◆ safe_search_support

◆ search_url

◆ soft_max_redirects

◆ suggestion_query

◆ thumbnail_prefix

◆ thumbnail_query

◆ time_range_map

◆ time_range_support

◆ time_range_url

◆ title_html_to_text

◆ title_query

◆ url_prefix

◆ url_query