mirror of
https://github.com/searxng/searxng.git
synced 2025-12-23 20:20:05 +00:00
[doc] build from commit 920b40253c
This commit is contained in:
inetol
233
_modules/searx/search/models.html
Normal file
233
_modules/searx/search/models.html
Normal file
@@ -0,0 +1,233 @@
|
||||
<!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.search.models — SearXNG Documentation (2025.12.12+920b40253)</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=f2f42c25"></script>
|
||||
<script src="../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.12.12+920b40253" 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.12.12+920b40253)</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="../search.html" accesskey="U">searx.search</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">searx.search.models</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for searx.search.models</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="c1"># pylint: disable=missing-module-docstring</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EngineRef">
|
||||
<a class="viewcode-back" href="../../../src/searx.search.html#searx.search.models.EngineRef">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">EngineRef</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Reference by names to an engine and category"""</span>
|
||||
|
||||
<span class="vm">__slots__</span> <span class="o">=</span> <span class="s1">'name'</span><span class="p">,</span> <span class="s1">'category'</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">category</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="n">category</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="s2">"EngineRef(</span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">)"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">category</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">name</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">category</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="nb">hash</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">category</span><span class="p">))</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SearchQuery">
|
||||
<a class="viewcode-back" href="../../../src/searx.search.html#searx.search.models.SearchQuery">[docs]</a>
|
||||
<span class="nd">@typing</span><span class="o">.</span><span class="n">final</span>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">SearchQuery</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""container for all the search parameters (query, language, etc...)"""</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">engineref_list</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">EngineRef</span><span class="p">],</span>
|
||||
<span class="n">lang</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'all'</span><span class="p">,</span>
|
||||
<span class="n">safesearch</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
|
||||
<span class="n">pageno</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
|
||||
<span class="n">time_range</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">"day"</span><span class="p">,</span> <span class="s2">"week"</span><span class="p">,</span> <span class="s2">"month"</span><span class="p">,</span> <span class="s2">"year"</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">timeout_limit</span><span class="p">:</span> <span class="nb">float</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">external_bang</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">engine_data</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">redirect_to_first_result</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="p">):</span> <span class="c1"># pylint:disable=too-many-arguments</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">query</span> <span class="o">=</span> <span class="n">query</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span> <span class="o">=</span> <span class="n">engineref_list</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">lang</span> <span class="o">=</span> <span class="n">lang</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">safesearch</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="n">safesearch</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">pageno</span> <span class="o">=</span> <span class="n">pageno</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">time_range</span><span class="p">:</span> <span class="n">typing</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">"day"</span><span class="p">,</span> <span class="s2">"week"</span><span class="p">,</span> <span class="s2">"month"</span><span class="p">,</span> <span class="s2">"year"</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">time_range</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">timeout_limit</span> <span class="o">=</span> <span class="n">timeout_limit</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">external_bang</span> <span class="o">=</span> <span class="n">external_bang</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">engine_data</span> <span class="o">=</span> <span class="n">engine_data</span> <span class="ow">or</span> <span class="p">{}</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">redirect_to_first_result</span> <span class="o">=</span> <span class="n">redirect_to_first_result</span>
|
||||
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">locale</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">lang</span><span class="p">:</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">locale</span> <span class="o">=</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">lang</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="s1">'-'</span><span class="p">)</span>
|
||||
<span class="k">except</span> <span class="n">babel</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">UnknownLocaleError</span><span class="p">:</span>
|
||||
<span class="k">pass</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">categories</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="nb">set</span><span class="p">(</span><span class="nb">map</span><span class="p">(</span><span class="k">lambda</span> <span class="n">engineref</span><span class="p">:</span> <span class="n">engineref</span><span class="o">.</span><span class="n">category</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span><span class="p">)))</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="s2">"SearchQuery(</span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">, </span><span class="si">{!r}</span><span class="s2">)"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">lang</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">safesearch</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">pageno</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">time_range</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">timeout_limit</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">external_bang</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">redirect_to_first_result</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="p">(</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">query</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">query</span>
|
||||
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">engineref_list</span>
|
||||
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">lang</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">lang</span>
|
||||
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">safesearch</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">safesearch</span>
|
||||
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">pageno</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">pageno</span>
|
||||
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">time_range</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">time_range</span>
|
||||
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">timeout_limit</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">timeout_limit</span>
|
||||
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">external_bang</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">external_bang</span>
|
||||
<span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">redirect_to_first_result</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">redirect_to_first_result</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span>
|
||||
<span class="p">(</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">,</span>
|
||||
<span class="nb">tuple</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span><span class="p">),</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">lang</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">safesearch</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">pageno</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">time_range</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">timeout_limit</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">external_bang</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">redirect_to_first_result</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">__copy__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="n">SearchQuery</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">query</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">engineref_list</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">lang</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">safesearch</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">pageno</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">time_range</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">timeout_limit</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">external_bang</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">engine_data</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">redirect_to_first_result</span><span class="p">,</span>
|
||||
<span class="p">)</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="../search.html">searx.search</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>
|
||||
421
_modules/searx/search/processors/abstract.html
Normal file
421
_modules/searx/search/processors/abstract.html
Normal file
@@ -0,0 +1,421 @@
|
||||
<!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.search.processors.abstract — SearXNG Documentation (2025.12.12+920b40253)</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=f2f42c25"></script>
|
||||
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.12.12+920b40253" 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.12.12+920b40253)</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="../../search.html" accesskey="U">searx.search</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">searx.search.processors.abstract</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for searx.search.processors.abstract</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">"""Abstract base classes for all engine processors."""</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">t</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">logging</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">threading</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">abc</span><span class="w"> </span><span class="kn">import</span> <span class="n">abstractmethod</span><span class="p">,</span> <span class="n">ABC</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">timeit</span><span class="w"> </span><span class="kn">import</span> <span class="n">default_timer</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_setting</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.engines</span><span class="w"> </span><span class="kn">import</span> <span class="n">engines</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">get_time_for_thread</span><span class="p">,</span> <span class="n">get_network</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.metrics</span><span class="w"> </span><span class="kn">import</span> <span class="n">histogram_observe</span><span class="p">,</span> <span class="n">counter_inc</span><span class="p">,</span> <span class="n">count_exception</span><span class="p">,</span> <span class="n">count_error</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.exceptions</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearxEngineAccessDeniedException</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">get_engine_from_settings</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">types</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.enginelib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Engine</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchQuery</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.results</span><span class="w"> </span><span class="kn">import</span> <span class="n">ResultContainer</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">Result</span><span class="p">,</span> <span class="n">LegacyResult</span> <span class="c1"># pyright: ignore[reportPrivateLocalImportUsage]</span>
|
||||
|
||||
|
||||
<span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span><span class="o">.</span><span class="n">getChild</span><span class="p">(</span><span class="s2">"searx.search.processor"</span><span class="p">)</span>
|
||||
<span class="n">SUSPENDED_STATUS</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span> <span class="s2">"SuspendedStatus"</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="RequestParams">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.abstract.RequestParams">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">RequestParams</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">TypedDict</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Basic quantity of the Request parameters of all engine types."""</span>
|
||||
|
||||
<span class="n">query</span><span class="p">:</span> <span class="nb">str</span>
|
||||
<span class="w"> </span><span class="sd">"""Search term, stripped of search syntax arguments."""</span>
|
||||
|
||||
<span class="n">category</span><span class="p">:</span> <span class="nb">str</span>
|
||||
<span class="w"> </span><span class="sd">"""Current category, like ``general``.</span>
|
||||
|
||||
<span class="sd"> .. hint::</span>
|
||||
|
||||
<span class="sd"> This field is deprecated, don't use it in further implementations.</span>
|
||||
|
||||
<span class="sd"> This field is currently *arbitrarily* filled with the name of "one""</span>
|
||||
<span class="sd"> category (the name of the first category of the engine). In practice,</span>
|
||||
<span class="sd"> however, it is not clear what this "one" category should be; in principle,</span>
|
||||
<span class="sd"> multiple categories can also be activated in a search.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">pageno</span><span class="p">:</span> <span class="nb">int</span>
|
||||
<span class="w"> </span><span class="sd">"""Current page number, where the first page is ``1``."""</span>
|
||||
|
||||
<span class="n">safesearch</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]</span>
|
||||
<span class="w"> </span><span class="sd">"""Safe-Search filter (0:normal, 1:moderate, 2:strict)."""</span>
|
||||
|
||||
<span class="n">time_range</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">"day"</span><span class="p">,</span> <span class="s2">"week"</span><span class="p">,</span> <span class="s2">"month"</span><span class="p">,</span> <span class="s2">"year"</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span>
|
||||
<span class="w"> </span><span class="sd">"""Time-range filter."""</span>
|
||||
|
||||
<span class="n">engine_data</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span>
|
||||
<span class="w"> </span><span class="sd">"""Allows the transfer of (engine specific) data to the next request of the</span>
|
||||
<span class="sd"> client. In the case of the ``online`` engines, this data is delivered to</span>
|
||||
<span class="sd"> the client via the HTML ``<form>`` in response.</span>
|
||||
|
||||
<span class="sd"> If the client then sends this form back to the server with the next request,</span>
|
||||
<span class="sd"> this data will be available.</span>
|
||||
|
||||
<span class="sd"> This makes it possible to carry data from one request to the next without a</span>
|
||||
<span class="sd"> session context, but this feature (is fragile) and should only be used in</span>
|
||||
<span class="sd"> exceptional cases. See also :ref:`engine_data`."""</span>
|
||||
|
||||
<span class="n">searxng_locale</span><span class="p">:</span> <span class="nb">str</span>
|
||||
<span class="w"> </span><span class="sd">"""Language / locale filter from the search request, a string like 'all',</span>
|
||||
<span class="sd"> 'en', 'en-US', 'zh-HK' .. and others, for more details see</span>
|
||||
<span class="sd"> :py:obj:`searx.locales`."""</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="SuspendedStatus">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.abstract.SuspendedStatus">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">SuspendedStatus</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Class to handle suspend state."""</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">:</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">continuous_errors</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">suspend_end_time</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">suspend_reason</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span>
|
||||
|
||||
<span class="nd">@property</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">is_suspended</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">suspend_end_time</span> <span class="o">>=</span> <span class="n">default_timer</span><span class="p">()</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">suspend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">suspended_time</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="n">suspend_reason</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">:</span>
|
||||
<span class="c1"># update continuous_errors / suspend_end_time</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">continuous_errors</span> <span class="o">+=</span> <span class="mi">1</span>
|
||||
<span class="k">if</span> <span class="n">suspended_time</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="n">max_ban</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">"search.max_ban_time_on_fail"</span><span class="p">)</span>
|
||||
<span class="n">ban_fail</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">"search.ban_time_on_fail"</span><span class="p">)</span>
|
||||
<span class="n">suspended_time</span> <span class="o">=</span> <span class="nb">min</span><span class="p">(</span><span class="n">max_ban</span><span class="p">,</span> <span class="n">ban_fail</span><span class="p">)</span>
|
||||
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">suspend_end_time</span> <span class="o">=</span> <span class="n">default_timer</span><span class="p">()</span> <span class="o">+</span> <span class="n">suspended_time</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">suspend_reason</span> <span class="o">=</span> <span class="n">suspend_reason</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"Suspend for </span><span class="si">%i</span><span class="s2"> seconds"</span><span class="p">,</span> <span class="n">suspended_time</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">resume</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">lock</span><span class="p">:</span>
|
||||
<span class="c1"># reset the suspend variables</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">continuous_errors</span> <span class="o">=</span> <span class="mi">0</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">suspend_end_time</span> <span class="o">=</span> <span class="mi">0</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">suspend_reason</span> <span class="o">=</span> <span class="s2">""</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="EngineProcessor">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.abstract.EngineProcessor">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">EngineProcessor</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Base classes used for all types of request processors."""</span>
|
||||
|
||||
<span class="n">engine_type</span><span class="p">:</span> <span class="nb">str</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">engine</span><span class="p">:</span> <span class="s2">"Engine|types.ModuleType"</span><span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">:</span> <span class="s2">"Engine"</span> <span class="o">=</span> <span class="n">engine</span> <span class="c1"># pyright: ignore[reportAttributeAccessIssue]</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">:</span> <span class="n">logging</span><span class="o">.</span><span class="n">Logger</span> <span class="o">=</span> <span class="n">engines</span><span class="p">[</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">logger</span>
|
||||
<span class="n">key</span> <span class="o">=</span> <span class="n">get_network</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="n">key</span> <span class="o">=</span> <span class="nb">id</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="k">if</span> <span class="n">key</span> <span class="k">else</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">suspended_status</span><span class="p">:</span> <span class="n">SuspendedStatus</span> <span class="o">=</span> <span class="n">SUSPENDED_STATUS</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">SuspendedStatus</span><span class="p">())</span>
|
||||
|
||||
<div class="viewcode-block" id="EngineProcessor.initialize">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.abstract.EngineProcessor.initialize">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">initialize</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Callable</span><span class="p">[[</span><span class="s2">"EngineProcessor"</span><span class="p">,</span> <span class="nb">bool</span><span class="p">],</span> <span class="nb">bool</span><span class="p">]):</span>
|
||||
<span class="w"> </span><span class="sd">"""Initialization of *this* :py:obj:`EngineProcessor`.</span>
|
||||
|
||||
<span class="sd"> If processor's engine has an ``init`` method, it is called first.</span>
|
||||
<span class="sd"> Engine's ``init`` method is executed in a thread, meaning that the</span>
|
||||
<span class="sd"> *registration* (the ``callback``) may occur later and is not already</span>
|
||||
<span class="sd"> established by the return from this registration method.</span>
|
||||
|
||||
<span class="sd"> Registration only takes place if the ``init`` method is not available or</span>
|
||||
<span class="sd"> is successfully run through.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">,</span> <span class="s2">"init"</span><span class="p">):</span>
|
||||
<span class="n">callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
|
||||
<span class="k">return</span>
|
||||
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="nb">callable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">init</span><span class="p">):</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"Engine's init method isn't a callable (is of type: </span><span class="si">%s</span><span class="s2">)."</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">init</span><span class="p">))</span>
|
||||
<span class="n">callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
|
||||
<span class="k">return</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">__init_processor_thread</span><span class="p">():</span>
|
||||
<span class="n">eng_ok</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">init_engine</span><span class="p">()</span>
|
||||
<span class="n">callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">eng_ok</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># set up and start a thread</span>
|
||||
<span class="n">threading</span><span class="o">.</span><span class="n">Thread</span><span class="p">(</span><span class="n">target</span><span class="o">=</span><span class="n">__init_processor_thread</span><span class="p">,</span> <span class="n">daemon</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span><span class="o">.</span><span class="n">start</span><span class="p">()</span></div>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">init_engine</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="n">eng_setting</span> <span class="o">=</span> <span class="n">get_engine_from_settings</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="n">init_ok</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">init_ok</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">init</span><span class="p">(</span><span class="n">eng_setting</span><span class="p">)</span>
|
||||
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span>
|
||||
<span class="n">logger</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s2">"Init method of engine </span><span class="si">%s</span><span class="s2"> failed due to an exception."</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
||||
<span class="n">init_ok</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
<span class="c1"># In older engines, None is returned from the init method, which is</span>
|
||||
<span class="c1"># equivalent to indicating that the initialization was successful.</span>
|
||||
<span class="k">if</span> <span class="n">init_ok</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="n">init_ok</span> <span class="o">=</span> <span class="kc">True</span>
|
||||
<span class="k">return</span> <span class="n">init_ok</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">handle_exception</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">result_container</span><span class="p">:</span> <span class="s2">"ResultContainer"</span><span class="p">,</span>
|
||||
<span class="n">exception_or_message</span><span class="p">:</span> <span class="ne">BaseException</span> <span class="o">|</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">suspend</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="c1"># update result_container</span>
|
||||
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exception_or_message</span><span class="p">,</span> <span class="ne">BaseException</span><span class="p">):</span>
|
||||
<span class="n">exception_class</span> <span class="o">=</span> <span class="n">exception_or_message</span><span class="o">.</span><span class="vm">__class__</span>
|
||||
<span class="n">module_name</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">exception_class</span><span class="p">,</span> <span class="s1">'__module__'</span><span class="p">,</span> <span class="s1">'builtins'</span><span class="p">)</span>
|
||||
<span class="n">module_name</span> <span class="o">=</span> <span class="s1">''</span> <span class="k">if</span> <span class="n">module_name</span> <span class="o">==</span> <span class="s1">'builtins'</span> <span class="k">else</span> <span class="n">module_name</span> <span class="o">+</span> <span class="s1">'.'</span>
|
||||
<span class="n">error_message</span> <span class="o">=</span> <span class="n">module_name</span> <span class="o">+</span> <span class="n">exception_class</span><span class="o">.</span><span class="vm">__qualname__</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">error_message</span> <span class="o">=</span> <span class="n">exception_or_message</span>
|
||||
<span class="n">result_container</span><span class="o">.</span><span class="n">add_unresponsive_engine</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">error_message</span><span class="p">)</span>
|
||||
<span class="c1"># metrics</span>
|
||||
<span class="n">counter_inc</span><span class="p">(</span><span class="s1">'engine'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">'search'</span><span class="p">,</span> <span class="s1">'count'</span><span class="p">,</span> <span class="s1">'error'</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exception_or_message</span><span class="p">,</span> <span class="ne">BaseException</span><span class="p">):</span>
|
||||
<span class="n">count_exception</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">exception_or_message</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">count_error</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">exception_or_message</span><span class="p">)</span>
|
||||
<span class="c1"># suspend the engine ?</span>
|
||||
<span class="k">if</span> <span class="n">suspend</span><span class="p">:</span>
|
||||
<span class="n">suspended_time</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">exception_or_message</span><span class="p">,</span> <span class="n">SearxEngineAccessDeniedException</span><span class="p">):</span>
|
||||
<span class="n">suspended_time</span> <span class="o">=</span> <span class="n">exception_or_message</span><span class="o">.</span><span class="n">suspended_time</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">suspended_status</span><span class="o">.</span><span class="n">suspend</span><span class="p">(</span><span class="n">suspended_time</span><span class="p">,</span> <span class="n">error_message</span><span class="p">)</span> <span class="c1"># pylint: disable=no-member</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">_extend_container_basic</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">result_container</span><span class="p">:</span> <span class="s2">"ResultContainer"</span><span class="p">,</span>
|
||||
<span class="n">start_time</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
|
||||
<span class="n">search_results</span><span class="p">:</span> <span class="s2">"list[Result | LegacyResult]"</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="c1"># update result_container</span>
|
||||
<span class="n">result_container</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">search_results</span><span class="p">)</span>
|
||||
<span class="n">engine_time</span> <span class="o">=</span> <span class="n">default_timer</span><span class="p">()</span> <span class="o">-</span> <span class="n">start_time</span>
|
||||
<span class="n">page_load_time</span> <span class="o">=</span> <span class="n">get_time_for_thread</span><span class="p">()</span>
|
||||
<span class="n">result_container</span><span class="o">.</span><span class="n">add_timing</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">engine_time</span><span class="p">,</span> <span class="n">page_load_time</span><span class="p">)</span>
|
||||
<span class="c1"># metrics</span>
|
||||
<span class="n">counter_inc</span><span class="p">(</span><span class="s1">'engine'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">'search'</span><span class="p">,</span> <span class="s1">'count'</span><span class="p">,</span> <span class="s1">'successful'</span><span class="p">)</span>
|
||||
<span class="n">histogram_observe</span><span class="p">(</span><span class="n">engine_time</span><span class="p">,</span> <span class="s1">'engine'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">'time'</span><span class="p">,</span> <span class="s1">'total'</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">page_load_time</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="n">histogram_observe</span><span class="p">(</span><span class="n">page_load_time</span><span class="p">,</span> <span class="s1">'engine'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="s1">'time'</span><span class="p">,</span> <span class="s1">'http'</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">extend_container</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">result_container</span><span class="p">:</span> <span class="s2">"ResultContainer"</span><span class="p">,</span>
|
||||
<span class="n">start_time</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
|
||||
<span class="n">search_results</span><span class="p">:</span> <span class="s2">"list[Result | LegacyResult]|None"</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">threading</span><span class="o">.</span><span class="n">current_thread</span><span class="p">(),</span> <span class="s1">'_timeout'</span><span class="p">,</span> <span class="kc">False</span><span class="p">):</span>
|
||||
<span class="c1"># the main thread is not waiting anymore</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span><span class="p">(</span><span class="n">result_container</span><span class="p">,</span> <span class="s1">'timeout'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="c1"># check if the engine accepted the request</span>
|
||||
<span class="k">if</span> <span class="n">search_results</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_extend_container_basic</span><span class="p">(</span><span class="n">result_container</span><span class="p">,</span> <span class="n">start_time</span><span class="p">,</span> <span class="n">search_results</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">suspended_status</span><span class="o">.</span><span class="n">resume</span><span class="p">()</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">extend_container_if_suspended</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">result_container</span><span class="p">:</span> <span class="s2">"ResultContainer"</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">suspended_status</span><span class="o">.</span><span class="n">is_suspended</span><span class="p">:</span>
|
||||
<span class="n">result_container</span><span class="o">.</span><span class="n">add_unresponsive_engine</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">suspended_status</span><span class="o">.</span><span class="n">suspend_reason</span><span class="p">,</span> <span class="n">suspended</span><span class="o">=</span><span class="kc">True</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">return</span> <span class="kc">True</span>
|
||||
<span class="k">return</span> <span class="kc">False</span>
|
||||
|
||||
<div class="viewcode-block" id="EngineProcessor.get_params">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.abstract.EngineProcessor.get_params">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">search_query</span><span class="p">:</span> <span class="s2">"SearchQuery"</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">RequestParams</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns a dictionary with the :ref:`request parameters <engine</span>
|
||||
<span class="sd"> request arguments>` (:py:obj:`RequestParams`), if the search condition</span>
|
||||
<span class="sd"> is not supported by the engine, ``None`` is returned:</span>
|
||||
|
||||
<span class="sd"> - *time range* filter in search conditions, but the engine does not have</span>
|
||||
<span class="sd"> a corresponding filter</span>
|
||||
<span class="sd"> - page number > 1 when engine does not support paging</span>
|
||||
<span class="sd"> - page number > ``max_page``</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="c1"># if paging is not supported, skip</span>
|
||||
<span class="k">if</span> <span class="n">search_query</span><span class="o">.</span><span class="n">pageno</span> <span class="o">></span> <span class="mi">1</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">paging</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="c1"># if max page is reached, skip</span>
|
||||
<span class="n">max_page</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">max_page</span> <span class="ow">or</span> <span class="n">get_setting</span><span class="p">(</span><span class="s2">"search.max_page"</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">max_page</span> <span class="ow">and</span> <span class="n">max_page</span> <span class="o"><</span> <span class="n">search_query</span><span class="o">.</span><span class="n">pageno</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="c1"># if time_range is not supported, skip</span>
|
||||
<span class="k">if</span> <span class="n">search_query</span><span class="o">.</span><span class="n">time_range</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">time_range_support</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="n">params</span><span class="p">:</span> <span class="n">RequestParams</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s2">"query"</span><span class="p">:</span> <span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">,</span>
|
||||
<span class="s2">"category"</span><span class="p">:</span> <span class="n">engine_category</span><span class="p">,</span>
|
||||
<span class="s2">"pageno"</span><span class="p">:</span> <span class="n">search_query</span><span class="o">.</span><span class="n">pageno</span><span class="p">,</span>
|
||||
<span class="s2">"safesearch"</span><span class="p">:</span> <span class="n">search_query</span><span class="o">.</span><span class="n">safesearch</span><span class="p">,</span>
|
||||
<span class="s2">"time_range"</span><span class="p">:</span> <span class="n">search_query</span><span class="o">.</span><span class="n">time_range</span><span class="p">,</span>
|
||||
<span class="s2">"engine_data"</span><span class="p">:</span> <span class="n">search_query</span><span class="o">.</span><span class="n">engine_data</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="p">{}),</span>
|
||||
<span class="s2">"searxng_locale"</span><span class="p">:</span> <span class="n">search_query</span><span class="o">.</span><span class="n">lang</span><span class="p">,</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="c1"># deprecated / vintage --> use params["searxng_locale"]</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Conditions related to engine's traits are implemented in engine.traits</span>
|
||||
<span class="c1"># module. Don't do "locale" decisions here in the abstract layer of the</span>
|
||||
<span class="c1"># search processor, just pass the value from user's choice unchanged to</span>
|
||||
<span class="c1"># the engine request.</span>
|
||||
|
||||
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="p">,</span> <span class="s2">"language"</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">language</span><span class="p">:</span>
|
||||
<span class="n">params</span><span class="p">[</span><span class="s2">"language"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">language</span> <span class="c1"># pyright: ignore[reportGeneralTypeIssues]</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">params</span><span class="p">[</span><span class="s2">"language"</span><span class="p">]</span> <span class="o">=</span> <span class="n">search_query</span><span class="o">.</span><span class="n">lang</span> <span class="c1"># pyright: ignore[reportGeneralTypeIssues]</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">params</span></div>
|
||||
|
||||
|
||||
<span class="nd">@abstractmethod</span>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">params</span><span class="p">:</span> <span class="n">RequestParams</span><span class="p">,</span>
|
||||
<span class="n">result_container</span><span class="p">:</span> <span class="s2">"ResultContainer"</span><span class="p">,</span>
|
||||
<span class="n">start_time</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
|
||||
<span class="n">timeout_limit</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="k">pass</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="c1"># deprecated!</span>
|
||||
<span class="k">return</span> <span class="p">{}</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_default_tests</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="c1"># deprecated!</span>
|
||||
<span class="k">return</span> <span class="p">{}</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="../../search.html">searx.search</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>
|
||||
143
_modules/searx/search/processors/offline.html
Normal file
143
_modules/searx/search/processors/offline.html
Normal file
@@ -0,0 +1,143 @@
|
||||
<!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.search.processors.offline — SearXNG Documentation (2025.12.12+920b40253)</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=f2f42c25"></script>
|
||||
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.12.12+920b40253" 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.12.12+920b40253)</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="../../search.html" accesskey="U">searx.search</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">searx.search.processors.offline</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for searx.search.processors.offline</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">"""Processors for engine-type: ``offline``"""</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">t</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.abstract</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineProcessor</span><span class="p">,</span> <span class="n">RequestParams</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.results</span><span class="w"> </span><span class="kn">import</span> <span class="n">ResultContainer</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="OfflineProcessor">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.offline.OfflineProcessor">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">OfflineProcessor</span><span class="p">(</span><span class="n">EngineProcessor</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Processor class used by ``offline`` engines."""</span>
|
||||
|
||||
<span class="n">engine_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"offline"</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">params</span><span class="p">:</span> <span class="n">RequestParams</span><span class="p">,</span>
|
||||
<span class="n">result_container</span><span class="p">:</span> <span class="s2">"ResultContainer"</span><span class="p">,</span>
|
||||
<span class="n">start_time</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
|
||||
<span class="n">timeout_limit</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">search_results</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">search</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="bp">self</span><span class="o">.</span><span class="n">extend_container</span><span class="p">(</span><span class="n">result_container</span><span class="p">,</span> <span class="n">start_time</span><span class="p">,</span> <span class="n">search_results</span><span class="p">)</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
||||
<span class="c1"># do not record the error</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s1">'engine </span><span class="si">{0}</span><span class="s1"> : invalid input : </span><span class="si">{1}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">e</span><span class="p">))</span>
|
||||
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span><span class="p">(</span><span class="n">result_container</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s1">'engine </span><span class="si">{0}</span><span class="s1"> : exception : </span><span class="si">{1}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">e</span><span class="p">))</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="../../search.html">searx.search</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>
|
||||
407
_modules/searx/search/processors/online.html
Normal file
407
_modules/searx/search/processors/online.html
Normal file
@@ -0,0 +1,407 @@
|
||||
<!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.search.processors.online — SearXNG Documentation (2025.12.12+920b40253)</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=f2f42c25"></script>
|
||||
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.12.12+920b40253" 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.12.12+920b40253)</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="../../search.html" accesskey="U">searx.search</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">searx.search.processors.online</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for searx.search.processors.online</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">"""Processor used for ``online`` engines."""</span>
|
||||
|
||||
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"OnlineProcessor"</span><span class="p">,</span> <span class="s2">"OnlineParams"</span><span class="p">]</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">t</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">timeit</span><span class="w"> </span><span class="kn">import</span> <span class="n">default_timer</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">asyncio</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">ssl</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">httpx</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">searx.network</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">gen_useragent</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.exceptions</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
|
||||
<span class="n">SearxEngineAccessDeniedException</span><span class="p">,</span>
|
||||
<span class="n">SearxEngineCaptchaException</span><span class="p">,</span>
|
||||
<span class="n">SearxEngineTooManyRequestsException</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.metrics.error_recorder</span><span class="w"> </span><span class="kn">import</span> <span class="n">count_error</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.abstract</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineProcessor</span><span class="p">,</span> <span class="n">RequestParams</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchQuery</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.results</span><span class="w"> </span><span class="kn">import</span> <span class="n">ResultContainer</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.result_types</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineResults</span>
|
||||
|
||||
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">HTTPParams</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">TypedDict</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""HTTP request parameters"""</span>
|
||||
|
||||
<span class="n">method</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="s2">"GET"</span><span class="p">,</span> <span class="s2">"POST"</span><span class="p">]</span>
|
||||
<span class="w"> </span><span class="sd">"""HTTP request method."""</span>
|
||||
|
||||
<span class="n">headers</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span>
|
||||
<span class="w"> </span><span class="sd">"""HTTP header information."""</span>
|
||||
|
||||
<span class="n">data</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">int</span><span class="p">]]</span>
|
||||
<span class="w"> </span><span class="sd">"""Sending `form encoded data`_.</span>
|
||||
|
||||
<span class="sd"> .. _form encoded data:</span>
|
||||
<span class="sd"> https://www.python-httpx.org/quickstart/#sending-form-encoded-data</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">json</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span>
|
||||
<span class="w"> </span><span class="sd">"""`Sending `JSON encoded data`_.</span>
|
||||
|
||||
<span class="sd"> .. _JSON encoded data:</span>
|
||||
<span class="sd"> https://www.python-httpx.org/quickstart/#sending-json-encoded-data</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">content</span><span class="p">:</span> <span class="nb">bytes</span>
|
||||
<span class="w"> </span><span class="sd">"""`Sending `binary request data`_.</span>
|
||||
|
||||
<span class="sd"> .. _binary request data:</span>
|
||||
<span class="sd"> https://www.python-httpx.org/quickstart/#sending-json-encoded-data</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span>
|
||||
<span class="w"> </span><span class="sd">"""Requested url."""</span>
|
||||
|
||||
<span class="n">cookies</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span>
|
||||
<span class="w"> </span><span class="sd">"""HTTP cookies."""</span>
|
||||
|
||||
<span class="n">allow_redirects</span><span class="p">:</span> <span class="nb">bool</span>
|
||||
<span class="w"> </span><span class="sd">"""Follow redirects"""</span>
|
||||
|
||||
<span class="n">max_redirects</span><span class="p">:</span> <span class="nb">int</span>
|
||||
<span class="w"> </span><span class="sd">"""Maximum redirects, hard limit."""</span>
|
||||
|
||||
<span class="n">soft_max_redirects</span><span class="p">:</span> <span class="nb">int</span>
|
||||
<span class="w"> </span><span class="sd">"""Maximum redirects, soft limit. Record an error but don't stop the engine."""</span>
|
||||
|
||||
<span class="n">verify</span><span class="p">:</span> <span class="kc">None</span> <span class="o">|</span> <span class="n">t</span><span class="o">.</span><span class="n">Literal</span><span class="p">[</span><span class="kc">False</span><span class="p">]</span> <span class="o">|</span> <span class="nb">str</span> <span class="c1"># not sure str really works</span>
|
||||
<span class="w"> </span><span class="sd">"""If not ``None``, it overrides the verify value defined in the network. Use</span>
|
||||
<span class="sd"> ``False`` to accept any server certificate and use a path to file to specify a</span>
|
||||
<span class="sd"> server certificate"""</span>
|
||||
|
||||
<span class="n">auth</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span>
|
||||
<span class="w"> </span><span class="sd">"""An authentication to use when sending requests."""</span>
|
||||
|
||||
<span class="n">raise_for_httperror</span><span class="p">:</span> <span class="nb">bool</span>
|
||||
<span class="w"> </span><span class="sd">"""Raise an exception if the `HTTP response status code`_ is ``>= 300``.</span>
|
||||
|
||||
<span class="sd"> .. _HTTP response status code:</span>
|
||||
<span class="sd"> https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="OnlineParams">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online.OnlineParams">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">OnlineParams</span><span class="p">(</span><span class="n">HTTPParams</span><span class="p">,</span> <span class="n">RequestParams</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Request parameters of a ``online`` engine."""</span></div>
|
||||
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">default_request_params</span><span class="p">()</span> <span class="o">-></span> <span class="n">HTTPParams</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Default request parameters for ``online`` engines."""</span>
|
||||
<span class="k">return</span> <span class="p">{</span>
|
||||
<span class="s2">"method"</span><span class="p">:</span> <span class="s2">"GET"</span><span class="p">,</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="p">{},</span>
|
||||
<span class="s2">"data"</span><span class="p">:</span> <span class="p">{},</span>
|
||||
<span class="s2">"json"</span><span class="p">:</span> <span class="p">{},</span>
|
||||
<span class="s2">"content"</span><span class="p">:</span> <span class="sa">b</span><span class="s2">""</span><span class="p">,</span>
|
||||
<span class="s2">"url"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="p">{},</span>
|
||||
<span class="s2">"allow_redirects"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
|
||||
<span class="s2">"max_redirects"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
|
||||
<span class="s2">"soft_max_redirects"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
|
||||
<span class="s2">"auth"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="s2">"verify"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="s2">"raise_for_httperror"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="OnlineProcessor">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online.OnlineProcessor">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">OnlineProcessor</span><span class="p">(</span><span class="n">EngineProcessor</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Processor class for ``online`` engines."""</span>
|
||||
|
||||
<span class="n">engine_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"online"</span>
|
||||
|
||||
<div class="viewcode-block" id="OnlineProcessor.init_engine">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online.OnlineProcessor.init_engine">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">init_engine</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""This method is called in a thread, and before the base method is</span>
|
||||
<span class="sd"> called, the network must be set up for the ``online`` engines."""</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">init_network_in_thread</span><span class="p">(</span><span class="n">start_time</span><span class="o">=</span><span class="n">default_timer</span><span class="p">(),</span> <span class="n">timeout_limit</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">timeout</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">init_engine</span><span class="p">()</span></div>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">init_network_in_thread</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">start_time</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span> <span class="n">timeout_limit</span><span class="p">:</span> <span class="nb">float</span><span class="p">):</span>
|
||||
<span class="c1"># set timeout for all HTTP requests</span>
|
||||
<span class="n">searx</span><span class="o">.</span><span class="n">network</span><span class="o">.</span><span class="n">set_timeout_for_thread</span><span class="p">(</span><span class="n">timeout_limit</span><span class="p">,</span> <span class="n">start_time</span><span class="o">=</span><span class="n">start_time</span><span class="p">)</span>
|
||||
<span class="c1"># reset the HTTP total time</span>
|
||||
<span class="n">searx</span><span class="o">.</span><span class="n">network</span><span class="o">.</span><span class="n">reset_time_for_thread</span><span class="p">()</span>
|
||||
<span class="c1"># set the network</span>
|
||||
<span class="n">searx</span><span class="o">.</span><span class="n">network</span><span class="o">.</span><span class="n">set_context_network_name</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="OnlineProcessor.get_params">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online.OnlineProcessor.get_params">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">search_query</span><span class="p">:</span> <span class="s2">"SearchQuery"</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">OnlineParams</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns a dictionary with the :ref:`request params <engine request</span>
|
||||
<span class="sd"> online>` (:py:obj:`OnlineParams`), if the search condition is not</span>
|
||||
<span class="sd"> supported by the engine, ``None`` is returned."""</span>
|
||||
|
||||
<span class="n">base_params</span><span class="p">:</span> <span class="n">RequestParams</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_params</span><span class="p">(</span><span class="n">search_query</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">base_params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="n">base_params</span>
|
||||
|
||||
<span class="n">params</span><span class="p">:</span> <span class="n">OnlineParams</span> <span class="o">=</span> <span class="p">{</span><span class="o">**</span><span class="n">default_request_params</span><span class="p">(),</span> <span class="o">**</span><span class="n">base_params</span><span class="p">}</span>
|
||||
|
||||
<span class="n">headers</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">"headers"</span><span class="p">]</span>
|
||||
|
||||
<span class="c1"># add an user agent</span>
|
||||
<span class="n">headers</span><span class="p">[</span><span class="s2">"User-Agent"</span><span class="p">]</span> <span class="o">=</span> <span class="n">gen_useragent</span><span class="p">()</span>
|
||||
|
||||
<span class="c1"># add Accept-Language header</span>
|
||||
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">send_accept_language_header</span> <span class="ow">and</span> <span class="n">search_query</span><span class="o">.</span><span class="n">locale</span><span class="p">:</span>
|
||||
<span class="n">ac_lang</span> <span class="o">=</span> <span class="n">search_query</span><span class="o">.</span><span class="n">locale</span><span class="o">.</span><span class="n">language</span>
|
||||
<span class="k">if</span> <span class="n">search_query</span><span class="o">.</span><span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">:</span>
|
||||
<span class="n">ac_lang</span> <span class="o">=</span> <span class="s2">"</span><span class="si">%s</span><span class="s2">-</span><span class="si">%s</span><span class="s2">,</span><span class="si">%s</span><span class="s2">;q=0.9,*;q=0.5"</span> <span class="o">%</span> <span class="p">(</span>
|
||||
<span class="n">search_query</span><span class="o">.</span><span class="n">locale</span><span class="o">.</span><span class="n">language</span><span class="p">,</span>
|
||||
<span class="n">search_query</span><span class="o">.</span><span class="n">locale</span><span class="o">.</span><span class="n">territory</span><span class="p">,</span>
|
||||
<span class="n">search_query</span><span class="o">.</span><span class="n">locale</span><span class="o">.</span><span class="n">language</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
<span class="n">headers</span><span class="p">[</span><span class="s2">"Accept-Language"</span><span class="p">]</span> <span class="o">=</span> <span class="n">ac_lang</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">"HTTP Accept-Language: </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">headers</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"Accept-Language"</span><span class="p">,</span> <span class="s2">""</span><span class="p">))</span>
|
||||
|
||||
<span class="c1"># https://developer.mozilla.org/en-US/docs/Glossary/Fetch_metadata_request_header</span>
|
||||
<span class="n">headers</span><span class="p">[</span><span class="s2">"Sec-Fetch-Dest"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"empty"</span>
|
||||
<span class="n">headers</span><span class="p">[</span><span class="s2">"Sec-Fetch-Mode"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"cors"</span>
|
||||
<span class="n">headers</span><span class="p">[</span><span class="s2">"Sec-Fetch-Site"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"same-origin"</span>
|
||||
<span class="n">headers</span><span class="p">[</span><span class="s2">"Sec-Fetch-User"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"?1"</span>
|
||||
<span class="n">headers</span><span class="p">[</span><span class="s2">"Sec-GPC"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"1"</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">params</span></div>
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">_send_http_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="n">OnlineParams</span><span class="p">):</span>
|
||||
|
||||
<span class="c1"># create dictionary which contain all information about the request</span>
|
||||
<span class="n">request_args</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s2">"headers"</span><span class="p">:</span> <span class="n">params</span><span class="p">[</span><span class="s2">"headers"</span><span class="p">],</span>
|
||||
<span class="s2">"cookies"</span><span class="p">:</span> <span class="n">params</span><span class="p">[</span><span class="s2">"cookies"</span><span class="p">],</span>
|
||||
<span class="s2">"auth"</span><span class="p">:</span> <span class="n">params</span><span class="p">[</span><span class="s2">"auth"</span><span class="p">],</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="n">verify</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"verify"</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">verify</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="n">request_args</span><span class="p">[</span><span class="s2">"verify"</span><span class="p">]</span> <span class="o">=</span> <span class="n">verify</span>
|
||||
|
||||
<span class="c1"># max_redirects</span>
|
||||
<span class="n">max_redirects</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"max_redirects"</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">max_redirects</span><span class="p">:</span>
|
||||
<span class="n">request_args</span><span class="p">[</span><span class="s2">"max_redirects"</span><span class="p">]</span> <span class="o">=</span> <span class="n">max_redirects</span>
|
||||
|
||||
<span class="c1"># allow_redirects</span>
|
||||
<span class="k">if</span> <span class="s2">"allow_redirects"</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span>
|
||||
<span class="n">request_args</span><span class="p">[</span><span class="s2">"allow_redirects"</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">"allow_redirects"</span><span class="p">]</span>
|
||||
|
||||
<span class="c1"># soft_max_redirects</span>
|
||||
<span class="n">soft_max_redirects</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"soft_max_redirects"</span><span class="p">,</span> <span class="n">max_redirects</span> <span class="ow">or</span> <span class="mi">0</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># raise_for_status</span>
|
||||
<span class="n">request_args</span><span class="p">[</span><span class="s2">"raise_for_httperror"</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"raise_for_httperror"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># specific type of request (GET or POST)</span>
|
||||
<span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">"method"</span><span class="p">]</span> <span class="o">==</span> <span class="s2">"GET"</span><span class="p">:</span>
|
||||
<span class="n">req</span> <span class="o">=</span> <span class="n">searx</span><span class="o">.</span><span class="n">network</span><span class="o">.</span><span class="n">get</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">req</span> <span class="o">=</span> <span class="n">searx</span><span class="o">.</span><span class="n">network</span><span class="o">.</span><span class="n">post</span>
|
||||
<span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">"data"</span><span class="p">]:</span>
|
||||
<span class="n">request_args</span><span class="p">[</span><span class="s2">"data"</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">"data"</span><span class="p">]</span>
|
||||
<span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">"json"</span><span class="p">]:</span>
|
||||
<span class="n">request_args</span><span class="p">[</span><span class="s2">"json"</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">"json"</span><span class="p">]</span>
|
||||
<span class="k">if</span> <span class="n">params</span><span class="p">[</span><span class="s2">"content"</span><span class="p">]:</span>
|
||||
<span class="n">request_args</span><span class="p">[</span><span class="s2">"content"</span><span class="p">]</span> <span class="o">=</span> <span class="n">params</span><span class="p">[</span><span class="s2">"content"</span><span class="p">]</span>
|
||||
|
||||
<span class="c1"># send the request</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="n">req</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="s2">"url"</span><span class="p">],</span> <span class="o">**</span><span class="n">request_args</span><span class="p">)</span> <span class="c1"># pyright: ignore[reportArgumentType]</span>
|
||||
|
||||
<span class="c1"># check soft limit of the redirect count</span>
|
||||
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">history</span><span class="p">)</span> <span class="o">></span> <span class="n">soft_max_redirects</span><span class="p">:</span>
|
||||
<span class="c1"># unexpected redirect : record an error</span>
|
||||
<span class="c1"># but the engine might still return valid results.</span>
|
||||
<span class="n">status_code</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="ow">or</span> <span class="s2">""</span><span class="p">)</span>
|
||||
<span class="n">reason</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">reason_phrase</span> <span class="ow">or</span> <span class="s2">""</span>
|
||||
<span class="n">hostname</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">url</span><span class="o">.</span><span class="n">host</span>
|
||||
<span class="n">count_error</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
|
||||
<span class="s2">"</span><span class="si">{}</span><span class="s2"> redirects, maximum: </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">history</span><span class="p">),</span> <span class="n">soft_max_redirects</span><span class="p">),</span>
|
||||
<span class="p">(</span><span class="n">status_code</span><span class="p">,</span> <span class="n">reason</span><span class="p">,</span> <span class="n">hostname</span><span class="p">),</span>
|
||||
<span class="n">secondary</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">response</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">_search_basic</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">params</span><span class="p">:</span> <span class="n">OnlineParams</span><span class="p">)</span> <span class="o">-></span> <span class="s2">"EngineResults|None"</span><span class="p">:</span>
|
||||
<span class="c1"># update request parameters dependent on</span>
|
||||
<span class="c1"># search-engine (contained in engines folder)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">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"># ignoring empty urls</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">params</span><span class="p">[</span><span class="s2">"url"</span><span class="p">]:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="c1"># send request</span>
|
||||
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_send_http_request</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
|
||||
|
||||
<span class="c1"># parse the response</span>
|
||||
<span class="n">response</span><span class="o">.</span><span class="n">search_params</span> <span class="o">=</span> <span class="n">params</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">response</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span> <span class="c1"># pyright: ignore[reportIncompatibleMethodOverride]</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">query</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">params</span><span class="p">:</span> <span class="n">OnlineParams</span><span class="p">,</span>
|
||||
<span class="n">result_container</span><span class="p">:</span> <span class="s2">"ResultContainer"</span><span class="p">,</span>
|
||||
<span class="n">start_time</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
|
||||
<span class="n">timeout_limit</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
|
||||
<span class="p">):</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">init_network_in_thread</span><span class="p">(</span><span class="n">start_time</span><span class="p">,</span> <span class="n">timeout_limit</span><span class="p">)</span>
|
||||
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="c1"># send requests and parse the results</span>
|
||||
<span class="n">search_results</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_search_basic</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="bp">self</span><span class="o">.</span><span class="n">extend_container</span><span class="p">(</span><span class="n">result_container</span><span class="p">,</span> <span class="n">start_time</span><span class="p">,</span> <span class="n">search_results</span><span class="p">)</span>
|
||||
<span class="k">except</span> <span class="n">ssl</span><span class="o">.</span><span class="n">SSLError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
||||
<span class="c1"># requests timeout (connect or read)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span><span class="p">(</span><span class="n">result_container</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span> <span class="n">suspend</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">"SSLError </span><span class="si">{}</span><span class="s2">, verify=</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">e</span><span class="p">,</span> <span class="n">searx</span><span class="o">.</span><span class="n">network</span><span class="o">.</span><span class="n">get_network</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">engine</span><span class="o">.</span><span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">verify</span><span class="p">))</span>
|
||||
<span class="k">except</span> <span class="p">(</span><span class="n">httpx</span><span class="o">.</span><span class="n">TimeoutException</span><span class="p">,</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">TimeoutError</span><span class="p">)</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
||||
<span class="c1"># requests timeout (connect or read)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span><span class="p">(</span><span class="n">result_container</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span> <span class="n">suspend</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
|
||||
<span class="s2">"HTTP requests timeout (search duration : </span><span class="si">{0}</span><span class="s2"> s, timeout: </span><span class="si">{1}</span><span class="s2"> s) : </span><span class="si">{2}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">default_timer</span><span class="p">()</span> <span class="o">-</span> <span class="n">start_time</span><span class="p">,</span> <span class="n">timeout_limit</span><span class="p">,</span> <span class="n">e</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">except</span> <span class="p">(</span><span class="n">httpx</span><span class="o">.</span><span class="n">HTTPError</span><span class="p">,</span> <span class="n">httpx</span><span class="o">.</span><span class="n">StreamError</span><span class="p">)</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
||||
<span class="c1"># other requests exception</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span><span class="p">(</span><span class="n">result_container</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span> <span class="n">suspend</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span>
|
||||
<span class="s2">"requests exception (search duration : </span><span class="si">{0}</span><span class="s2"> s, timeout: </span><span class="si">{1}</span><span class="s2"> s) : </span><span class="si">{2}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
|
||||
<span class="n">default_timer</span><span class="p">()</span> <span class="o">-</span> <span class="n">start_time</span><span class="p">,</span> <span class="n">timeout_limit</span><span class="p">,</span> <span class="n">e</span>
|
||||
<span class="p">)</span>
|
||||
<span class="p">)</span>
|
||||
<span class="k">except</span> <span class="p">(</span>
|
||||
<span class="n">SearxEngineCaptchaException</span><span class="p">,</span>
|
||||
<span class="n">SearxEngineTooManyRequestsException</span><span class="p">,</span>
|
||||
<span class="n">SearxEngineAccessDeniedException</span><span class="p">,</span>
|
||||
<span class="p">)</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span><span class="p">(</span><span class="n">result_container</span><span class="p">,</span> <span class="n">e</span><span class="p">,</span> <span class="n">suspend</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="p">)</span>
|
||||
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> <span class="c1"># pylint: disable=broad-except</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">handle_exception</span><span class="p">(</span><span class="n">result_container</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s2">"exception : </span><span class="si">{0}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">e</span><span class="p">))</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="../../search.html">searx.search</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>
|
||||
236
_modules/searx/search/processors/online_currency.html
Normal file
236
_modules/searx/search/processors/online_currency.html
Normal file
@@ -0,0 +1,236 @@
|
||||
<!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.search.processors.online_currency — SearXNG Documentation (2025.12.12+920b40253)</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=f2f42c25"></script>
|
||||
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.12.12+920b40253" 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.12.12+920b40253)</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="../../search.html" accesskey="U">searx.search</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">searx.search.processors.online_currency</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for searx.search.processors.online_currency</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">"""Processor used for ``online_currency`` engines."""</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">t</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">unicodedata</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">flask_babel</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">babel</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.data</span><span class="w"> </span><span class="kn">import</span> <span class="n">CURRENCIES</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.online</span><span class="w"> </span><span class="kn">import</span> <span class="n">OnlineProcessor</span><span class="p">,</span> <span class="n">OnlineParams</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.abstract</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineProcessor</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchQuery</span>
|
||||
|
||||
|
||||
<span class="n">search_syntax</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">".*?(\d+(?:\.\d+)?) ([^.0-9]+) (?:in|to) ([^.0-9]+)"</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">I</span><span class="p">)</span>
|
||||
<span class="sd">"""Search syntax used for from/to currency (e.g. ``10 usd to eur``)"""</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="CurrenciesParams">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_currency.CurrenciesParams">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">CurrenciesParams</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">TypedDict</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Currencies request parameters."""</span>
|
||||
|
||||
<span class="n">amount</span><span class="p">:</span> <span class="nb">float</span>
|
||||
<span class="w"> </span><span class="sd">"""Currency amount to be converted"""</span>
|
||||
|
||||
<span class="n">to_iso4217</span><span class="p">:</span> <span class="nb">str</span>
|
||||
<span class="w"> </span><span class="sd">"""ISO_4217_ alpha code of the currency used as the basis for conversion.</span>
|
||||
|
||||
<span class="sd"> .. _ISO_4217: https://en.wikipedia.org/wiki/ISO_4217</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<span class="n">from_iso4217</span><span class="p">:</span> <span class="nb">str</span>
|
||||
<span class="w"> </span><span class="sd">"""ISO_4217_ alpha code of the currency to be converted."""</span>
|
||||
|
||||
<span class="n">from_name</span><span class="p">:</span> <span class="nb">str</span>
|
||||
<span class="w"> </span><span class="sd">"""Name of the currency used as the basis for conversion."""</span>
|
||||
|
||||
<span class="n">to_name</span><span class="p">:</span> <span class="nb">str</span>
|
||||
<span class="w"> </span><span class="sd">"""Name of the currency of the currency to be converted."""</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="OnlineCurrenciesParams">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_currency.OnlineCurrenciesParams">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">OnlineCurrenciesParams</span><span class="p">(</span><span class="n">CurrenciesParams</span><span class="p">,</span> <span class="n">OnlineParams</span><span class="p">):</span> <span class="c1"># pylint: disable=duplicate-bases</span>
|
||||
<span class="w"> </span><span class="sd">"""Request parameters of a ``online_currency`` engine."""</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="OnlineCurrencyProcessor">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_currency.OnlineCurrencyProcessor">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">OnlineCurrencyProcessor</span><span class="p">(</span><span class="n">OnlineProcessor</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Processor class used by ``online_currency`` engines."""</span>
|
||||
|
||||
<span class="n">engine_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"online_currency"</span>
|
||||
|
||||
<div class="viewcode-block" id="OnlineCurrencyProcessor.get_params">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_currency.OnlineCurrencyProcessor.get_params">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">search_query</span><span class="p">:</span> <span class="s2">"SearchQuery"</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">OnlineCurrenciesParams</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns a dictionary with the :ref:`request params <engine request</span>
|
||||
<span class="sd"> online_currency>` (:py:obj:`OnlineCurrenciesParams`). ``None`` is</span>
|
||||
<span class="sd"> returned if the search query does not match :py:obj:`search_syntax`."""</span>
|
||||
|
||||
<span class="n">online_params</span><span class="p">:</span> <span class="n">OnlineParams</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_params</span><span class="p">(</span><span class="n">search_query</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">)</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">online_params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
<span class="n">m</span> <span class="o">=</span> <span class="n">search_syntax</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">m</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="n">amount_str</span><span class="p">,</span> <span class="n">from_currency</span><span class="p">,</span> <span class="n">to_currency</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">groups</span><span class="p">()</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="n">amount</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">amount_str</span><span class="p">)</span>
|
||||
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="c1"># most often $ stands for USD</span>
|
||||
<span class="k">if</span> <span class="n">from_currency</span> <span class="o">==</span> <span class="s2">"$"</span><span class="p">:</span>
|
||||
<span class="n">from_currency</span> <span class="o">=</span> <span class="s2">"$ us"</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">to_currency</span> <span class="o">==</span> <span class="s2">"$"</span><span class="p">:</span>
|
||||
<span class="n">to_currency</span> <span class="o">=</span> <span class="s2">"$ us"</span>
|
||||
|
||||
<span class="n">from_iso4217</span> <span class="o">=</span> <span class="n">from_currency</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">is_iso4217</span><span class="p">(</span><span class="n">from_iso4217</span><span class="p">):</span>
|
||||
<span class="n">from_iso4217</span> <span class="o">=</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">name_to_iso4217</span><span class="p">(</span><span class="n">_normalize_name</span><span class="p">(</span><span class="n">from_currency</span><span class="p">))</span>
|
||||
|
||||
<span class="n">to_iso4217</span> <span class="o">=</span> <span class="n">to_currency</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">is_iso4217</span><span class="p">(</span><span class="n">to_iso4217</span><span class="p">):</span>
|
||||
<span class="n">to_iso4217</span> <span class="o">=</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">name_to_iso4217</span><span class="p">(</span><span class="n">_normalize_name</span><span class="p">(</span><span class="n">to_currency</span><span class="p">))</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">from_iso4217</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">to_iso4217</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="n">ui_locale</span> <span class="o">=</span> <span class="n">flask_babel</span><span class="o">.</span><span class="n">get_locale</span><span class="p">()</span> <span class="ow">or</span> <span class="n">babel</span><span class="o">.</span><span class="n">Locale</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="s2">"en"</span><span class="p">)</span>
|
||||
<span class="n">from_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">iso4217_to_name</span><span class="p">(</span>
|
||||
<span class="n">from_iso4217</span><span class="p">,</span> <span class="n">ui_locale</span><span class="o">.</span><span class="n">language</span>
|
||||
<span class="p">)</span> <span class="c1"># pyright: ignore[reportAssignmentType]</span>
|
||||
<span class="n">to_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">CURRENCIES</span><span class="o">.</span><span class="n">iso4217_to_name</span><span class="p">(</span>
|
||||
<span class="n">to_iso4217</span><span class="p">,</span> <span class="n">ui_locale</span><span class="o">.</span><span class="n">language</span>
|
||||
<span class="p">)</span> <span class="c1"># pyright: ignore[reportAssignmentType]</span>
|
||||
|
||||
<span class="n">params</span><span class="p">:</span> <span class="n">OnlineCurrenciesParams</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="o">**</span><span class="n">online_params</span><span class="p">,</span>
|
||||
<span class="s2">"amount"</span><span class="p">:</span> <span class="n">amount</span><span class="p">,</span>
|
||||
<span class="s2">"from_iso4217"</span><span class="p">:</span> <span class="n">from_iso4217</span><span class="p">,</span>
|
||||
<span class="s2">"to_iso4217"</span><span class="p">:</span> <span class="n">to_iso4217</span><span class="p">,</span>
|
||||
<span class="s2">"from_name"</span><span class="p">:</span> <span class="n">from_name</span><span class="p">,</span>
|
||||
<span class="s2">"to_name"</span><span class="p">:</span> <span class="n">to_name</span><span class="p">,</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">params</span></div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">_normalize_name</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="n">name</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"-"</span><span class="p">,</span> <span class="s2">" "</span><span class="p">)</span>
|
||||
<span class="n">name</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s2">" +"</span><span class="p">,</span> <span class="s2">" "</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">unicodedata</span><span class="o">.</span><span class="n">normalize</span><span class="p">(</span><span class="s2">"NFKD"</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
|
||||
</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="../../search.html">searx.search</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>
|
||||
222
_modules/searx/search/processors/online_dictionary.html
Normal file
222
_modules/searx/search/processors/online_dictionary.html
Normal file
@@ -0,0 +1,222 @@
|
||||
<!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.search.processors.online_dictionary — SearXNG Documentation (2025.12.12+920b40253)</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=f2f42c25"></script>
|
||||
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.12.12+920b40253" 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.12.12+920b40253)</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="../../search.html" accesskey="U">searx.search</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">searx.search.processors.online_dictionary</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for searx.search.processors.online_dictionary</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">"""Processor used for ``online_dictionary`` engines."""</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">t</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.sxng_locales</span><span class="w"> </span><span class="kn">import</span> <span class="n">sxng_locales</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.online</span><span class="w"> </span><span class="kn">import</span> <span class="n">OnlineProcessor</span><span class="p">,</span> <span class="n">OnlineParams</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchQuery</span>
|
||||
|
||||
<span class="n">search_syntax</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">".*?([a-z]+)-([a-z]+) (.+)$"</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">I</span><span class="p">)</span>
|
||||
<span class="sd">"""Search syntax used for from/to language (e.g. ``en-de``)"""</span>
|
||||
|
||||
<span class="n">FromToType</span><span class="p">:</span> <span class="n">t</span><span class="o">.</span><span class="n">TypeAlias</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">[</span><span class="nb">bool</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span>
|
||||
<span class="sd">"""Type of a language descriptions in the context of a ``online_dictionary``."""</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="DictParams">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_dictionary.DictParams">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">DictParams</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">TypedDict</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Dictionary request parameters."""</span>
|
||||
|
||||
<span class="n">from_lang</span><span class="p">:</span> <span class="n">FromToType</span>
|
||||
<span class="w"> </span><span class="sd">"""Language from which is to be translated."""</span>
|
||||
|
||||
<span class="n">to_lang</span><span class="p">:</span> <span class="n">FromToType</span>
|
||||
<span class="w"> </span><span class="sd">"""Language to translate into."""</span>
|
||||
|
||||
<span class="n">query</span><span class="p">:</span> <span class="nb">str</span>
|
||||
<span class="w"> </span><span class="sd">"""Search term, cleaned of search syntax (*from-to* has been removed)."""</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="OnlineDictParams">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_dictionary.OnlineDictParams">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">OnlineDictParams</span><span class="p">(</span><span class="n">DictParams</span><span class="p">,</span> <span class="n">OnlineParams</span><span class="p">):</span> <span class="c1"># pylint: disable=duplicate-bases</span>
|
||||
<span class="w"> </span><span class="sd">"""Request parameters of a ``online_dictionary`` engine."""</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="OnlineDictionaryProcessor">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_dictionary.OnlineDictionaryProcessor">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">OnlineDictionaryProcessor</span><span class="p">(</span><span class="n">OnlineProcessor</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Processor class for ``online_dictionary`` engines."""</span>
|
||||
|
||||
<span class="n">engine_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"online_dictionary"</span>
|
||||
|
||||
<div class="viewcode-block" id="OnlineDictionaryProcessor.get_params">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_dictionary.OnlineDictionaryProcessor.get_params">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">search_query</span><span class="p">:</span> <span class="s2">"SearchQuery"</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">OnlineDictParams</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns a dictionary with the :ref:`request params <engine request</span>
|
||||
<span class="sd"> online_dictionary>` (:py:obj:`OnlineDictParams`). ``None`` is returned</span>
|
||||
<span class="sd"> if the search query does not match :py:obj:`search_syntax`."""</span>
|
||||
|
||||
<span class="n">online_params</span><span class="p">:</span> <span class="n">OnlineParams</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_params</span><span class="p">(</span><span class="n">search_query</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">online_params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
<span class="n">m</span> <span class="o">=</span> <span class="n">search_syntax</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">m</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="n">from_lang</span><span class="p">,</span> <span class="n">to_lang</span><span class="p">,</span> <span class="n">query</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">groups</span><span class="p">()</span>
|
||||
<span class="n">from_lang</span> <span class="o">=</span> <span class="n">_get_lang_descr</span><span class="p">(</span><span class="n">from_lang</span><span class="p">)</span>
|
||||
<span class="n">to_lang</span> <span class="o">=</span> <span class="n">_get_lang_descr</span><span class="p">(</span><span class="n">to_lang</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">from_lang</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">to_lang</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="n">params</span><span class="p">:</span> <span class="n">OnlineDictParams</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="o">**</span><span class="n">online_params</span><span class="p">,</span>
|
||||
<span class="s2">"from_lang"</span><span class="p">:</span> <span class="n">from_lang</span><span class="p">,</span>
|
||||
<span class="s2">"to_lang"</span><span class="p">:</span> <span class="n">to_lang</span><span class="p">,</span>
|
||||
<span class="s2">"query"</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">params</span></div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">_get_lang_descr</span><span class="p">(</span><span class="n">lang</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">FromToType</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns language's code and language's english name if argument ``lang``</span>
|
||||
<span class="sd"> describes a language known by SearXNG, otherwise ``None``.</span>
|
||||
|
||||
<span class="sd"> Examples:</span>
|
||||
|
||||
<span class="sd"> .. code:: python</span>
|
||||
|
||||
<span class="sd"> >>> _get_lang_descr("zz")</span>
|
||||
<span class="sd"> None</span>
|
||||
<span class="sd"> >>> _get_lang_descr("uk")</span>
|
||||
<span class="sd"> (True, "uk", "ukrainian")</span>
|
||||
<span class="sd"> >>> _get_lang_descr(b"uk")</span>
|
||||
<span class="sd"> (True, "uk", "ukrainian")</span>
|
||||
<span class="sd"> >>> _get_lang_descr("en")</span>
|
||||
<span class="sd"> (True, "en", "english")</span>
|
||||
<span class="sd"> >>> _get_lang_descr("Español")</span>
|
||||
<span class="sd"> (True, "es", "spanish")</span>
|
||||
<span class="sd"> >>> _get_lang_descr("Spanish")</span>
|
||||
<span class="sd"> (True, "es", "spanish")</span>
|
||||
|
||||
<span class="sd"> """</span>
|
||||
<span class="n">lang</span> <span class="o">=</span> <span class="n">lang</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
|
||||
<span class="n">is_abbr</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">lang</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span>
|
||||
<span class="k">if</span> <span class="n">is_abbr</span><span class="p">:</span>
|
||||
<span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">sxng_locales</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">l</span><span class="p">[</span><span class="mi">0</span><span class="p">][:</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="n">lang</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="n">l</span><span class="p">[</span><span class="mi">0</span><span class="p">][:</span><span class="mi">2</span><span class="p">],</span> <span class="n">l</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
<span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">sxng_locales</span><span class="p">:</span>
|
||||
<span class="k">if</span> <span class="n">l</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">lang</span> <span class="ow">or</span> <span class="n">l</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="n">lang</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="p">(</span><span class="kc">True</span><span class="p">,</span> <span class="n">l</span><span class="p">[</span><span class="mi">0</span><span class="p">][:</span><span class="mi">2</span><span class="p">],</span> <span class="n">l</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">())</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
</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="../../search.html">searx.search</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>
|
||||
184
_modules/searx/search/processors/online_url_search.html
Normal file
184
_modules/searx/search/processors/online_url_search.html
Normal file
@@ -0,0 +1,184 @@
|
||||
<!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.search.processors.online_url_search — SearXNG Documentation (2025.12.12+920b40253)</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=f2f42c25"></script>
|
||||
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script data-project="searxng" data-version="2025.12.12+920b40253" 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.12.12+920b40253)</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="../../search.html" accesskey="U">searx.search</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">searx.search.processors.online_url_search</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for searx.search.processors.online_url_search</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># SPDX-License-Identifier: AGPL-3.0-or-later</span>
|
||||
<span class="sd">"""Processor used for ``online_url_search`` engines."""</span>
|
||||
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">typing</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="nn">t</span>
|
||||
<span class="kn">import</span><span class="w"> </span><span class="nn">re</span>
|
||||
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.online</span><span class="w"> </span><span class="kn">import</span> <span class="n">OnlineProcessor</span><span class="p">,</span> <span class="n">OnlineParams</span>
|
||||
|
||||
<span class="k">if</span> <span class="n">t</span><span class="o">.</span><span class="n">TYPE_CHECKING</span><span class="p">:</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">.abstract</span><span class="w"> </span><span class="kn">import</span> <span class="n">EngineProcessor</span>
|
||||
<span class="kn">from</span><span class="w"> </span><span class="nn">searx.search.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">SearchQuery</span>
|
||||
|
||||
|
||||
<span class="n">search_syntax</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="s2">"http"</span><span class="p">:</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">"https?:\/\/[^ ]*"</span><span class="p">),</span>
|
||||
<span class="s2">"ftp"</span><span class="p">:</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">"ftps?:\/\/[^ ]*"</span><span class="p">),</span>
|
||||
<span class="s2">"data:image"</span><span class="p">:</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s2">"data:image/[^; ]*;base64,[^ ]*"</span><span class="p">),</span>
|
||||
<span class="p">}</span>
|
||||
<span class="sd">"""Search syntax used for a URL search."""</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="UrlParams">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_url_search.UrlParams">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">UrlParams</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">TypedDict</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""URL request parameters."""</span>
|
||||
|
||||
<span class="n">search_urls</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">]</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="OnlineUrlSearchParams">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_url_search.OnlineUrlSearchParams">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">OnlineUrlSearchParams</span><span class="p">(</span><span class="n">UrlParams</span><span class="p">,</span> <span class="n">OnlineParams</span><span class="p">):</span> <span class="c1"># pylint: disable=duplicate-bases</span>
|
||||
<span class="w"> </span><span class="sd">"""Request parameters of a ``online_url_search`` engine."""</span></div>
|
||||
|
||||
|
||||
|
||||
<div class="viewcode-block" id="OnlineUrlSearchProcessor">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_url_search.OnlineUrlSearchProcessor">[docs]</a>
|
||||
<span class="k">class</span><span class="w"> </span><span class="nc">OnlineUrlSearchProcessor</span><span class="p">(</span><span class="n">OnlineProcessor</span><span class="p">):</span>
|
||||
<span class="w"> </span><span class="sd">"""Processor class used by ``online_url_search`` engines."""</span>
|
||||
|
||||
<span class="n">engine_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"online_url_search"</span>
|
||||
|
||||
<div class="viewcode-block" id="OnlineUrlSearchProcessor.get_params">
|
||||
<a class="viewcode-back" href="../../../../src/searx.search.processors.html#searx.search.processors.online_url_search.OnlineUrlSearchProcessor.get_params">[docs]</a>
|
||||
<span class="k">def</span><span class="w"> </span><span class="nf">get_params</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">search_query</span><span class="p">:</span> <span class="s2">"SearchQuery"</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">OnlineUrlSearchParams</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="sd">"""Returns a dictionary with the :ref:`request params <engine request</span>
|
||||
<span class="sd"> online_currency>` (:py:obj:`OnlineUrlSearchParams`). ``None`` is</span>
|
||||
<span class="sd"> returned if the search query does not match :py:obj:`search_syntax`."""</span>
|
||||
|
||||
<span class="n">online_params</span><span class="p">:</span> <span class="n">OnlineParams</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">get_params</span><span class="p">(</span><span class="n">search_query</span><span class="p">,</span> <span class="n">engine_category</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">online_params</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="n">search_urls</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
|
||||
<span class="n">has_match</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
||||
|
||||
<span class="k">for</span> <span class="n">url_schema</span><span class="p">,</span> <span class="n">url_re</span> <span class="ow">in</span> <span class="n">search_syntax</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
||||
<span class="n">search_urls</span><span class="p">[</span><span class="n">url_schema</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
||||
<span class="n">m</span> <span class="o">=</span> <span class="n">url_re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">search_query</span><span class="o">.</span><span class="n">query</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="n">m</span><span class="p">:</span>
|
||||
<span class="n">has_match</span> <span class="o">=</span> <span class="kc">True</span>
|
||||
<span class="n">search_urls</span><span class="p">[</span><span class="n">url_schema</span><span class="p">]</span> <span class="o">=</span> <span class="n">m</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
|
||||
|
||||
<span class="k">if</span> <span class="ow">not</span> <span class="n">has_match</span><span class="p">:</span>
|
||||
<span class="k">return</span> <span class="kc">None</span>
|
||||
|
||||
<span class="n">params</span><span class="p">:</span> <span class="n">OnlineUrlSearchParams</span> <span class="o">=</span> <span class="p">{</span>
|
||||
<span class="o">**</span><span class="n">online_params</span><span class="p">,</span>
|
||||
<span class="s2">"search_urls"</span><span class="p">:</span> <span class="n">search_urls</span><span class="p">,</span>
|
||||
<span class="p">}</span>
|
||||
|
||||
<span class="k">return</span> <span class="n">params</span></div>
|
||||
</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="../../search.html">searx.search</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>
|
||||
Reference in New Issue
Block a user