<!DOCTYPE html>
<html lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>searx.engines.json_engine — SearXNG Documentation (2025.5.2+590b21165)</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
<script src="../../../_static/documentation_options.js?v=8c00f3b4"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2025.5.2+590b21165" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.5.2+590b21165)</a> »</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-2"><a href="../engines.html" accesskey="U">searx.engines</a> »</li>
<li class="nav-item nav-item-this"><a href="">searx.engines.json_engine</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for searx.engines.json_engine</h1><div class="highlight"><pre>
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
<span class="sd">"""The JSON engine is a *generic* engine with which it is possible to configure</span>
<span class="sd">engines in the settings.</span>
<span class="sd">Configuration</span>
<span class="sd">=============</span>
<span class="sd">Request:</span>
<span class="sd">- :py:obj:`search_url`</span>
<span class="sd">- :py:obj:`lang_all`</span>
<span class="sd">- :py:obj:`soft_max_redirects`</span>
<span class="sd">- :py:obj:`method`</span>
<span class="sd">- :py:obj:`request_body`</span>
<span class="sd">- :py:obj:`cookies`</span>
<span class="sd">- :py:obj:`headers`</span>
<span class="sd">Paging:</span>
<span class="sd">- :py:obj:`paging`</span>
<span class="sd">- :py:obj:`page_size`</span>
<span class="sd">- :py:obj:`first_page_num`</span>
<span class="sd">Time Range:</span>
<span class="sd">- :py:obj:`time_range_support`</span>
<span class="sd">- :py:obj:`time_range_url`</span>
<span class="sd">- :py:obj:`time_range_map`</span>
<span class="sd">Safe-Search:</span>
<span class="sd">- :py:obj:`safe_search_support`</span>
<span class="sd">- :py:obj:`safe_search_map`</span>
<span class="sd">Response:</span>
<span class="sd">- :py:obj:`title_html_to_text`</span>
<span class="sd">- :py:obj:`content_html_to_text`</span>
<span class="sd">- :py:obj:`no_result_for_http_status`</span>
<span class="sd">JSON query:</span>
<span class="sd">- :py:obj:`results_query`</span>
<span class="sd">- :py:obj:`url_query`</span>
<span class="sd">- :py:obj:`url_prefix`</span>
<span class="sd">- :py:obj:`title_query`</span>
<span class="sd">- :py:obj:`content_query`</span>
<span class="sd">- :py:obj:`thumbnail_query`</span>
<span class="sd">- :py:obj:`thumbnail_prefix`</span>
<span class="sd">- :py:obj:`suggestion_query`</span>
<span class="sd">Example</span>
<span class="sd">=======</span>
<span class="sd">Here is a simple example of a JSON engine configure in the :ref:`settings</span>
<span class="sd">engines` section, further read :ref:`engines-dev`.</span>
<span class="sd">.. code:: yaml</span>
<span class="sd"> - name : mdn</span>
<span class="sd"> engine : json_engine</span>
<span class="sd"> paging : True</span>
<span class="sd"> search_url : https://developer.mozilla.org/api/v1/search?q={query}&page={pageno}</span>
<span class="sd"> results_query : documents</span>
<span class="sd"> url_query : mdn_url</span>
<span class="sd"> url_prefix : https://developer.mozilla.org</span>
<span class="sd"> title_query : title</span>
<span class="sd"> content_query : summary</span>
<span class="sd">Implementations</span>
<span class="sd">===============</span>
<span class="sd">"""</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">collections.abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">Iterable</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">json</span><span class="w"> </span><span class="kn">import</span> <span class="n">loads</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.parse</span><span class="w"> </span><span class="kn">import</span> <span class="n">urlencode</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.utils</span><span class="w"> </span><span class="kn">import</span> <span class="n">to_string</span><span class="p">,</span> <span class="n">html_to_text</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.network</span><span class="w"> </span><span class="kn">import</span> <span class="n">raise_for_httperror</span>
<span class="n">search_url</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">"""</span>
<span class="sd">Search URL of the engine. Example::</span>
<span class="sd"> https://example.org/?search={query}&page={pageno}{time_range}{safe_search}</span>
<span class="sd">Replacements are:</span>
<span class="sd">``{query}``:</span>
<span class="sd"> Search terms from user.</span>
<span class="sd">``{pageno}``:</span>
<span class="sd"> Page number if engine supports paging :py:obj:`paging`</span>
<span class="sd">``{lang}``:</span>
<span class="sd"> ISO 639-1 language code (en, de, fr ..)</span>
<span class="sd">``{time_range}``:</span>
<span class="sd"> :py:obj:`URL parameter <time_range_url>` if engine :py:obj:`supports time</span>
<span class="sd"> range <time_range_support>`. The value for the parameter is taken from</span>
<span class="sd"> :py:obj:`time_range_map`.</span>
<span class="sd">``{safe_search}``:</span>
<span class="sd"> Safe-search :py:obj:`URL parameter <safe_search_map>` if engine</span>
<span class="sd"> :py:obj:`supports safe-search <safe_search_support>`. The ``{safe_search}``</span>
<span class="sd"> replacement is taken from the :py:obj:`safes_search_map`. Filter results::</span>
<span class="sd"> 0: none, 1: moderate, 2:strict</span>
<span class="sd"> If not supported, the URL parameter is an empty string.</span>
<span class="sd">"""</span>
<span class="n">lang_all</span> <span class="o">=</span> <span class="s1">'en'</span>
<span class="sd">'''Replacement ``{lang}`` in :py:obj:`search_url` if language ``all`` is</span>
<span class="sd">selected.</span>
<span class="sd">'''</span>
<span class="n">no_result_for_http_status</span> <span class="o">=</span> <span class="p">[]</span>
<span class="sd">'''Return empty result for these HTTP status codes instead of throwing an error.</span>
<span class="sd">.. code:: yaml</span>
<span class="sd"> no_result_for_http_status: []</span>
<span class="sd">'''</span>
<span class="n">soft_max_redirects</span> <span class="o">=</span> <span class="mi">0</span>
<span class="sd">'''Maximum redirects, soft limit. Record an error but don't stop the engine'''</span>
<span class="n">method</span> <span class="o">=</span> <span class="s1">'GET'</span>
<span class="sd">'''Some engines might require to do POST requests for search.'''</span>
<span class="n">request_body</span> <span class="o">=</span> <span class="s1">''</span>
<span class="sd">'''The body of the request. This can only be used if different :py:obj:`method`</span>
<span class="sd">is set, e.g. ``POST``. For formatting see the documentation of :py:obj:`search_url`.</span>
<span class="sd">Note: Curly brackets which aren't encapsulating a replacement placeholder</span>
<span class="sd">must be escaped by doubling each ``{`` and ``}``.</span>
<span class="sd">.. code:: yaml</span>
<span class="sd"> request_body: >-</span>
<span class="sd"> {{</span>
<span class="sd"> "search": "{query}",</span>
<span class="sd"> "page": {pageno},</span>
<span class="sd"> "extra": {{</span>
<span class="sd"> "time_range": {time_range},</span>
<span class="sd"> "rating": "{safe_search}"</span>
<span class="sd"> }}</span>
<span class="sd"> }}</span>
<span class="sd">'''</span>
<span class="n">cookies</span> <span class="o">=</span> <span class="p">{}</span>
<span class="sd">'''Some engines might offer different result based on cookies.</span>
<span class="sd">Possible use-case: To set safesearch cookie.'''</span>
<span class="n">headers</span> <span class="o">=</span> <span class="p">{}</span>
<span class="sd">'''Some engines might offer different result based on cookies or headers.</span>
<span class="sd">Possible use-case: To set safesearch cookie or header to moderate.'''</span>
<span class="n">paging</span> <span class="o">=</span> <span class="kc">False</span>
<span class="sd">'''Engine supports paging [True or False].'''</span>
<span class="n">page_size</span> <span class="o">=</span> <span class="mi">1</span>
<span class="sd">'''Number of results on each page. Only needed if the site requires not a page</span>
<span class="sd">number, but an offset.'''</span>
<span class="n">first_page_num</span> <span class="o">=</span> <span class="mi">1</span>
<span class="sd">'''Number of the first page (usually 0 or 1).'''</span>
<span class="n">results_query</span> <span class="o">=</span> <span class="s1">''</span>
<span class="sd">'''JSON query for the list of result items.</span>
<span class="sd">The query string is a slash `/` separated path of JSON key names.</span>
<span class="sd">Array entries can be specified using the index or can be omitted entirely,</span>
<span class="sd">in which case each entry is considered -</span>
<span class="sd">most implementations will default to the first entry in this case.</span>
<span class="sd">'''</span>
<span class="n">url_query</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">'''JSON query of result's ``url``. For the query string documentation see :py:obj:`results_query`'''</span>
<span class="n">url_prefix</span> <span class="o">=</span> <span class="s2">""</span>
<span class="sd">'''String to prepend to the result's ``url``.'''</span>
<span class="n">title_query</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">'''JSON query of result's ``title``. For the query string documentation see :py:obj:`results_query`'''</span>
<span class="n">content_query</span> <span class="o">=</span> <span class="kc">None</span>
<span class="sd">'''JSON query of result's ``content``. For the query string documentation see :py:obj:`results_query`'''</span>
<span class="n">thumbnail_query</span> <span class="o">=</span> <span class="kc">False</span>
<span class="sd">'''JSON query of result's ``thumbnail``. For the query string documentation see :py:obj:`results_query`'''</span>
<span class="n">thumbnail_prefix</span> <span class="o">=</span> <span class="s1">''</span>
<span class="sd">'''String to prepend to the result's ``thumbnail``.'''</span>
<span class="n">suggestion_query</span> <span class="o">=</span> <span class="s1">''</span>
<span class="sd">'''JSON query of result's ``suggestion``. For the query string documentation see :py:obj:`results_query`'''</span>
<span class="n">title_html_to_text</span> <span class="o">=</span> <span class="kc">False</span>
<span class="sd">'''Extract text from a HTML title string'''</span>
<span class="n">content_html_to_text</span> <span class="o">=</span> <span class="kc">False</span>
<span class="sd">'''Extract text from a HTML content string'''</span>
<span class="n">time_range_support</span> <span class="o">=</span> <span class="kc">False</span>
<span class="sd">'''Engine supports search time range.'''</span>
<span class="n">time_range_url</span> <span class="o">=</span> <span class="s1">'&hours=</span><span class="si">{time_range_val}</span><span class="s1">'</span>
<span class="sd">'''Time range URL parameter in the in :py:obj:`search_url`. If no time range is</span>
<span class="sd">requested by the user, the URL parameter is an empty string. The</span>
<span class="sd">``{time_range_val}`` replacement is taken from the :py:obj:`time_range_map`.</span>
<span class="sd">.. code:: yaml</span>
<span class="sd"> time_range_url : '&days={time_range_val}'</span>
<span class="sd">'''</span>
<span class="n">time_range_map</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'day'</span><span class="p">:</span> <span class="mi">24</span><span class="p">,</span>
<span class="s1">'week'</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">7</span><span class="p">,</span>
<span class="s1">'month'</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">30</span><span class="p">,</span>
<span class="s1">'year'</span><span class="p">:</span> <span class="mi">24</span> <span class="o">*</span> <span class="mi">365</span><span class="p">,</span>
<span class="p">}</span>
<span class="sd">'''Maps time range value from user to ``{time_range_val}`` in</span>
<span class="sd">:py:obj:`time_range_url`.</span>
<span class="sd">.. code:: yaml</span>
<span class="sd"> time_range_map:</span>
<span class="sd"> day: 1</span>
<span class="sd"> week: 7</span>
<span class="sd"> month: 30</span>
<span class="sd"> year: 365</span>
<span class="sd">'''</span>
<span class="n">safe_search_support</span> <span class="o">=</span> <span class="kc">False</span>
<span class="sd">'''Engine supports safe-search.'''</span>
<span class="n">safe_search_map</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s1">'&filter=none'</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">'&filter=moderate'</span><span class="p">,</span> <span class="mi">2</span><span class="p">:</span> <span class="s1">'&filter=strict'</span><span class="p">}</span>
<span class="sd">'''Maps safe-search value to ``{safe_search}`` in :py:obj:`search_url`.</span>
<span class="sd">.. code:: yaml</span>
<span class="sd"> safesearch: true</span>
<span class="sd"> safes_search_map:</span>
<span class="sd"> 0: '&filter=none'</span>
<span class="sd"> 1: '&filter=moderate'</span>
<span class="sd"> 2: '&filter=strict'</span>
<span class="sd">'''</span>
<span class="k">def</span><span class="w"> </span><span class="nf">iterate</span><span class="p">(</span><span class="n">iterable</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">iterable</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="n">items</span> <span class="o">=</span> <span class="n">iterable</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">items</span> <span class="o">=</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">iterable</span><span class="p">)</span>
<span class="k">for</span> <span class="n">index</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">items</span><span class="p">:</span>
<span class="k">yield</span> <span class="nb">str</span><span class="p">(</span><span class="n">index</span><span class="p">),</span> <span class="n">value</span>
<span class="k">def</span><span class="w"> </span><span class="nf">is_iterable</span><span class="p">(</span><span class="n">obj</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">parse</span><span class="p">(</span><span class="n">query</span><span class="p">):</span> <span class="c1"># pylint: disable=redefined-outer-name</span>
<span class="n">q</span> <span class="o">=</span> <span class="p">[]</span> <span class="c1"># pylint: disable=invalid-name</span>
<span class="k">for</span> <span class="n">part</span> <span class="ow">in</span> <span class="n">query</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'/'</span><span class="p">):</span>
<span class="k">if</span> <span class="n">part</span> <span class="o">==</span> <span class="s1">''</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">q</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">part</span><span class="p">)</span>
<span class="k">return</span> <span class="n">q</span>
<span class="k">def</span><span class="w"> </span><span class="nf">do_query</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">q</span><span class="p">):</span> <span class="c1"># pylint: disable=invalid-name</span>
<span class="n">ret</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">q</span><span class="p">:</span>
<span class="k">return</span> <span class="n">ret</span>
<span class="n">qkey</span> <span class="o">=</span> <span class="n">q</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">iterate</span><span class="p">(</span><span class="n">data</span><span class="p">):</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">q</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="n">qkey</span><span class="p">:</span>
<span class="n">ret</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="n">ret</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">do_query</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">q</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">is_iterable</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="n">qkey</span><span class="p">:</span>
<span class="n">ret</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">do_query</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">q</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">ret</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">do_query</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">q</span><span class="p">))</span>
<span class="k">return</span> <span class="n">ret</span>
<span class="k">def</span><span class="w"> </span><span class="nf">query</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">query_string</span><span class="p">):</span>
<span class="n">q</span> <span class="o">=</span> <span class="n">parse</span><span class="p">(</span><span class="n">query_string</span><span class="p">)</span>
<span class="k">return</span> <span class="n">do_query</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">q</span><span class="p">)</span>
<div class="viewcode-block" id="request">
<a class="viewcode-back" href="../../../dev/engines/json_engine.html#searx.engines.json_engine.request">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span> <span class="c1"># pylint: disable=redefined-outer-name</span>
<span class="w"> </span><span class="sd">'''Build request parameters (see :ref:`engine request`).'''</span>
<span class="n">lang</span> <span class="o">=</span> <span class="n">lang_all</span>
<span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">'language'</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">'all'</span><span class="p">:</span>
<span class="n">lang</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s1">'language'</span><span class="p">][:</span><span class="mi">2</span><span class="p">]</span>
<span class="n">time_range</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">if</span> <span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'time_range'</span><span class="p">):</span>
<span class="n">time_range_val</span> <span class="o">=</span> <span class="n">time_range_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'time_range'</span><span class="p">))</span>
<span class="n">time_range</span> <span class="o">=</span> <span class="n">time_range_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">time_range_val</span><span class="o">=</span><span class="n">time_range_val</span><span class="p">)</span>
<span class="n">safe_search</span> <span class="o">=</span> <span class="s1">''</span>
<span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s1">'safesearch'</span><span class="p">]:</span>
<span class="n">safe_search</span> <span class="o">=</span> <span class="n">safe_search_map</span><span class="p">[</span><span class="n">params</span><span class="p">[</span><span class="s1">'safesearch'</span><span class="p">]]</span>
<span class="n">fp</span> <span class="o">=</span> <span class="p">{</span> <span class="c1"># pylint: disable=invalid-name</span>
<span class="s1">'query'</span><span class="p">:</span> <span class="n">urlencode</span><span class="p">({</span><span class="s1">'q'</span><span class="p">:</span> <span class="n">query</span><span class="p">})[</span><span class="mi">2</span><span class="p">:],</span>
<span class="s1">'lang'</span><span class="p">:</span> <span class="n">lang</span><span class="p">,</span>
<span class="s1">'pageno'</span><span class="p">:</span> <span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s1">'pageno'</span><span class="p">]</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="n">page_size</span> <span class="o">+</span> <span class="n">first_page_num</span><span class="p">,</span>
<span class="s1">'time_range'</span><span class="p">:</span> <span class="n">time_range</span><span class="p">,</span>
<span class="s1">'safe_search'</span><span class="p">:</span> <span class="n">safe_search</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">params</span><span class="p">[</span><span class="s1">'cookies'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">cookies</span><span class="p">)</span>
<span class="n">params</span><span class="p">[</span><span class="s1">'headers'</span><span class="p">]</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">headers</span><span class="p">)</span>
<span class="n">params</span><span class="p">[</span><span class="s1">'url'</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_url</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">fp</span><span class="p">)</span>
<span class="n">params</span><span class="p">[</span><span class="s1">'method'</span><span class="p">]</span> <span class="o">=</span> <span class="n">method</span>
<span class="k">if</span> <span class="n">request_body</span><span class="p">:</span>
<span class="c1"># don't url-encode the query if it's in the request body</span>
<span class="n">fp</span><span class="p">[</span><span class="s1">'query'</span><span class="p">]</span> <span class="o">=</span> <span class="n">query</span>
<span class="n">params</span><span class="p">[</span><span class="s1">'data'</span><span class="p">]</span> <span class="o">=</span> <span class="n">request_body</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="o">**</span><span class="n">fp</span><span class="p">)</span>
<span class="n">params</span><span class="p">[</span><span class="s1">'soft_max_redirects'</span><span class="p">]</span> <span class="o">=</span> <span class="n">soft_max_redirects</span>
<span class="n">params</span><span class="p">[</span><span class="s1">'raise_for_httperror'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">return</span> <span class="n">params</span></div>
<span class="k">def</span><span class="w"> </span><span class="nf">identity</span><span class="p">(</span><span class="n">arg</span><span class="p">):</span>
<span class="k">return</span> <span class="n">arg</span>
<span class="k">def</span><span class="w"> </span><span class="nf">extract_response_info</span><span class="p">(</span><span class="n">result</span><span class="p">):</span>
<span class="n">title_filter</span> <span class="o">=</span> <span class="n">html_to_text</span> <span class="k">if</span> <span class="n">title_html_to_text</span> <span class="k">else</span> <span class="n">identity</span>
<span class="n">content_filter</span> <span class="o">=</span> <span class="n">html_to_text</span> <span class="k">if</span> <span class="n">content_html_to_text</span> <span class="k">else</span> <span class="n">identity</span>
<span class="n">tmp_result</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">url_query</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">tmp_result</span><span class="p">[</span><span class="s1">'url'</span><span class="p">]</span> <span class="o">=</span> <span class="n">url_prefix</span> <span class="o">+</span> <span class="n">to_string</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
<span class="n">title</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">title_query</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">tmp_result</span><span class="p">[</span><span class="s1">'title'</span><span class="p">]</span> <span class="o">=</span> <span class="n">title_filter</span><span class="p">(</span><span class="n">to_string</span><span class="p">(</span><span class="n">title</span><span class="p">))</span>
<span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">content</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">content_query</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">tmp_result</span><span class="p">[</span><span class="s1">'content'</span><span class="p">]</span> <span class="o">=</span> <span class="n">content_filter</span><span class="p">(</span><span class="n">to_string</span><span class="p">(</span><span class="n">content</span><span class="p">))</span>
<span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
<span class="n">tmp_result</span><span class="p">[</span><span class="s1">'content'</span><span class="p">]</span> <span class="o">=</span> <span class="s2">""</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="n">thumbnail_query</span><span class="p">:</span>
<span class="n">thumbnail_query_result</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">result</span><span class="p">,</span> <span class="n">thumbnail_query</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">tmp_result</span><span class="p">[</span><span class="s1">'thumbnail'</span><span class="p">]</span> <span class="o">=</span> <span class="n">thumbnail_prefix</span> <span class="o">+</span> <span class="n">to_string</span><span class="p">(</span><span class="n">thumbnail_query_result</span><span class="p">)</span>
<span class="k">except</span><span class="p">:</span> <span class="c1"># pylint: disable=bare-except</span>
<span class="k">pass</span>
<span class="k">return</span> <span class="n">tmp_result</span>
<div class="viewcode-block" id="response">
<a class="viewcode-back" href="../../../dev/engines/json_engine.html#searx.engines.json_engine.response">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">response</span><span class="p">(</span><span class="n">resp</span><span class="p">):</span>
<span class="w"> </span><span class="sd">'''Scrap *results* from the response (see :ref:`result types`).'''</span>
<span class="n">results</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">no_result_for_http_status</span> <span class="ow">and</span> <span class="n">resp</span><span class="o">.</span><span class="n">status_code</span> <span class="ow">in</span> <span class="n">no_result_for_http_status</span><span class="p">:</span>
<span class="k">return</span> <span class="n">results</span>
<span class="n">raise_for_httperror</span><span class="p">(</span><span class="n">resp</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">:</span>
<span class="k">return</span> <span class="n">results</span>
<span class="n">json</span> <span class="o">=</span> <span class="n">loads</span><span class="p">(</span><span class="n">resp</span><span class="o">.</span><span class="n">text</span><span class="p">)</span>
<span class="n">is_onion</span> <span class="o">=</span> <span class="s1">'onions'</span> <span class="ow">in</span> <span class="n">categories</span>
<span class="k">if</span> <span class="n">results_query</span><span class="p">:</span>
<span class="n">rs</span> <span class="o">=</span> <span class="n">query</span><span class="p">(</span><span class="n">json</span><span class="p">,</span> <span class="n">results_query</span><span class="p">)</span> <span class="c1"># pylint: disable=invalid-name</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">rs</span><span class="p">:</span>
<span class="k">return</span> <span class="n">results</span>
<span class="n">rs</span> <span class="o">=</span> <span class="n">rs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># pylint: disable=invalid-name</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">rs</span> <span class="o">=</span> <span class="n">json</span> <span class="c1"># pylint: disable=invalid-name</span>
<span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">rs</span><span class="p">:</span>
<span class="n">tmp_result</span> <span class="o">=</span> <span class="n">extract_response_info</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">tmp_result</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="n">is_onion</span><span class="p">:</span>
<span class="n">tmp_result</span><span class="p">[</span><span class="s1">'is_onion'</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">tmp_result</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">suggestion_query</span><span class="p">:</span>
<span class="k">return</span> <span class="n">results</span>
<span class="k">for</span> <span class="n">suggestion</span> <span class="ow">in</span> <span class="n">query</span><span class="p">(</span><span class="n">json</span><span class="p">,</span> <span class="n">suggestion_query</span><span class="p">):</span>
<span class="n">results</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s1">'suggestion'</span><span class="p">:</span> <span class="n">suggestion</span><span class="p">})</span>
<span class="k">return</span> <span class="n">results</span></div>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../index.html">
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="../../../index.html">Table of Contents</a></h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../dev/index.html">Developer documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../../index.html">Overview</a>
<ul>
<li><a href="../../index.html">Module code</a>
<ul>
<li><a href="../engines.html">searx.engines</a>
</ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
© Copyright SearXNG team.
</div>
</body>
</html>