Functions
	iterate (iterable)

	is_iterable (obj)

	parse (query)

	do_query (data, q)

	query (data, query_string)

	request (query, params)

	identity (arg)

	response (resp)

Variables
	search_url = None

	url_query = None

str	url_prefix = ""

	content_query = None

	title_query = None

bool	content_html_to_text = False

bool	title_html_to_text = False

bool	paging = False

str	suggestion_query = ''

str	results_query = ''

dict	cookies = {}

dict	headers = {}

int	page_size = 1

int	first_page_num = 1

Detailed Description

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

.. todo::

   - The JSON engine needs documentation!!

   - The parameters of the JSON engine should be adapted to those of the XPath
     engine.

Function Documentation

◆ do_query()

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

Definition at line 70 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 searx.engines.json_engine.do_query(), searx.engines.json_engine.is_iterable(), and searx.engines.json_engine.iterate().

Referenced by searx.engines.json_engine.do_query(), and searx.engines.json_engine.query().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ identity()

searx.engines.json_engine.identity ( arg )

Definition at line 116 of file json_engine.py.

def identity(arg):
    return arg

◆ is_iterable()

searx.engines.json_engine.is_iterable ( obj )

Definition at line 55 of file json_engine.py.

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

Referenced by searx.engines.json_engine.do_query().

Here is the caller graph for this function:

◆ iterate()

searx.engines.json_engine.iterate ( iterable )

Definition at line 45 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 searx.engines.json_engine.do_query().

Here is the caller graph for this function:

◆ parse()

searx.engines.json_engine.parse ( query )

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

◆ query()

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

Definition at line 94 of file json_engine.py.

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

References searx.engines.json_engine.do_query().

Here is the call graph for this function:

◆ request()

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

Definition at line 100 of file json_engine.py.

def request(query, params):  # pylint: disable=redefined-outer-name
    query = urlencode({'q': query})[2:]
 
    fp = {'query': query}  # pylint: disable=invalid-name
    if paging and search_url.find('{pageno}') >= 0:
        fp['pageno'] = (params['pageno'] - 1) * page_size + first_page_num
 
    params['cookies'].update(cookies)
    params['headers'].update(headers)
 
    params['url'] = search_url.format(**fp)
    params['query'] = query
 
    return params
 
 

◆ response()

searx.engines.json_engine.response ( resp )

Definition at line 120 of file json_engine.py.

def response(resp):
    results = []
    json = loads(resp.text)
 
    title_filter = html_to_text if title_html_to_text else identity
    content_filter = html_to_text if content_html_to_text else identity
 
    if results_query:
        rs = query(json, results_query)  # pylint: disable=invalid-name
        if not rs:
            return results
        for result in rs[0]:
            try:
                url = query(result, url_query)[0]
                title = query(result, title_query)[0]
            except:  # pylint: disable=bare-except
                continue
            try:
                content = query(result, content_query)[0]
            except:  # pylint: disable=bare-except
                content = ""
            results.append(
                {
                    'url': url_prefix + to_string(url),
                    'title': title_filter(to_string(title)),
                    'content': content_filter(to_string(content)),
                }
            )
    else:
        for url, title, content in zip(query(json, url_query), query(json, title_query), query(json, content_query)):
            results.append(
                {
                    'url': url_prefix + to_string(url),
                    'title': title_filter(to_string(title)),
                    'content': content_filter(to_string(content)),
                }
            )
 
    if not suggestion_query:
        return results
    for suggestion in query(json, suggestion_query):
        results.append({'suggestion': suggestion})
    return results

Variable Documentation

◆ content_html_to_text

bool searx.engines.json_engine.content_html_to_text = False

Definition at line 25 of file json_engine.py.

◆ content_query

searx.engines.json_engine.content_query = None

Definition at line 23 of file json_engine.py.

◆ cookies

dict searx.engines.json_engine.cookies = {}

Definition at line 31 of file json_engine.py.

◆ first_page_num

int searx.engines.json_engine.first_page_num = 1

Definition at line 42 of file json_engine.py.

◆ headers

dict searx.engines.json_engine.headers = {}

Definition at line 32 of file json_engine.py.

◆ page_size

int searx.engines.json_engine.page_size = 1

Definition at line 40 of file json_engine.py.

◆ paging

bool searx.engines.json_engine.paging = False

Definition at line 27 of file json_engine.py.

◆ results_query

str searx.engines.json_engine.results_query = ''

Definition at line 29 of file json_engine.py.

◆ search_url

searx.engines.json_engine.search_url = None

Definition at line 20 of file json_engine.py.

◆ suggestion_query

str searx.engines.json_engine.suggestion_query = ''

Definition at line 28 of file json_engine.py.

◆ title_html_to_text

bool searx.engines.json_engine.title_html_to_text = False

Definition at line 26 of file json_engine.py.

◆ title_query

searx.engines.json_engine.title_query = None

Definition at line 24 of file json_engine.py.

◆ url_prefix

str searx.engines.json_engine.url_prefix = ""

Definition at line 22 of file json_engine.py.

◆ url_query

searx.engines.json_engine.url_query = None

Definition at line 21 of file json_engine.py.

Functions

Variables

Detailed Description

Function Documentation

◆ do_query()

◆ identity()

◆ is_iterable()

◆ iterate()

◆ parse()

◆ query()

◆ request()

◆ response()

Variable Documentation

◆ content_html_to_text

◆ content_query

◆ cookies

◆ first_page_num

◆ headers

◆ page_size

◆ paging

◆ results_query

◆ search_url

◆ suggestion_query

◆ title_html_to_text

◆ title_query

◆ url_prefix

◆ url_query